Medidata Rave

App · 19 actions

Work with clinical trial data in Medidata Rave EDC: read studies, subjects, forms and the audit trail, create subjects, enter data and manage queries, and start workflows when data or queries change. The Rave user needs web services access from your Rave administrator.

Actions

ActionWhat it does
Answer, close or cancel queryAnswer, close or cancel a query on a field, by its query ID from the audit trail or a trigger.
Check connectionCheck that Rave Web Services is up and the connected user can sign in: its version, build, self-check and how many studies the user can reach.
Create subjectAdd a subject to a study at a site, optionally filling in fields on the enrollment form.
Enter or update form dataEnter or change field values on a subject's form, or add a log line.
Export study dataExport a study's data from Rave's clinical views, field by field: one form or all, one version or all, or only what changed since a time.
Get audit recordsRead a page of the study's clinical audit trail: who entered, changed, queried, reviewed or signed what, and when.
Get study versionGet a study version's design: its folders, forms, fields (with their questions, types, formats and choices) and data dictionaries.
Get subject dataGet one subject's data from Rave's clinical views, field by field, for every form or one form.
List commentsList the comments left on the study's data in Rave.
List data dictionariesList the study's data dictionaries: each coded value Rave stores and the text users see for it.
List foldersList the folders (visits) of every study version and matrix, including the extra matrices a study version's design leaves out.
List protocol deviationsList the protocol deviations recorded on the study's data, with their class and code.
List signature definitionsList the study's signature definitions: what each signature means and the statement the signer affirms.
List sitesList a study's sites with their numbers and the study version each uses.
List studiesList the studies and environments the connected Rave user can reach, such as Mediflex(Prod) and Mediflex(UAT).
List study usersList the Rave users in a study with their roles, groups and sites, optionally only those at one site.
List study versionsList a study's published versions (CRF versions), newest first, or its drafts in Architect.
List subjectsList a study's subjects with their site, UUID, link into Rave and workflow status flags (such as ready to lock).
Open queryOpen a query on a field for the site to answer.

Answer, close or cancel query

Answer, close or cancel a query on a field, by its query ID from the audit trail or a trigger. Sent once and never retried.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Subjectsubject_nametextRequired
The subject's name (Subject ID) as Rave shows it, such as 001-002. 'List subjects' or a trigger gives it.
Folderfolder_oidtextRequired
The folder (visit) the form is in, such as SCREEN. Pick Subject level for forms that sit in no folder.
Formform_oidtextRequired
The form, such as VS. Pick one, or give its OID.
Fieldfield_oidtextRequired
The field the query is on, such as VS.PULSE.
Current valuecurrent_valuetextRequired
The field's value now, exactly as entered in Rave, such as 72 or 05 MAR 2026 (a trigger's value gives it). Rave acts only when it matches.
Query IDquery_idnumberRequired
The query's ID, from a query trigger or 'Get audit records'.At least 1.
Actionnew_statustextRequired
What to do with the query.One of: Answered (Answer it), Closed (Close it), Cancelled (Cancel it).
Answerresponsetext
The answer to the query.Only when Action is Answer it.
Sitesite_oidtext
The subject's site. Leave empty to look it up from the subject.
Folder instancefolder_repeat_keynumber
Which instance of a repeating folder. Leave empty otherwise.At least 1.
Form instanceform_repeat_keynumber
Which instance of a repeating form. Defaults to 1.At least 1.
Log linelog_linenumber
The log line's number, for a log form. Leave empty otherwise.At least 1.

Outputs

field_oidtext
The field
fields_touchednumber
How many fields Rave changed
file_oidtext
The ID of the ODM document sent, as Rave's records show it
forms_touchednumber
How many forms Rave changed
log_lines_touchednumber
How many log lines Rave changed
query_idnumber
The query's ID
reference_numbertext
Rave's reference number for the change
statustext
Answered, Closed or Cancelled
study_oidtext
The study
subject_nametext
The subject
subjects_touchednumber
How many subjects Rave changed
summarytext
A one-line summary
Example output
{
  "field_oid": "VS.PULSE",
  "fields_touched": 1,
  "file_oid": "3b9fea8b-e825-4e5f-bdc8-1464bdd7a664",
  "forms_touched": 1,
  "log_lines_touched": 0,
  "query_id": 135,
  "reference_number": "82e942b0-48e8-4cf4-b299-51e2b6a89a1b",
  "status": "Closed",
  "study_oid": "Mediflex(UAT)",
  "subject_name": "001-002",
  "subjects_touched": 1,
  "summary": "Query 135 on VS.PULSE closed."
}

Check connection

Check that Rave Web Services is up and the connected user can sign in: its version, build, self-check and how many studies the user can reach.

Inputs

None.

Outputs

build_versiontext
The Rave build, such as 2026.1.0.0
diagnosticstext
Rave Web Services' self-check, OK when healthy
healthytrue/false
Whether the self-check said OK
rave_urltext
The Rave address the connection uses
study_countnumber
How many studies the user can reach
summarytext
A one-line summary
versiontext
The Rave Web Services version, such as 1.16.0
Example output
{
  "build_version": "2026.1.0.0",
  "diagnostics": "OK",
  "healthy": true,
  "rave_url": "https://innovate.mdsol.com",
  "study_count": 3,
  "summary": "Rave Web Services 1.16.0 (build 2026.1.0.0) at innovate.mdsol.com is up; this user can reach 3 studies.",
  "version": "1.16.0"
}

Create subject

Add a subject to a study at a site, optionally filling in fields on the enrollment form. Sent once and never retried.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Sitesite_oidtextRequired
The site to add the subject at.
Subjectsubject_nametextRequired
The new subject's name (Subject ID), such as 001-002.
Enrollment formform_oidtext
The subject-level form to fill in, usually the study's enrollment form. Leave empty to fill in nothing.
Field valuesfield_valuesobject
Values for the enrollment form, one per field. Dates are written in each field's Rave format for you.

Outputs

fields_touchednumber
How many fields Rave changed
file_oidtext
The ID of the ODM document sent, as Rave's records show it
forms_touchednumber
How many forms Rave changed
log_lines_touchednumber
How many log lines Rave changed
reference_numbertext
Rave's reference number for the change
site_oidtext
The site it was added at
study_oidtext
The study
subject_count_at_sitenumber
How many subjects the site now has, if Rave says
subject_count_in_studynumber
How many subjects the study now has, if Rave says
subject_nametext
The new subject's name
subjects_touchednumber
How many subjects Rave changed
summarytext
A one-line summary
Example output
{
  "fields_touched": 1,
  "file_oid": "3b9fea8b-e825-4e5f-bdc8-1464bdd7a664",
  "forms_touched": 1,
  "log_lines_touched": 0,
  "reference_number": "82e942b0-48e8-4cf4-b299-51e2b6a89a1b",
  "site_oid": "MDSOL",
  "study_oid": "Mediflex(UAT)",
  "subject_count_at_site": 55,
  "subject_count_in_study": 1103,
  "subject_name": "001-002",
  "subjects_touched": 1,
  "summary": "Subject 001-002 created at site MDSOL in Mediflex(UAT)."
}

Enter or update form data

Enter or change field values on a subject's form, or add a log line. Rave records the change under the connected user. Sent once and never retried.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Subjectsubject_nametextRequired
The subject's name (Subject ID) as Rave shows it, such as 001-002. 'List subjects' or a trigger gives it.
Folderfolder_oidtextRequired
The folder (visit) the form is in, such as SCREEN. Pick Subject level for forms that sit in no folder.
Formform_oidtextRequired
The form, such as VS. Pick one, or give its OID.
Field valuesfield_valuesobjectRequired
The values to save, one per field. Dates and times are written in each field's Rave format for you. Fields left empty are not touched.
Sitesite_oidtext
The subject's site. Leave empty to look it up from the subject.
Folder instancefolder_repeat_keynumber
Which instance of a repeating folder. Leave empty otherwise.At least 1.
Form instanceform_repeat_keynumber
Which instance of a repeating form. Defaults to 1.At least 1.
Log linelog_linenumber
The log line's number, for a log form. Leave empty otherwise.At least 1.
Add as a new log linenew_log_linetrue/false
Add 'Log line' as a new line instead of changing it. Rave refuses if the line exists.

Outputs

field_oidslist
The fields sent
fields_touchednumber
How many fields Rave changed
file_oidtext
The ID of the ODM document sent, as Rave's records show it
folder_oidtext
The folder
form_oidtext
The form
forms_touchednumber
How many forms Rave changed
log_lines_touchednumber
How many log lines Rave changed
reference_numbertext
Rave's reference number for the change
study_oidtext
The study
subject_nametext
The subject
subjects_touchednumber
How many subjects Rave changed
summarytext
A one-line summary
Example output
{
  "field_oids": [
    "VS.PULSE"
  ],
  "fields_touched": 1,
  "file_oid": "3b9fea8b-e825-4e5f-bdc8-1464bdd7a664",
  "folder_oid": "SCREEN",
  "form_oid": "VS",
  "forms_touched": 1,
  "log_lines_touched": 0,
  "reference_number": "82e942b0-48e8-4cf4-b299-51e2b6a89a1b",
  "study_oid": "Mediflex(UAT)",
  "subject_name": "001-002",
  "subjects_touched": 1,
  "summary": "Saved 1 field on VS in SCREEN for subject 001-002."
}

Export study data

Export a study's data from Rave's clinical views, field by field: one form or all, one version or all, or only what changed since a time.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Formform_oidtext
Only this form's data. Leave empty for every form.
Versionversion_oidtext
Only subjects on this study version. Leave empty for all.
Valuesdata_typetext
Regular gives Rave's clinical view values; raw gives them as entered. Defaults to regular.One of: regular (Regular (default)), raw. Default: regular.
Changed sincechanged_sincedate and time
Only data changed since this time. Needs the clinical views set to include inactive records.
Most valuesmax_rowsnumber
The most values to return. Defaults to 5,000.From 1 to 50000. Default: 5000.

Outputs

countnumber
How many values came back
itemslist
The values, with where each sits
study_oidtext
The study
subject_countnumber
How many subjects the values are from
totalnumber
How many values Rave sent
truncatedtrue/false
Whether some were left out by 'Most values'
views_updated_attext
When Rave last refreshed its clinical views
Example output
{
  "count": 1,
  "items": [
    {
      "field_oid": "VS.PULSE",
      "folder_oid": "SCREEN",
      "folder_repeat_key": "1",
      "form_oid": "VS",
      "form_repeat_key": "1",
      "item_group_oid": "VS",
      "log_line": "",
      "site_oid": "MDSOL",
      "study_oid": "Mediflex(UAT)",
      "subject_name": "001-002",
      "subject_uuid": "",
      "value": "72",
      "version_oid": "23"
    }
  ],
  "study_oid": "Mediflex(UAT)",
  "subject_count": 1,
  "total": 1,
  "truncated": false,
  "views_updated_at": "2026-10-28T09:10:00"
}

Get audit records

Read a page of the study's clinical audit trail: who entered, changed, queried, reviewed or signed what, and when.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Start fromstart_fromtext
Where in the audit trail to start reading.One of: beginning (The start of the audit trail (default)), time (A date and time), audit_id (An audit ID). Default: beginning.
Sincesincedate and time
Records from this time on.Only when Start from is A date and time.
Audit IDstart_idnumber
Records from this audit ID on, such as an earlier step's next_start_id.Only when Start from is An audit ID. At least 1.
How manyper_pagenumber
How many records to read, 1 to 1,000. Defaults to 100.From 1 to 1000. Default: 100.
Kinds of changedetailtext
Enhanced and every kind add more kinds of change (Rave EDC 2022.3 and later). Defaults to standard.One of: default (Standard (default)), enhanced, all (Every kind of change). Default: default.

Outputs

countnumber
How many came back
has_moretrue/false
Whether Rave has more records after these
next_start_idnumber
The audit ID to read the next page from
recordslist
The audit records, oldest first
started_at_idnumber
The audit ID reading started at
study_oidtext
The study
Example output
{
  "count": 1,
  "has_more": false,
  "next_start_id": 21480,
  "records": [
    {
      "audit_id": 21479,
      "comment": null,
      "deviation": null,
      "field_oid": "VS.PULSE",
      "folder_name": "Screening",
      "folder_oid": "SCREEN",
      "folder_repeat_key": "SCREEN[1]",
      "form_oid": "VS",
      "form_repeat_key": "1",
      "frozen": null,
      "item_group_oid": "VS",
      "locked": null,
      "log_line": "",
      "occurred_at": "2026-07-14T06:55:34",
      "page_name": "Vital Signs",
      "query": {
        "id": "135",
        "recipient": "Site from System",
        "response": "",
        "status": "Open",
        "text": "Please enter the pulse."
      },
      "reason_for_change": "",
      "record_id": "8511",
      "review": null,
      "signature": null,
      "site_oid": "MDSOL",
      "specify_value": "",
      "study_oid": "Mediflex(UAT)",
      "subcategory": "QueryOpen",
      "subject_name": "001-002",
      "subject_status": "",
      "subject_uuid": "a9611217-268e-4c92-9dff-f4b697741765",
      "user": "systemuser",
      "user_site_oid": "MDSOL",
      "value": "",
      "verified": null,
      "version_oid": "23"
    }
  ],
  "started_at_id": 21400,
  "study_oid": "Mediflex(UAT)"
}

Get study version

Get a study version's design: its folders, forms, fields (with their questions, types, formats and choices) and data dictionaries. Needs Architect access in Rave.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Versionversion_oidtext
The study version. Leave empty for the newest.

Outputs

code_listslist
The data dictionaries
default_matrix_oidtext
The study's default matrix
field_countnumber
How many fields
fieldslist
Every field of every form
folderslist
The folders and their forms
form_countnumber
How many forms
formslist
The forms
primary_form_oidtext
The form a subject is enrolled with
project_nametext
The study's project name
version_nametext
The version's name
version_oidtext
The version's OID
Example output
{
  "code_lists": [
    {
      "data_type": "integer",
      "items": [
        {
          "label": "Yes",
          "value": "1"
        },
        {
          "label": "No",
          "value": "0"
        }
      ],
      "name": "Yes No",
      "oid": "YES_NO"
    }
  ],
  "default_matrix_oid": "BASE",
  "field_count": 1,
  "fields": [
    {
      "active": true,
      "choices": [],
      "code_list_oid": "",
      "control_type": "Text",
      "data_type": "integer",
      "date_format": "",
      "form_oid": "VS",
      "label": "Pulse",
      "length": 3,
      "mandatory": false,
      "name": "PULSE",
      "oid": "VS.PULSE",
      "question": "Pulse (beats per minute)",
      "variable_oid": "PULSE"
    }
  ],
  "folders": [
    {
      "form_oids": [
        "VS"
      ],
      "name": "Screening",
      "oid": "SCREEN",
      "repeating": false,
      "type": "Common"
    }
  ],
  "form_count": 1,
  "forms": [
    {
      "field_count": 1,
      "name": "Vital Signs",
      "oid": "VS",
      "repeating": false
    }
  ],
  "primary_form_oid": "EN",
  "project_name": "Mediflex",
  "version_name": "2",
  "version_oid": "23"
}

Get subject data

Get one subject's data from Rave's clinical views, field by field, for every form or one form.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Subjectsubject_nametextRequired
The subject's name (Subject ID) as Rave shows it, such as 001-002. 'List subjects' or a trigger gives it.
Formform_oidtext
Only this form's data. Leave empty for every form.
Valuesdata_typetext
Regular gives Rave's clinical view values; raw gives them as entered. Defaults to regular.One of: regular (Regular (default)), raw. Default: regular.

Outputs

countnumber
How many values came back
itemslist
Every value, with where it sits
site_oidtext
The subject's site
study_oidtext
The study
subject_nametext
The subject
valuesobject
Each field's first value by field OID, such as VS.PULSE
views_updated_attext
When Rave last refreshed its clinical views
Example output
{
  "count": 1,
  "items": [
    {
      "field_oid": "VS.PULSE",
      "folder_oid": "SCREEN",
      "folder_repeat_key": "1",
      "form_oid": "VS",
      "form_repeat_key": "1",
      "item_group_oid": "VS",
      "log_line": "",
      "site_oid": "MDSOL",
      "study_oid": "Mediflex(UAT)",
      "subject_name": "001-002",
      "subject_uuid": "",
      "value": "72",
      "version_oid": "23"
    }
  ],
  "site_oid": "MDSOL",
  "study_oid": "Mediflex(UAT)",
  "subject_name": "001-002",
  "values": {
    "VS.PULSE": "72"
  },
  "views_updated_at": "2026-10-28T09:10:00"
}

List comments

List the comments left on the study's data in Rave.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

commentslist
The comments
countnumber
How many came back
study_oidtext
The study
Example output
{
  "comments": [
    {
      "active": true,
      "datapoint_id": "2289046",
      "field_oid": "PULSE",
      "folder_instance_id": "192317",
      "folder_name": "Screening",
      "form_oid": "VS",
      "page_id": "662516",
      "page_name": "Vitals",
      "record_position": "0",
      "site_number": "TESTSITE",
      "subject_id": "32114",
      "subject_name": "001-002",
      "text": "Taken after the second dose.",
      "updated": "10/7/2026 3:50:18 PM",
      "updated_at": "2026-10-07T15:50:18"
    }
  ],
  "count": 1,
  "study_oid": "Mediflex(UAT)"
}

List data dictionaries

List the study's data dictionaries: each coded value Rave stores and the text users see for it.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

countnumber
How many entries came back
dictionarieslist
The dictionaries' names
entrieslist
Every coded value
study_oidtext
The study
Example output
{
  "count": 1,
  "dictionaries": [
    "AE Severity"
  ],
  "entries": [
    {
      "coded_value": "3",
      "crf_version_id": "18",
      "dictionary": "AE Severity",
      "user_value": "Severe"
    }
  ],
  "study_oid": "Mediflex(UAT)"
}

List folders

List the folders (visits) of every study version and matrix, including the extra matrices a study version's design leaves out.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

countnumber
How many came back
folderslist
The folders
study_oidtext
The study
Example output
{
  "count": 1,
  "folders": [
    {
      "is_default_matrix": true,
      "matrix_oid": "BASE",
      "name": "Screening",
      "oid": "SCREEN",
      "order": 1,
      "repeating": false,
      "type": "Common",
      "version_name": "2",
      "version_oid": "23"
    }
  ],
  "study_oid": "Mediflex(UAT)"
}

List protocol deviations

List the protocol deviations recorded on the study's data, with their class and code.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

countnumber
How many came back
deviationslist
The protocol deviations
study_oidtext
The study
Example output
{
  "count": 1,
  "deviations": [
    {
      "active": true,
      "code": "Deviation",
      "datapoint_id": "2289046",
      "deviation_class": "Incl/Excl Criteria not met",
      "field_oid": "PULSE",
      "folder_instance_id": "192317",
      "folder_name": "Screening",
      "form_oid": "VS",
      "page_id": "662516",
      "page_name": "Vitals",
      "record_position": "0",
      "site_number": "TESTSITE",
      "subject_id": "32114",
      "subject_name": "001-002",
      "text": "Inclusion criteria not met.",
      "updated": "10/7/2026 3:50:18 PM",
      "updated_at": "2026-10-07T15:50:18"
    }
  ],
  "study_oid": "Mediflex(UAT)"
}

List signature definitions

List the study's signature definitions: what each signature means and the statement the signer affirms.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

countnumber
How many came back
project_nametext
The study's project name
signatureslist
The signature definitions
Example output
{
  "count": 1,
  "project_name": "Mediflex",
  "signatures": [
    {
      "legal_reason": "I hereby confirm that all data is accurate to the best of my knowledge.",
      "meaning": "Approval",
      "methodology": "Electronic",
      "oid": "2866",
      "study": "Mediflex"
    }
  ]
}

List sites

List a study's sites with their numbers and the study version each uses.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.

Outputs

countnumber
How many sites came back
siteslist
The sites
study_oidtext
The study
Example output
{
  "count": 1,
  "sites": [
    {
      "active": true,
      "current_version_oid": "23",
      "name": "Uxbridge Medical Centre",
      "oid": "MDSOL",
      "study_site_number": "",
      "type": "Site",
      "versions": [
        {
          "effective_date": "2009-04-20",
          "study_oid": "Mediflex(UAT)",
          "study_site_number": "",
          "version_oid": "23"
        }
      ]
    }
  ],
  "study_oid": "Mediflex(UAT)"
}

List studies

List the studies and environments the connected Rave user can reach, such as Mediflex(Prod) and Mediflex(UAT).

Inputs

Environmentsenvironmenttext
Which environments to list. Defaults to all.One of: all (All environments (default)), production (Production only), non_production (Test environments only (not Prod)). Default: all.

Outputs

countnumber
How many studies came back
studieslist
The studies
Example output
{
  "count": 1,
  "studies": [
    {
      "environment": "UAT",
      "is_production": false,
      "name": "Mediflex (UAT)",
      "oid": "Mediflex(UAT)",
      "project_type": "Project",
      "protocol_name": "Mediflex"
    }
  ]
}

List study users

List the Rave users in a study with their roles, groups and sites, optionally only those at one site.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Sitesite_oidtext
Only users at this site. Leave empty for all.

Outputs

countnumber
How many users came back
study_oidtext
The study
userslist
The users
Example output
{
  "count": 1,
  "study_oid": "Mediflex(UAT)",
  "users": [
    {
      "active": true,
      "display_name": "Jane Smith",
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "full_name": "Jane Smith",
      "last_name": "Smith",
      "login": "jsmith",
      "oid": "jsmith",
      "role": "CRA",
      "site_group": "World",
      "site_oids": [
        "MDSOL"
      ],
      "user_group": "Monitors",
      "user_type": "Other"
    }
  ]
}

List study versions

List a study's published versions (CRF versions), newest first, or its drafts in Architect.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Whichwhich_versionstext
Published versions or drafts. Defaults to versions.One of: versions (Published versions (default)), drafts (Drafts in Architect). Default: versions.

Outputs

countnumber
How many came back
newest_oidtext
The newest one's OID, empty if none
project_nametext
The study's project name
versionslist
The versions, newest first
which_versionstext
versions or drafts
Example output
{
  "count": 2,
  "newest_oid": "23",
  "project_name": "Mediflex",
  "versions": [
    {
      "name": "2",
      "oid": "23"
    },
    {
      "name": "1",
      "oid": "16"
    }
  ],
  "which_versions": "versions"
}

List subjects

List a study's subjects with their site, UUID, link into Rave and workflow status flags (such as ready to lock).

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Includealso_includetext
Which subjects to list. Defaults to active ones.One of: none (Active subjects only (default)), inactive (Also inactive subjects), deleted (Also deleted subjects), inactiveAndDeleted (Also inactive and deleted subjects). Default: none.
Sitesite_oidtext
Only subjects at this site. Leave empty for all.

Outputs

countnumber
How many came back
study_oidtext
The study
subjectslist
The subjects
Example output
{
  "count": 1,
  "study_oid": "Mediflex(UAT)",
  "subjects": [
    {
      "active": true,
      "deleted": false,
      "flags": {
        "empty": false,
        "frozen": false,
        "incomplete": false,
        "locked": false,
        "non_conformant": false,
        "overdue": false,
        "pending_review": false,
        "ready_for_freeze": false,
        "ready_for_lock": false,
        "requires_answer_query": false,
        "requires_close_query": false,
        "requires_coding": false,
        "requires_pending_answer_query": false,
        "requires_pending_close_query": false,
        "requires_reconciliation": false,
        "requires_review": false,
        "requires_second_pass": false,
        "requires_signature": false,
        "requires_translation": false,
        "requires_verification": false,
        "reviewed": false,
        "signature_current": false,
        "signed": false,
        "sticky_placed": false,
        "touched": true,
        "verified": false
      },
      "link": "https://innovate.mdsol.com/MedidataRAVE/HandleLink.aspx?page=SubjectPage.aspx?ID=849",
      "name": "001-002",
      "site_number": "001",
      "site_oid": "MDSOL",
      "status": "",
      "study_oid": "Mediflex(UAT)",
      "uuid": "e983f330-c108-45ab-8f16-b4a566c7089c",
      "version_oid": "23"
    }
  ]
}

Open query

Open a query on a field for the site to answer. Rave opens it only if the field still holds the value given. Sent once and never retried.

Inputs

Studystudy_oidtextRequired
The study and environment, such as Mediflex(Prod) or Mediflex(UAT). Pick one, or give its OID from an earlier step.
Subjectsubject_nametextRequired
The subject's name (Subject ID) as Rave shows it, such as 001-002. 'List subjects' or a trigger gives it.
Folderfolder_oidtextRequired
The folder (visit) the form is in, such as SCREEN. Pick Subject level for forms that sit in no folder.
Formform_oidtextRequired
The form, such as VS. Pick one, or give its OID.
Fieldfield_oidtextRequired
The field the query is on, such as VS.PULSE.
Current valuecurrent_valuetextRequired
The field's value now, exactly as entered in Rave, such as 72 or 05 MAR 2026 (a trigger's value gives it). Rave acts only when it matches.
Queryquery_texttextRequired
What the site should check, such as Please confirm the pulse.
Send torecipienttext
The marking group to send it to, as named in Rave. Defaults to Site from System.Default: Site from System.
Needs an answerrequires_responsetrue/false
Whether the site must answer it. Defaults to yes.Default: true.
Sitesite_oidtext
The subject's site. Leave empty to look it up from the subject.
Folder instancefolder_repeat_keynumber
Which instance of a repeating folder. Leave empty otherwise.At least 1.
Form instanceform_repeat_keynumber
Which instance of a repeating form. Defaults to 1.At least 1.
Log linelog_linenumber
The log line's number, for a log form. Leave empty otherwise.At least 1.

Outputs

field_oidtext
The field queried
fields_touchednumber
How many fields Rave changed
file_oidtext
The ID of the ODM document sent, as Rave's records show it
form_oidtext
The form
forms_touchednumber
How many forms Rave changed
log_lines_touchednumber
How many log lines Rave changed
recipienttext
The marking group it was sent to
reference_numbertext
Rave's reference number for the change
study_oidtext
The study
subject_nametext
The subject
subjects_touchednumber
How many subjects Rave changed
summarytext
A one-line summary
Example output
{
  "field_oid": "VS.PULSE",
  "fields_touched": 1,
  "file_oid": "3b9fea8b-e825-4e5f-bdc8-1464bdd7a664",
  "form_oid": "VS",
  "forms_touched": 1,
  "log_lines_touched": 0,
  "recipient": "Site from System",
  "reference_number": "82e942b0-48e8-4cf4-b299-51e2b6a89a1b",
  "study_oid": "Mediflex(UAT)",
  "subject_name": "001-002",
  "subjects_touched": 1,
  "summary": "Query opened on VS.PULSE for subject 001-002, sent to Site from System."
}

On this page