All REST Endpoints

Codelist/v1.0
The operations from the Codelist/v1.0 category.
[Deprecated] Delete an existing codelist
Method: delete
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated] Get a codelist for the given code name
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{name}
[Deprecated] Get a codelist matching the given name
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/{name}
[Deprecated] Get all codelist values by codelist ID and data type
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/{codeId}/code
[Deprecated] Get codelist by tag
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/tag/{tagName}
[Deprecated] Get list of all codelists
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated] Get list of all codelists by codelist type
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/all
[Deprecated] Insert a new codelist
Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/code
[Deprecated] Insert a new codelist with tag
Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/code/tag
[Deprecated] Insert a system-level codelist
Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated] Update an existing codelist
Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated] Update codelist by codelist ID
Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}
[Deprecated] Update codelist tags by codelist ID
Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}/tag
Associate the Group to the Study
Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/study/{studyId}
Delete an existing codelist using codelist ID
Method: delete
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}
Get a codelist matching the given fieldName, type, data type, isHierarchial and language.
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/values/{fieldName}
Get all codelist tag values by codelist ID and data type
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}/tag
Insert a new CodeList Group
Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/groups
Retrieve a CodeList group by id
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/{groupId}
Retrieves all CodeList groups
Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/groups
Update codelist with tag values
Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/tag
Updates the CodeList Group by the given id
Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/{groupId}
Codelist/v2.0
The operations from the Codelist/v2.0 category.
[Deprecated] Delete an existing codelist
Method: delete
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated] Get a codelist matching the given code name in the payload
Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated] Get a codelist matching the given name
Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/{name}
[Deprecated] Get all historic codelists for a given code name
Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/history/{name}
[Deprecated] Insert a new codelist
Method: post
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated] Update an existing codelist
Method: put
Path: /ec-codelist-svc/rest/v2.0/codelist
Get a codelist values matching the given fieldName, type, studyId, groupId, data type, isHierarchial and language.
Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/values/{fieldName}
Get list of all codelists with tag by codelist type.
Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/all
Insert a new codelist with tag if present
Method: post
Path: /ec-codelist-svc/rest/v2.0/codelist/code
Update an existing codelist using codelist ID with tag
Method: put
Path: /ec-codelist-svc/rest/v2.0/codelist/code/{codeId}
Codelist/v3.0
The operations from the Codelist/v3.0 category.
[Deprecated] Get a codelist matching the given name
Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist/{name}
Get a list of all codelists by codelist type
Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist
Insert a new codelist
Method: post
Path: /ec-codelist-svc/rest/v3.0/codelist/code
Codelist/v4.0
The operations from the Codelist/v4.0 category.
[Deprecated] Get a codelist matching the given name
Method: get
Path: /ec-codelist-svc/rest/v4.0/codelist/{name}
Get a list of all codelists by codelist type
Method: get
Path: /ec-codelist-svc/rest/v4.0/codelist
Coding/Query Resource/v1.0
The operations from the Coding/Query Resource/v1.0 category.
Create queries/discrepancies
Method: post
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query
Get query details by query ID or discrepancyId and revision number
Method: post
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query/discrepancy
Get query details on a verbatim term from Clinical One
Method: get
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query/transaction
Update status of created queries/discrepancies
Method: put
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query
Coding/Service Status/v1.0
The operations from the Coding/Service Status/v1.0 category.
Get the list of verbatim terms to code
Method: get
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/verbatimTerms
Put coded verbatims terms in DCS
Method: put
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/codedValues
Data Capture/Coding Status/v1.0
The operations from the Data Capture/Coding Status/v1.0 category.
Get data elements to be coded by codeType
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus
Get data elements to be coded using source IDs
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus
Updates multiple coded data elements for a source data element
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus/codedItems
Data Capture/DCProperties APIs/v1.0
The operations from the Data Capture/DCProperties APIs/v1.0 category.
Get audit history of a property
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/history/{id}
Get Data Capture properties
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{id}
Data Capture/Data Elements/v1.0
The operations from the Data Capture/Data Elements/v1.0 category.
Create data elements for a visit and for a flat port of multi section form
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Create data elements for a visit and for a form
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode
Create data elements for a visit and for a repeat port of multi section form
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Create migrate data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/migratedata
Create multiple data elements for a form with form associations
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
Create multiple data elements in a reapeating form for a subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multirepeatingform
Create source data verification group
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup
Delete data elements for a visit and for a form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/dataelements/delete
Delete the data elements for a visit and for a form
Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Freeze multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze
Get all data elements based on subject and visit
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
Get all existing data elements across all repeating form/visit instances
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/repeatinginstances/subjectId/{subjectId}
Get all items with source data verification information
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/sdv
Get all source data verification groups
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup/all
Get data elements along with form associations
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get data elements based on subject, visit, and form
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/dataelements
Get data elements by form ID, Subject ID, Event ID and Vendor code
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/vendorCode/{vendorCode}/dataelements/withvendorcode
Get data elements for a list of items by subject ID
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and form combination
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for multiple items
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multiple
Get data elements history with pagination
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/all
Get form associations by study ID
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/formassociations
Get the audit history for a data element
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the audit history for a form association
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}
Get the current status of a data element
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataelementId}
Get the data element for a subject for a form and a site
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
Get the data elements for a subject for a given date range.
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get the deleted data element
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Unfreeze single data element of a visit
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}
Update a single data element for a subject
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataElementId}
Update data elements for a visit and for a flat part of multi section form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Update data elements for a visit and for a form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode
Update data elements for a visit and for a repeat part part of multi section form.
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Update multiple data elements
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
Update multiple data elements for a subject on a given form and visit
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations
Update source data verification group
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup
Upsert data elements for a visit and for a flat part of multi section form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat
Upsert data elements for a visit and for a form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode
Upsert data elements for a visit and for a repeat part of multi section form
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat
Verify multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/verify
Data Capture/Data Elements/v10.0
The operations from the Data Capture/Data Elements/v10.0 category.
Create multiple data elements for a subject with form associations
Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements
Data Capture/Data Elements/v11.0
The operations from the Data Capture/Data Elements/v11.0 category.
Create multiple data elements for a subject with form associations
Method: post
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements
Data Capture/Data Elements/v2.0
The operations from the Data Capture/Data Elements/v2.0 category.
Create data elements for a visit and for a flat port of multi section form
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Create data elements for a visit and for a repeat port of multi section form
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
Create multiple data elements for a subject in a form with form associations
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations
Create multiple data elements for section form
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
Delete the data elements for a visit and for a form, including two section forms
Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Freeze multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/freeze
Get all data elements based on study ID
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
Get all the latest datalement records for a subject for a given date range
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get data elements based on subject, visit, and form
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/dataelements
Get data elements for a list of item IDs
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and form combination
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for multiple items
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multiple
Get data elements history with pagination
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/all
Get data elements with form associations and section forms
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get the audit history for a data element
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the data element for a subject, a form and a site
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
Get the deleted data element
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Unfreeze single data element of a visit
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}
Upsert data elements for a visit and for a flat part of multi section form
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat
Upsert data elements for a visit and for a repeat part of multi section form
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat
Verify multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/verify
Data Capture/Data Elements/v3.0
The operations from the Data Capture/Data Elements/v3.0 category.
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
Create multiple data elements for sectionform
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
Delete the data elements for a visit and for a form, including two section forms
Method: delete
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Freeze multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/freeze
Get all data elements for a subject and for a visit or for all subjects or all visits
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
Get all the latest datalement records for a subject for a given date range
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get data elements along with form associations, with section forms
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get data elements for a list of items by subject ID
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and combination
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for multiple items
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multiple
Get data elements history with pagination
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/all
Get the audit history for a data element
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the deleted data element
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Update single data element
Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Verify multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/verify
Data Capture/Data Elements/v4.0
The operations from the Data Capture/Data Elements/v4.0 category.
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
Get all data elements based on subject, visit
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
Get data elements for a list of items by subject ID
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and combination
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements that have been deleted
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element
Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Verify multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/verify
Data Capture/Data Elements/v5.0
The operations from the Data Capture/Data Elements/v5.0 category.
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
Get data elements for a list of items by subject ID
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and form combination
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for one or multiple subjects and their visits
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element
Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Data Capture/Data Elements/v6.0
The operations from the Data Capture/Data Elements/v6.0 category.
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements
Get data elements for a list of items by subject ID with repeat transformations
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and form combination
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for one or multiple subjects and their visits
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
List all visits of subject with the form in it
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/eventsCount
Data Capture/Data Elements/v7.0
The operations from the Data Capture/Data Elements/v7.0 category.
Create multiple data elements for a subject
Method: post
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
Get data elements for one or multiple subjects and their visits
Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Data Capture/Data Elements/v8.0
The operations from the Data Capture/Data Elements/v8.0 category.
Create multiple data elements for a subject with form associations
Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements
Get data elements for one or multiple subjects and their visits
Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element with section support
Method: put
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Data Capture/Data Elements/v9.0
The operations from the Data Capture/Data Elements/v9.0 category.
Create multiple data elements for a subject with form associations
Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history
Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element with support for the fields innerRepeat and outerRepeat
Method: put
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Data Capture/Electronic Signature/v1.0
The operations from the Data Capture/Electronic Signature/v1.0 category.
Get URL for IAMS login page
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/esign/geturl/orgId/{orgId}/subjectId/{subjectId}
Data Capture/Enrollment Settings/v1.0
The operations from the Data Capture/Enrollment Settings/v1.0 category.
Create enrollment setting
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings
Get specific enrollment settings
Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings
Update enrollment setting
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings
Data Capture/Lab/v1.0
The operations from the Data Capture/Lab/v1.0 category.
Create lab for a subject
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals
Update lab for a subject
Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals
Data Capture/Lab/v2.0
The operations from the Data Capture/Lab/v2.0 category.
Create lab for a subject
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals
Update lab for a subject
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals
Data Capture/Rules Generic Operations/v1.0
The operations from the Data Capture/Rules Generic Operations/v1.0 category.
Perform generic operation on repeating forms
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/genericoperation
Data Capture/Subject Reports/v1.0
The operations from the Data Capture/Subject Reports/v1.0 category.
Generate a report based on the path parameter
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/reports/{reportName}
Generate a specific report
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/report/{reportName}
Generate report for a subject's data and events
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}
Data Capture/Subject Reports/v2.0
The operations from the Data Capture/Subject Reports/v2.0 category.
Generate a report based on the path parameter
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}
Data Capture/Subject Reports/v3.0
The operations from the Data Capture/Subject Reports/v3.0 category.
Generate a report based on the path parameter
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}
Data Capture/Subject Reports/v4.0
The operations from the Data Capture/Subject Reports/v4.0 category.
Generate a report based on the path parameter
Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/report/{reportName}
Data Capture/Subject Settings/v1.0
The operations from the Data Capture/Subject Settings/v1.0 category.
Create subject settings
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Get all the mHealth settings
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings
Get all the source data verification settings
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings
Get specific subject settings
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Get the subject settings based on settings ID
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/{id}
Remove subject settings
Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Update mHealth settings
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings
Update source data verification settings
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings
Update subject settings
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Data Capture/Subject Settings/v2.0
The operations from the Data Capture/Subject Settings/v2.0 category.
Creates subject settings
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
Get all subject settings
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
Update subject settings
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
Data Capture/Subjects/v1.0
The operations from the Data Capture/Subjects/v1.0 category.
Add a subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
Add a transferred subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/migratesubject
Check status of study randomization limit or restriction
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randrestricted
Check the study randomization limit
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randlimitexceeded
Code view on a subject
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Create a subject transfer
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
Enroll a subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/enroll
Get a list of events by type
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/events
Get a list of subject numbers
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/numberstatus
Get a list of subject-related values
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/lov/{pathAttr}
Get a list of subjects for the specified study and mode
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
Get a subject's events within a date range
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get all subjects for a specific study version
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sitestudyversion
Get Clinical Data which is part of ODMSubmit
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}
Get details for a subject
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
Get events within a date range
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange
Get history for a specific subject
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get information for a transfer ID
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId}
Get last added subject number
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/availableSubjectNumbers
Get latest audit verification records for visits
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history
Get latest/audit records for Source Data Verification
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sdvselected
Get OrgId used to generate subject number
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/orgid
Get source data verification selection status for all subjects
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/selectionStatus/{siteId}
Get subjects and their visit schedule
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/visitschedule
Get the history of all subjects in a mode
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/all
Get transfer records for a study
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
Get transfer records for a subject for a date range
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}
Get transfer records for a subject.
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
Get Visits MetaData which is part of ODMSubmit
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}
List all subjects for the study and mode
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/idsforsitestudyversion
Perform code break on a subject
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Randomize or dispense subject
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randomizeordispense
Register subject to mHealth
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/mhealthRegister
Sign subject and visits
Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Undo the latest operation applied to the subject
Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/state/{subjectId}
Update subject details
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
Data Capture/Subjects/v2.0
The operations from the Data Capture/Subjects/v2.0 category.
Add a subject to a study
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
Code break a subject
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Code view on a subject
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Get a list of subjects for the site study version
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get a list of subjects for the specified study and mode
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
Get a subject's events within a date range
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get all the transfer records for a subject ID
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
Get details for a subject
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get history for a subject
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get latest audit verification records for visits
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visit/verify/history
Get transfer records for a study
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers
Get visit data by subject ID
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dispensedvisits/{subjectId}
Randomize or dispense subject
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/randomizeordispense
Revert the latest subject state
Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/state/{subjectId}
Sign subject and visits
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Update single data element
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Update subject details
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
Data Capture/Subjects/v3.0
The operations from the Data Capture/Subjects/v3.0 category.
Add a subject to a study
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
Get a list of subjects for the specified study and mode
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
Get all the transfer records for a subject ID
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
Get or search list of subjects
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject based on ID
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get subject history
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Perform code break on a subject
Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Sign subject and visits
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Update subject information
Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
Data Capture/Subjects/v4.0
The operations from the Data Capture/Subjects/v4.0 category.
Get or search list of subjects
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject based on ID
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get subject history
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Data Capture/Subjects/v5.0
The operations from the Data Capture/Subjects/v5.0 category.
Get or search list of subjects
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject history
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Data Capture/Subjects/v6.0
The operations from the Data Capture/Subjects/v6.0 category.
Get or search list of subjects
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Update single data element
Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Update single data element to clear rule error
Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId}/clearruleerror/{message}
Data Capture/Subjects/v7.0
The operations from the Data Capture/Subjects/v7.0 category.
Get or search list of subjects
Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Return list of repeatFormNumber, formSectionId and repeatInstanceNumbers
Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/repeatInstanceNumbers
Update single data element
Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Update single data element to clear rule error
Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/{dataElementId}/clearruleerror/{message}
Data Capture/Subjects/v8.0
The operations from the Data Capture/Subjects/v8.0 category.
Get or search or filter list of subjects
Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Data Capture/Visits Status/v1.0
The operations from the Data Capture/Visits Status/v1.0 category.
Create a new visit status record
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
Get list of adverse event visit counts for a list of subjects
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects/aeCount
Get list of visit statuses for given entries
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/multiple
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a date range
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
Get list of visits status for a list of subjects
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects
Get the audit/history visits status for the given visit ID
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Persist migrated visit data
Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/migratevisit
Retrieve the Associated and Dynamic forms for a subject visit
Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/forms/studyVersion/{studyVersion}/subject/{subjectId}/event/{eventId}
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v2.0
The operations from the Data Capture/Visits Status/v2.0 category.
Create visit status record
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a data range
Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange
Get subject's visits list and the current state's study version
Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/subjects
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v3.0
The operations from the Data Capture/Visits Status/v3.0 category.
Create visit status record
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
Get subject's visits list and the current state's study version
Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/subjects
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v4.0
The operations from the Data Capture/Visits Status/v4.0 category.
Create visit status record
Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a date range
Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
Get list of visits status for subjects
Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/subjects
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v5.0
The operations from the Data Capture/Visits Status/v5.0 category.
Create visit status record
Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for subjects
Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/subjects
Update and remove the visit status rule error
Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v6.0
The operations from the Data Capture/Visits Status/v6.0 category.
Get audit/history records for the given visit status ID
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus
Update the visit status for a given ID.
Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v7.0
The operations from the Data Capture/Visits Status/v7.0 category.
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus
Update the visit status for a given ID
Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Data Capture/Visits Status/v8.0
The operations from the Data Capture/Visits Status/v8.0 category.
Get list of visits status for subjects
Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/subjects
Data Capture/Visits Status/v9.0
The operations from the Data Capture/Visits Status/v9.0 category.
Get list of visits status
Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for subjects
Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/subjects
Data Hub/v1.0
Get blinded visit details
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get codelists for study
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/codelists
Get data collection for study
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Get kits and randomization design data for study
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
Get queries raised for study
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details
Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for admin data
Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/admin
ODM extract for clinical data with hidden data
Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data
Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data
Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/metadata
Data Hub/v2.0
Get blinded visit details
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get queries raised for study
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details
Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data
Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data
Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data
Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/metadata
Data Hub/v3.0
Get blinded visit details
Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get subject data details
Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details
Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details
Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get unblinded subject data details
Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data
Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data
Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
Data Hub/v4.0
Get subject form items data details
Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details
Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Designer/Branch APIs/v1.0
The operations from the Designer/Branch APIs/v1.0 category.
Add a branch
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches
Delete a branch
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
Get a list of study branches
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches
Get study branch
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
Update a branch
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/branches/{branchid}
Designer/Branch APIs/v2.0
The operations from the Designer/Branch APIs/v2.0 category.
Add a branch
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches
Delete a branch
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches/{branchid}
Get a list of study branches
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches
Get study branch
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches/{branchid}
Update a branch
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches/{branchid}
Designer/Dispensing APIs/v1.0
The operations from the Designer/Dispensing APIs/v1.0 category.
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/dispensings
Designer/Dispensing APIs/v2.0
The operations from the Designer/Dispensing APIs/v2.0 category.
[Deprecated]: Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/dispensings
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/dispensings
Designer/Dispensing APIs/v3.0
The operations from the Designer/Dispensing APIs/v3.0 category.
[Deprecated]: Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/dispensings
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/dispensings
Designer/Dispensing APIs/v4.0
The operations from the Designer/Dispensing APIs/v4.0 category.
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/dispensings
Designer/Dispensing APIs/v5.0
The operations from the Designer/Dispensing APIs/v5.0 category.
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/dispensings
Designer/Dispensing APIs/v6.0
The operations from the Designer/Dispensing APIs/v6.0 category.
Get list of dispensation visits in a study version
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits
Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/dispensings
Designer/FormItem APIs -- Deprecated/v1.0
The operations from the Designer/FormItem APIs -- Deprecated/v1.0 category.
[Deprecated]: Add a question in a form
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Designer/FormItem APIs -- Deprecated/v2.0
The operations from the Designer/FormItem APIs -- Deprecated/v2.0 category.
[Deprecated]: Add a question in a form
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Get a question for a form
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Delete a question from a form
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Designer/FormItem APIs -- Deprecated/v3.0
The operations from the Designer/FormItem APIs -- Deprecated/v3.0 category.
[Deprecated]: Add a question in a form
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Designer/FormItem APIs -- Deprecated/v4.0
The operations from the Designer/FormItem APIs -- Deprecated/v4.0 category.
[Deprecated]: Add a question in a form
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form
Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Designer/FormItem APIs -- Deprecated/v5.0
The operations from the Designer/FormItem APIs -- Deprecated/v5.0 category.
[Deprecated]: Add a question in a form
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form
Method: delete
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
Designer/FormItemHistory APIs/v1.0
The operations from the Designer/FormItemHistory APIs/v1.0 category.
Get questions history for a form
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/itemhistory
Designer/FormVisit APIs/v1.0
The operations from the Designer/FormVisit APIs/v1.0 category.
[Deprecated]: Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
[Deprecated]: Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v10.0
The operations from the Designer/FormVisit APIs/v10.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v5.0
The operations from the Designer/FormVisit APIs/v5.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v6.0
The operations from the Designer/FormVisit APIs/v6.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v7.0
The operations from the Designer/FormVisit APIs/v7.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v8.0
The operations from the Designer/FormVisit APIs/v8.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/FormVisit APIs/v9.0
The operations from the Designer/FormVisit APIs/v9.0 category.
Get visits associated with a form
Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form
Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Designer/Forms APIs/v1.0
The operations from the Designer/Forms APIs/v1.0 category.
[Deprecated]: Bulk assign forms to visits
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/visits
[Deprecated]: Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms
Bulk copy for forms
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/copyForms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
Get all study forms
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/allstudiesforms
Get forms and questions used in dosing calculations
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/numericItems
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v10.0
The operations from the Designer/Forms APIs/v10.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms
Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v11.0
The operations from the Designer/Forms APIs/v11.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/unblinded
Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v12.0
The operations from the Designer/Forms APIs/v12.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form
Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v14.0
The operations from the Designer/Forms APIs/v14.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form
Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v15.0
The operations from the Designer/Forms APIs/v15.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form
Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v2.0
The operations from the Designer/Forms APIs/v2.0 category.
[Deprecated]: Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms
Bulk assign forms to visits
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/visits
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v3.0
The operations from the Designer/Forms APIs/v3.0 category.
[Deprecated]: Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms
Bulk assign forms to visits
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/visits
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v4.0
The operations from the Designer/Forms APIs/v4.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms
Bulk assign forms to visits
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/visits
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms
Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v5.0
The operations from the Designer/Forms APIs/v5.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v6.0
The operations from the Designer/Forms APIs/v6.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v7.0
The operations from the Designer/Forms APIs/v7.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v8.0
The operations from the Designer/Forms APIs/v8.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/Forms APIs/v9.0
The operations from the Designer/Forms APIs/v9.0 category.
Adds a form in a study version.
Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms
Delete a specific form
Method: delete
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form
Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms
Get list questions used in stratified randomization
Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
Update a specific form
Method: put
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
Designer/IntegrationReport APIs/v1.0
The operations from the Designer/IntegrationReport APIs/v1.0 category.
Get list RTSM elements such as visits or forms
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/integrationreport
Designer/Kits APIs/v1.0
The operations from the Designer/Kits APIs/v1.0 category.
[Deprecated]: Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits
Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits
Delete a kit
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get kits from all study versions in Testing, Approved and Archived
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/kits
Get list of all investigational product kits and devices
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/kitsonly
Get list of kit names in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/kits/names
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Update a kit
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
Designer/Kits APIs/v2.0
The operations from the Designer/Kits APIs/v2.0 category.
[Deprecated]: Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Update a kit
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}
Delete a kit
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get kits from all study versions in Testing, Approved and Archived
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/kits
Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Designer/Kits APIs/v3.0
The operations from the Designer/Kits APIs/v3.0 category.
[Deprecated]: Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Update a kit
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get blinded data on a kit
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
Get kits from all study versions in Testing, Approved and Archived
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/kits
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Designer/Kits APIs/v4.0
The operations from the Designer/Kits APIs/v4.0 category.
[Deprecated]: Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Update a kit
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get blinded data on a kit
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Designer/Kits APIs/v5.0
The operations from the Designer/Kits APIs/v5.0 category.
Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits
Get blinded data on a kit
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Update a kit
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/kits/{kitId}
Designer/Kits APIs/v6.0
The operations from the Designer/Kits APIs/v6.0 category.
Add a kit in a study
Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits
Delete a kit
Method: delete
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get list of all kits
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits
Get the dispensation data of a kit
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
Update a kit
Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
Designer/Lock Object APIs/v1.0
The operations from the Designer/Lock Object APIs/v1.0 category.
Get a list of locked objects.
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lockObjectDetails
Designer/Randomization APIs/v1.0
The operations from the Designer/Randomization APIs/v1.0 category.
Create randomization design
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations
Delete randomization design
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get a randomization design
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get list of randomization designs in a study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Designer/Randomization APIs/v2.0
The operations from the Designer/Randomization APIs/v2.0 category.
Create randomization design
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations
Delete randomization design
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get a randomization design
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get list of randomization designs in a study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Designer/Randomization APIs/v3.0
The operations from the Designer/Randomization APIs/v3.0 category.
Create randomization design
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations
Delete randomization design
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get a randomization design
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get list of randomization designs in a study version
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Designer/Randomization APIs/v4.0
The operations from the Designer/Randomization APIs/v4.0 category.
Create randomization design
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations
Delete randomization design
Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get a randomization design
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get list of randomization designs in a study version
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Designer/Randomization APIs/v5.0
The operations from the Designer/Randomization APIs/v5.0 category.
Create randomization design
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/randomizations
Delete randomization design
Method: delete
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get a randomization design
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Get list of randomization designs in a study version
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
Designer/Randomization Cohorts APIs/v1.0
The operations from the Designer/Randomization Cohorts APIs/v1.0 category.
Create a single cohort group
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts
Create multiple cohort groups
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Delete cohort group
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Delete multiple existing cohort groups
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Get a list of all cohort groups in a randomization
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts
Get cohort group in a randomization
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Update existing cohort group
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Update multiple existing cohort groups
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Designer/Randomization Ratios APIs/v1.0
The operations from the Designer/Randomization Ratios APIs/v1.0 category.
[Deprecated]: Create treatment arms ratios
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete all treatment arm ratios
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete treatment arm ratios
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
[Deprecated]: Update treatment arm ratios for adaptive cohorts
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizationRatios
Get list of all treatment arm ratios for cohort or stratum groups by randomization ID
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of treatment arm ratios for cohort or stratum groups in a randomization design
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Get list of treatment arms
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms
Update treatment arm ratios
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Update treatment arm ratios for adaptive cohorts
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/adaptivecohort
Designer/Randomization Ratios APIs/v2.0
The operations from the Designer/Randomization Ratios APIs/v2.0 category.
[Deprecated]: Delete all treatment arm ratios
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete treatment arm ratios
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Create treatment arms ratios
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups by randomization ID
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of treatment arm ratios for cohort or stratum groups
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Get list of treatment arms
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms
Update treatment arm ratios
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Update treatment arm ratios for adaptive cohorts
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Designer/Randomization Ratios APIs/v3.0
The operations from the Designer/Randomization Ratios APIs/v3.0 category.
[Deprecated]: Delete all treatment arm ratios
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Create treatment arms ratios
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Update treatment arm ratios for adaptive cohorts
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Designer/Reporting APIs/v1.0
The operations from the Designer/Reporting APIs/v1.0 category.
Generate study design reports
Method: post
Path: /ec-designer-svc/rest/v1.0/report/{reportName}
Designer/Reporting APIs/v2.0
The operations from the Designer/Reporting APIs/v2.0 category.
Generate study design reports
Method: post
Path: /ec-designer-svc/rest/v2.0/report/{reportName}
Designer/Reporting APIs/v3.0
The operations from the Designer/Reporting APIs/v3.0 category.
Generate study design reports
Method: post
Path: /ec-designer-svc/rest/v3.0/report/{reportName}
Designer/Rollback APIs/v1.0
The operations from the Designer/Rollback APIs/v1.0 category.
Rollback tracked transaction
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/rollback/{trackingId}
Start tracking transaction
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/start
Stop tracking transaction
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/stop/{trackingId}
Designer/Strata APIs/Study Strata APIs/v1.0
The operations from the Designer/Strata APIs/Study Strata APIs/v1.0 category.
Get all active strata in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/strata
Designer/Strata APIs/v1.0
The operations from the Designer/Strata APIs/v1.0 category.
Create list of cohort groups
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Create randomization stratum group
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Delete a stratum group
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Delete cohort groups
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get a stratum group
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Get list of all strata groups
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Update existing stratum group
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Update randomization cohort groups
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Designer/Strata APIs/v2.0
The operations from the Designer/Strata APIs/v2.0 category.
Create list of cohort groups
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Create randomization stratum group
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Delete a stratum group
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Delete cohort groups
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get a stratum group
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Get list of all strata groups
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Update existing stratum group
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Update randomization cohort groups
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Designer/Study APIs/v1.0
The operations from the Designer/Study APIs/v1.0 category.
[Deprecated]: Check visit in study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visits/{visitId}/validate
[Deprecated]: Get coding questions in all forms
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms
Add study
Method: post
Path: /ec-designer-svc/rest/v1.0/studies
Check form in study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/validate
Check form item existence in study.
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/items/{formItemId}/validate
Get a list of all studies
Method: get
Path: /ec-designer-svc/rest/v1.0/studies
Get a study's status
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state
Get all forms
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/allForms
Get all statuses of a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses
Get all statuses' summaries of a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statusessummary
Get all study versions of multiple tenants
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/all
Get IDs of all artifacts in a study in a specific mode
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/objectids
Get IDs of all artifacts in an approved study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/approved/objectids
Get latest study versions of a tenant
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/tenant
Get list of treatment arms for all study versions
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/arms
Get maximum study versions of a tenant
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/maxversion/tenant
Get options of all choice items in the latest approved version.
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/approved/choiceoptions
Get status of latest study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses/{version}
Get study identity based on protocol ID
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/identity
Get study rule copy status
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/studycopystatus
Retrieves all the visits, forms, questionnaire for the study ID and one or more study version.
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studyDesign
Update a study's state
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state/{statedata}
Update existing study
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}
Update study rule copy status
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studycopystatus
Designer/Study APIs/v2.0
The operations from the Designer/Study APIs/v2.0 category.
Add study
Method: post
Path: /ec-designer-svc/rest/v2.0/studies
Check visit in study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visits/{visitId}/validate
Get a list of all studies
Method: get
Path: /ec-designer-svc/rest/v2.0/studies
Get all coding questions in all forms
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms/coding
Get all forms
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms
Get all statuses of a study
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses
Get all statuses' summaries of a study
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statusessummary
Get status of latest study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses/{version}
Retrieves all the visits, forms, questionnaire for the study ID and one or more study version.
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/studyDesign
Update existing study
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}
Designer/Study APIs/v3.0
The operations from the Designer/Study APIs/v3.0 category.
[Deprecated]: Retrieves all the visits, forms, questionnaire for the study ID in one or more study version by mode.
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/studyDesign
Check visit in study version
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/visits/{visitId}/validate
Get all coding questions in all forms
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/allForms/coding
Get all forms
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/allForms
Get all statuses of a study
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/statuses
Get status of latest study version
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/statuses/{version}
Retrieves all the visits, forms, questionnaire for the study ID and one or more study version.
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/studyDesign
Designer/Study APIs/v4.0
The operations from the Designer/Study APIs/v4.0 category.
Check visit in study version
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/visits/{visitId}/validate
Get all forms
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/allForms
Retrieves all the visits, forms, questionnaire for the study ID and one or more study version.
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/studyDesign
Designer/Study APIs/v5.0
The operations from the Designer/Study APIs/v5.0 category.
[Deprecated]: Retrieves all the visits, forms, questionnaire for the study ID in one or more study version by mode.
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/studyDesign
Designer/Study APIs/v6.0
The operations from the Designer/Study APIs/v6.0 category.
Retrieves all the visits, forms, questionnaire for the study ID in one or more study version by mode.
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/studyDesign
Designer/Study APIs/v7.0
The operations from the Designer/Study APIs/v7.0 category.
Retrieves all the visits, forms, questionnaire for the study ID and one or more study version.
Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign
Retrieves all the visits, forms, questionnaire for the study ID in one or more study version by mode.
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign
Designer/Study Cohorts APIs/v1.0
The operations from the Designer/Study Cohorts APIs/v1.0 category.
Get a list of all active cohorts in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/cohorts
Designer/Study Metadata APIs/v1.0
The operations from the Designer/Study Metadata APIs/v1.0 category.
Get metadata of a specified study ID and study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/studyMetadata
Designer/Study Metadata APIs/v2.0
The operations from the Designer/Study Metadata APIs/v2.0 category.
Get metadata of a specified study ID and study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/studyMetadata
Designer/Study RandFactors APIs/v1.0
The operations from the Designer/Study RandFactors APIs/v1.0 category.
Get all active factors in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/randomizationfactors
Designer/Study Versions History APIs/v1.0
The operations from the Designer/Study Versions History APIs/v1.0 category.
Get history of all versions for a study as of a certain date
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versionshistory/asofdate/{asofdate}
Designer/StudyLock APIs/v1.0
The operations from the Designer/StudyLock APIs/v1.0 category.
[Deprecated]: Create study lock
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Delete study lock
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Get study lock
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Update study lock
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
Acquire lock
Method: post
Path: /ec-designer-svc/rest/locks/acquireLock/{studyId}
Get all the active locks on the study
Method: get
Path: /ec-designer-svc/rest/locks/childLocks/{studyId}
Release lock
Method: put
Path: /ec-designer-svc/rest/locks/releaseLock/{studyId}
Designer/Treatment Arms APIs/v1.0
The operations from the Designer/Treatment Arms APIs/v1.0 category.
[Deprecated]: Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Create a new treatment arm for a study version
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms
Delete treatment arm from a study version
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms/{armId}
Get a study version's treatment arm
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms/{armId}
Get list of treatment arms in a study version
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms
Updates an existing treatment arm in a study version
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/arms/{armId}
Designer/Treatment Arms APIs/v2.0
The operations from the Designer/Treatment Arms APIs/v2.0 category.
[Deprecated]: Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Designer/Treatment Arms APIs/v3.0
The operations from the Designer/Treatment Arms APIs/v3.0 category.
[Deprecated]: Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Designer/Treatment Arms APIs/v4.0
The operations from the Designer/Treatment Arms APIs/v4.0 category.
[Deprecated]: Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Designer/Treatment Arms APIs/v5.0
The operations from the Designer/Treatment Arms APIs/v5.0 category.
Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Designer/Treatment Arms APIs/v6.0
The operations from the Designer/Treatment Arms APIs/v6.0 category.
Get list of treatment arm dispensations in a study version
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/arms/{armId}/dispensings
Designer/Versions APIs/v1.0
The operations from the Designer/Versions APIs/v1.0 category.
Add study version
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions
Delete study version
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}
Get list of study versions
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions
Get version of a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}
Remove duplicate study version
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/revert
Set status of study version
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/status/{state}
Update status of study version
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/status/{state}
Update study version's title
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}
Designer/Versions APIs/v2.0
The operations from the Designer/Versions APIs/v2.0 category.
Delete study version
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}
Get list of study versions
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions
Designer/Visit APIs/v1.0
The operations from the Designer/Visit APIs/v1.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits
Clear visit schedule
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Create visit schedule
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits
Get all visits, forms, and questions by study ID
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visitsforms
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Identify if a visit contains a kit type titration
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings/hasTitration
Update a visit
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update visit schedule
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Designer/Visit APIs/v2.0
The operations from the Designer/Visit APIs/v2.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits
Clear visit schedule
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Create visit schedule
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Update a visit
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update visit schedule
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Designer/Visit APIs/v3.0
The operations from the Designer/Visit APIs/v3.0 category.
[Deprecated]: Add a visit
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get study visit
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Update a visit
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
Clear visit schedule
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Create visit schedule
Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Update visit schedule
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Designer/Visit APIs/v4.0
The operations from the Designer/Visit APIs/v4.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
Designer/Visit APIs/v5.0
The operations from the Designer/Visit APIs/v5.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit
Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}
Designer/Visit APIs/v6.0
The operations from the Designer/Visit APIs/v6.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit
Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}
Designer/Visit APIs/v7.0
The operations from the Designer/Visit APIs/v7.0 category.
Add a visit
Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits
Delete a visit
Method: delete
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit
Method: put
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}
Designer/Visit Design APIs/v1.0
The operations from the Designer/Visit Design APIs/v1.0 category.
[Deprecated]: Get study design visits
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design
Assign kit type titration to a visit
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/kits/{kitId}
Assign randomization to visit
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/randomizations/{randomizationId}
Get titration dispensation data
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/dispense/kits/{kitId}
Validate assigning randomization
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}
Designer/Visit Design APIs/v2.0
The operations from the Designer/Visit Design APIs/v2.0 category.
[Deprecated]: Get study design visits
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design
Assign kit type titration to a visit
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/kits/{kitId}
Get titration dispensation data
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/dispense/kits/{kitId}
Validate assigning randomization
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}
Designer/Visit Design APIs/v3.0
The operations from the Designer/Visit Design APIs/v3.0 category.
[Deprecated]: Get study design visits
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/design
Designer/Visit Design APIs/v4.0
The operations from the Designer/Visit Design APIs/v4.0 category.
Get study design visits
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/design
Designer/Visit Design APIs/v5.0
The operations from the Designer/Visit Design APIs/v5.0 category.
Get study design visits
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/design
Designer/Visit Design APIs/v6.0
The operations from the Designer/Visit Design APIs/v6.0 category.
Get study design visits
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/design
Get study design visits for multiple versions.
Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/design
Designer/Visit Design APIs/v7.0
The operations from the Designer/Visit Design APIs/v7.0 category.
Get study design visits
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/design
Get study design visits for multiple versions.
Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/design
Designer/Visit Design APIs/v8.0
The operations from the Designer/Visit Design APIs/v8.0 category.
Get study design visits
Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/design
Get study design visits for multiple versions.
Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/design
Designer/Visit Metadata APIs/v1.0
The operations from the Designer/Visit Metadata APIs/v1.0 category.
Get the metadata of specified visits by study ID and study version
Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visitsMetadata
Designer/Visit Metadata APIs/v2.0
The operations from the Designer/Visit Metadata APIs/v2.0 category.
Get the metadata of specified visits by study ID and study version
Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visitsMetadata
Designer/VisitForm APIs/V11.0
The operations from the Designer/VisitForm APIs/V11.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/V12.0
The operations from the Designer/VisitForm APIs/V12.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/V13.0
The operations from the Designer/VisitForm APIs/V13.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v13.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/V14.0
The operations from the Designer/VisitForm APIs/V14.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/V15.0
The operations from the Designer/VisitForm APIs/V15.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v1.0
The operations from the Designer/VisitForm APIs/v1.0 category.
[Deprecated]: Delete form from a specific visit
Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Update forms of a specific visit
Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v10.0
The operations from the Designer/VisitForm APIs/v10.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v2.0
The operations from the Designer/VisitForm APIs/v2.0 category.
[Deprecated]: Delete form from a specific visit
Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Update forms of a specific visit
Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v3.0
The operations from the Designer/VisitForm APIs/v3.0 category.
Delete form from a specific visit
Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
Get all questions included in a form
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/rules
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Update forms of a specific visit
Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v4.0
The operations from the Designer/VisitForm APIs/v4.0 category.
[Deprecated]: Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Delete form from a specific visit
Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
Update forms of a specific visit
Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v5.0
The operations from the Designer/VisitForm APIs/v5.0 category.
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v6.0
The operations from the Designer/VisitForm APIs/v6.0 category.
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v7.0
The operations from the Designer/VisitForm APIs/v7.0 category.
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v8.0
The operations from the Designer/VisitForm APIs/v8.0 category.
Get list of forms in a study
Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitForm APIs/v9.0
The operations from the Designer/VisitForm APIs/v9.0 category.
Get list of forms in a visit
Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
Designer/VisitSchedules APIs/v1.0
The operations from the Designer/VisitSchedules APIs/v1.0 category.
[Deprecated]: Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visitschedules
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v1.0/visitschedules/{studyId}/{version}
Designer/VisitSchedules APIs/v2.0
The operations from the Designer/VisitSchedules APIs/v2.0 category.
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v2.0/visitschedules/{studyId}/{version}
Get visit schedule of a study version
Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visitschedules
Designer/VisitSchedules APIs/v4.0
The operations from the Designer/VisitSchedules APIs/v4.0 category.
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visitschedules
Designer/VisitSchedules APIs/v5.0
The operations from the Designer/VisitSchedules APIs/v5.0 category.
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visitschedules
Designer/VisitSchedules APIs/v6.0
The operations from the Designer/VisitSchedules APIs/v6.0 category.
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visitschedules
Designer/VisitSchedules APIs/v7.0
The operations from the Designer/VisitSchedules APIs/v7.0 category.
Get visit schedule
Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visitschedules
Digital Gateway/Data Import/v1.0
The operations from the Digital Gateway/Data Import/v1.0 category.
Push data into ClinicalOne via real-time integration configured in Digital Gateway
Method: post
Path: /ib-ext-svc/rest/v1.0/integrationdata
File Upload/v3.0
The operations from the File Upload/v3.0 category.
Delete a file part
Method: delete
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}/parts/{partNumber}
Delete a file successfully uploaded before
Method: delete
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}
Download an uploaded file
Method: get
Path: /ec-fileupload-svc/rest/v3.0/storage/file/{objectName}
Get a list of uploaded files
Method: get
Path: /ec-fileupload-svc/rest/v3.0/storage/list
Get metadata of an uploaded file
Method: get
Path: /ec-fileupload-svc/rest/v3.0/storage/file/metadata/{objectName}
Get the admin configurations for file upload service
Method: get
Path: /ec-fileupload-svc/rest/v3.0/storage/config
Merge or delete file parts
Method: post
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}/parts
Uncompress a compressed file
Method: post
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}
Update configuration in the system
Method: put
Path: /ec-fileupload-svc/rest/v3.0/storage/config
Upload a file to the system
Method: put
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}
Upload a part of the file
Method: put
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}/parts/{partNumber}
Notifications/Auth/v1.0
The operations from the Notifications/Auth/v1.0 category.
List users to send notifications to
Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/{rightname}
Notifications/Broadcast/v1.0
The operations from the Notifications/Broadcast/v1.0 category.
Delete a notification for an ID (v1.0)
Method: delete
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
Display the number of unread and read notifications in the inbox
Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/notificationCount
Get a specific notification by ID
Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
Post notification broadcast for a user (v1.0)
Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast
Update the notification broadcast with an ID (v1.0)
Method: put
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
View a user's inbox
Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast
Notifications/Broadcast/v2.0
The operations from the Notifications/Broadcast/v2.0 category.
Post a notification broadcast for a user
Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationsbroadcast
Notifications/Email/v1.0
The operations from the Notifications/Email/v1.0 category.
Use a template to send email to a user
Method: post
Path: /ec-notifications-svc/rest/v1.0/email/{templatetype}
Notifications/Email/v2.0
The operations from the Notifications/Email/v2.0 category.
Use a template to send email to a user
Method: post
Path: /ec-notifications-svc/rest/v2.0/email/{templatetype}
Notifications/Email/v3.0
The operations from the Notifications/Email/v3.0 category.
Use a template to send email to a user
Method: post
Path: /ec-notifications-svc/rest/v3.0/email/{templatetype}
Notifications/Log/v1.0
The operations from the Notifications/Log/v1.0 category.
Create a log entry and send it or schedule it (v1.0)
Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog
Lists all the notification logs
Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog
Notifications/Log/v2.0
The operations from the Notifications/Log/v2.0 category.
Create a log entry and send it or schedule it (v2.0)
Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog
List all the notification logs
Method: get
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog
Notifications/Log/v3.0
The operations from the Notifications/Log/v3.0 category.
Create a log entry and send it or schedule it (v3.0)
Method: post
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog
List all the notification logs
Method: get
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog
Notifications/Log/v4.0
The operations from the Notifications/Log/v4.0 category.
Create a log entry and send it or schedule it (multiple language)
Method: post
Path: /ec-notifications-svc/rest/v4.0/studies/{studyId}/{mode}/notificationlog
Query/Reporting/v1.0
The operations from the Query/Reporting/v1.0 category.
[Deprecated]: Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v1.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v2.0
The operations from the Query/Reporting/v2.0 category.
[Deprecated]: Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v2.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v3.0
The operations from the Query/Reporting/v3.0 category.
Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v3.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v4.0
The operations from the Query/Reporting/v4.0 category.
[Deprecated]: Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v4.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v5.0
The operations from the Query/Reporting/v5.0 category.
Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v5.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v6.0
The operations from the Query/Reporting/v6.0 category.
Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v6.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v7.0
The operations from the Query/Reporting/v7.0 category.
Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v7.0/studies/{studyId}/{mode}/report/{reportName}
Query/Reporting/v8.0
The operations from the Query/Reporting/v8.0 category.
Generates a new Subject Queries report by study ID and study mode (Testing, Training, or Production).
Method: post
Path: /v8.0/studies/{studyId}/{mode}/report/{reportName}
Query/v1.0
The operations from the Query/v1.0 category.
Assign study roles to queries
Method: put
Path: /v1.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
Close or delete any existing queries based on provided filter details
Method: put
Path: /v1.0/studies/{studyId}/{mode}/queries/clear/{level}
Get all historical records on DC_Query table
Method: get
Path: /v1.0/studies/{studyId}/{mode}/queries/queryTable
Get all historical records on table DC_Query_Study_Roles
Method: get
Path: /v1.0/studies/{studyId}/{mode}/queries/queryStudyRolesTable
Get the list of all query states
Method: get
Path: /v1.0/studies/{studyId}/{mode}/queries/state
Get the number of open queries in a study
Method: get
Path: /v1.0/studies/{studyId}/{mode}/studyOpenQueryCount
Get the number of queries in a study
Method: get
Path: /v1.0/studies/{studyId}/{mode}/studyQueryCount
Get the subjects having open queries in a study
Method: get
Path: /v1.0/studies/{studyId}/{mode}/subjects
Update subject's site transfer information
Method: post
Path: /v1.0/studies/{studyId}/{mode}/queries/subjectsitetransfer
Query/v2.0
The operations from the Query/v2.0 category.
Answer an existing query
Method: put
Path: /v2.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Assign study roles to queries
Method: put
Path: /v2.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
Delete an existing query
Method: put
Path: /v2.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get all historical records on DC_Query table
Method: get
Path: /v2.0/studies/{studyId}/{mode}/queries/queryTable
Get number of queries in a study
Method: post
Path: /v2.0/studies/{studyId}/{mode}/queryCount
Get query data based on multiple parameters
Method: get
Path: /v2.0/studies/{studyId}/{mode}/queryDetails
Get the list of all query states
Method: get
Path: /v2.0/studies/{studyId}/{mode}/queries/state
Get the number of open queries in a study
Method: post
Path: /v2.0/studies/{studyId}/{mode}/openQueryCount
Query/v3.0
The operations from the Query/v3.0 category.
Create a query with the status Candidate
Method: post
Path: /v3.0/studies/{studyId}/{mode}/queries/candidate
Create an open query
Method: post
Path: /v3.0/studies/{studyId}/{mode}/queries/open
Get details of an opened query
Method: get
Path: /v3.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters
Method: get
Path: /v3.0/studies/{studyId}/{mode}/queryDetails
Query/v4.0
The operations from the Query/v4.0 category.
Close an existing query
Method: put
Path: /v4.0/studies/{studyId}/{mode}/queries/{queryId}/close
Get a query by ID
Method: get
Path: /v4.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query
Method: get
Path: /v4.0/studies/{studyId}/{mode}/openQueryDetails
Update a query's status to Open
Method: put
Path: /v4.0/studies/{studyId}/{mode}/queries/{queryId}/open
Query/v5.0
The operations from the Query/v5.0 category.
Answer an existing query
Method: put
Path: /v5.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Close an existing query
Method: put
Path: /v5.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create a query with the status Candidate
Method: post
Path: /v5.0/studies/{studyId}/{mode}/queries/candidate
Create an open query
Method: post
Path: /v5.0/studies/{studyId}/{mode}/queries/open
Delete an existing query
Method: put
Path: /v5.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get details of an opened query
Method: get
Path: /v5.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters
Method: get
Path: /v5.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open
Method: put
Path: /v5.0/studies/{studyId}/{mode}/queries/{queryId}/open
Query/v6.0
The operations from the Query/v6.0 category.
Answer an existing query
Method: put
Path: /v6.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Close an existing query
Method: put
Path: /v6.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create a query with the status Candidate
Method: post
Path: /v6.0/studies/{studyId}/{mode}/queries/candidate
Create an open query
Method: post
Path: /v6.0/studies/{studyId}/{mode}/queries/open
Delete an existing query
Method: put
Path: /v6.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get a query by ID
Method: get
Path: /v6.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query
Method: get
Path: /v6.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters
Method: get
Path: /v6.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open
Method: put
Path: /v6.0/studies/{studyId}/{mode}/queries/{queryId}/open
Query/v7.0
The operations from the Query/v7.0 category.
Answer an existing query
Method: put
Path: /v7.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Close an existing query
Method: put
Path: /v7.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create an open query
Method: post
Path: /v7.0/studies/{studyId}/{mode}/queries/open
Get a query by ID
Method: get
Path: /v7.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query
Method: get
Path: /v7.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters
Method: get
Path: /v7.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open
Method: put
Path: /v7.0/studies/{studyId}/{mode}/queries/{queryId}/open
Query/v8.0
The operations from the Query/v8.0 category.
Answer an existing query
Method: put
Path: /v8.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Close an existing query
Method: put
Path: /v8.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create a query with the status Candidate
Method: post
Path: /v8.0/studies/{studyId}/{mode}/queries/candidate
Create an open query
Method: post
Path: /v8.0/studies/{studyId}/{mode}/queries/open
Delete an existing query
Method: put
Path: /v8.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get a query by ID
Method: get
Path: /v8.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query
Method: get
Path: /v8.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters
Method: get
Path: /v8.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open
Method: put
Path: /v8.0/studies/{studyId}/{mode}/queries/{queryId}/open
Randomization and Supplies/Cohort APIs/v1.0
The operations from the Randomization and Supplies/Cohort APIs/v1.0 category.
Get cohort enrollments by study, mode and cohort ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/cohortenrollments/{cohortid}
Get cohort limits by study and mode
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits
Save cohort limits by study and mode
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits
Randomization and Supplies/Device Management APIs/v1.0
The operations from the Randomization and Supplies/Device Management APIs/v1.0 category.
Deregister an mHealth device
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}
Recreate an accessId and One-Time Password of a bootstrap device
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}/access-code
Register mHealth device
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/register-device
Randomization and Supplies/Dose Hold Settings APIs/v1.0
The operations from the Randomization and Supplies/Dose Hold Settings APIs/v1.0 category.
Create DoseHoldSetting of given DoseHolddetails
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
Delete DoseHoldSettingDetails of given DoseHoldId
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Get all DoseHoldSettingDetails
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
Get DoseHoldSettingDetails of given DoseHoldId
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Update DoseHoldSetting of given DoseHolddetails
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Randomization and Supplies/Dose Hold Settings APIs/v2.0
The operations from the Randomization and Supplies/Dose Hold Settings APIs/v2.0 category.
Create DoseHoldSetting of given DoseHolddetails
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings
Get all DoseHoldSettingDetails including last visit.
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings
Get DoseHoldSettingDetails of given DoseHoldId including last visit
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Update DoseHoldSetting of given DoseHolddetails
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Randomization and Supplies/Dose Hold Subject Visits APIs/v1.0
The operations from the Randomization and Supplies/Dose Hold Subject Visits APIs/v1.0 category.
Get Visits of the subjects which are marked as dose hold
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-doseholds
Randomization and Supplies/Event APIs/v1.0
The operations from the Randomization and Supplies/Event APIs/v1.0 category.
Get details about a Code Break event
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
Get details about a Kit Replacement event
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/kitreplacement/{eventId}
Get list of events in a study
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events
Randomization and Supplies/Inventory APIs/v1.0
The operations from the Randomization and Supplies/Inventory APIs/v1.0 category.
Create blinded lot
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Create label groups
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Create manufacturing lot
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Create randomization list from uploaded file
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/fileupload/rndlists/{rndListId}
Delete blinded lot
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Delete kit list file
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/file/{fileId}
Delete label groups
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Delete manufacturing lot by ID
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Disable kitlist with inventories
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists/{listId}/disable
Export kit details for the inventory
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Generate kits
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/generate
Get a kit's barcode
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Get a kit's last status
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus
Get a site inventory's status
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/site
Get a site's kit history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
Get all manufacturing lots
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get blinded lot by ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Get cancelled inventory status
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/cancelledshipment
Get destruction inventory statuses
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/destruction
Get dispensation details by inventory ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Get generated/uploaded kit lists details in a study
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists
Get inventory database headers
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadkits
Get kit details by kit number
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
Get kit summary by kit type ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get kit types
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kit-types
Get label groups
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Get label groups by ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Get latest status of kit
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus
Get list of blinded lots
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Get list of filtered kits
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/qualified-kits
Get lots with kits
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsWithKits
Get manufacturing lot by ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get max kit number
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/suggested-max-numbers
Get pending Destruction count by location ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/location/{locationId}/pendingdestructioncount
Get randomization list database headers
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
Get single kit settings
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/singlekitsettings
Get sites
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings
Get types of packages
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/packagetypes
Kitlist details of each kit
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/audit
Parse file headers
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/{fileId}/fileheaders
Set kit verification status
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}/verify
Update a barcode
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/barcode
Update a kit's barcode
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Update a kit's dispensation confirmation
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/confirmDispensation
Update blinded lot
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Update kit attributes
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits
Update kit attributes
Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits
Update kit label group
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/label-group
Update kit location
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/location
Update kit manufactoring lot
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/manufacturing-lot
Update kit status
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status
Update label groups
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Update manufacturing lot by ID
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Upload inventory data as CSV file
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadinventory
Upload kit list file
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadfile
Upload kit types data
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/kittypesfromfile
Randomization and Supplies/Inventory APIs/v2.0
The operations from the Randomization and Supplies/Inventory APIs/v2.0 category.
Export kit details with barcodes for the inventory
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Generate kits
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/generate
Get a site's kit history
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
Get all manufacturing lots
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get dispensation details by inventory ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Get generated/uploaded kit lists details in a study
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kitlists
Get inventory database headers with barcodes
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadkits
Get inventory status
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit history
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
Get kit summary
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types
Get kit summary by kit type ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get kit types
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kit-types
Get list of filtered kits
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/qualified-kits
Get manufacturing lot by ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get randomization list database headers
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
Get received inventory status
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/receivedshipment
Kitlist details of each kit
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/audit
Update kit attributes
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits
Update kit status for a site
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
Update status for kits in a site
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Randomization and Supplies/Inventory APIs/v3.0
The operations from the Randomization and Supplies/Inventory APIs/v3.0 category.
Export kit details for the inventory
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Get allowed inventory status
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get inventory status
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit summary
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kit-types
Kitlist details of each kit
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits/audit
Searches for kits in a given range for a site
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Update kit status for a site
Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
Randomization and Supplies/Inventory APIs/v4.0
The operations from the Randomization and Supplies/Inventory APIs/v4.0 category.
Get inventory status
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kitDetails
Search for kits in a given range for a site.
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Randomization and Supplies/Inventory APIs/v5.0
The operations from the Randomization and Supplies/Inventory APIs/v5.0 category.
Search for kits in a given range for a site
Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Randomization and Supplies/Inventory APIs/v6.0
The operations from the Randomization and Supplies/Inventory APIs/v6.0 category.
Search for kits in a given range for a site
Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Randomization and Supplies/Randomization APIs/v1.0
The operations from the Randomization and Supplies/Randomization APIs/v1.0 category.
Get list of all treatment arms for a randomization
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/treatments
Get list of headers from a CSV file
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/{fileId}/fileheaders
Get unique values for treatments, stratums or cohorts from a CSV file
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/csvuniquevalues
Upload randomization list based on header mappings and treatment, cohort, stratum mappings
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadrndlist
Upload randomization list file from a file service into RTSM
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadfile
Randomization and Supplies/Randomization List APIs/v1.0
The operations from the Randomization and Supplies/Randomization List APIs/v1.0 category.
Associate randomization design to randomization list
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}
Check randomization design is block by region
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/rndListsByRegion/regions/{regionId}
Create randomization list
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
Delete randomization list file
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/file/{fileId}
Dissociate randomization design from randomization list
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}
Export randomization list
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/export
Get list of randomization blocks
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks
Get random number statuses
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randnumberstatuses
Get randomization design list
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns
Update randomization list blocks
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks
Update randomization status
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumber/randstatus
Randomization and Supplies/Randomization List APIs/v3.0
The operations from the Randomization and Supplies/Randomization List APIs/v3.0 category.
Get randomization list
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists
Get randomization list by ID
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}
Get randomization number
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
Randomization and Supplies/Randomization List APIs/v4.0
The operations from the Randomization and Supplies/Randomization List APIs/v4.0 category.
Get randomization list
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists
Get randomization list by ID
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}
Get randomization number
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
Randomization and Supplies/Randomization List APIs/v5.0
The operations from the Randomization and Supplies/Randomization List APIs/v5.0 category.
Get randomization list based on query param minimizationList.
Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists
Randomization and Supplies/Report APIs/v1.0
The operations from the Randomization and Supplies/Report APIs/v1.0 category.
Get Cohort Enrollment Audit Trail report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments/history
Get Cohort Enrollment report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments
Get Kit Blinded Chain of Custody report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
Get Kit Chain of Custody Unblinded report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Inventory Blinded report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
Get Kit Inventory Unblinded report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
Get Kit Reconciliation report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/recon
Get Randomization List report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/randList
Get Study Design kit list report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kitlist
Get Study Design report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/supplysettings
Get Study Inventory Settings report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/inventorysettings
Get System Usage report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/shipments
Get the Order Summary report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/order-summary
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/dispensations-audit
Get Titration Summary (Blinded) report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/blinded-titration-summary
Get Titration Summary (Unblinded) report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/titration-summary
Get Unblinded Visit Schedule report
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule
Gets minimizatoin list report.
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/minimization
Retrieves the dose hold settings report.
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/doseholdsettings
Randomization and Supplies/Report APIs/v2.0
The operations from the Randomization and Supplies/Report APIs/v2.0 category.
Get Kit Chain of Custody Unblinded report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Inventory Blinded report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
Get Kit Inventory Unblinded report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
Get Kit Reconciliation report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/recon
Get Randomization List report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get Study Design report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/supplysettings
Get Study Inventory Settings report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/inventorysettings
Get Subject Data report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/subjects
Get the Order Summary report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/order-summary
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/dispensations
Retrieves the dose hold settings report.
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/doseholdsettings
Randomization and Supplies/Report APIs/v3.0
The operations from the Randomization and Supplies/Report APIs/v3.0 category.
Get Kit Chain of Custody Unblinded report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Reconciliation report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/recon
Get Randomization List report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get Study Inventory Settings report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/inventorysettings
Get Subject Data report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/subjects
Get the Order Summary report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/order-summary
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/dispensations
Randomization and Supplies/Report APIs/v4.0
The operations from the Randomization and Supplies/Report APIs/v4.0 category.
Get Kit Chain of Custody Unblinded report
Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Reconciliation report
Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/recon
Get Randomization List report
Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/dispensations
Randomization and Supplies/Report APIs/v5.0
The operations from the Randomization and Supplies/Report APIs/v5.0 category.
Get Kit Chain of Custody Unblinded report
Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/dispensations
Randomization and Supplies/Report APIs/v6.0
The operations from the Randomization and Supplies/Report APIs/v6.0 category.
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/reports/dispensations
Randomization and Supplies/Report APIs/v7.0
The operations from the Randomization and Supplies/Report APIs/v7.0 category.
Get the Subject Dispensation report
Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/reports/dispensations
Randomization and Supplies/Settings APIs/v1.0
The operations from the Randomization and Supplies/Settings APIs/v1.0 category.
Create a resupply group
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
Create blinding group
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups
Create or update selected resupply associations
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies/updateselected
Create or update selected resupply associations
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies/updateselected
Delete a resupply by ID
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Delete blinding group by ID
Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Get a resupply group by ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Get all blinding groups
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups
Get all depot resupplies
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies
Get all resupply groups
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
Get all site resupplies
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies
Get blinding group by ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Get kit types which do not belong to any blinding group
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kittypes/noblindinggroup
Update a resupply by ID
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Update blinding group
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Randomization and Supplies/Settings APIs/v2.0
The operations from the Randomization and Supplies/Settings APIs/v2.0 category.
Create a resupply group
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
Get a resupply group by ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Get all blinding groups
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups
Get all resupply groups
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
Get blinding group by ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
Update a resupply by ID
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Settings APIs/v3.0
The operations from the Randomization and Supplies/Settings APIs/v3.0 category.
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Settings APIs/v4.0
The operations from the Randomization and Supplies/Settings APIs/v4.0 category.
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Settings APIs/v5.0
The operations from the Randomization and Supplies/Settings APIs/v5.0 category.
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Settings APIs/v6.0
The operations from the Randomization and Supplies/Settings APIs/v6.0 category.
Get supply settings
Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Settings APIs/v7.0
The operations from the Randomization and Supplies/Settings APIs/v7.0 category.
Update supply settings
Method: put
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/supply/settings
Randomization and Supplies/Shipment APIs/v1.0
The operations from the Randomization and Supplies/Shipment APIs/v1.0 category.
[Deprecated] Mark kits at a specific site as received
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
Add additional kits to a received shipment
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
Add kits to an order shipment
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Cancel recon shipment
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/cancel
Cancel shipments
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/cancel
Confim order shipment
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/confirmed
Create a manual depot shipment in resupply strategy
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/depotmanual
Create shipment for kits marked for destruction from site to depot
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments
Create shipment for kits marked for destruction from specific site to depot
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments
Get kit details by order
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits eligible to be received against a shipment
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits
Get kits or a specific kit for a shipment
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get list of lost shipments
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/mark-lost
Get order details by a shipment ID
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Invalidate order shipment
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/invalid
Mark kits as received
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
Mark shipments as lost
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/mark-lost
OrderItems
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-inventory/audit
Received shipment for destruction
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/destroyed
Regenerat order form
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/regenerate-order-form
Remove kits from an order shipment
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits
Search kits by kit type or shipment details
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Search orders in the given date range matching the status
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders
Update a Qurantine shipment and its kits
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined
Update a shipment's ship date
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/ship-date
Update a shipment's tracking details
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/tracking
Update shipment and its kits as quarantined
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
Update shipment as received for destruction
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/received
Update shipment details for an order
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Update shipping date
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/ship-date
Update status of a received kit
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
Update tracking details for an order shipment
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking
Randomization and Supplies/Shipment APIs/v2.0
The operations from the Randomization and Supplies/Shipment APIs/v2.0 category.
Create a resupply strategy
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/resupply
Create first shipment in resupply strategy
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/initial
Create manual shipment in resupply strategy
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/manual
Get a shipment's details by ID for a site
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits or a specific kit for a shipment
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get order details by a shipment ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get shipment by shipment ID
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}
Initiate manual resupply to a site
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual
List available order status values
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipment-statuses
Mark kits at a specific site as received
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
Search orders in the given date range matching the status
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders
Search shipments for a site
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments
Search shipments in a study
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments
Randomization and Supplies/Shipment APIs/v3.0
The operations from the Randomization and Supplies/Shipment APIs/v3.0 category.
Get a shipment's details by ID for a site
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get order details by a shipment ID
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get order details of shipments
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders
Get shipment by shipment ID
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}
List available order status values
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipment-statuses
Search shipments for a study
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments
Randomization and Supplies/Shipment APIs/v4.0
The operations from the Randomization and Supplies/Shipment APIs/v4.0 category.
Get a shipment's details by ID for a site
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get order details by a shipment ID
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get order details for shipments in a study
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders
Get shipment by shipment ID
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}
List available order status values
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipment-statuses
Randomization and Supplies/Study Import APIs/v1.0
The operations from the Randomization and Supplies/Study Import APIs/v1.0 category.
Get unique values for treatments, stratums or cohorts from a CSV file
Method: post
Path: /ec-ors-svc/rest/v1.0/import/{studyId}/{version}
Update study version
Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/studyversions/{version}
Randomization and Supplies/Subject APIs/v1.0
The operations from the Randomization and Supplies/Subject APIs/v1.0 category.
Check if titration has any impact on kit dispensation
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-impact
Get a list of all randomized subjects
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/randomized
Get a list of all subjects
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{siteId}/subjects
Randomization and Supplies/Titration APIs/v1.0
The operations from the Randomization and Supplies/Titration APIs/v1.0 category.
[Deprecated]: Checks if subject is eligible for titration.
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
Randomization and Supplies/Titration APIs/v2.0
The operations from the Randomization and Supplies/Titration APIs/v2.0 category.
[Deprecated]: Check if Subject is eligible for titration
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
Randomization and Supplies/Titration APIs/v3.0
The operations from the Randomization and Supplies/Titration APIs/v3.0 category.
To check if Subject is eligible for titration.
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
Randomization and Supplies/Visit APIs/v1.0
The operations from the Randomization and Supplies/Visit APIs/v1.0 category.
Get code break
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
Get code view
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
Get dose hold history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld-history
Get kits allowed for dose hold
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
Get kits which are marked as dose hold
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get list of visits
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits
Get randomization history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history
Get reusable kits for a list of subjects
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get reusable kits for a subject
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get subject treatment
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/treatment
Get tratment arms for a list of subjects
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment
Get treatment arms for a subject
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment
Get unblinded dispensation history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history
Get unblinded dispensation history for all subjects
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-disp-history
Get unblinded randomization history
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history
Get unblinded randomization history for all subjects
Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-rand-history
Replace a subject's kits
Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
Randomization and Supplies/Visit APIs/v10.0
The operations from the Randomization and Supplies/Visit APIs/v10.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v11.0
The operations from the Randomization and Supplies/Visit APIs/v11.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v12.0
The operations from the Randomization and Supplies/Visit APIs/v12.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v13.0
The operations from the Randomization and Supplies/Visit APIs/v13.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v2.0
The operations from the Randomization and Supplies/Visit APIs/v2.0 category.
Get code break
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
Get code view
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
Get kits allowed for dose hold
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
Get kits which are marked as dose hold
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get previously dispensed kits that can be reused in the current visit
Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get randomization history
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history
Get unblinded dispensation history for all subjects
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-disp-history
Get unblinded randomization history
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history
Get unblinded randomization history for all subjects
Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-rand-history
Randomization and Supplies/Visit APIs/v3.0
The operations from the Randomization and Supplies/Visit APIs/v3.0 category.
Get dispensation history
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get unblinded dispensation history for all subjects
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/unblinded-disp-history
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v4.0
The operations from the Randomization and Supplies/Visit APIs/v4.0 category.
Get dispensation history
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get unblinded dispensation history for all subjects
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/unblinded-disp-history
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v5.0
The operations from the Randomization and Supplies/Visit APIs/v5.0 category.
Get dispensation history
Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v6.0
The operations from the Randomization and Supplies/Visit APIs/v6.0 category.
Get dispensation history
Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v7.0
The operations from the Randomization and Supplies/Visit APIs/v7.0 category.
Get dispensation history
Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v8.0
The operations from the Randomization and Supplies/Visit APIs/v8.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomization and Supplies/Visit APIs/v9.0
The operations from the Randomization and Supplies/Visit APIs/v9.0 category.
Get visit by visit ID
Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit
Method: post
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit
Reporting/v1.0
The operations from the Reporting/v1.0 category.
Aggregate data for Oracle CRF Submit
Method: post
Path: /ec-reporting-svc/rest/v1.0/crf/reports
Delete a report based on path parameters
Method: delete
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports
Delete a report based on query parameters
Method: delete
Path: /ec-reporting-svc/rest/v1.0/reports
Downloads the generated report based on query parameters
Method: get
Path: /ec-reporting-svc/rest/v1.0/reports/download
Downloads the report for a given report job id
Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/download
Generate a report based on search specifications and path parameters
Method: post
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports
Generate a report based on search specifications and query parameters
Method: post
Path: /ec-reporting-svc/rest/v1.0/reports
Generate a report based on the direct report payload
Method: post
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/direct
Generate a scheduled report
Method: post
Path: /ec-reporting-svc/rest/v1.0/scheduled/reports
Generate and paginate a report
Method: post
Path: /ec-reporting-svc/rest/v1.0/reports/page
Get metadata for a specific report based on query parameters
Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata/reportId/{id}
Get metadata for a specific report by ID
Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reportmetadata/reportId/{id}
Get metdata for all reports based on path paramaters
Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reportmetadata
Get metdata for all reports based on query paramaters
Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata
Kickstarts the generation of report
Method: post
Path: /ec-reporting-svc/rest/v1.0/report/job/{jobId}
Lists the generated reports that are available for download
Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata/downloadList
Reporting/v2.0
The operations from the Reporting/v2.0 category.
Downloads the report for a given report job id
Method: get
Path: /ec-reporting-svc/rest/v2.0/reports/download
Downloads the report for a given report job id
Method: get
Path: /ec-reporting-svc/rest/v2.0/studies/{studyId}/{mode}/reports/download
Generate a report based on the direct report payload
Method: post
Path: /ec-reporting-svc/rest/v2.0/studies/{studyId}/{mode}/reports/direct
Generate and paginate a report
Method: post
Path: /ec-reporting-svc/rest/v2.0/reports/page
Lists the generated reports that are available for download
Method: get
Path: /ec-reporting-svc/rest/v2.0/reportmetadata/downloadList
Rules/v1.0
The operations from the Rules/v1.0 category.
Cancel jobs
Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/cancelRuleJob
Copy all rules from one study mode to another
Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/copy
Copy rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/bulkcopy
Copy Rules to newly copied study
Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/copyrules
Debug a rule
Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/debugRule
Delete rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkdelete
Delete ui rules per form id
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/delete/form/{formId}
Disable All notification rules
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/disableAllNotificationRules
Enable or disable rule
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/{ruleStatus}
Generate Rule Designer reports
Method: post
Path: /ec-rule-designer-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}
Get all rule states
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/rulestates
Get all rules by form ID, question ID, or other parameters
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/simple
Get multiple parameters of all rules in a study
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/rulenames
Get rule by form ID
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}
Get rule by form ID
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}/valid
Get rule by property
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
Get rule by question ID
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/item/{itemId}
Get rule by rule ID
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
Get rule by study ID based on study mode
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}
Get rule Operands list by rule IDs
Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleIds/operands
Get visits/forms action information
Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/versions/{version}/formId/{formId}
Job Status rules
Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/jobStatus
Publish a collection of rules in Testing mode
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/publish
Update rule states in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/from/{fromState}/to/{toState}/bulkstateupdate
Update rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkupdate
Validate copied rules
Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/validateCopiedRules
Rules/v2.0
The operations from the Rules/v2.0 category.
[Deprecated]: Execute rules for the deleted repeating form items
Method: put
Path: /ec-rule-svc/rest/v2.0/studies/{studyId}/{mode}/deleteform
Copy rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/bulkcopy
Generate Rule Designer reports
Method: post
Path: /ec-rule-designer-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}
Get rule by property
Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
Get rule by question ID
Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/item/{itemId}
Get rule by rule ID
Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
Job Status rules
Method: put
Path: /ec-rule-svc/rest/v2.0/studies/{studyId}/{mode}/jobStatus
Update rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/bulkupdate
Rules/v3.0
The operations from the Rules/v3.0 category.
Generate Rule Designer reports
Method: post
Path: /ec-rule-designer-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}
Get rule by property
Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
Get rule by question ID
Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/item/{itemId}
Get rule by rule ID
Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
Update rules in bulk
Method: put
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/bulkupdate
Rules/v4.0
The operations from the Rules/v4.0 category.
[Deprecated]: Execute rules for the deleted repeating form items
Method: put
Path: /ec-rule-svc/rest/v4.0/studies/{studyId}/{mode}/executeRule
Execute rules for the deleted repeating form items
Method: put
Path: /ec-rule-svc/rest/v4.0/studies/{studyId}/{mode}/deleteform
Generate Rule Designer reports
Method: post
Path: /ec-rule-designer-svc/rest/v4.0/studies/{studyId}/{mode}/report/{reportName}
Rules/v5.0
The operations from the Rules/v5.0 category.
Generate Rule Designer reports
Method: post
Path: /ec-rule-designer-svc/rest/v5.0/studies/{studyId}/{mode}/report/{reportName}
Sites and Depots/Country/v1.0
The operations from the Sites and Depots/Country/v1.0 category.
Add a region to a country
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
Associate countries to site or depot
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{sdfId}
Disassociate country from site
Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfcountry/{sdfCountryId}
Get a country based on ISO code
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country
Get association between country and site
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfcountry
Get country based on country ID
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}
Get states based on country ID.
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}/states
Update countries association to site
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{sdfId}
Sites and Depots/Country/v2.0
The operations from the Sites and Depots/Country/v2.0 category.
Associate countries and states to site or depot
Method: post
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{sdfId}
Get association between country and site (ISO3 codes)
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfcountry
Get country name based on an ISO3 code
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country
Update countries and states association to site
Method: put
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{sdfId}
Sites and Depots/Country/v3.0
The operations from the Sites and Depots/Country/v3.0 category.
Get all country and state names
Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/country
Sites and Depots/Labs/v1.0
The operations from the Sites and Depots/Labs/v1.0 category.
Add an association between a lab and a site
Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
Create a lab
Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
Create or update lab normals
Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals
Delete lab if site association with lab does not exist
Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Delete the lab's association with the given site
Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
Get all lab normals
Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}/labnormals
Get all lab normals for given subject
Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals/lookup
Get all labs associated with a given site
Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
Get lab details of a given lab ID
Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Get lab history for the given labId
Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}/history
Update a lab
Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Sites and Depots/Region/v1.0
The operations from the Sites and Depots/Region/v1.0 category.
Delete a region
Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Get a list of regions
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
Get a region's details
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Get list of countries associated to a region
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}/countries
Get region by country
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/filter/countries/{countryId}
Update a region and associated countries
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Sites and Depots/Region/v2.0
The operations from the Sites and Depots/Region/v2.0 category.
Create a region with countries and states association.
Method: post
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions
Get list of countries and states associated to a region
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}/countries
Get list of regions along with states
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions
Get region by country or state Id
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/filter/countries/{countryId}
Get region details
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}
Update a region and its associated countries and states list
Method: put
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}
Sites and Depots/Site/Site Address/v1.0
The operations from the Sites and Depots/Site/Site Address/v1.0 category.
Create site address
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address
Delete site address by site and address ID
Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}
Update site address by site and address ID
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}
Sites and Depots/Site/Site LOV/v1.0
The operations from the Sites and Depots/Site/Site LOV/v1.0 category.
Get sites by column, type and status
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/lov/{pathAttr}
Get the principal investigator's full name for all sites
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/properties/piname
Sites and Depots/Site/Site Property/v1.0
The operations from the Sites and Depots/Site/Site Property/v1.0 category.
Create site property by site ID
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
Delete the SDF property of the site
Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Get all properties of the site by SDF ID
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
Get property of the site by ID
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Update the SDF property of the site
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Sites and Depots/Site/Site Upload/v1.0
The operations from the Sites and Depots/Site/Site Upload/v1.0 category.
Get all headers for mapping
Method: get
Path: /ec-site-svc/rest/v1/sites/headers
Get headers and rows from the CSV file
Method: get
Path: /ec-site-svc/rest/v1/sites/{bucketName}/{objectName}
Sites and Depots/Site/v1.0
The operations from the Sites and Depots/Site/v1.0 category.
Create a site
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
Create a site and send notification
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf
Delete a site by ID
Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Generate report for sites
Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/report/{reportName}
Get a site by ID
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Get a site by SDF ID from tenant
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/tenant/{sdfId}
Get all sites by type
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/all
Get all sites by type and study version
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/allstudyversions
Get countries by type
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/countries
Get SDF information with creation date by SDF type
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/creationDate
Get site by filter parameters
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/siteFilterPaginated
Get site by site name and address
Method: get
Path: /ec-site-svc/rest/v1/tenant/sdfs/autoSuggest
Get site by site name or address and type of SDF
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/search
Get site by site name or address and type of SDF (UI search autocomplete)
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/autoSuggest
Get sites by type or list of countries
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
Get sites on search key
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/searchSite
Get the principal investigator's last name and address of the site
Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/pinaddr
Update a site
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Update a site and send notification
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}
Update all sites with a new study version
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/versionupdate
Update site properties for managing sites
Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/multiple
Sites and Depots/Site/v2.0
The operations from the Sites and Depots/Site/v2.0 category.
Generate report for sites
Method: post
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}
Get sites in a paginated format
Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/paginated
Users, Permissions and Roles/Data Classification/v1.0
The operations from the Users, Permissions and Roles/Data Classification/v1.0 category.
Assign data classifications to a study role for study ID
Method: put
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyrole/{studyRoleId}
Assign specific data classifications for all study roles in a study
Method: put
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyroles
Assign tenant data classifications to study role
Method: put
Path: /ec-auth-svc/rest/v1.0/dataclassification/studyrole/{studyRoleId}
Create a list of data classifications and mappings for a tenant
Method: post
Path: /ec-auth-svc/rest/v1.0/dataclassification/copy/{studyId}
Get data classifications for a specific study role by study ID
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyrole/{studyRoleId}
Get list of data classification for a study ID
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}
Get list of data classification for a tenant
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification
Get list of data classification with levels
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/{mode}/user/{userId}
Get specific data classifications for all study roles in a study
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyroles
Get tenant data classifications and study roles
Method: put
Path: /ec-auth-svc/rest/v1.0/dataclassification/studyroles
Get tenant data classifications for study role
Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/studyrole/{studyRoleId}
Users, Permissions and Roles/Permissions/v1.0
The operations from the Users, Permissions and Roles/Permissions/v1.0 category.
Get a user's global rights
Method: get
Path: /ec-auth-svc/rest/v1.0/globalrights
Get a user's ID
Method: get
Path: /ec-auth-svc/rest/v1.0/userids/{username}
Get a user's info
Method: get
Path: /ec-auth-svc/rest/v1.0/userinfo
Get a user's permissions
Method: get
Path: /ec-auth-svc/rest/v1.0/rights
Get a user's rights
Method: get
Path: /ec-auth-svc/rest/v1.0/allrights
Get a user's rights for all studies
Method: get
Path: /ec-auth-svc/rest/v1.0/allStudyRights
Get studies and modes
Method: get
Path: /ec-auth-svc/rest/v1.0/studies
Get user name
Method: get
Path: /ec-auth-svc/rest/v1.0/usernames/{userid}
Get users and rights in a study
Method: get
Path: /ec-auth-svc/rest/v1.0/{studyId}/userrights
Verify right name
Method: get
Path: /ec-auth-svc/rest/v1.0/rightname/{rightname}
Users, Permissions and Roles/Permissions/v2.0
The operations from the Users, Permissions and Roles/Permissions/v2.0 category.
Get a user's info
Method: get
Path: /ec-auth-svc/rest/v2.0/userinfo
Users, Permissions and Roles/Reports/v1.0
The operations from the Users, Permissions and Roles/Reports/v1.0 category.
[Deprecated]: Generate a user assignment report
Method: post
Path: /ec-auth-svc/rest/v1.0/{studyId}/{mode}/report/{reportName}
Generate a global report
Method: post
Path: /ec-auth-svc/rest/v1.0/report/{reportName}
Generates the user upload error report
Method: post
Path: /ec-auth-svc/rest/v1.0/{studyId}/{mode}/report/uploaderror/{reportName}
Users, Permissions and Roles/Reports/v2.0
The operations from the Users, Permissions and Roles/Reports/v2.0 category.
Generate a user assignment report
Method: post
Path: /ec-auth-svc/rest/v2.0/{studyId}/{mode}/report/{reportName}
Users, Permissions and Roles/Roles/Authorization Roles/v1.0
The operations from the Users, Permissions and Roles/Roles/Authorization Roles/v1.0 category.
[Deprecated]: Get list roles
Method: get
Path: /ec-auth-svc/rest/v1.0/authroles/{studyId}
[Deprecated]: Get the list of roles
Method: get
Path: /ec-auth-svc/rest/v1.0/authroles
Get assigned permissions
Method: get
Path: /ec-auth-svc/rest/v1.0/authroles/{roleid}/assignedrights
Get list of permissions for a role
Method: get
Path: /ec-auth-svc/rest/v1.0/authroles/{roleid}/rights
Get the list of permissions
Method: get
Path: /ec-auth-svc/rest/v1.0/authroles/rolesrights
Users, Permissions and Roles/Roles/Authorization Roles/v2.0
The operations from the Users, Permissions and Roles/Roles/Authorization Roles/v2.0 category.
Get the list of roles
Method: get
Path: /ec-auth-svc/rest/v2.0/authroles
Users, Permissions and Roles/Roles/Study Roles/v1.0
The operations from the Users, Permissions and Roles/Roles/Study Roles/v1.0 category.
Create a study role group for a study
Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
Create a study role group for an organization
Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles
Create study roles list for a study
Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles/copy/{studyId}
Delete study roles list for a study
Method: delete
Path: /ec-auth-svc/rest/v1.0/studyroles/remove/{studyId}
Get groups of permissions
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyroleid}/rightsgroups
Get groups of permissions by study ID
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyroleId}/study/{studyId}/rightsgroups
Get list of study roles for a study
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
Get list of study roles for an organization
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles
Get list of study roles for studyId and studyRoleId
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}/{studyRoleId}
Get study roles list for studyRoleId
Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/studyroleid/{studyRoleId}
Retire a study role
Method: put
Path: /ec-auth-svc/rest/v1.0/studyroles/retire/{studyroleId}
Retire study roles list for a study
Method: put
Path: /ec-auth-svc/rest/v1.0/studyroles/retire/{studyroleId}/study/{studyId}
Update a study role group
Method: put
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
Update a study role group for an organization
Method: put
Path: /ec-auth-svc/rest/v1.0/studyroles
Users, Permissions and Roles/Roles/Study Roles/v2.0
The operations from the Users, Permissions and Roles/Roles/Study Roles/v2.0 category.
Get list of study roles for a study
Method: get
Path: /ec-auth-svc/rest/v2.0/studyroles/{studyId}
Get list of study roles for an organization
Method: get
Path: /ec-auth-svc/rest/v2.0/studyroles
Users, Permissions and Roles/Roles/v1.0
The operations from the Users, Permissions and Roles/Roles/v1.0 category.
[Deprecated]: Get a user's modes and roles
Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}
[Deprecated]: Update a user's mode and roles
Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}
Delete a global user's roles
Method: delete
Path: /ec-auth-svc/rest/v1.0/globalusers/{userid}/roles
Delete a user's mode and roles
Method: delete
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}
Get a global user's roles
Method: get
Path: /ec-auth-svc/rest/v1.0/globalusers/{userid}/roles
Get all global roles
Method: get
Path: /ec-auth-svc/rest/v1.0/globalroles
Get user roles in a study
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/userroles
Update a global user's roles
Method: put
Path: /ec-auth-svc/rest/v1.0/globalusers/{userid}/roles
Users, Permissions and Roles/Roles/v2.0
The operations from the Users, Permissions and Roles/Roles/v2.0 category.
Get a global user's roles
Method: get
Path: /ec-auth-svc/rest/v2.0/globalusers/{userid}/roles
Get list of roles for a study
Method: get
Path: /ec-auth-svc/rest/v2.0/authroles/{studyId}
Get mode and roles
Method: get
Path: /ec-auth-svc/rest/v2.0/authusers/{userid}/studies/{studyId}
Users, Permissions and Roles/Roles/v3.0
The operations from the Users, Permissions and Roles/Roles/v3.0 category.
Get mode and roles
Method: get
Path: /ec-auth-svc/rest/v3.0/authusers/{userid}/studies/{studyId}
Users, Permissions and Roles/Sites and Depots/v1.0
The operations from the Users, Permissions and Roles/Sites and Depots/v1.0 category.
Get depots
Method: get
Path: /ec-auth-svc/rest/v1.0/depots
Get sites
Method: get
Path: /ec-auth-svc/rest/v1.0/sites
Get sites and depots
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/sdfs
Users, Permissions and Roles/Users/v1.0
The operations from the Users, Permissions and Roles/Users/v1.0 category.
[Deprecated]: Get all unassigned users for a study
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users/unassigned
[Deprecated]: Get global users
Method: get
Path: /ec-auth-svc/rest/v1.0/globalroles/users
[Deprecated]: Get global users unassigned to a study
Method: get
Path: /ec-auth-svc/rest/v1.0/globalroles/users/unassigned
[Deprecated]: Get users and rights in a study
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users
Create bulk users
Method: post
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/bulk
Get a global user's details by user ID
Method: get
Path: /ec-auth-svc/rest/v1.0/globalusers/{userid}
Get all active inactive users per study
Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/study/{studyid}
Get all active users for a study with study roles and email address
Method: post
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/{mode}/users/studyroles
Get all users for a study
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users/detail
Get list of users
Method: get
Path: /ec-auth-svc/rest/v1.0/authusers
Get user details by user ID
Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}
Get user language attributes by userId
Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/language
Get users for a depot
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/depots/{depotId}/users
Get users for a right
Method: get
Path: /ec-auth-svc/rest/v1.0/notifications/{rightname}/users
Get users for a site
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/sites/{siteId}/users
Get users with a certain role
Method: get
Path: /ec-auth-svc/rest/v1.0/users/role/{role}
Users, Permissions and Roles/Users/v2.0
The operations from the Users, Permissions and Roles/Users/v2.0 category.
[Deprecated]: Get all users for a study
Method: get
Path: /ec-auth-svc/rest/v2.0/authstudies/{studyId}/users
Associate a user with a study role
Method: put
Path: /ec-auth-svc/rest/v2.0/authusers/{userid}/studies/{studyId}
Get a global user's details by user ID
Method: get
Path: /ec-auth-svc/rest/v2.0/globalusers/{userid}
Get all unassigned users for a study
Method: get
Path: /ec-auth-svc/rest/v2.0/authstudies/{studyId}/users/unassigned
Get global users
Method: get
Path: /ec-auth-svc/rest/v2.0/globalroles/users
Get global users unassigned to a study
Method: get
Path: /ec-auth-svc/rest/v2.0/globalroles/users/unassigned
Get global users' details
Method: get
Path: /ec-auth-svc/rest/v2.0/globalusers
Get list of users
Method: get
Path: /ec-auth-svc/rest/v2.0/authusers
Get user details by user ID
Method: get
Path: /ec-auth-svc/rest/v2.0/authusers/{userid}
Users, Permissions and Roles/Users/v3.0
The operations from the Users, Permissions and Roles/Users/v3.0 category.
Get all users for a study
Method: get
Path: /ec-auth-svc/rest/v3.0/authstudies/{studyId}/users
Get global users
Method: get
Path: /ec-auth-svc/rest/v3.0/globalroles/users
Users, Permissions and Roles/Users/v4.0
The operations from the Users, Permissions and Roles/Users/v4.0 category.
Get all users for a study
Method: get
Path: /ec-auth-svc/rest/v4.0/authstudies/{studyId}/users
Users, Permissions and Roles/Users/v5.0
The operations from the Users, Permissions and Roles/Users/v5.0 category.
Get all users for a study
Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/paginatedUsers