REST API for Clinical One Platform

All REST Endpoints

Codelist/v1.0

The operations from the Codelist/v1.0 category.

[Deprecated]: Get a code list for the given code name: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{name}
[Deprecated]: Get all code list values by code list ID and data type: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/{codeId}/code
[Deprecated]: Get code list by code name: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/{name}
[Deprecated]: Get code list by tag: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/tag/{tagName}
[Deprecated]: Get code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/values/{fieldName}
[Deprecated]: Get list of all code lists: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated]: Get list of all code lists by code list type: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/all
[Deprecated]: Insert a new code in a code list: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/code
[Deprecated]: Insert a new code list: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated]: Insert code list with tag: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/code/tag
[Deprecated]: Update an existing code list: Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist
[Deprecated]: Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}
[Deprecated]: Update tags for an existing code list: Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}/tag
Associate group to study: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/study/{studyId}
Copy dynamic codelist mappings from source study to target study: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/dynamic/copy
Create copy of code list by given ID and name: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/code/copy/{codeId}
Export code list values to file: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/values/export/{codeId}
Get all code list groups: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/groups
Get all code list tag values by code list ID and data type: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/code/{codeId}/tag
Get all code lists matching a given study ID and code ID: Method: get
Path: /ec-codelist-svc/rest/v1.0/history/codes
Get all code lists matching a given study ID, code ID and language: Method: get
Path: /ec-codelist-svc/rest/v1.0/history/codevalues
Get code list group by ID: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/{groupId}
Get historical code list groups: Method: get
Path: /ec-codelist-svc/rest/v1.0/history/groups
Get historical code lists by name: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/search
Insert code list group: Method: post
Path: /ec-codelist-svc/rest/v1.0/codelist/groups
Update code list group by ID: Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/groups/{groupId}
Update code list with tag values: Method: put
Path: /ec-codelist-svc/rest/v1.0/codelist/tag

Codelist/v2.0

The operations from the Codelist/v2.0 category.

[Deprecated]: Get a code list matching the given code name in the payload: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated]: Get all historic code lists for a given code name: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/history/{name}
[Deprecated]: Get code list by code namematching the given code name.: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/{name}
[Deprecated]: Get code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/values/{fieldName}
[Deprecated]: Insert a new code in a code list: Method: post
Path: /ec-codelist-svc/rest/v2.0/codelist/code
[Deprecated]: Insert a new code list: Method: post
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated]: Update an existing code list: Method: put
Path: /ec-codelist-svc/rest/v2.0/codelist
[Deprecated]: Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v2.0/codelist/code/{codeId}
Get list of all code lists by code list type: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/all

Codelist/v3.0

The operations from the Codelist/v3.0 category.

[Deprecated]: Get code list by code name: Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist/{name}
[Deprecated]: Get list of all code lists by code list type: Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist
[Deprecated]: Insert a new code in a code list: Method: post
Path: /ec-codelist-svc/rest/v3.0/codelist/code
[Deprecated]: Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v3.0/codelist/code/{codeId}
Get code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist/values/{fieldName}
Get snapshot of code list asDate based on studyId, codeListId, hidden, language: Method: get
Path: /ec-codelist-svc/rest/v1.0/codelist/values/asOfDate/{id}

Codelist/v4.0

The operations from the Codelist/v4.0 category.

[Deprecated]: Get code list by code name: Method: get
Path: /ec-codelist-svc/rest/v4.0/codelist/{name}
Get a list of all code lists by code list type: Method: get
Path: /ec-codelist-svc/rest/v4.0/codelist
Get code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v4.0/codelist/values/{fieldName}
Insert a new code in a code list: Method: post
Path: /ec-codelist-svc/rest/v4.0/codelist/code
Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v4.0/codelist/code/{codeId}

Codelist/v5.0

The operations from the Codelist/v5.0 category.

Insert a new code (static/ dynamic) in a code list: Method: post
Path: /ec-codelist-svc/rest/v5.0/codelist/code
Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v5.0/codelist/code/{codeId}

Coding/Query Resource/v1.0

The operations from the Coding/Query Resource/v1.0 category.

Create queries or discrepancies: Method: post
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query
Get query details by query ID or discrepancy ID 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 or 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 list of verbatim terms to code: Method: get
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/verbatimTerms
Update coded verbatim terms in DCS: Method: put
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/codedValues

Comments/Add comment or reply to an object

The operations from the Comments/Add comment or reply to an object category.

V1.0: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments

Comments/Delete comment or reply

The operations from the Comments/Delete comment or reply category.

V1.0: Method: delete
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/{commentId}

Comments/Get all comments for an object

The operations from the Comments/Get all comments for an object category.

V1.0: Method: get
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/{objectId}

Comments/Get unread comments count for a list of objects

The operations from the Comments/Get unread comments count for a list of objects category.

V1.0: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/unreadCount

Comments/Get unread comments count for an object

The operations from the Comments/Get unread comments count for an object category.

V1.0: Method: get
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/{objectId}/unreadCount

Comments/Mark comments as read for a user

The operations from the Comments/Mark comments as read for a user category.

V1.0: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/markAsRead

Comments/Mark comments as unread for a user

The operations from the Comments/Mark comments as unread for a user category.

V1.0: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/markAsUnRead

Comments/Post comment or reply

The operations from the Comments/Post comment or reply category.

V1.0: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects

Comments/Update comment

The operations from the Comments/Update comment category.

V1.0: Method: put
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/{commentId}

Data Actions/Bulk Action/Given bulk action on set of given subjectIds or visitIds

The operations from the Data Actions/Bulk Action/Given bulk action on set of given subjectIds or visitIds category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/bulkaction

Data Actions/Data Elements/Get all items with source data verification information

The operations from the Data Actions/Data Elements/Get all items with source data verification information category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/sdv

Data Actions/Data Elements/Get data elements items summary for locked or frozen

The operations from the Data Actions/Data Elements/Get data elements items summary for locked or frozen category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/validate/multipleitems

Data Actions/Data Elements/Get data elements summary for locked or frozen items at row level

The operations from the Data Actions/Data Elements/Get data elements summary for locked or frozen items at row level category.

[Deprecated]: V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements

Data Actions/Data Elements/Get data elements validation summary for locked or frozen items at row level

The operations from the Data Actions/Data Elements/Get data elements validation summary for locked or frozen items at row level category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/validate/dataelements

Data Actions/Freeze/Freeze multiple data elements for a subject

The operations from the Data Actions/Freeze/Freeze multiple data elements for a subject category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze

Data Actions/Freeze/Unfreeze single data element of a visit

The operations from the Data Actions/Freeze/Unfreeze single data element of a visit category.

V1.0: Method: put
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Data Actions/Freeze/Unfreeze visit start date

The operations from the Data Actions/Freeze/Unfreeze visit start date category.

V1.0: Method: put
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/vsd

Data Actions/Lock/Get all Lock records for a visit

The operations from the Data Actions/Lock/Get all Lock records for a visit category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/all

Data Actions/Lock/Get all subject lock records

The operations from the Data Actions/Lock/Get all subject lock records category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects-with-locked-data

Data Actions/Lock/Get item level Lock records for a subject

The operations from the Data Actions/Lock/Get item level Lock records for a subject category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/multipleitems/locks

Data Actions/Lock/Get item level lock records for an item

The operations from the Data Actions/Lock/Get item level lock records for an item category.

[Deprecated]: V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks
V2.0: Method: get
Path: /ec-dataaction-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks
V3.0: Method: get
Path: /ec-dataaction-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks

Data Actions/Lock/Get visit level lock records for a visit

The operations from the Data Actions/Lock/Get visit level lock records for a visit category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/visits

Data Actions/Lock/Lock data elements in a subject

The operations from the Data Actions/Lock/Lock data elements in a subject category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/lock/allvisit

Data Actions/Lock/Lock data elements in a visit

The operations from the Data Actions/Lock/Lock data elements in a visit category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks

Data Actions/Lock/Lock multiple visits' items

The operations from the Data Actions/Lock/Lock multiple visits' items category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/visits/lock

Data Actions/Lock/Lock subject level record for Subject ID

The operations from the Data Actions/Lock/Lock subject level record for Subject ID category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/lock

Data Actions/Multiple Visits/Get request for multiple locked visits summary

The operations from the Data Actions/Multiple Visits/Get request for multiple locked visits summary category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/validate/multiplevisits

Data Actions/Sign Evaluation/Calculate sign overdue and trigger mail notification

The operations from the Data Actions/Sign Evaluation/Calculate sign overdue and trigger mail notification category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/triggeremail

Data Actions/Sign Evaluation/Get number of all due and overdue signatures for a study

The operations from the Data Actions/Sign Evaluation/Get number of all due and overdue signatures for a study category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/configchange/studysummary

Data Actions/Sign Evaluation/Process sign evaluation from data change event

The operations from the Data Actions/Sign Evaluation/Process sign evaluation from data change event category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/processque

Data Actions/Sign Verify Resource/Check if scope type (ITEM-VSD) item is eligible for clearing its data

The operations from the Data Actions/Sign Verify Resource/Check if scope type (ITEM-VSD) item is eligible for clearing its data category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/cleardatacheck/{scope}
V2.0: Method: post
Path: /ec-dataaction-svc/rest/v2.0/studies/{studyId}/{mode}/cleardatacheck/{scope}

Data Actions/Sign Verify Resource/Get list of svf by study

The operations from the Data Actions/Sign Verify Resource/Get list of svf by study category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/svf

Data Actions/Sign Verify Resource/Get sign information

The operations from the Data Actions/Sign Verify Resource/Get sign information category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signinfo

Data Actions/Sign Verify Resource/Get sign information by visit

The operations from the Data Actions/Sign Verify Resource/Get sign information by visit category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signinfo

Data Actions/Sign Verify Resource/Unsign and unverify data

The operations from the Data Actions/Sign Verify Resource/Unsign and unverify data category.

V1.0: Method: put
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverify

Data Actions/Sign Verify Resource/Unsign and unverify item

The operations from the Data Actions/Sign Verify Resource/Unsign and unverify item category.

V1.0: Method: put
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverifyforitem
V2.0: Method: put
Path: /ec-dataaction-svc/rest/v2.0/studies/{studyId}/{mode}/unsign-unverifyforitem

Data Actions/Sign Verify Resource/v1.0

The operations from the Data Actions/Sign Verify Resource/v1.0 category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/visit/sdv

Data Actions/Signature Configuration/Delete record from sign configuration

The operations from the Data Actions/Signature Configuration/Delete record from sign configuration category.

V1.0: Method: delete
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{id}

Data Actions/Signature Configuration/Get signature configuration of a study

The operations from the Data Actions/Signature Configuration/Get signature configuration of a study category.

V1.0: Method: get
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration

Data Actions/Signature Configuration/Save signature configuration of a study

The operations from the Data Actions/Signature Configuration/Save signature configuration of a study category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration

Data Actions/Signature Configuration/Update signature configuration of a study

The operations from the Data Actions/Signature Configuration/Update signature configuration of a study category.

V1.0: Method: put
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{signConfigurationId}

Data Actions/Unlock/Unlock Visit Level Records

The operations from the Data Actions/Unlock/Unlock Visit Level Records category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlockvisits

Data Actions/Unlock/Unlock subject level record for subject ID

The operations from the Data Actions/Unlock/Unlock subject level record for subject ID category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlock

Data Actions/Unlock/Unlock the given records for a visit

The operations from the Data Actions/Unlock/Unlock the given records for a visit category.

V1.0: Method: post
Path: /ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/unlocks

Data Capture/Coding Status/Get data elements to be coded by code Type

The operations from the Data Capture/Coding Status/Get data elements to be coded by code Type category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Data Capture/Coding Status/Get data elements to be coded using source IDs

The operations from the Data Capture/Coding Status/Get data elements to be coded using source IDs category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Data Capture/Coding Status/Update multiple coded data elements

The operations from the Data Capture/Coding Status/Update multiple coded data elements category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus/codedItems
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/codingstatus/codedItems

Data Capture/DCProperties APIs/Get Data Capture properties

The operations from the Data Capture/DCProperties APIs/Get Data Capture properties category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{id}

Data Capture/DCProperties APIs/Get audit history of a property

The operations from the Data Capture/DCProperties APIs/Get audit history of a property category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/history/{id}

Data Capture/Data Elements/Clear data elements scope by study ID and mode

The operations from the Data Capture/Data Elements/Clear data elements scope by study ID and mode category.

[Deprecated]:V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
[Deprecated]:V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
V4.0: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/clear/{scope}

Data Capture/Data Elements/Create data elements for a visit and form

The operations from the Data Capture/Data Elements/Create data elements for a visit and form category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode

Data Capture/Data Elements/Create data elements for the flat part of a multi section form

The operations from the Data Capture/Data Elements/Create data elements for the flat part of a multi section form category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat

Data Capture/Data Elements/Create data elements for the repeating part of a multi section form

The operations from the Data Capture/Data Elements/Create data elements for the repeating part of a multi section form category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat

Data Capture/Data Elements/Create migrate data elements for a subject

The operations from the Data Capture/Data Elements/Create migrate data elements for a subject category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/migratedata

Data Capture/Data Elements/Create multiple data elements for a subject

The operations from the Data Capture/Data Elements/Create multiple data elements for a subject category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
[Deprecated]: V10.0: Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V5.0: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V7.0: Method: post
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V8.0: Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V9.0: Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements
V11.0: Method: post
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements
V12.0: Method: post
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/dataelements

Data Capture/Data Elements/Create multiple data elements for repeating form

The operations from the Data Capture/Data Elements/Create multiple data elements for repeating form category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multirepeatingform
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/multirepeatingform

Data Capture/Data Elements/Create multiple data elements in a form with form associations

The operations from the Data Capture/Data Elements/Create multiple data elements in a form with form associations category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations

Data Capture/Data Elements/Create source data verification group

The operations from the Data Capture/Data Elements/Create source data verification group category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup

Data Capture/Data Elements/Delete data elements for a visit and form

The operations from the Data Capture/Data Elements/Delete data elements for a visit and form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/dataelements/delete

Data Capture/Data Elements/Delete data elements in a form within a visit

The operations from the Data Capture/Data Elements/Delete data elements in a form within a visit category.

[Deprecated]: V1.0: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
[Deprecated]: V2.0: Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
V3.0: Method: delete
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
V4.0: Method: delete
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements

Data Capture/Data Elements/Freeze multiple data elements for a subject

The operations from the Data Capture/Data Elements/Freeze multiple data elements for a subject category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/freeze
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/freeze

Data Capture/Data Elements/Get all data elements based on subject and visit

The operations from the Data Capture/Data Elements/Get all data elements based on subject and visit category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements

Data Capture/Data Elements/Get all elements required to be cleared to modify a data element

The operations from the Data Capture/Data Elements/Get all elements required to be cleared to modify a data element category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/{dataelementId}/{opeartionType}/childItems
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId}/{opeartionType}/childItems

Data Capture/Data Elements/Get all existing data elements across all repeating form and visit instances

The operations from the Data Capture/Data Elements/Get all existing data elements across all repeating form and visit instances category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/repeatinginstances/subjectId/{subjectId}

Data Capture/Data Elements/Get all items with source data verification information

The operations from the Data Capture/Data Elements/Get all items with source data verification information category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/sdv

Data Capture/Data Elements/Get all source data verification groups

The operations from the Data Capture/Data Elements/Get all source data verification groups category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup/all

Data Capture/Data Elements/Get audit history for a form association

The operations from the Data Capture/Data Elements/Get audit history for a form association category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}

Data Capture/Data Elements/Get consolidated repeat instance numbers

The operations from the Data Capture/Data Elements/Get consolidated repeat instance numbers category.

V7.0: Method: post
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/consolidatedRepeatInstanceNumbers

Data Capture/Data Elements/Get data element records for a subject and date range

The operations from the Data Capture/Data Elements/Get data element records for a subject and date range category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}

Data Capture/Data Elements/Get data elements based on subject, visit, and form

The operations from the Data Capture/Data Elements/Get data elements based on subject, visit, and form category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/dataelements
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/dataelements

Data Capture/Data Elements/Get data elements by form ID, Subject ID, Event ID and Vendor code

The operations from the Data Capture/Data Elements/Get data elements by form ID, Subject ID, Event ID and Vendor code category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/vendorCode/{vendorCode}/dataelements/withvendorcode

Data Capture/Data Elements/Get data elements by subject and event ID

The operations from the Data Capture/Data Elements/Get data elements by subject and event ID category.

[Deprecated]:V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
[Deprecated]:V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata

Data Capture/Data Elements/Get data elements for a list of items by subject ID

The operations from the Data Capture/Data Elements/Get data elements for a list of items by subject ID category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items

Data Capture/Data Elements/Get data elements for a visit and form combination

The operations from the Data Capture/Data Elements/Get data elements for a visit and form combination category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements

Data Capture/Data Elements/Get data elements for multiple items

The operations from the Data Capture/Data Elements/Get data elements for multiple items category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multiple
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multiple
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multiple
V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/multiple

Data Capture/Data Elements/Get data elements history with pagination

The operations from the Data Capture/Data Elements/Get data elements history with pagination category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/all
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/all
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/all

Data Capture/Data Elements/Get data elements with form associations

The operations from the Data Capture/Data Elements/Get data elements with form associations category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations

Data Capture/Data Elements/Get deleted data elements

The operations from the Data Capture/Data Elements/Get deleted data elements category.

[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements

Data Capture/Data Elements/Get form associations by study ID

The operations from the Data Capture/Data Elements/Get form associations by study ID category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/formassociations

Data Capture/Data Elements/Get repeat instance numbers

The operations from the Data Capture/Data Elements/Get repeat instance numbers category.

V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/repeatInstanceNumbers

Data Capture/Data Elements/Get the audit history for a data element

The operations from the Data Capture/Data Elements/Get the audit history for a data element category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V10.0: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V11.0: Method: get
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: V9.0: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
V12.0: Method: get
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
V13.0: Method: get
Path: /ec-dc-svc/rest/v13.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}

Data Capture/Data Elements/Get the current status of a data element

The operations from the Data Capture/Data Elements/Get the current status of a data element category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataelementId}
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId}

Data Capture/Data Elements/Get the data element for a subject for a form and a site

The operations from the Data Capture/Data Elements/Get the data element for a subject for a form and a site category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements

Data Capture/Data Elements/Get the deleted data elements in a form

The operations from the Data Capture/Data Elements/Get the deleted data elements in a form category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/form/dataelements
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/form/dataelements

Data Capture/Data Elements/Unfreeze single data element of a visit

The operations from the Data Capture/Data Elements/Unfreeze single data element of a visit category.

[Deprecated]: V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Data Capture/Data Elements/Update data elements for a repeating part of a multi section form

The operations from the Data Capture/Data Elements/Update data elements for a repeating part of a multi section form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat

Data Capture/Data Elements/Update data elements for a visit and form

The operations from the Data Capture/Data Elements/Update data elements for a visit and form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode

Data Capture/Data Elements/Update data elements for the flat part of a multi section form

The operations from the Data Capture/Data Elements/Update data elements for the flat part of a multi section form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat

Data Capture/Data Elements/Update data elements for the repeating part of a multi section form

The operations from the Data Capture/Data Elements/Update data elements for the repeating part of a multi section form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat

Data Capture/Data Elements/Update multiple data elements for a given form, event and subject

The operations from the Data Capture/Data Elements/Update multiple data elements for a given form, event and subject category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations

Data Capture/Data Elements/Update single data element

The operations from the Data Capture/Data Elements/Update single data element category.

[Deprecated]: V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V10.0: Method: put
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V11.0: Method: put
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V4.0: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V5.0: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V6.0: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V7.0: Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V8.0: Method: put
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
[Deprecated]: V9.0: Method: put
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
V12.0: Method: put
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/Update source data verification group

The operations from the Data Capture/Data Elements/Update source data verification group category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup

Data Capture/Data Elements/Upsert data elements for a visit and form

The operations from the Data Capture/Data Elements/Upsert data elements for a visit and form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode

Data Capture/Data Elements/Upsert data elements for the flat part of a multi section form

The operations from the Data Capture/Data Elements/Upsert data elements for the flat part of a multi section form category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat

Data Capture/Data Elements/Verify VSD and multiple data elements for a subject

The operations from the Data Capture/Data Elements/Verify VSD and multiple data elements for a subject category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify

Data Capture/Data Elements/Verify multiple data elements for a subject

The operations from the Data Capture/Data Elements/Verify multiple data elements for a subject category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/verify
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/verify
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/verify
V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/verify

Data Capture/EHR Data/Add EHR Data for a particular subject and a visit

The operations from the Data Capture/EHR Data/Add EHR Data for a particular subject and a visit category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata

Data Capture/EHR Data/Get EHR Data for a particular subject and visit

The operations from the Data Capture/EHR Data/Get EHR Data for a particular subject and visit category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/subjects/{subjectId}/visit/{eventId}/studyversion/{studyVersion}/{category}

Data Capture/EHR Data/Get patient information based on the Medical Record Number

The operations from the Data Capture/EHR Data/Get patient information based on the Medical Record Number category.

v1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/medicalrecordnumber/{siteId}/{medicalRecordNumber}

Data Capture/EHR Data/Get patient link status based on the site ID

The operations from the Data Capture/EHR Data/Get patient link status based on the site ID category.

v1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/subjectslinkstatus

Data Capture/Electronic Signature/Get URL for IAMS login page

The operations from the Data Capture/Electronic Signature/Get URL for IAMS login page category.

v1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/esign/geturl/orgId/{orgId}/subjectId/{subjectId}

Data Capture/Enrollment Settings/Create enrollment settings

The operations from the Data Capture/Enrollment Settings/Create enrollment settings category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Data Capture/Enrollment Settings/Get specific enrollment settings

The operations from the Data Capture/Enrollment Settings/Get specific enrollment settings category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Data Capture/Enrollment Settings/Update enrollment setting

The operations from the Data Capture/Enrollment Settings/Update enrollment setting category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Data Capture/Lab/Create lab for a subject

The operations from the Data Capture/Lab/Create lab for a subject category.

[Deprecated]:V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/labnormals

Data Capture/Lab/Update lab for a subject

The operations from the Data Capture/Lab/Update lab for a subject category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{type}/{subjectId}/{id}

Data Capture/Lab/Update lab normals for a subject

The operations from the Data Capture/Lab/Update lab normals for a subject category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals

Data Capture/Safety Case/Update safety case status

The operations from the Data Capture/Safety Case/Update safety case status category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/safetycase/{id}

Data Capture/Subject Settings/Create subject settings

The operations from the Data Capture/Subject Settings/Create subject settings category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subject Settings/Get all source data verification settings

The operations from the Data Capture/Subject Settings/Get all source data verification settings category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings

Data Capture/Subject Settings/Get all subject settings

The operations from the Data Capture/Subject Settings/Get all subject settings category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subject Settings/Get all the mHealth settings

The operations from the Data Capture/Subject Settings/Get all the mHealth settings category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings

Data Capture/Subject Settings/Get the subject settings based on settings ID

The operations from the Data Capture/Subject Settings/Get the subject settings based on settings ID category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/{id}

Data Capture/Subject Settings/Remove subject settings

The operations from the Data Capture/Subject Settings/Remove subject settings category.

V1.0: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subject Settings/Update mHealth settings

The operations from the Data Capture/Subject Settings/Update mHealth settings category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings

Data Capture/Subject Settings/Update source data verification settings

The operations from the Data Capture/Subject Settings/Update source data verification settings category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings

Data Capture/Subject Settings/Update subject settings

The operations from the Data Capture/Subject Settings/Update subject settings category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subjects/Add a subject

The operations from the Data Capture/Subjects/Add a subject category.

[Deprecated]: V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects

Data Capture/Subjects/Check status of study randomization limit or restriction

The operations from the Data Capture/Subjects/Check status of study randomization limit or restriction category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randrestricted

Data Capture/Subjects/Check the study randomization limit

The operations from the Data Capture/Subjects/Check the study randomization limit category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randlimitexceeded

Data Capture/Subjects/Code view on a subject

The operations from the Data Capture/Subjects/Code view on a subject category.

[Deprecated]: V1: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview

Data Capture/Subjects/Create a subject transfer

The operations from the Data Capture/Subjects/Create a subject transfer category.

V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers

Data Capture/Subjects/Enroll a subject

The operations from the Data Capture/Subjects/Enroll a subject category.

V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/enroll

Data Capture/Subjects/Get Clinical Data which is part of ODMSubmit

The operations from the Data Capture/Subjects/Get Clinical Data which is part of ODMSubmit category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}

Data Capture/Subjects/Get Subject count

The operations from the Data Capture/Subjects/Get Subject count category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/count
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/count

Data Capture/Subjects/Get Visits MetaData which is part of ODMSubmit

The operations from the Data Capture/Subjects/Get Visits MetaData which is part of ODMSubmit category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}

Data Capture/Subjects/Get a list of subject numbers

The operations from the Data Capture/Subjects/Get a list of subject numbers category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/numberstatus

Data Capture/Subjects/Get a list of subject-related values

The operations from the Data Capture/Subjects/Get a list of subject-related values category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/lov/{pathAttr}

Data Capture/Subjects/Get a subject's events within a date range

The operations from the Data Capture/Subjects/Get a subject's events within a date range category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}

Data Capture/Subjects/Get all subject Numbers for a site

The operations from the Data Capture/Subjects/Get all subject Numbers for a site category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screeningnumber

Data Capture/Subjects/Get all subjects by study version

The operations from the Data Capture/Subjects/Get all subjects by study version category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/idsforsitestudyversion

Data Capture/Subjects/Get events within a date range

The operations from the Data Capture/Subjects/Get events within a date range category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange

Data Capture/Subjects/Get history of all subjects in a study mode

The operations from the Data Capture/Subjects/Get history of all subjects in a study mode category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/all

Data Capture/Subjects/Get information for a transfer ID

The operations from the Data Capture/Subjects/Get information for a transfer ID category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId}

Data Capture/Subjects/Get last added subject number

The operations from the Data Capture/Subjects/Get last added subject number category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/availableSubjectNumbers

Data Capture/Subjects/Get latest audit records for Source Data Verification

The operations from the Data Capture/Subjects/Get latest audit records for Source Data Verification category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visit/verify/history
V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sdvselected

Data Capture/Subjects/Get latest records for sign, verify and freeze

The operations from the Data Capture/Subjects/Get latest records for sign, verify and freeze category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/svf

Data Capture/Subjects/Get list of events by type

The operations from the Data Capture/Subjects/Get list of events by type category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/events

Data Capture/Subjects/Get list of subjects with specific demographic details

The operations from the Data Capture/Subjects/Get list of subjects with specific demographic details category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/{studyVersion}/demographicstatus

Data Capture/Subjects/Get list of visits status for a subject

The operations from the Data Capture/Subjects/Get list of visits status for a subject category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/visitstatus

Data Capture/Subjects/Get organization ID used to generate subject number

The operations from the Data Capture/Subjects/Get organization ID used to generate subject number category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/orgid

Data Capture/Subjects/Get screened and randomized subjects for resupply

The operations from the Data Capture/Subjects/Get screened and randomized subjects for resupply category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/forResupply

Data Capture/Subjects/Get source data verification selection status for all subjects

The operations from the Data Capture/Subjects/Get source data verification selection status for all subjects category.

V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/selectionStatus/{siteId}

Data Capture/Subjects/Get subject details

The operations from the Data Capture/Subjects/Get subject details category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}
V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/screenfaildates
V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{subjectId}
V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/{subjectId}
V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Capture/Subjects/Get subject history

The operations from the Data Capture/Subjects/Get subject history category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]: V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
V10.0: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
V9.0: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Capture/Subjects/Get subjects and their visit schedule

The operations from the Data Capture/Subjects/Get subjects and their visit schedule category.

[Deprecated]: V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/visitschedule
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/visitschedule
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/visitschedule
[Deprecated]: V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/visitschedule
[Deprecated]: V5.0: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/visitschedule
[Deprecated]: V6.0: Method: post
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/visitschedule
V10.0: Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/subjects/visitschedule
V8.0: Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/visitschedule
V9.0: Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/visitschedule

Data Capture/Subjects/Get subjects for the specified study and mode

The operations from the Data Capture/Subjects/Get subjects for the specified study and mode category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
[Deprecated]:V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
[Deprecated]:V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects
V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects
V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects

Data Capture/Subjects/Get the next visit action and rescreen eligibility for subject

The operations from the Data Capture/Subjects/Get the next visit action and rescreen eligibility for subject category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/nextVisitAction
V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/nextVisitAction

Data Capture/Subjects/Get transfer records for a study

The operations from the Data Capture/Subjects/Get transfer records for a study category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers

Data Capture/Subjects/Get transfer records for a subject

The operations from the Data Capture/Subjects/Get transfer records for a subject category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}

Data Capture/Subjects/Get transfer records for a subject and date range

The operations from the Data Capture/Subjects/Get transfer records for a subject and date range category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

Data Capture/Subjects/Get visit data by subject ID

The operations from the Data Capture/Subjects/Get visit data by subject ID category.

V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dispensedvisits/{subjectId}

Data Capture/Subjects/Get visit window information

The operations from the Data Capture/Subjects/Get visit window information category.

V10.0: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/subjects/{subjectId}/visitWindowInfo/{visitId}

Data Capture/Subjects/Get, search or filter list of subjects

The operations from the Data Capture/Subjects/Get, search or filter list of subjects category.

[Deprecated]: V1: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/sitestudyversion
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/sitestudyversion
V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/sitestudyversion
V9.0: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/sitestudyversion

Data Capture/Subjects/Link subject with patient MRN

The operations from the Data Capture/Subjects/Link subject with patient MRN category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/linkehr/{mrn}

Data Capture/Subjects/Migrate a subject

The operations from the Data Capture/Subjects/Migrate a subject category.

[Deprecated]: V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/migratesubject
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/migratesubject
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/migratesubject

Data Capture/Subjects/Perform code break on a subject

The operations from the Data Capture/Subjects/Perform code break on a subject category.

[Deprecated]: V1: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
[Deprecated]: V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
V4.0: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak

Data Capture/Subjects/Perform replace randomization on a subject

The operations from the Data Capture/Subjects/Perform replace randomization on a subject category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/replaceSubject

Data Capture/Subjects/Randomize or dispense subject

The operations from the Data Capture/Subjects/Randomize or dispense subject category.

[Deprecated]: V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randomizeordispense
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/randomizeordispense
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/randomizeordispense
[Deprecated]: V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/randomizeordispense
V5.0: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/randomizeordispense
V6.0: Method: post
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/randomizeordispense

Data Capture/Subjects/Register subject to mHealth

The operations from the Data Capture/Subjects/Register subject to mHealth category.

V1: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/mhealthRegister

Data Capture/Subjects/Revert to the latest subject state

The operations from the Data Capture/Subjects/Revert to the latest subject state category.

V1: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/state/{subjectId}
V2.0: Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/state/{subjectId}

Data Capture/Subjects/Save the data and screen the subject to assign subject number

The operations from the Data Capture/Subjects/Save the data and screen the subject to assign subject number category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screen

Data Capture/Subjects/Sign subject and visits

The operations from the Data Capture/Subjects/Sign subject and visits category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}

Data Capture/Subjects/Undo the Add subject action in a study

The operations from the Data Capture/Subjects/Undo the Add subject action in a study category.

V1.0: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/undoSubject

Data Capture/Subjects/Unfreeze single data element of a visit

The operations from the Data Capture/Subjects/Unfreeze single data element of a visit category.

[Deprecated]: V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Data Capture/Subjects/Unlink subject from patient MRN

The operations from the Data Capture/Subjects/Unlink subject from patient MRN category.

V1.0: Method: delete
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/linkehr

Data Capture/Subjects/Update subject

The operations from the Data Capture/Subjects/Update subject category.

[Deprecated]: V1: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: V4.0: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}
V5.0: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{subjectId}
V6.0: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Capture/Subjects/Update subject number

The operations from the Data Capture/Subjects/Update subject number category.

V1: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber

Data Capture/Subjects/Updates subject numbers in bulk

The operations from the Data Capture/Subjects/Updates subject numbers in bulk category.

V1: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/subjectnumber

Data Capture/Visit Status/Freeze visit data with dataelements and Visit start date

The operations from the Data Capture/Visit Status/Freeze visit data with dataelements and Visit start date category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/freeze

Data Capture/Visits Status/Create visit status record

The operations from the Data Capture/Visits Status/Create visit status record category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
V5.0: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus

Data Capture/Visits Status/Get adverse event visits for a list of subjects

The operations from the Data Capture/Visits Status/Get adverse event visits for a list of subjects category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects/aeCount

Data Capture/Visits Status/Get associated and dynamic forms for a subject visit

The operations from the Data Capture/Visits Status/Get associated and dynamic forms for a subject visit category.

V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/forms/studyVersion/{studyVersion}/subject/{subjectId}/event/{eventId}

Data Capture/Visits Status/Get audit history records for the given visit status ID

The operations from the Data Capture/Visits Status/Get audit history records for the given visit status ID category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
V8.0: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}

Data Capture/Visits Status/Get list of visit statuses for given entries

The operations from the Data Capture/Visits Status/Get list of visit statuses for given entries category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/multiple
V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/multiple

Data Capture/Visits Status/Get list of visits status

The operations from the Data Capture/Visits Status/Get list of visits status category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V3.0: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V5.0: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V6.0: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V7.0: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: V9.0: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus
V10.0: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus
V11.0: Method: get
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/visitstatus
V12.0: Method: get
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/visitstatus

Data Capture/Visits Status/Get list of visits status for a date range

The operations from the Data Capture/Visits Status/Get list of visits status for a date range category.

[Deprecated]: V1.0: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
[Deprecated]: V2.0: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange
[Deprecated]: V4.0: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}

Data Capture/Visits Status/Get list of visits status for a list of subjects

The operations from the Data Capture/Visits Status/Get list of visits status for a list of subjects category.

[Deprecated]: V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V2.0: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V3.0: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/Get list of visits status for subjects

The operations from the Data Capture/Visits Status/Get list of visits status for subjects category.

[Deprecated]: V10.0: Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V11.0: Method: post
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V12.0: Method: post
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V13.0: Method: post
Path: /ec-dc-svc/rest/v13.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V4.0: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V5.0: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V8.0: Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]: V9.0: Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]:V14.0: Method: post
Path: /ec-dc-svc/rest/v14.0/studies/{studyId}/{mode}/visitstatus/subjects
[Deprecated]:V15.0: Method: post
Path: /ec-dc-svc/rest/v15.0/studies/{studyId}/{mode}/visitstatus/subjects
V16.0: Method: post
Path: /ec-dc-svc/rest/v16.0/studies/{studyId}/{mode}/visitstatus/subjects
V17.0: Method: post
Path: /ec-dc-svc/rest/v17.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/Get list of visits' start dates for subjects

The operations from the Data Capture/Visits Status/Get list of visits' start dates for subjects category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visits/subjectvisitsinfo

Data Capture/Visits Status/Post migrated visit data

The operations from the Data Capture/Visits Status/Post migrated visit data category.

V1.0: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/migratevisit

Data Capture/Visits Status/Update and remove the visit status rule error

The operations from the Data Capture/Visits Status/Update and remove the visit status rule error category.

V5.0: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}
V6.0: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}

Data Capture/Visits Status/Update visit status for a given ID

The operations from the Data Capture/Visits Status/Update visit status for a given ID category.

[Deprecated]: V1.0: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V2.0: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V3.0: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V4.0: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V5.0: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V6.0: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V7.0: Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
[Deprecated]: V8.0: Method: put
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
V10.0: Method: put
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
V11.0: Method: put
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
V9.0: Method: put
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}

Data Hub/Datasets/Get Blinded kits for study

The operations from the Data Hub/Datasets/Get Blinded kits for study category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits

Data Hub/Datasets/Get Datahub Metrics Details

The operations from the Data Hub/Datasets/Get Datahub Metrics Details category.

V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/metrics

Data Hub/Datasets/Get Study Design dataset

The operations from the Data Hub/Datasets/Get Study Design dataset category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/dataCollection
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/dataCollection
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/dataCollection
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/dataCollection
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/dataCollection
V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/dataCollection
V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/dataCollection
V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/dataCollection
V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/dataCollection

Data Hub/Datasets/Get Unblided kits for study

The operations from the Data Hub/Datasets/Get Unblided kits for study category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
[Deprecated]: V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits

Data Hub/Datasets/Get blinded visit details

The operations from the Data Hub/Datasets/Get blinded visit details category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
[Deprecated]: V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
V10.0: Method: post
Path: /ec-datahub-svc/rest/v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
V11.0: Method: post
Path: /ec-datahub-svc/rest/v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits

Data Hub/Datasets/Get codelists for a study and a given mode

The operations from the Data Hub/Datasets/Get codelists for a study and a given mode category.

V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/codelists

Data Hub/Datasets/Get codelists for study

The operations from the Data Hub/Datasets/Get codelists for study category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/codelists
V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/codelists
V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/codelists

Data Hub/Datasets/Get codelists for tenant

The operations from the Data Hub/Datasets/Get codelists for tenant category.

V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/codelists

Data Hub/Datasets/Get kits and randomization design data for study

The operations from the Data Hub/Datasets/Get kits and randomization design data for study category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations

Data Hub/Datasets/Get queries raised for study

The operations from the Data Hub/Datasets/Get queries raised for study category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries

Data Hub/Datasets/Get subject data details

The operations from the Data Hub/Datasets/Get subject data details category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V3.1: Method: post
Path: /ec-datahub-svc/rest/v3.1/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects

Data Hub/Datasets/Get subject form items data details

The operations from the Data Hub/Datasets/Get subject form items data details category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V10.0: Method: post
Path: /ec-datahub-svc/rest/v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V11.0: Method: post
Path: /ec-datahub-svc/rest/v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
[Deprecated]: V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
V12.0: Method: post
Path: /ec-datahub-svc/rest/v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
V13.0: Method: post
Path: /ec-datahub-svc/rest/v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems

Data Hub/Datasets/Get subject form level actions details

The operations from the Data Hub/Datasets/Get subject form level actions details category.

V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms/actions

Data Hub/Datasets/Get subject forms data details

The operations from the Data Hub/Datasets/Get subject forms data details category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V10.0: Method: post
Path: /ec-datahub-svc/rest/v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V11.0: Method: post
Path: /ec-datahub-svc/rest/v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V12.0: Method: post
Path: /ec-datahub-svc/rest/v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
[Deprecated]: V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
V13.0: Method: post
Path: /ec-datahub-svc/rest/v13.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
V14.0: Method: post
Path: /ec-datahub-svc/rest/v14.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms

Data Hub/Datasets/Get subject item level actions details

The operations from the Data Hub/Datasets/Get subject item level actions details category.

V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/items/actions

Data Hub/Datasets/Get subject visit and visit date actions details

The operations from the Data Hub/Datasets/Get subject visit and visit date actions details category.

V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/visits/actions

Data Hub/Datasets/Get unblinded subject data details

The operations from the Data Hub/Datasets/Get unblinded subject data details category.

[Deprecated]: V1.0: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V10.0: Method: post
Path: /ec-datahub-svc/rest/v10.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V2.0: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V3.0: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V4.0: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V5.0: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V6.0: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V7.0: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V8.0: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
[Deprecated]: V9.0: Method: post
Path: /ec-datahub-svc/rest/v9.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
V11.0: Method: post
Path: /ec-datahub-svc/rest/v11.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
V12.0: Method: post
Path: /ec-datahub-svc/rest/v12.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Hub/Get Datahub latest sync timestamp

The operations from the Data Hub/Get Datahub latest sync timestamp category.

V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/{mode}/dhSynchupTime

Data Hub/ODM/ODM extract for admin data

The operations from the Data Hub/ODM/ODM extract for admin data category.

V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/admin

Data Hub/ODM/ODM extract for clinical data with hidden data

The operations from the Data Hub/ODM/ODM extract for clinical data with hidden data category.

[Deprecated]: V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V2.0: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V3.0: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V4.0: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V5.0: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V6.0: Method: get
Path: /ec-datahub-svc/rest/v6.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V7.0: Method: get
Path: /ec-datahub-svc/rest/v7.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V8.0: Method: get
Path: /ec-datahub-svc/rest/v8.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
[Deprecated]: V9.0: Method: get
Path: /ec-datahub-svc/rest/v9.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
V10.0: Method: get
Path: /ec-datahub-svc/rest/v10.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
V11.0: Method: get
Path: /ec-datahub-svc/rest/v11.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded

Data Hub/ODM/ODM extract for clinical data without hidden data

The operations from the Data Hub/ODM/ODM extract for clinical data without hidden data category.

[Deprecated]: V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V2.0: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V3.0: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V4.0: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V5.0: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V6.0: Method: get
Path: /ec-datahub-svc/rest/v6.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V7.0: Method: get
Path: /ec-datahub-svc/rest/v7.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V8.0: Method: get
Path: /ec-datahub-svc/rest/v8.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
[Deprecated]: V9.0: Method: get
Path: /ec-datahub-svc/rest/v9.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
V10.0: Method: get
Path: /ec-datahub-svc/rest/v10.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
V11.0: Method: get
Path: /ec-datahub-svc/rest/v11.0/studies/{studyId}/{mode}/odm/clinicalData/blinded

Data Hub/ODM/ODM extract for meta data

The operations from the Data Hub/ODM/ODM extract for meta data category.

[Deprecated]: V1.0: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V2.0: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V3.0: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V4.0: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V5.0: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V6.0: Method: get
Path: /ec-datahub-svc/rest/v6.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V7.0: Method: get
Path: /ec-datahub-svc/rest/v7.0/studies/{studyId}/{mode}/odm/metadata
[Deprecated]: V8.0: Method: get
Path: /ec-datahub-svc/rest/v8.0/studies/{studyId}/{mode}/odm/metadata
V10.0: Method: get
Path: /ec-datahub-svc/rest/v10.0/studies/{studyId}/{mode}/odm/metadata
V9.0: Method: get
Path: /ec-datahub-svc/rest/v9.0/studies/{studyId}/{mode}/odm/metadata

Data Integration/Coding Status/Get data elements to be coded by code type

The operations from the Data Integration/Coding Status/Get data elements to be coded by code type category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Data Integration/DCProperties APIs/Get Data Capture properties history

The operations from the Data Integration/DCProperties APIs/Get Data Capture properties history category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/properties/history

Data Integration/Data Elements/Get data element records for subject inserted or updated after visit completion for a given date range

The operations from the Data Integration/Data Elements/Get data element records for subject inserted or updated after visit completion for a given date range category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}

Data Integration/Data Elements/Get data elements by form ID, Subject ID, Event ID and Vendor code

The operations from the Data Integration/Data Elements/Get data elements by form ID, Subject ID, Event ID and Vendor code category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/vendorCode/{vendorCode}/dataelements/withvendorcode

Data Integration/Data Elements/Get data elements for a list of items by subject ID

The operations from the Data Integration/Data Elements/Get data elements for a list of items by subject ID category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items

Data Integration/Data Elements/Get data elements for a visit and form combination

The operations from the Data Integration/Data Elements/Get data elements for a visit and form combination category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements

Data Integration/Data Elements/Get data elements for one or multiple subjects and their visits

The operations from the Data Integration/Data Elements/Get data elements for one or multiple subjects and their visits category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements
v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements

Data Integration/Data Elements/Get data elements history with pagination

The operations from the Data Integration/Data Elements/Get data elements history with pagination category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/all
v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/all

Data Integration/Data Elements/Get data elements that have been deleted

The operations from the Data Integration/Data Elements/Get data elements that have been deleted category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements

Data Integration/Data Elements/Get document details for a subject

The operations from the Data Integration/Data Elements/Get document details for a subject category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataElements/subjects/{subjectId}/documentDetails

Data Integration/Data Elements/Get form associations by study ID

The operations from the Data Integration/Data Elements/Get form associations by study ID category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/formassociations

Data Integration/Data Elements/Get form statuses for list of event or form IDs

The operations from the Data Integration/Data Elements/Get form statuses for list of event or form IDs category.

v1.0: Method: put
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/formStatus
v2.0: Method: put
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/formStatus

Data Integration/Data Elements/Get records for Source Data Verification group

The operations from the Data Integration/Data Elements/Get records for Source Data Verification group category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup

Data Integration/Data Elements/Get the audit history for a data element with sign verify history

The operations from the Data Integration/Data Elements/Get the audit history for a data element with sign verify history category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}

Data Integration/Signature Configuration/Get sign configuration history

The operations from the Data Integration/Signature Configuration/Get sign configuration history category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/history

Data Integration/Signature Eligibility/Get eligibility data

The operations from the Data Integration/Signature Eligibility/Get eligibility data category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/signeligibility/history

Data Integration/Subject Reports/Generate a report based on the path parameter

The operations from the Data Integration/Subject Reports/Generate a report based on the path parameter category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Data Integration/Subject Reports/Generate report for a subject's data and events (Asynchronous)

The operations from the Data Integration/Subject Reports/Generate report for a subject's data and events (Asynchronous) category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/asynch/report/{reportName}

Data Integration/Subject Transfer/Get all the transfer records for a subject ID

The operations from the Data Integration/Subject Transfer/Get all the transfer records for a subject ID category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}

Data Integration/Subject Transfer/Get information for a transfer ID

The operations from the Data Integration/Subject Transfer/Get information for a transfer ID category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/{transferId}

Data Integration/Subject Transfer/Get transfer records for a study

The operations from the Data Integration/Subject Transfer/Get transfer records for a study category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers

Data Integration/Subject Transfer/Get transfer records for a subject and date range

The operations from the Data Integration/Subject Transfer/Get transfer records for a subject and date range category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

Data Integration/Subjects Lock Status/Add subject lock status for given subject list

The operations from the Data Integration/Subjects Lock Status/Add subject lock status for given subject list category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lock/subjects

Data Integration/Subjects Lock Status/Get subject lock status for given subject list

The operations from the Data Integration/Subjects Lock Status/Get subject lock status for given subject list category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lock/subjects

Data Integration/Subjects/Get Clinical Data which is part of ODMSubmit

The operations from the Data Integration/Subjects/Get Clinical Data which is part of ODMSubmit category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}

Data Integration/Subjects/Get Latest lock records for all subjects in a study

The operations from the Data Integration/Subjects/Get Latest lock records for all subjects in a study category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lockedstatus

Data Integration/Subjects/Get a list of subject-related values

The operations from the Data Integration/Subjects/Get a list of subject-related values category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/lov/{pathAttr}

Data Integration/Subjects/Get a subject's events within a date range

The operations from the Data Integration/Subjects/Get a subject's events within a date range category.

[Deprecated]:v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
[Deprecated]:v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
v3.0: Method: get
Path: /ec-dataintegration-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
v4.0: Method: get
Path: /ec-dataintegration-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}

Data Integration/Subjects/Get details for a subject

The operations from the Data Integration/Subjects/Get details for a subject category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}
v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Integration/Subjects/Get history of all subjects in a mode

The operations from the Data Integration/Subjects/Get history of all subjects in a mode category.

[Deprecated]:v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]:v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/all
v3.0: Method: get
Path: /ec-dataintegration-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/all
v4.0: Method: get
Path: /ec-dataintegration-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/all

Data Integration/Subjects/Get latest records for sign, verify and freeze

The operations from the Data Integration/Subjects/Get latest records for sign, verify and freeze category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/svf

Data Integration/Subjects/Get list of events by type

The operations from the Data Integration/Subjects/Get list of events by type category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/events

Data Integration/Subjects/Get list of subjects for the specified study and mode

The operations from the Data Integration/Subjects/Get list of subjects for the specified study and mode category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects

Data Integration/Subjects/Get records for Source Data Verification with site information

The operations from the Data Integration/Subjects/Get records for Source Data Verification with site information category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history

Data Integration/Subjects/Get screened and randomized subjects for resupply grouped by site

The operations from the Data Integration/Subjects/Get screened and randomized subjects for resupply grouped by site category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/forResupply

Data Integration/Subjects/Get subject history

The operations from the Data Integration/Subjects/Get subject history category.

[Deprecated]:v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]:v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
[Deprecated]:v3.0: Method: get
Path: /ec-dataintegration-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
v4.0: Method: get
Path: /ec-dataintegration-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
v5.0: Method: get
Path: /ec-dataintegration-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Integration/Subjects/Get subjects and their visit schedule

The operations from the Data Integration/Subjects/Get subjects and their visit schedule category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/visitschedule

Data Integration/Subjects/Get subjects for the specified study and mode

The operations from the Data Integration/Subjects/Get subjects for the specified study and mode category.

v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects

Data Integration/Subjects/Get visits MetaData which is part of ODMSubmit

The operations from the Data Integration/Subjects/Get visits MetaData which is part of ODMSubmit category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}

Data Integration/Subjects/Get, search or filter list of subjects

The operations from the Data Integration/Subjects/Get, search or filter list of subjects category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/sitestudyversion

Data Integration/Visits Status History/Get list of visits status history

The operations from the Data Integration/Visits Status History/Get list of visits status history category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/history

Data Integration/Visits Status/Get audit history records for the given visit status ID

The operations from the Data Integration/Visits Status/Get audit history records for the given visit status ID category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}

Data Integration/Visits Status/Get list of visits status

The operations from the Data Integration/Visits Status/Get list of visits status category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus

Data Integration/Visits Status/Get list of visits status for a date range

The operations from the Data Integration/Visits Status/Get list of visits status for a date range category.

v1.0: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
v2.0: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}

Data Integration/Visits Status/Get list of visits status for subjects

The operations from the Data Integration/Visits Status/Get list of visits status for subjects category.

v1.0: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/subjects
v2.0: Method: post
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/subjects

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
Copy a branch: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/branches/{branchid}/copyBranch
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/Form APIs/Form Item - [Deprecated]/v1.0

The operations from the Designer/Form APIs/Form Item - [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/Form APIs/Form Item - [Deprecated]/v2.0

The operations from the Designer/Form APIs/Form Item - [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]: Delete a question from a form: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[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}

Designer/Form APIs/Form Item - [Deprecated]/v3.0

The operations from the Designer/Form APIs/Form Item - [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/Form APIs/Form Item - [Deprecated]/v4.0

The operations from the Designer/Form APIs/Form Item - [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/Form APIs/Form Item - [Deprecated]/v5.0

The operations from the Designer/Form APIs/Form Item - [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/Form APIs/Form Item History/v1.0

The operations from the Designer/Form APIs/Form Item History/v1.0 category.

Get questions history for a form: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/itemhistory

Designer/Form APIs/Form Item History/v2.0

The operations from the Designer/Form APIs/Form Item History/v2.0 category.

Get questions history for a form: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/itemhistory

Designer/Form APIs/Form Preview/v1.0

The operations from the Designer/Form APIs/Form Preview/v1.0 category.

Send a notification to preview a form: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/previewFormNotification

Designer/Form APIs/Form-Visit Association/v1.0

The operations from the Designer/Form APIs/Form-Visit Association/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
Get a list of study form visits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/visits

Designer/Form APIs/Form-Visit Association/v10.0

The operations from the Designer/Form APIs/Form-Visit Association/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/Form APIs/Form-Visit Association/v5.0

The operations from the Designer/Form APIs/Form-Visit Association/v5.0 category.

[Deprecated]: Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
[Deprecated]: 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/Form APIs/Form-Visit Association/v6.0

The operations from the Designer/Form APIs/Form-Visit Association/v6.0 category.

[Deprecated]: Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
[Deprecated]: 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/Form APIs/Form-Visit Association/v7.0

The operations from the Designer/Form APIs/Form-Visit Association/v7.0 category.

[Deprecated]: Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
[Deprecated]: 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/Form APIs/Form-Visit Association/v8.0

The operations from the Designer/Form APIs/Form-Visit Association/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/Form APIs/Form-Visit Association/v9.0

The operations from the Designer/Form APIs/Form-Visit Association/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/Form APIs/Forms/v1.0

The operations from the Designer/Form APIs/Forms/v1.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Bulk assign forms to visits: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/visits
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}
Copy forms in bulk: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/copyForms
Get a list of study forms: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/{mode}/forms
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 associated forms: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/associateForms

Designer/Form APIs/Forms/v10.0

The operations from the Designer/Form APIs/Forms/v10.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Designer/Form APIs/Forms/v11.0

The operations from the Designer/Form APIs/Forms/v11.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific unblinded form: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get unblinded forms: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/unblinded
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Designer/Form APIs/Forms/v12.0

The operations from the Designer/Form APIs/Forms/v12.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific unblinded form: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get unblinded forms: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/unblinded
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Designer/Form APIs/Forms/v13.0

The operations from the Designer/Form APIs/Forms/v13.0 category.

Get list questions used in stratified randomization: Method: get
Path: /ec-designer-ors-svc/rest/v13.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Designer/Form APIs/Forms/v14.0

The operations from the Designer/Form APIs/Forms/v14.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific unblinded form: Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get unblinded forms: Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/unblinded
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v15.0

The operations from the Designer/Form APIs/Forms/v15.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific unblinded form: Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get unblinded forms: Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/unblinded
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v16.0

The operations from the Designer/Form APIs/Forms/v16.0 category.

[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v16.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v17.0

The operations from the Designer/Form APIs/Forms/v17.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific unblinded form: Method: get
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get unblinded forms: Method: get
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms/unblinded
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v18.0

The operations from the Designer/Form APIs/Forms/v18.0 category.

Add form in a study version: Method: post
Path: /ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms
Delete a specific form: Method: delete
Path: /ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form: Method: get
Path: /ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get unblinded forms: Method: get
Path: /ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form: Method: put
Path: /ec-designer-edc-svc/rest/v18.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v19.0

The operations from the Designer/Form APIs/Forms/v19.0 category.

Add form in a study version: Method: post
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms
Delete a specific form: Method: delete
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form: Method: get
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form: Method: get
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study: Method: get
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms
Get unblinded forms: Method: get
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form: Method: put
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v2.0

The operations from the Designer/Form APIs/Forms/v2.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Bulk assign forms to visits: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/visits
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}
Copy forms in bulk: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/copyForms
Get a list of study forms: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/{mode}/forms
Get forms and questions used in dosing calculations: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/numericItems

Designer/Form APIs/Forms/v20.0

The operations from the Designer/Form APIs/Forms/v20.0 category.

Add form in a study version: Method: post
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms
Delete a specific form: Method: delete
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific form: Method: get
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a specific unblinded form: Method: get
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms/unblinded/{formId}
Get list of forms in a study: Method: get
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms
Get unblinded forms: Method: get
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms/unblinded
Update a specific form: Method: put
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v3.0

The operations from the Designer/Form APIs/Forms/v3.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Bulk assign forms to visits: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/visits
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}
Get a list of study forms: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/{mode}/forms

Designer/Form APIs/Forms/v4.0

The operations from the Designer/Form APIs/Forms/v4.0 category.

[Deprecated]: Bulk assign forms to visits: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/visits
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/randomizationfactors
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}
Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms

Designer/Form APIs/Forms/v5.0

The operations from the Designer/Form APIs/Forms/v5.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v6.0

The operations from the Designer/Form APIs/Forms/v6.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v7.0

The operations from the Designer/Form APIs/Forms/v7.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v8.0

The operations from the Designer/Form APIs/Forms/v8.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}

Designer/Form APIs/Forms/v9.0

The operations from the Designer/Form APIs/Forms/v9.0 category.

[Deprecated]: Add form in a study version: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Delete a specific form: Method: delete
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get a specific form: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms
[Deprecated]: Update a specific form: Method: put
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}
Get list questions used in stratified randomization: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/randomizationfactors

Designer/Forms APIs/v1.0

The operations from the Designer/Forms APIs/v1.0 category.

Get all EHR Data mappings for a study: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/ehrmapping/all
Get all or specified form items in a study: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/formSummaryInfo
Get EHR Data mappings: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/ehrmapping
Get form item actions assigned to a visit in a study version: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/actionitems
Get form items identified as lab normals in a study: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/forms/labNormalItems
Get forms summary: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/versions/{version}/formssummary
Get forms with item IDs and types for a given study mode: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/formitems
Get list of latest forms by mode in a study: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/latest
Get the E2B R3 Data mappings: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/e2bmapping/all
Get visit summary with form and item IDs: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/formitems
Get visits forms items ehr mappings: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/ehrmapping

Designer/Forms APIs/v2.0

The operations from the Designer/Forms APIs/v2.0 category.

Get forms with item IDs and types for a given study mode: Method: get
Path: /ec-designer-edc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/formitems
Get list of latest forms by mode in a study: Method: get
Path: /ec-designer-edc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/latest

Designer/Kits APIs/v1.0

The operations from the Designer/Kits APIs/v1.0 category.

[Deprecated]: Add a kit in a study: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Delete a kit: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get kits from all study versions in Testing, Approved and Archived: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/kits
[Deprecated]: Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Get the dispensation data of a kit: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
[Deprecated]: Update a kit: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/kits/{kitId}
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

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]: Delete a kit: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get kits from all study versions in Testing, Approved and Archived: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/kits
[Deprecated]: Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Get the dispensation data of a kit: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
[Deprecated]: Update a kit: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/kits/{kitId}

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 blinded data on a kit: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
[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]: Get the dispensation data of a kit: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
[Deprecated]: Update a kit: Method: put
Path: /ec-designer-svc/rest/v3.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/v3.0/studies/{studyId}/kits

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 blinded data on a kit: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
[Deprecated]: Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}
[Deprecated]: Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits
[Deprecated]: Get the dispensation data of a kit: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}/dispensings
[Deprecated]: Update a kit: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/kits/{kitId}

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 kits from all study versions in Testing, Approved and Archived: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/kits
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 blinded data on a kit: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get kits from all study versions in Testing, Approved and Archived: Method: get
Path: /ec-designer-ors-svc/rest/v6.0/studies/{studyId}/kits
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/Kits APIs/v7.0

The operations from the Designer/Kits APIs/v7.0 category.

Add a kit in a study: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits
Delete a kit: Method: delete
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get blinded data on a kit: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits/{kitId}/blindedInfo
Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get kits from all study versions in Testing, Approved and Archived: Method: get
Path: /ec-designer-ors-svc/rest/v7.0/studies/{studyId}/kits
Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits
Update a kit: Method: put
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits/{kitId}

Designer/Kits APIs/v8.0

The operations from the Designer/Kits APIs/v8.0 category.

Add a kit in a study: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/kits
Delete a kit: Method: delete
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/kits

Designer/Kits APIs/v9.0

The operations from the Designer/Kits APIs/v9.0 category.

Add a kit in a study: Method: post
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits
Add a kit in a study: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits
Delete a kit: Method: delete
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits/{kitId}
Delete a kit: Method: delete
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit: Method: get
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get data on a kit: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits/{kitId}
Get list of all kits: Method: get
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits
Get list of all kits: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits
Update a kit: Method: put
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/kits/{kitId}
Update a kit: Method: put
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits/{kitId}

Designer/Lock Object APIs/v1.0

The operations from the Designer/Lock Object APIs/v1.0 category.

Create list of locked objects: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lockObjectDetails

Designer/Lock Object APIs/v2.0

The operations from the Designer/Lock Object APIs/v2.0 category.

Get locked objects: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/lockObjectDetails

Designer/Lock Object APIs/v3.0

The operations from the Designer/Lock Object APIs/v3.0 category.

Get locked objects: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/lockObjectDetails

Designer/Lock Object APIs/v4.0

The operations from the Designer/Lock Object APIs/v4.0 category.

Get locked objects: Method: post
Path: /ec-designer-edc-svc/rest/v4.0/studies/{studyId}/lockObjectDetails

Designer/Lock Object APIs/v5.0

The operations from the Designer/Lock Object APIs/v5.0 category.

Get locked objects: Method: post
Path: /ec-designer-edc-svc/rest/v5.0/studies/{studyId}/lockObjectDetails

Designer/Randomization APIs/Randomization Cohorts/v1.0

The operations from the Designer/Randomization APIs/Randomization Cohorts/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 APIs/Randomization Cohorts/v2.0

The operations from the Designer/Randomization APIs/Randomization Cohorts/v2.0 category.

Get a list of all cohort groups in a randomization: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts

Designer/Randomization APIs/Randomization Ratios/v1.0

The operations from the Designer/Randomization APIs/Randomization Ratios/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]: Get 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
[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 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 treatment arms: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms
Get treatment arm ratios for cohort or stratum groups: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
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 APIs/Randomization Ratios/v2.0

The operations from the Designer/Randomization APIs/Randomization Ratios/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 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 arms: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/arms
Get 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}
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 APIs/Randomization Ratios/v3.0

The operations from the Designer/Randomization APIs/Randomization Ratios/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 all treatment arm ratios for cohort or stratum groups by randomization ID: 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/Randomization APIs/Randomization/v1.0

The operations from the Designer/Randomization APIs/Randomization/v1.0 category.

[Deprecated]: Create randomization design: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Delete randomization design: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get a randomization design: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get list of randomization designs in a study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Update existing randomization design: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}

Designer/Randomization APIs/Randomization/v2.0

The operations from the Designer/Randomization APIs/Randomization/v2.0 category.

[Deprecated]: Create randomization design: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Delete randomization design: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get a randomization design: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get list of randomization designs in a study version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Update existing randomization design: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}

Designer/Randomization APIs/Randomization/v3.0

The operations from the Designer/Randomization APIs/Randomization/v3.0 category.

[Deprecated]: Create randomization design: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Delete randomization design: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get a randomization design: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}
[Deprecated]: Get list of randomization designs in a study version: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations
[Deprecated]: Update existing randomization design: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}

Designer/Randomization APIs/Randomization/v4.0

The operations from the Designer/Randomization APIs/Randomization/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/Randomization/v5.0

The operations from the Designer/Randomization APIs/Randomization/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 APIs/Randomization/v6.0

The operations from the Designer/Randomization APIs/Randomization/v6.0 category.

Create randomization design: Method: post
Path: /ec-designer-ors-svc/rest/v6.0/studies/{studyId}/versions/{version}/randomizations
Update existing randomization design: Method: put
Path: /ec-designer-ors-svc/rest/v6.0/studies/{studyId}/versions/{version}/randomizations/{randomId}

Designer/Randomization APIs/Study Strata/v1.0

The operations from the Designer/Randomization APIs/Study Strata/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 all active strata in a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/strata
Get list of all strata groups: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Get stratum items in a study for given randomized visits and study version: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/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/Randomization APIs/Study Strata/v2.0

The operations from the Designer/Randomization APIs/Study Strata/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/Randomization APIs/Study Strata/v3.0

The operations from the Designer/Randomization APIs/Study Strata/v3.0 category.

Create list of cohort groups: Method: post
Path: /ec-designer-ors-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get list of all strata groups: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Update randomization cohort groups: Method: put
Path: /ec-designer-ors-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk

Designer/Randomization APIs/Study Strata/v4.0

The operations from the Designer/Randomization APIs/Study Strata/v4.0 category.

Delete cohort groups: Method: delete
Path: /ec-designer-ors-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get a stratum group: Method: get
Path: /ec-designer-ors-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Get list of all strata groups: Method: get
Path: /ec-designer-ors-svc/rest/v4.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata

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/Study APIs/Study Actions/v1.0

The operations from the Designer/Study APIs/Study Actions/v1.0 category.

[Deprecated]: Add study: Method: post
Path: /ec-designer-svc/rest/v1.0/studies
[Deprecated]: Check visit in study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visits/{visitId}/validate
[Deprecated]: Get a list of all studies: Method: get
Path: /ec-designer-svc/rest/v1.0/studies
[Deprecated]: Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses
[Deprecated]: Get all statuses summary of a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statusessummary
[Deprecated]: Get coding questions in all forms: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms
[Deprecated]: Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/statuses/{version}
[Deprecated]: Update existing study: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}
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
Clone system codelist: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/cloneSystemCodelist
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studyDesign
Get a study's status: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state
Get all form items in a form: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/formitems
Get all form items in a form by form ID: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/formitems
Get all forms: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/allForms
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 by study mode and form ID(s).: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/forms/{formId}/choiceoptions
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 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
Update a study's state: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/state/{statedata}
Update study rule copy status: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/studycopystatus

Designer/Study APIs/Study Actions/v10.0

The operations from the Designer/Study APIs/Study Actions/v10.0 category.

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/studyDesign

Designer/Study APIs/Study Actions/v2.0

The operations from the Designer/Study APIs/Study Actions/v2.0 category.

[Deprecated]: Check visit in study version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visits/{visitId}/validate
[Deprecated]: Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses
[Deprecated]: Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statuses/{version}
Add study: Method: post
Path: /ec-designer-svc/rest/v2.0/studies
Copy study design objects: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{targetId}/copystudyobjects
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/studyDesign
Create study copy template: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{sourceStudyId}/copy
Create study copy template: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{targetStudyId}/retryCopyStudy
Get a list of all studies: Method: get
Path: /ec-designer-svc/rest/v2.0/studies
Get all coding questions forms: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms/coding
Get all form items in a form: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/formitems
Get all form items in a form by form ID: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/formitems
Get all forms: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/allForms
Get all statuses summary of a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/statusessummary
Get IDs of all artifacts in a study in a specific mode: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/objectids
Get IDs of all artifacts in an approved study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/approved/objectids
Get options of all choice items by study mode and form ID(s).: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/forms/{formId}/choiceoptions
Get options of all choice items in the latest approved version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/approved/choiceoptions
Get summary of library studies usage: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/library/{libraryId}/studyType/{studyType}/studyUses
Update existing study: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}
Update study copy status: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/updateCopyStudyStatus

Designer/Study APIs/Study Actions/v3.0

The operations from the Designer/Study APIs/Study Actions/v3.0 category.

[Deprecated]: Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/statuses
[Deprecated]: Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/statuses/{version}
Add study: Method: post
Path: /ec-designer-svc/rest/v3.0/studies
Check visit in study version: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/visits/{visitId}/validate
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/studyDesign
Create study copy template: Method: post
Path: /ec-designer-study-svc/rest/v3.0/studies/{sourceStudyId}/copy
Get a list of all library studies: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/library
Get a list of all studies: Method: get
Path: /ec-designer-svc/rest/v3.0/studies
Get all coding questions forms: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/allForms/coding
Get all form items in a form by form ID: Method: get
Path: /ec-designer-edc-svc/rest/v3.0/studies/{studyId}/forms/{formId}/formitems
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}/statusessummary
Get options of all choice items in the latest approved version: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/approved/choiceoptions
Update existing study: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}

Designer/Study APIs/Study Actions/v4.0

The operations from the Designer/Study APIs/Study Actions/v4.0 category.

[Deprecated]: Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/studyDesign
Add study: Method: post
Path: /ec-designer-svc/rest/v4.0/studies
Check visit in study version: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/visits/{visitId}/validate
Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/studyDesign
Get all coding questions forms: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/allForms/coding
Get all forms: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/allForms
Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/statuses
Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/statusessummary
Get latest statuses of a study: Method: get
Path: /ec-designer-study-svc/rest/v4.0/studies/{studyId}/statuses/latest
Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/statuses/{version}

Designer/Study APIs/Study Actions/v5.0

The operations from the Designer/Study APIs/Study Actions/v5.0 category.

[Deprecated]: Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/studyDesign
Get all forms: Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/allForms
Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/statuses
Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/statuses/{version}
Update existing study: Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}

Designer/Study APIs/Study Actions/v6.0

The operations from the Designer/Study APIs/Study Actions/v6.0 category.

Get all forms: Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/allForms
Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/studyDesign

Designer/Study APIs/Study Actions/v7.0

The operations from the Designer/Study APIs/Study Actions/v7.0 category.

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign
Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/statuses
Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign
Get all visits, forms and questionnaires in a paginated format: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign/paginated
Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/statuses/{version}

Designer/Study APIs/Study Actions/v8.0

The operations from the Designer/Study APIs/Study Actions/v8.0 category.

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign
Get all statuses of a study: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/statuses
Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign
Get all visits, forms and questionnaires in a paginated format: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign/paginated
Get status of latest study version: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/statuses/{version}

Designer/Study APIs/Study Actions/v9.0

The operations from the Designer/Study APIs/Study Actions/v9.0 category.

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/studyDesign
Get all visits, forms and questionnaires in a paginated format: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/studyDesign/paginated

Designer/Study APIs/Study Cohorts/v1.0

The operations from the Designer/Study APIs/Study Cohorts/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 APIs/Study Lock/v1.0

The operations from the Designer/Study APIs/Study Lock/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/Study APIs/Study Metadata APIs/v1.0

The operations from the Designer/Study APIs/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 APIs/Study Metadata APIs/v2.0

The operations from the Designer/Study APIs/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 APIs/Study Randomization Factors/v1.0

The operations from the Designer/Study APIs/Study Randomization Factors/v1.0 category.

Get all active factors in a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/randomizationfactors

Designer/Study APIs/Study Randomization Factors/v2.0

The operations from the Designer/Study APIs/Study Randomization Factors/v2.0 category.

Get all active factors in a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/randomizationfactors

Designer/Study APIs/Study Randomization Factors/v3.0

The operations from the Designer/Study APIs/Study Randomization Factors/v3.0 category.

Get all active factors in a study: Method: get
Path: /ec-designer-ors-svc/rest/v3.0/studies/{studyId}/randomizationfactors

Designer/Study Version APIs/v1.0

The operations from the Designer/Study Version 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}
Get list of combination of study version and boolean representing the existence of randomization: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/hasRandomization

Designer/Study Version APIs/v2.0

The operations from the Designer/Study Version APIs/v2.0 category.

Get items with ASVs within date range: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/studyversionobjects/formitems

Designer/Study Version APIs/v5.0

The operations from the Designer/Study Version APIs/v5.0 category.

Get study version objects: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/studyversionobjects

Designer/Study Version APIs/v6.0

The operations from the Designer/Study Version APIs/v6.0 category.

Get study version objects: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/studyversionobjects

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/Treatment Arms APIs/v7.0

The operations from the Designer/Treatment Arms APIs/v7.0 category.

Get list of treatment arm dispensations in a study version: Method: get
Path: /ec-designer-svc/rest/v7.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 status of study version asynchronously: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/status/{state}/async
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/Dispensation Visits/v1.0

The operations from the Designer/Visit APIs/Dispensation Visits/v1.0 category.

[Deprecated]: Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/dispensings
[Deprecated]: Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/dispensings

Designer/Visit APIs/Dispensation Visits/v2.0

The operations from the Designer/Visit APIs/Dispensation Visits/v2.0 category.

[Deprecated]: Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/dispensings
[Deprecated]: Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/dispensings

Designer/Visit APIs/Dispensation Visits/v3.0

The operations from the Designer/Visit APIs/Dispensation Visits/v3.0 category.

[Deprecated]: Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/dispensings
[Deprecated]: Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/dispensings

Designer/Visit APIs/Dispensation Visits/v4.0

The operations from the Designer/Visit APIs/Dispensation Visits/v4.0 category.

[Deprecated]: Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/dispensings
[Deprecated]: Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/dispensings

Designer/Visit APIs/Dispensation Visits/v5.0

The operations from the Designer/Visit APIs/Dispensation Visits/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/Visit APIs/Dispensation Visits/v6.0

The operations from the Designer/Visit APIs/Dispensation Visits/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/Visit APIs/Dispensation Visits/v7.0

The operations from the Designer/Visit APIs/Dispensation Visits/v7.0 category.

Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-ors-svc/rest/v7.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits: Method: put
Path: /ec-designer-ors-svc/rest/v7.0/studies/{studyId}/versions/{version}/dispensings

Designer/Visit APIs/Visit Design/v1.0

The operations from the Designer/Visit APIs/Visit Design/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 APIs/Visit Design/v10.0

The operations from the Designer/Visit APIs/Visit Design/v10.0 category.

Get study design visits: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Design/v2.0

The operations from the Designer/Visit APIs/Visit Design/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 APIs/Visit Design/v3.0

The operations from the Designer/Visit APIs/Visit Design/v3.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/design
Validate assigning randomization: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}

Designer/Visit APIs/Visit Design/v4.0

The operations from the Designer/Visit APIs/Visit Design/v4.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Design/v5.0

The operations from the Designer/Visit APIs/Visit Design/v5.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Design/v6.0

The operations from the Designer/Visit APIs/Visit Design/v6.0 category.

Create study design visits for multiple versions: Method: post
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/design
Get study design visits: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Design/v7.0

The operations from the Designer/Visit APIs/Visit Design/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 APIs/Visit Design/v8.0

The operations from the Designer/Visit APIs/Visit Design/v8.0 category.

Create study design visits for multiple versions: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/design
Get study design visits: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Design/v9.0

The operations from the Designer/Visit APIs/Visit Design/v9.0 category.

Create study design visits for multiple versions: Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/design
Create study design visits for multiple versions: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/design
Get study design visits: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/design

Designer/Visit APIs/Visit Forms/v1.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v10.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v11.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v12.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v13.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v14.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v15.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v16.0

The operations from the Designer/Visit APIs/Visit Forms/v16.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v16.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v17.0

The operations from the Designer/Visit APIs/Visit Forms/v17.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v17.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v19.0

The operations from the Designer/Visit APIs/Visit Forms/v19.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-edc-svc/rest/v19.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v2.0

The operations from the Designer/Visit APIs/Visit Forms/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}
[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
[Deprecated]: Update forms of a specific visit: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v20.0

The operations from the Designer/Visit APIs/Visit Forms/v20.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v3.0

The operations from the Designer/Visit APIs/Visit Forms/v3.0 category.

[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms
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
Update forms of a specific visit: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v4.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v5.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Forms/v6.0

The operations from the Designer/Visit APIs/Visit Forms/v6.0 category.

[Deprecated]: Use latest version instead. Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v7.0

The operations from the Designer/Visit APIs/Visit Forms/v7.0 category.

[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v8.0

The operations from the Designer/Visit APIs/Visit Forms/v8.0 category.

[Deprecated]: Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit APIs/Visit Forms/v9.0

The operations from the Designer/Visit APIs/Visit Forms/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/Visit APIs/Visit Metadata/v1.0

The operations from the Designer/Visit APIs/Visit Metadata/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 APIs/Visit Metadata/v2.0

The operations from the Designer/Visit APIs/Visit Metadata/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/Visit APIs/Visit Schedule/v1.0

The operations from the Designer/Visit APIs/Visit Schedule/v1.0 category.

[Deprecated]: Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visitschedules
[Deprecated]: Get visit schedule of a study version: Method: get
Path: /ec-designer-svc/rest/v1.0/visitschedules/{studyId}/{version}

Designer/Visit APIs/Visit Schedule/v2.0

The operations from the Designer/Visit APIs/Visit Schedule/v2.0 category.

[Deprecated]: Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visitschedules
[Deprecated]: Get visit schedule of a study version: Method: get
Path: /ec-designer-svc/rest/v2.0/visitschedules/{studyId}/{version}

Designer/Visit APIs/Visit Schedule/v4.0

The operations from the Designer/Visit APIs/Visit Schedule/v4.0 category.

[Deprecated]: Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit APIs/Visit Schedule/v5.0

The operations from the Designer/Visit APIs/Visit Schedule/v5.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit APIs/Visit Schedule/v6.0

The operations from the Designer/Visit APIs/Visit Schedule/v6.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit APIs/Visit Schedule/v7.0

The operations from the Designer/Visit APIs/Visit Schedule/v7.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit APIs/Visit Schedule/v8.0

The operations from the Designer/Visit APIs/Visit Schedule/v8.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit APIs/Visits/v1.0

The operations from the Designer/Visit APIs/Visits/v1.0 category.

[Deprecated]: Add a visit: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Clear visit schedule: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
[Deprecated]: Create visit schedule: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
[Deprecated]: Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get all visits, forms, and questions by study ID: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visitsforms
[Deprecated]: Get dispensation visits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
[Deprecated]: Update a visit: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Update visit schedule: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Get study visit: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get study 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

Designer/Visit APIs/Visits/v10.0

The operations from the Designer/Visit APIs/Visits/v10.0 category.

Add a visit: Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits
Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get dispensation visits: Method: get
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit: Method: put
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}

Designer/Visit APIs/Visits/v2.0

The operations from the Designer/Visit APIs/Visits/v2.0 category.

[Deprecated]: Add a visit: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Clear visit schedule: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
[Deprecated]: Create visit schedule: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
[Deprecated]: Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get dispensation visits: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
[Deprecated]: Get study visit: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Update a visit: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Update visit schedule: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visits
Get all visits, forms, and questions by study ID: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visitsforms
Get study visit schedule: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule

Designer/Visit APIs/Visits/v3.0

The operations from the Designer/Visit APIs/Visits/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 study 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/Visits/v4.0

The operations from the Designer/Visit APIs/Visits/v4.0 category.

[Deprecated]: Add a visit: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits
Clear visit schedule: Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Create visit schedule: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
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}
Get study visit schedule: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule
Update a visit: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update visit schedule: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}

Designer/Visit APIs/Visits/v5.0

The operations from the Designer/Visit APIs/Visits/v5.0 category.

[Deprecated]: Add a visit: Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get a list of study visits: Method: get
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 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/Visits/v6.0

The operations from the Designer/Visit APIs/Visits/v6.0 category.

[Deprecated]: 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/Visits/v7.0

The operations from the Designer/Visit APIs/Visits/v7.0 category.

[Deprecated]: 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 APIs/Visits/v8.0

The operations from the Designer/Visit APIs/Visits/v8.0 category.

Add a visit: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits
Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits
Get dispensation visits: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get study visit: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit: Method: put
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visits/{visitid}

Designer/Visit APIs/Visits/v9.0

The operations from the Designer/Visit APIs/Visits/v9.0 category.

Add a visit: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits
Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}
Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits
Get study visit: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}
Update a visit: Method: put
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}

Designer/Visits APIs/v10.0

The operations from the Designer/Visits APIs/v10.0 category.

Get visit kits blinded information: Method: get
Path: /ec-designer-ors-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitId}/kits/blindedInfo

Designer/Welcome APIs/v1.0

The operations from the Designer/Welcome APIs/v1.0 category.

Create welcome message: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/welcome
Delete welcome message: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/welcome
Get welcome message: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/welcome
Update welcome message: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/welcome

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/ib-ext-svc/rest/v1.0/integrationdata

Digital Gateway/Data Import/v2.0

The operations from the Digital Gateway/Data Import/v2.0 category.

Push data into ClinicalOne via real-time integration configured in Digital Gateway: Method: post
Path: /ib/ib-ext-svc/rest/v2.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
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 a file: Method: put
Path: /ec-fileupload-svc/rest/v3.0/storage/{bucketName}/{objectName}/parts/{partNumber}

Library/Library Kits APIs/v1.0

The operations from the Library/Library Kits APIs/v1.0 category.

Add library kit: Method: post
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits
Delete library kit: Method: delete
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}
Get all library kits: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits
Get history of all library kits: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}/history
Get library kit by ID: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}
Get library kits with pagination: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/pagination
Update library kit: Method: put
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}
Update library kit status in bulk: Method: post
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/bulk/{status}

Library/Library Object History APIs/v1.0

The operations from the Library/Library Object History APIs/v1.0 category.

Get history of a library object: Method: get
Path: /ec-library-svc/rest/v1.0/libraryHistory/{libraryId}

Library/Library Objects APIs/v1.0

The operations from the Library/Library Objects APIs/v1.0 category.

[Deprecated]: Get library object: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/{libraryId}
Delete library object: Method: delete
Path: /ec-library-svc/rest/v1.0/libraryObjects/{libraryId}
Undo the previous copy of a library object: Method: post
Path: /ec-library-svc/rest/v1.0/libraryObjects/studies/{studyId}/versions/{studyVersion}/revertCopyObjects
Update library object: Method: put
Path: /ec-library-svc/rest/v1.0/libraryObjects/{libraryId}
Update library objects in bulk: Method: post
Path: /ec-library-svc/rest/v1.0/libraryObjects/bulkUpdate

Library/Library Objects APIs/v2.0

The operations from the Library/Library Objects APIs/v2.0 category.

Add library object: Method: post
Path: /ec-library-svc/rest/v2.0/libraryObjects
Add library objects in bulk: Method: post
Path: /ec-library-svc/rest/v2.0/libraryObjects/bulk
Copy library object: Method: post
Path: /ec-library-svc/rest/v2.0/libraryObjects/studies/{studyId}/versions/{studyVersion}/{copyObjectMethod}/copyObjects
Delete library object version: Method: delete
Path: /ec-library-svc/rest/v2.0/libraryObjects
Get list of library objects: Method: get
Path: /ec-library-svc/rest/v2.0/libraryObjects
Gets a library depending on query parameters with pagination: Method: get
Path: /ec-library-svc/rest/v2.0/libraryObjects/pagination
Update library objects for study version: Method: post
Path: /ec-library-svc/rest/v2.0/libraryObjects/updateStudyVersion

Library/Library Uses APIs/v1.0

The operations from the Library/Library Uses APIs/v1.0 category.

Delete library uses: Method: delete
Path: /ec-library-svc/rest/v1.0/libraryUses
Get library uses object: Method: get
Path: /ec-library-svc/rest/v1.0/libraryUses/{libraryId}

Library/Library Uses APIs/v2.0

The operations from the Library/Library Uses APIs/v2.0 category.

Get all library uses for a given study: Method: get
Path: /ec-library-svc/rest/v2.0/libraryUses/study/{studyId}
Get library uses by study ID and version: Method: get
Path: /ec-library-svc/rest/v2.0/libraryUses/studies/{studyId}/versions/{studyVersion}
Get library uses for given library ID and study type: Method: get
Path: /ec-library-svc/rest/v2.0/libraryUses/library/{libraryId}/studyType/{studyType}
Get library uses for given study ID and type: Method: get
Path: /ec-library-svc/rest/v2.0/libraryUses/study/{studyId}/studyType/{studyType}
Update library uses object: Method: put
Path: /ec-library-svc/rest/v2.0/libraryUses

Notifications/Broadcast/Post request to broadcast notifications

The operations from the Notifications/Broadcast/Post request to broadcast notifications category.

V1.0: Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast
V2.0: Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationsbroadcast

Notifications/Broadcast/Retrieves the number of total and unread notifications

The operations from the Notifications/Broadcast/Retrieves the number of total and unread notifications category.

V1.0: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/notificationCount

Notifications/Broadcast/Update the notification broadcast

The operations from the Notifications/Broadcast/Update the notification broadcast category.

V1.0: Method: put
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}

Notifications/Broadcast/View notification broadcast message description

The operations from the Notifications/Broadcast/View notification broadcast message description category.

V1.0: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast

Notifications/Broadcast/View notification broadcast message description with notification ID

The operations from the Notifications/Broadcast/View notification broadcast message description with notification ID category.

V1.0: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}

Notifications/Email/Use a template and an i18n to send notifications

The operations from the Notifications/Email/Use a template and an i18n to send notifications category.

V1.0: Method: post
Path: /ec-notifications-svc/rest/v1.0/i18support/email/{templatetype}

Notifications/Email/Use a template to send notifications

The operations from the Notifications/Email/Use a template to send notifications category.

[Deprecated]: V1.0: Method: post
Path: /ec-notifications-svc/rest/v1.0/email/{templatetype}
[Deprecated]: V2.0: Method: post
Path: /ec-notifications-svc/rest/v2.0/email/{templatetype}
V3.0: Method: post
Path: /ec-notifications-svc/rest/v3.0/email/{templatetype}
V4.0: Method: post
Path: /ec-notifications-svc/rest/v4.0/email/{templatetype}

Notifications/Log/Create a log entry and broadcast immediately or schedule notifications

The operations from the Notifications/Log/Create a log entry and broadcast immediately or schedule notifications category.

[Deprecated]: V1.0: Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog
[Deprecated]: V2.0: Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog
[Deprecated]: V3.0: Method: post
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog
V4.0: Method: post
Path: /ec-notifications-svc/rest/v4.0/studies/{studyId}/{mode}/notificationlog
V5.0: Method: post
Path: /ec-notifications-svc/rest/v5.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/Get list of all notification logs

The operations from the Notifications/Log/Get list of all notification logs category.

[Deprecated]: V1.0: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog
[Deprecated]: V2.0: Method: get
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog
V3.0: Method: get
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/Get notification notification properties for a study

The operations from the Notifications/Log/Get notification notification properties for a study category.

V1.0: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/notificationProperties

Notifications/Log/Update notification properties for a study

The operations from the Notifications/Log/Update notification properties for a study category.

V1.0: Method: put
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/notificationProperties

Notifications/Reports/Generate specific report for notifications settings

The operations from the Notifications/Reports/Generate specific report for notifications settings category.

V1.0: Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Query/Query Management/v1.0

The operations from the Query/Query Management/v1.0 category.

[Deprecated]: Assign study roles to queries: Method: put
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
[Deprecated]: Get all historical records on DC_Query table: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/queryTable
[Deprecated]: Get list of all query states: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/state
[Deprecated]: Get list of opened queries: Method: post
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/querymgmt/openQueryList
[Deprecated]: Get list of queries based on multiple parameters: Method: post
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/querymgmt/queryList
Get all historical records on DC_Query_Study_Roles table: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/queryStudyRolesTable
Get subjects with open queries in a study: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/subjects
Get the number of open queries in a study: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/studyOpenQueryCount
Get the number of queries in a study: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/studyQueryCount

Query/Query Management/v10.0

The operations from the Query/Query Management/v10.0 category.

[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/queryDetails

Query/Query Management/v11.0

The operations from the Query/Query Management/v11.0 category.

Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v11.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v11.0/studies/{studyId}/{mode}/queryDetails

Query/Query Management/v2.0

The operations from the Query/Query Management/v2.0 category.

[Deprecated]: Answer an existing query: Method: put
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/{queryId}/answer
[Deprecated]: Assign study roles to queries: Method: put
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
[Deprecated]: Delete an existing query: Method: put
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/{queryId}/delete
[Deprecated]: Get all historical records on DC_Query table: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/queryTable
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queryDetails
Get list of all query states: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/state
Get list of opened queries: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/querymgmt/openQueryList
Get list of queries based on multiple parameters: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/querymgmt/queryList
Get number of open queries in a study for selected subjects: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/openQueryCount
Get number of queries in a study: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queryCount

Query/Query Management/v3.0

The operations from the Query/Query Management/v3.0 category.

[Deprecated]: Create candidate query: Method: post
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create open query: Method: post
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/queryDetails
Get all historical records on DC_Query table: Method: get
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/queries/queryTable

Query/Query Management/v4.0

The operations from the Query/Query Management/v4.0 category.

[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query by ID: Method: get
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Query Management/v5.0

The operations from the Query/Query Management/v5.0 category.

[Deprecated]: Answer an existing query: Method: put
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/{queryId}/answer
[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Create candidate query: Method: post
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create open query: Method: post
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Delete an existing query: Method: put
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/{queryId}/delete
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queryDetails
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Query Management/v6.0

The operations from the Query/Query Management/v6.0 category.

[Deprecated]: Answer an existing query: Method: put
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}/answer
[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Create candidate query: Method: post
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create open query: Method: post
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Delete an existing query: Method: put
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}/delete
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query by ID: Method: get
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queryDetails
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Query Management/v7.0

The operations from the Query/Query Management/v7.0 category.

[Deprecated]: Answer an existing query: Method: put
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}/answer
[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Create open query: Method: post
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query by ID: Method: get
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queryDetails
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Query Management/v8.0

The operations from the Query/Query Management/v8.0 category.

[Deprecated]: Answer an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/answer
[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Create candidate query: Method: post
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create open query: Method: post
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Delete an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/delete
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query by ID: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queryDetails
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Query Management/v9.0

The operations from the Query/Query Management/v9.0 category.

[Deprecated]: Close an existing query: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/close
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queryDetails
Answer an existing query: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Assign study roles to queries: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/assignupdate
Create candidate query: Method: post
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/candidate
Create open query: Method: post
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/open
Delete an existing query: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get query by ID: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}
Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/Reporting/v1.0

The operations from the Query/Reporting/v1.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v10.0

The operations from the Query/Reporting/v10.0 category.

Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v2.0

The operations from the Query/Reporting/v2.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v3.0

The operations from the Query/Reporting/v3.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v4.0

The operations from the Query/Reporting/v4.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v5.0

The operations from the Query/Reporting/v5.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v6.0

The operations from the Query/Reporting/v6.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v7.0

The operations from the Query/Reporting/v7.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v8.0

The operations from the Query/Reporting/v8.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/report/{reportName}

Query/Reporting/v9.0

The operations from the Query/Reporting/v9.0 category.

[Deprecated]: Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/report/{reportName}

Randomization and Supplies/Cohort APIs/Get cohort enrollments by study, mode and cohort ID

The operations from the Randomization and Supplies/Cohort APIs/Get cohort enrollments by study, mode and cohort ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/cohortenrollments/{cohortid}

Randomization and Supplies/Cohort APIs/Get cohort limits by study and mode

The operations from the Randomization and Supplies/Cohort APIs/Get cohort limits by study and mode category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/settings/cohortlimits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/settings/cohortlimits

Randomization and Supplies/Cohort APIs/Save cohort limits by study and mode

The operations from the Randomization and Supplies/Cohort APIs/Save cohort limits by study and mode category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/settings/cohortlimits
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/settings/cohortlimits

Randomization and Supplies/Device Management APIs/Deregister an mHealth device

The operations from the Randomization and Supplies/Device Management APIs/Deregister an mHealth device category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}

Randomization and Supplies/Device Management APIs/Recreate the access ID and one-time password for a bootstrap device

The operations from the Randomization and Supplies/Device Management APIs/Recreate the access ID and one-time password for a bootstrap device category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}/access-code

Randomization and Supplies/Device Management APIs/Register mHealth device

The operations from the Randomization and Supplies/Device Management APIs/Register mHealth device category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/register-device

Randomization and Supplies/Dispensation Logic APIs/Create DND Exception

The operations from the Randomization and Supplies/Dispensation Logic APIs/Create DND Exception category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception

Randomization and Supplies/Dispensation Logic APIs/Delete DND Exception

The operations from the Randomization and Supplies/Dispensation Logic APIs/Delete DND Exception category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}

Randomization and Supplies/Dispensation Logic APIs/Get DND Exception details by ID

The operations from the Randomization and Supplies/Dispensation Logic APIs/Get DND Exception details by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}

Randomization and Supplies/Dispensation Logic APIs/Get all DND Exceptions

The operations from the Randomization and Supplies/Dispensation Logic APIs/Get all DND Exceptions category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception

Randomization and Supplies/Dispensation Logic APIs/Update DND Exception

The operations from the Randomization and Supplies/Dispensation Logic APIs/Update DND Exception category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}

Randomization and Supplies/Dose Hold Subject Visits APIs/Get visits on dose hold for all subjects

The operations from the Randomization and Supplies/Dose Hold Subject Visits APIs/Get visits on dose hold for all subjects category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-doseholds

Randomization and Supplies/Event APIs/Get details about a Code Break event

The operations from the Randomization and Supplies/Event APIs/Get details about a Code Break event category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/events/codebreak/{eventId}

Randomization and Supplies/Event APIs/Get details about a Kit Replacement event

The operations from the Randomization and Supplies/Event APIs/Get details about a Kit Replacement event category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/kitreplacement/{eventId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/events/kitreplacement/{eventId}

Randomization and Supplies/Event APIs/Get details about a Resume Partial Dispensation event

The operations from the Randomization and Supplies/Event APIs/Get details about a Resume Partial Dispensation event category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/resume_partial_dispensation/{eventId}

Randomization and Supplies/Event APIs/Get details about a Resume dose hold dispensation event

The operations from the Randomization and Supplies/Event APIs/Get details about a Resume dose hold dispensation event category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/resume_dosehold_dispensation/{eventId}

Randomization and Supplies/Event APIs/Get list of events in a study

The operations from the Randomization and Supplies/Event APIs/Get list of events in a study category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events

Randomization and Supplies/Inventory APIs/Create blinded lot

The operations from the Randomization and Supplies/Inventory APIs/Create blinded lot category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/blinded-lots
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots

Randomization and Supplies/Inventory APIs/Create label groups

The operations from the Randomization and Supplies/Inventory APIs/Create label groups category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups

Randomization and Supplies/Inventory APIs/Create manufacturing lot

The operations from the Randomization and Supplies/Inventory APIs/Create manufacturing lot category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots

Randomization and Supplies/Inventory APIs/Create randomization list from uploaded file

The operations from the Randomization and Supplies/Inventory APIs/Create randomization list from uploaded file category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/fileupload/rndlists/{rndListId}

Randomization and Supplies/Inventory APIs/Delete blinded lot

The operations from the Randomization and Supplies/Inventory APIs/Delete blinded lot category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}

Randomization and Supplies/Inventory APIs/Delete kit list file

The operations from the Randomization and Supplies/Inventory APIs/Delete kit list file category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/file/{fileId}

Randomization and Supplies/Inventory APIs/Delete label groups

The operations from the Randomization and Supplies/Inventory APIs/Delete label groups category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}

Randomization and Supplies/Inventory APIs/Delete manufacturing lot by ID

The operations from the Randomization and Supplies/Inventory APIs/Delete manufacturing lot by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}

Randomization and Supplies/Inventory APIs/Disable kit list with inventories

The operations from the Randomization and Supplies/Inventory APIs/Disable kit list with inventories category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists/{listId}/disable

Randomization and Supplies/Inventory APIs/Export kit details for the inventory

The operations from the Randomization and Supplies/Inventory APIs/Export kit details for the inventory category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{sourceId}/export
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{sourceId}/export
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kits/{sourceId}/export

Randomization and Supplies/Inventory APIs/Generate kits

The operations from the Randomization and Supplies/Inventory APIs/Generate kits category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/generate
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/generate

Randomization and Supplies/Inventory APIs/Get Kit History by depot ID and kit ID

The operations from the Randomization and Supplies/Inventory APIs/Get Kit History by depot ID and kit ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits/{inventoryId}/historyById

Randomization and Supplies/Inventory APIs/Get a kit's barcode by kit ID

The operations from the Randomization and Supplies/Inventory APIs/Get a kit's barcode by kit ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode

Randomization and Supplies/Inventory APIs/Get a kit's last status

The operations from the Randomization and Supplies/Inventory APIs/Get a kit's last status category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/lastStatusById
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/lastStatus

Randomization and Supplies/Inventory APIs/Get a kit's last status by kit number

The operations from the Randomization and Supplies/Inventory APIs/Get a kit's last status by kit number category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus

Randomization and Supplies/Inventory APIs/Get a site inventory's status

The operations from the Randomization and Supplies/Inventory APIs/Get a site inventory's status category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/site

Randomization and Supplies/Inventory APIs/Get all manufacturing lots

The operations from the Randomization and Supplies/Inventory APIs/Get all manufacturing lots category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots

Randomization and Supplies/Inventory APIs/Get allowed inventory statuses

The operations from the Randomization and Supplies/Inventory APIs/Get allowed inventory statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}

Randomization and Supplies/Inventory APIs/Get blinded lot by ID

The operations from the Randomization and Supplies/Inventory APIs/Get blinded lot by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots/{blindedLotId}

Randomization and Supplies/Inventory APIs/Get blinded lots

The operations from the Randomization and Supplies/Inventory APIs/Get blinded lots category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/blinded-lots
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots

Randomization and Supplies/Inventory APIs/Get cancelled inventory statuses

The operations from the Randomization and Supplies/Inventory APIs/Get cancelled inventory statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/cancelledshipment

Randomization and Supplies/Inventory APIs/Get destruction inventory statuses

The operations from the Randomization and Supplies/Inventory APIs/Get destruction inventory statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/destruction

Randomization and Supplies/Inventory APIs/Get dispensation details by inventory ID

The operations from the Randomization and Supplies/Inventory APIs/Get dispensation details by inventory ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation

Randomization and Supplies/Inventory APIs/Get inventory database headers

The operations from the Randomization and Supplies/Inventory APIs/Get inventory database headers category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadkits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadkits

Randomization and Supplies/Inventory APIs/Get inventory statuses

The operations from the Randomization and Supplies/Inventory APIs/Get inventory statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventorystatuses

Randomization and Supplies/Inventory APIs/Get kit details by kit number

The operations from the Randomization and Supplies/Inventory APIs/Get kit details by kit number category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kitDetails
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kitDetails
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kitDetails
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kitDetails

Randomization and Supplies/Inventory APIs/Get kit history by ID

The operations from the Randomization and Supplies/Inventory APIs/Get kit history by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById

Randomization and Supplies/Inventory APIs/Get kit history by KitNumberUTF

The operations from the Randomization and Supplies/Inventory APIs/Get kit history by KitNumberUTF category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/history

Randomization and Supplies/Inventory APIs/Get kit history by kit number for a site

The operations from the Randomization and Supplies/Inventory APIs/Get kit history by kit number for a site category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history

Randomization and Supplies/Inventory APIs/Get kit history for a site by kitNumberUTF

The operations from the Randomization and Supplies/Inventory APIs/Get kit history for a site by kitNumberUTF category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/history

Randomization and Supplies/Inventory APIs/Get kit list details

The operations from the Randomization and Supplies/Inventory APIs/Get kit list details category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kitlists
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kitlists

Randomization and Supplies/Inventory APIs/Get kit summary by kit type ID

The operations from the Randomization and Supplies/Inventory APIs/Get kit summary by kit type ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits

Randomization and Supplies/Inventory APIs/Get kit summary of serialized and non-serialized kits

The operations from the Randomization and Supplies/Inventory APIs/Get kit summary of serialized and non-serialized kits category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kit-types
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kit-types
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/inventory/kit-types
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/inventory/kit-types
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/inventory/kit-types

Randomization and Supplies/Inventory APIs/Get kit types

The operations from the Randomization and Supplies/Inventory APIs/Get kit types category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kit-types
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kit-types

Randomization and Supplies/Inventory APIs/Get kit types by lots

The operations from the Randomization and Supplies/Inventory APIs/Get kit types by lots category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsbykittype/sdfs/{sdfType}/{sdfId}

Randomization and Supplies/Inventory APIs/Get kits from depot inventory by depot ID

The operations from the Randomization and Supplies/Inventory APIs/Get kits from depot inventory by depot ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits

Randomization and Supplies/Inventory APIs/Get label groups

The operations from the Randomization and Supplies/Inventory APIs/Get label groups category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups

Randomization and Supplies/Inventory APIs/Get label groups by ID

The operations from the Randomization and Supplies/Inventory APIs/Get label groups by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}

Randomization and Supplies/Inventory APIs/Get latest status of kit in site inventory

The operations from the Randomization and Supplies/Inventory APIs/Get latest status of kit in site inventory category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/lastStatus

Randomization and Supplies/Inventory APIs/Get latest status of kit in site inventory by ID

The operations from the Randomization and Supplies/Inventory APIs/Get latest status of kit in site inventory by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/lastStatusById

Randomization and Supplies/Inventory APIs/Get list of filtered kits

The operations from the Randomization and Supplies/Inventory APIs/Get list of filtered kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/qualified-kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/qualified-kits

Randomization and Supplies/Inventory APIs/Get lots with kits

The operations from the Randomization and Supplies/Inventory APIs/Get lots with kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsWithKits

Randomization and Supplies/Inventory APIs/Get manufacturing lot by ID

The operations from the Randomization and Supplies/Inventory APIs/Get manufacturing lot by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}

Randomization and Supplies/Inventory APIs/Get max kit number

The operations from the Randomization and Supplies/Inventory APIs/Get max kit number category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/suggested-max-numbers

Randomization and Supplies/Inventory APIs/Get pending Destruction count by location ID

The operations from the Randomization and Supplies/Inventory APIs/Get pending Destruction count by location ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/location/{locationId}/pendingdestructioncount

Randomization and Supplies/Inventory APIs/Get randomization list database headers

The operations from the Randomization and Supplies/Inventory APIs/Get randomization list database headers category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist

Randomization and Supplies/Inventory APIs/Get received inventory statuses

The operations from the Randomization and Supplies/Inventory APIs/Get received inventory statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/receivedshipment
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/receivedshipment

Randomization and Supplies/Inventory APIs/Get single kit settings

The operations from the Randomization and Supplies/Inventory APIs/Get single kit settings category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/singlekitsettings

Randomization and Supplies/Inventory APIs/Get sites

The operations from the Randomization and Supplies/Inventory APIs/Get sites category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites

Randomization and Supplies/Inventory APIs/Get study settings

The operations from the Randomization and Supplies/Inventory APIs/Get study settings category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings

Randomization and Supplies/Inventory APIs/Get types of packages

The operations from the Randomization and Supplies/Inventory APIs/Get types of packages category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/packagetypes

Randomization and Supplies/Inventory APIs/Kit list details for each kit

The operations from the Randomization and Supplies/Inventory APIs/Kit list details for each kit category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/audit
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/audit
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits/audit
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kits/audit

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Add quantity to lot for non-serialized kit types

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Add quantity to lot for non-serialized kit types category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/lots/{lotId}

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get allowed inventory status for non-serialized kits

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get allowed inventory status for non-serialized kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventorystatuses/allowed/{fromInventoryStatusId}

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get audit details for non-serialized kits

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get audit details for non-serialized kits category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/audit

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get kit type quantities by lot ID

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get kit type quantities by lot ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/lots/{lotId}/quantity

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get non-serialized kits by kit type ID

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Get non-serialized kits by kit type ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/kit-types/{kitTypeId}/kits

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Update multiple non-serialized kits

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Update multiple non-serialized kits category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory

Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Update non-serialized kits

The operations from the Randomization and Supplies/Inventory APIs/Non-Serialized Kits APIs/Update non-serialized kits category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/nsinventory/{nsinventoryId}

Randomization and Supplies/Inventory APIs/Parse file headers

The operations from the Randomization and Supplies/Inventory APIs/Parse file headers category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/{fileId}/fileheaders

Randomization and Supplies/Inventory APIs/Search for kits in a given range for a site

The operations from the Randomization and Supplies/Inventory APIs/Search for kits in a given range for a site category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/Set kit verification status

The operations from the Randomization and Supplies/Inventory APIs/Set kit verification status category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}/verify

Randomization and Supplies/Inventory APIs/Update a barcode

The operations from the Randomization and Supplies/Inventory APIs/Update a barcode category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/barcode
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/barcode

Randomization and Supplies/Inventory APIs/Update a kit's barcode

The operations from the Randomization and Supplies/Inventory APIs/Update a kit's barcode category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode

Randomization and Supplies/Inventory APIs/Update a kit's dispensation confirmation

The operations from the Randomization and Supplies/Inventory APIs/Update a kit's dispensation confirmation category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/confirmDispensation

Randomization and Supplies/Inventory APIs/Update blinded lot

The operations from the Randomization and Supplies/Inventory APIs/Update blinded lot category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots/{blindedLotId}

Randomization and Supplies/Inventory APIs/Update kit attributes

The operations from the Randomization and Supplies/Inventory APIs/Update kit attributes category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits
v4.0: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kits

Randomization and Supplies/Inventory APIs/Update kit attributes from depot inventory by depot ID

The operations from the Randomization and Supplies/Inventory APIs/Update kit attributes from depot inventory by depot ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits

Randomization and Supplies/Inventory APIs/Update kit label group

The operations from the Randomization and Supplies/Inventory APIs/Update kit label group category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/label-group

Randomization and Supplies/Inventory APIs/Update kit location

The operations from the Randomization and Supplies/Inventory APIs/Update kit location category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/location

Randomization and Supplies/Inventory APIs/Update kit manufacturing lot

The operations from the Randomization and Supplies/Inventory APIs/Update kit manufacturing lot category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/manufacturing-lot

Randomization and Supplies/Inventory APIs/Update kit status

The operations from the Randomization and Supplies/Inventory APIs/Update kit status category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status

Randomization and Supplies/Inventory APIs/Update kit status by kit ID

The operations from the Randomization and Supplies/Inventory APIs/Update kit status by kit ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
v4.0: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
v5.0: Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}

Randomization and Supplies/Inventory APIs/Update label groups

The operations from the Randomization and Supplies/Inventory APIs/Update label groups category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}

Randomization and Supplies/Inventory APIs/Update manufacturing lot by ID

The operations from the Randomization and Supplies/Inventory APIs/Update manufacturing lot by ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}

Randomization and Supplies/Inventory APIs/Update status for kits in a site

The operations from the Randomization and Supplies/Inventory APIs/Update status for kits in a site category.

v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v4.0: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
v5.0: Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/Upload inventory data as CSV file

The operations from the Randomization and Supplies/Inventory APIs/Upload inventory data as CSV file category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadinventory

Randomization and Supplies/Inventory APIs/Upload kit list file

The operations from the Randomization and Supplies/Inventory APIs/Upload kit list file category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadfile

Randomization and Supplies/Inventory APIs/Upload kit types data

The operations from the Randomization and Supplies/Inventory APIs/Upload kit types data category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/kittypesfromfile

Randomization and Supplies/NonSubjectForm APIs/Get existing data from non-subject forms for kit IDs

The operations from the Randomization and Supplies/NonSubjectForm APIs/Get existing data from non-subject forms for kit IDs category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/existingdata

Randomization and Supplies/Partial Dispensation Subject Visits APIs/Get visits with partial dispensation for all subjects

The operations from the Randomization and Supplies/Partial Dispensation Subject Visits APIs/Get visits with partial dispensation for all subjects category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations

Randomization and Supplies/Randomization APIs/Get list of all treatment arms for a randomization

The operations from the Randomization and Supplies/Randomization APIs/Get list of all treatment arms for a randomization category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/treatments

Randomization and Supplies/Randomization APIs/Get list of headers from a CSV file

The operations from the Randomization and Supplies/Randomization APIs/Get list of headers from a CSV file category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/{fileId}/fileheaders

Randomization and Supplies/Randomization APIs/Get unique values for treatments, strata, or cohorts from a CSV file

The operations from the Randomization and Supplies/Randomization APIs/Get unique values for treatments, strata, or cohorts from a CSV file category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/csvuniquevalues

Randomization and Supplies/Randomization APIs/Upload randomization list based on header mappings and treatment, cohort, stratum mappings

The operations from the Randomization and Supplies/Randomization APIs/Upload randomization list based on header mappings and treatment, cohort, stratum mappings category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadrndlist

Randomization and Supplies/Randomization APIs/Upload randomization list file from a file service into RTSM

The operations from the Randomization and Supplies/Randomization APIs/Upload randomization list file from a file service into RTSM category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadfile

Randomization and Supplies/Randomization List APIs/Blocks/Get list of randomization blocks

The operations from the Randomization and Supplies/Randomization List APIs/Blocks/Get list of randomization blocks category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks

Randomization and Supplies/Randomization List APIs/Blocks/Update randomization list blocks

The operations from the Randomization and Supplies/Randomization List APIs/Blocks/Update randomization list blocks category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks

Randomization and Supplies/Randomization List APIs/Designs/Associate randomization design to randomization list

The operations from the Randomization and Supplies/Randomization List APIs/Designs/Associate randomization design to randomization list category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}

Randomization and Supplies/Randomization List APIs/Designs/Check randomization design is blocked by region

The operations from the Randomization and Supplies/Randomization List APIs/Designs/Check randomization design is blocked by region category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/rndListsByRegion/regions/{regionId}

Randomization and Supplies/Randomization List APIs/Designs/Dissociate randomization design from randomization list

The operations from the Randomization and Supplies/Randomization List APIs/Designs/Dissociate randomization design from randomization list category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}

Randomization and Supplies/Randomization List APIs/Designs/Get randomization design list

The operations from the Randomization and Supplies/Randomization List APIs/Designs/Get randomization design list category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/randlistdesigns
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlistdesigns

Randomization and Supplies/Randomization List APIs/Export/Export randomization list

The operations from the Randomization and Supplies/Randomization List APIs/Export/Export randomization list category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/export

Randomization and Supplies/Randomization List APIs/Lists/Create randomization list

The operations from the Randomization and Supplies/Randomization List APIs/Lists/Create randomization list category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate

Randomization and Supplies/Randomization List APIs/Lists/Delete randomization list file

The operations from the Randomization and Supplies/Randomization List APIs/Lists/Delete randomization list file category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/file/{fileId}

Randomization and Supplies/Randomization List APIs/Lists/Get randomization list

The operations from the Randomization and Supplies/Randomization List APIs/Lists/Get randomization list category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/randlists
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/randlists
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/randlists

Randomization and Supplies/Randomization List APIs/Lists/Get randomization list by ID

The operations from the Randomization and Supplies/Randomization List APIs/Lists/Get randomization list by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/randlists/{rndlistid}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists/{rndlistid}

Randomization and Supplies/Randomization List APIs/Numbers/Get random number statuses

The operations from the Randomization and Supplies/Randomization List APIs/Numbers/Get random number statuses category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randnumberstatuses

Randomization and Supplies/Randomization List APIs/Numbers/Get randomization number

The operations from the Randomization and Supplies/Randomization List APIs/Numbers/Get randomization number category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers

Randomization and Supplies/Randomization List APIs/Numbers/Update randomization status

The operations from the Randomization and Supplies/Randomization List APIs/Numbers/Update randomization status category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumber/randstatus

Randomization and Supplies/Report APIs/Depot Resupply details for the study

The operations from the Randomization and Supplies/Report APIs/Depot Resupply details for the study category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/depotresupply

Randomization and Supplies/Report APIs/Get Blinded Randomization List report

The operations from the Randomization and Supplies/Report APIs/Get Blinded Randomization List report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/blindedrandreport

Randomization and Supplies/Report APIs/Get Cohort Enrollment Audit Trail report

The operations from the Randomization and Supplies/Report APIs/Get Cohort Enrollment Audit Trail report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments/history
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/cohortenrollments/history

Randomization and Supplies/Report APIs/Get Cohort Enrollment report

The operations from the Randomization and Supplies/Report APIs/Get Cohort Enrollment report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/cohortenrollments

Randomization and Supplies/Report APIs/Get DND Exceptions report

The operations from the Randomization and Supplies/Report APIs/Get DND Exceptions report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/dndexceptions

Randomization and Supplies/Report APIs/Get Kit Blinded Chain of Custody report

The operations from the Randomization and Supplies/Report APIs/Get Kit Blinded Chain of Custody report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody

Randomization and Supplies/Report APIs/Get Kit Chain of Custody Unblinded report

The operations from the Randomization and Supplies/Report APIs/Get Kit Chain of Custody Unblinded report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v6.0: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
v7.0: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/reports/kits/chainofcustody

Randomization and Supplies/Report APIs/Get Kit Inventory (Blinded) report

The operations from the Randomization and Supplies/Report APIs/Get Kit Inventory (Blinded) report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/blindedInventory

Randomization and Supplies/Report APIs/Get Kit Inventory (Unblinded) report

The operations from the Randomization and Supplies/Report APIs/Get Kit Inventory (Unblinded) report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory

Randomization and Supplies/Report APIs/Get Kit Reconciliation report

The operations from the Randomization and Supplies/Report APIs/Get Kit Reconciliation report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/recon
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/recon
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/recon
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/recon

Randomization and Supplies/Report APIs/Get Order Summary report

The operations from the Randomization and Supplies/Report APIs/Get Order Summary report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/order-summary
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/order-summary
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/order-summary
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/order-summary
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/order-summary

Randomization and Supplies/Report APIs/Get Projected Supplies Data Extract report

The operations from the Randomization and Supplies/Report APIs/Get Projected Supplies Data Extract report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/generateAsync

Randomization and Supplies/Report APIs/Get Randomization List report

The operations from the Randomization and Supplies/Report APIs/Get Randomization List report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/randList
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/unblindedrandreport
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/unblindedrandreport
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/unblindedrandreport
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/unblindedrandreport

Randomization and Supplies/Report APIs/Get Study Design kit list report

The operations from the Randomization and Supplies/Report APIs/Get Study Design kit list report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kitlist

Randomization and Supplies/Report APIs/Get Study Design report

The operations from the Randomization and Supplies/Report APIs/Get Study Design report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/supplysettings
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/supplysettings

Randomization and Supplies/Report APIs/Get Study Inventory Settings report

The operations from the Randomization and Supplies/Report APIs/Get Study Inventory Settings report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/inventorysettings
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/inventorysettings
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/inventorysettings

Randomization and Supplies/Report APIs/Get Subject Data report

The operations from the Randomization and Supplies/Report APIs/Get Subject Data report category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/subjects
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/subjects
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/subjects
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/subjects

Randomization and Supplies/Report APIs/Get System Usage report

The operations from the Randomization and Supplies/Report APIs/Get System Usage report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/shipments

Randomization and Supplies/Report APIs/Get Titration Summary (Blinded) report

The operations from the Randomization and Supplies/Report APIs/Get Titration Summary (Blinded) report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/blinded-titration-summary
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/blinded-titration-summary

Randomization and Supplies/Report APIs/Get Titration Summary (Unblinded) report

The operations from the Randomization and Supplies/Report APIs/Get Titration Summary (Unblinded) report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/titration-summary
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/titration-summary

Randomization and Supplies/Report APIs/Get Unblinded Visit Schedule report

The operations from the Randomization and Supplies/Report APIs/Get Unblinded Visit Schedule report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule

Randomization and Supplies/Report APIs/Get dose hold settings report

The operations from the Randomization and Supplies/Report APIs/Get dose hold settings report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/doseholdsettings
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/doseholdsettings
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/doseholdsettings

Randomization and Supplies/Report APIs/Get local source settings report

The operations from the Randomization and Supplies/Report APIs/Get local source settings report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/locallysourcedkits

Randomization and Supplies/Report APIs/Get minimization list report

The operations from the Randomization and Supplies/Report APIs/Get minimization list report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/minimization

Randomization and Supplies/Report APIs/Get partial dispensation settings report

The operations from the Randomization and Supplies/Report APIs/Get partial dispensation settings report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/partialdispensations
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/partialdispensations

Randomization and Supplies/Report APIs/Get projected supplies data for countries

The operations from the Randomization and Supplies/Report APIs/Get projected supplies data for countries category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/countrycounts
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/projectedsupplies/countrycounts
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/projectedsupplies/countrycounts

Randomization and Supplies/Report APIs/Get projected supplies data for depots

The operations from the Randomization and Supplies/Report APIs/Get projected supplies data for depots category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/depotcounts
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/projectedsupplies/depotcounts

Randomization and Supplies/Report APIs/Get projected supplies data for sites

The operations from the Randomization and Supplies/Report APIs/Get projected supplies data for sites category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/projectedsupplies/sitecounts
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/projectedsupplies/sitecounts
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/projectedsupplies/sitecounts

Randomization and Supplies/Report APIs/Get the Subject Dispensation Audit report

The operations from the Randomization and Supplies/Report APIs/Get the Subject Dispensation Audit report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/dispensations-audit

Randomization and Supplies/Report APIs/Get the Subject Dispensation report

The operations from the Randomization and Supplies/Report APIs/Get the Subject Dispensation report category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/dispensations
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/dispensations
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/dispensations
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/dispensations
v6.0: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/reports/dispensations
v7.0: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Report APIs/Get the Supply Settings audit report

The operations from the Randomization and Supplies/Report APIs/Get the Supply Settings audit report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/supplysettingsaudit

Randomization and Supplies/Report APIs/Retrieves Min/Max resupply strategy details of a study for a report

The operations from the Randomization and Supplies/Report APIs/Retrieves Min/Max resupply strategy details of a study for a report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/minmaxresupply

Randomization and Supplies/Report APIs/Retrieves predictive resupply details of a study for a report

The operations from the Randomization and Supplies/Report APIs/Retrieves predictive resupply details of a study for a report category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/predictiveresupply

Randomization and Supplies/Report APIs/Site Resupply details for the study

The operations from the Randomization and Supplies/Report APIs/Site Resupply details for the study category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/siteresupply

Randomization and Supplies/Settings APIs/Blinding Group/Create blinding group

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Create blinding group category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups

Randomization and Supplies/Settings APIs/Blinding Group/Delete blinding group by ID

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Delete blinding group by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}

Randomization and Supplies/Settings APIs/Blinding Group/Get all blinding groups

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Get all blinding groups category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups

Randomization and Supplies/Settings APIs/Blinding Group/Get blinding group by ID

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Get blinding group by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}

Randomization and Supplies/Settings APIs/Blinding Group/Get kit types which do not belong to any blinding group

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Get kit types which do not belong to any blinding group category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kittypes/noblindinggroup

Randomization and Supplies/Settings APIs/Blinding Group/Update blinding group

The operations from the Randomization and Supplies/Settings APIs/Blinding Group/Update blinding group category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}

Randomization and Supplies/Settings APIs/Dose Hold Settings/Create dose hold settings for the given dose hold

The operations from the Randomization and Supplies/Settings APIs/Dose Hold Settings/Create dose hold settings for the given dose hold category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings

Randomization and Supplies/Settings APIs/Dose Hold Settings/Delete dose hold settings of a given dose hold by ID

The operations from the Randomization and Supplies/Settings APIs/Dose Hold Settings/Delete dose hold settings of a given dose hold by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}

Randomization and Supplies/Settings APIs/Dose Hold Settings/Get all dose hold settings details

The operations from the Randomization and Supplies/Settings APIs/Dose Hold Settings/Get all dose hold settings details category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings

Randomization and Supplies/Settings APIs/Dose Hold Settings/Get dose hold setting details of given dose hold by ID

The operations from the Randomization and Supplies/Settings APIs/Dose Hold Settings/Get dose hold setting details of given dose hold by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}

Randomization and Supplies/Settings APIs/Dose Hold Settings/Update dose hold settings of a given dose hold by ID

The operations from the Randomization and Supplies/Settings APIs/Dose Hold Settings/Update dose hold settings of a given dose hold by ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}

Randomization and Supplies/Settings APIs/Get supply settings

The operations from the Randomization and Supplies/Settings APIs/Get supply settings category.

v11.0: Method: get
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/supply/settings
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/Local Source Settings/Create local source settings for kit types

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Create local source settings for kit types category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits

Randomization and Supplies/Settings APIs/Local Source Settings/Delete local source settings by ID

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Delete local source settings by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}

Randomization and Supplies/Settings APIs/Local Source Settings/Get all local source settings

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Get all local source settings category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits

Randomization and Supplies/Settings APIs/Local Source Settings/Get local source settings by ID

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Get local source settings by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}

Randomization and Supplies/Settings APIs/Local Source Settings/Get local source settings for a Subject ID

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Get local source settings for a Subject ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/locally-sourced-kits

Randomization and Supplies/Settings APIs/Local Source Settings/Update local source settings by ID

The operations from the Randomization and Supplies/Settings APIs/Local Source Settings/Update local source settings by ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}

Randomization and Supplies/Settings APIs/Partial Dispensation/Create partial dispensation settings

The operations from the Randomization and Supplies/Settings APIs/Partial Dispensation/Create partial dispensation settings category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings

Randomization and Supplies/Settings APIs/Partial Dispensation/Delete partial dispensation settings of a given partial dispensation definition by ID

The operations from the Randomization and Supplies/Settings APIs/Partial Dispensation/Delete partial dispensation settings of a given partial dispensation definition by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}

Randomization and Supplies/Settings APIs/Partial Dispensation/Get all partial dispensation details

The operations from the Randomization and Supplies/Settings APIs/Partial Dispensation/Get all partial dispensation details category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings

Randomization and Supplies/Settings APIs/Partial Dispensation/Get partial dispensation settings of a given partial dispensation by ID

The operations from the Randomization and Supplies/Settings APIs/Partial Dispensation/Get partial dispensation settings of a given partial dispensation by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}

Randomization and Supplies/Settings APIs/Partial Dispensation/Update partial dispensation settings of a given partial dispensation by ID

The operations from the Randomization and Supplies/Settings APIs/Partial Dispensation/Update partial dispensation settings of a given partial dispensation by ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}

Randomization and Supplies/Settings APIs/Resupply Group Settings/Create a resupply group

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Create a resupply group category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupplies

Randomization and Supplies/Settings APIs/Resupply Group Settings/Create or update selected depot resupply associations

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Create or update selected depot resupply associations category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies/updateselected

Randomization and Supplies/Settings APIs/Resupply Group Settings/Create or update selected site resupply associations

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Create or update selected site resupply associations category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies/updateselected

Randomization and Supplies/Settings APIs/Resupply Group Settings/Delete a resupply by ID

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Delete a resupply by ID category.

v1.0: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}

Randomization and Supplies/Settings APIs/Resupply Group Settings/Get a resupply group by ID

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Get a resupply group by ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupplies/{resupplyId}

Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all depot resupplies

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all depot resupplies category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies

Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all resupply groups

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all resupply groups category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupplies

Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all site resupplies

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Get all site resupplies category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies

Randomization and Supplies/Settings APIs/Resupply Group Settings/Update a resupply by ID

The operations from the Randomization and Supplies/Settings APIs/Resupply Group Settings/Update a resupply by ID category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupplies/{resupplyId}

Randomization and Supplies/Settings APIs/Update supply settings

The operations from the Randomization and Supplies/Settings APIs/Update supply settings category.

v10.0: Method: put
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/supply/settings
v11.0: Method: put
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/supply/settings
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
v3.0: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings
v4.0: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings
v5.0: Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings
v6.0: Method: put
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings
v7.0: Method: put
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/supply/settings
v8.0: Method: put
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/supply/settings
v9.0: Method: put
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Shipment APIs/Forms/Regenerate order form

The operations from the Randomization and Supplies/Shipment APIs/Forms/Regenerate order form category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/regenerate-order-form

Randomization and Supplies/Shipment APIs/Kits/Add additional kits to a received shipment

The operations from the Randomization and Supplies/Shipment APIs/Kits/Add additional kits to a received shipment category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits

Randomization and Supplies/Shipment APIs/Kits/Add kits to a shipment

The operations from the Randomization and Supplies/Shipment APIs/Kits/Add kits to a shipment category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits

Randomization and Supplies/Shipment APIs/Kits/Assign Pooling Shipment kits

The operations from the Randomization and Supplies/Shipment APIs/Kits/Assign Pooling Shipment kits category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits

Randomization and Supplies/Shipment APIs/Kits/Get eligible kits

The operations from the Randomization and Supplies/Shipment APIs/Kits/Get eligible kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits

Randomization and Supplies/Shipment APIs/Kits/Get kits

The operations from the Randomization and Supplies/Shipment APIs/Kits/Get kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits

Randomization and Supplies/Shipment APIs/Kits/Get kits eligible to be received against a shipment

The operations from the Randomization and Supplies/Shipment APIs/Kits/Get kits eligible to be received against a shipment category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits

Randomization and Supplies/Shipment APIs/Kits/Get kits or a specific kit for a shipment

The operations from the Randomization and Supplies/Shipment APIs/Kits/Get kits or a specific kit for a shipment category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits

Randomization and Supplies/Shipment APIs/Kits/Remove kits from a shipment

The operations from the Randomization and Supplies/Shipment APIs/Kits/Remove kits from a shipment category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits

Randomization and Supplies/Shipment APIs/Kits/Update status of a received kit

The operations from the Randomization and Supplies/Shipment APIs/Kits/Update status of a received kit category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits

Randomization and Supplies/Shipment APIs/NS Inventory/Get non-serialized inventory order items

The operations from the Randomization and Supplies/Shipment APIs/NS Inventory/Get non-serialized inventory order items category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-nsinventory

Randomization and Supplies/Shipment APIs/Orders/Confirm order shipment

The operations from the Randomization and Supplies/Shipment APIs/Orders/Confirm order shipment category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/confirmed

Randomization and Supplies/Shipment APIs/Orders/Get order details by a shipment ID

The operations from the Randomization and Supplies/Shipment APIs/Orders/Get order details by a shipment ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
v10.0: Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/orders/{shipmentId}
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders/{shipmentId}
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders/{shipmentId}
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/orders/{shipmentId}
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/orders/{shipmentId}
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/orders/{shipmentId}
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/orders/{shipmentId}
v9.0: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/orders/{shipmentId}

Randomization and Supplies/Shipment APIs/Orders/Get order items

The operations from the Randomization and Supplies/Shipment APIs/Orders/Get order items category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-inventory/audit
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders-inventory/audit

Randomization and Supplies/Shipment APIs/Orders/Get orders

The operations from the Randomization and Supplies/Shipment APIs/Orders/Get orders category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders
v10.0: Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/orders
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/orders
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/orders
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/orders
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/orders
v9.0: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/orders

Randomization and Supplies/Shipment APIs/Orders/Invalidate order shipment

The operations from the Randomization and Supplies/Shipment APIs/Orders/Invalidate order shipment category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/invalid

Randomization and Supplies/Shipment APIs/Orders/List available order status values

The operations from the Randomization and Supplies/Shipment APIs/Orders/List available order status values category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipment-statuses
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipment-statuses
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipment-statuses

Randomization and Supplies/Shipment APIs/Orders/Update shipment details for an order

The operations from the Randomization and Supplies/Shipment APIs/Orders/Update shipment details for an order category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
v2.0: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}

Randomization and Supplies/Shipment APIs/Quarantine/Update a quarantined shipment and its kits to received

The operations from the Randomization and Supplies/Shipment APIs/Quarantine/Update a quarantined shipment and its kits to received category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined

Randomization and Supplies/Shipment APIs/Quarantine/Update shipment and its kits as quarantined

The operations from the Randomization and Supplies/Shipment APIs/Quarantine/Update shipment and its kits as quarantined category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined

Randomization and Supplies/Shipment APIs/Shipments/All shipments

The operations from the Randomization and Supplies/Shipment APIs/Shipments/All shipments category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/allShipments

Randomization and Supplies/Shipment APIs/Shipments/Cancel reconciliation shipment

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Cancel reconciliation shipment category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/cancel

Randomization and Supplies/Shipment APIs/Shipments/Cancel shipments

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Cancel shipments category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/cancel

Randomization and Supplies/Shipment APIs/Shipments/Create a resupply strategy

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create a resupply strategy category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/resupply
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupply/resupply

Randomization and Supplies/Shipment APIs/Shipments/Create first shipment in resupply strategy

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create first shipment in resupply strategy category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/initial

Randomization and Supplies/Shipment APIs/Shipments/Create manual depot shipment

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create manual depot shipment category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/depotmanual
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/depotmanual

Randomization and Supplies/Shipment APIs/Shipments/Create manual shipment in resupply strategy

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create manual shipment in resupply strategy category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/manual
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupply/manual
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/resupply/manual

Randomization and Supplies/Shipment APIs/Shipments/Create shipment for kits marked for destruction from a given site to depot

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create shipment for kits marked for destruction from a given site to depot category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments

Randomization and Supplies/Shipment APIs/Shipments/Create shipment for kits marked for destruction in a study

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Create shipment for kits marked for destruction in a study category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments

Randomization and Supplies/Shipment APIs/Shipments/Get a shipment's details by ID for a site

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Get a shipment's details by ID for a site category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}

Randomization and Supplies/Shipment APIs/Shipments/Get shipment by shipment ID

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Get shipment by shipment ID category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}

Randomization and Supplies/Shipment APIs/Shipments/Initiate manual resupply to a site

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Initiate manual resupply to a site category.

v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual

Randomization and Supplies/Shipment APIs/Shipments/Mark kits as received

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Mark kits as received category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received

Randomization and Supplies/Shipment APIs/Shipments/Mark kits as received for a given site

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Mark kits as received for a given site category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received

Randomization and Supplies/Shipment APIs/Shipments/Mark reconciliation shipments as lost

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Mark reconciliation shipments as lost category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/mark-lost

Randomization and Supplies/Shipment APIs/Shipments/Mark shipments as lost

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Mark shipments as lost category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/mark-lost

Randomization and Supplies/Shipment APIs/Shipments/Received shipment for destruction

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Received shipment for destruction category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/destroyed

Randomization and Supplies/Shipment APIs/Shipments/Search shipments for a site

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Search shipments for a site category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments

Randomization and Supplies/Shipment APIs/Shipments/Search shipments for a study

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Search shipments for a study category.

v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/shipments
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/shipments
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/shipments
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/shipments

Randomization and Supplies/Shipment APIs/Shipments/Update a shipment's ship date

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Update a shipment's ship date category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/ship-date

Randomization and Supplies/Shipment APIs/Shipments/Update shipment as received for destruction

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Update shipment as received for destruction category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/received

Randomization and Supplies/Shipment APIs/Shipments/Update shipping date

The operations from the Randomization and Supplies/Shipment APIs/Shipments/Update shipping date category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/ship-date

Randomization and Supplies/Shipment APIs/Tracking/Update a shipment's tracking details

The operations from the Randomization and Supplies/Shipment APIs/Tracking/Update a shipment's tracking details category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/tracking

Randomization and Supplies/Shipment APIs/Tracking/Update tracking details for an order shipment

The operations from the Randomization and Supplies/Shipment APIs/Tracking/Update tracking details for an order shipment category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking

Randomization and Supplies/Study Import APIs/Get unique values for treatments, stratums or cohorts from a CSV file

The operations from the Randomization and Supplies/Study Import APIs/Get unique values for treatments, stratums or cohorts from a CSV file category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/import/{studyId}/{version}

Randomization and Supplies/Study Import APIs/Update study version

The operations from the Randomization and Supplies/Study Import APIs/Update study version category.

v1.0: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/studyversions/{version}

Randomization and Supplies/Subject APIs/Check if titration has any impact on kit dispensation

The operations from the Randomization and Supplies/Subject APIs/Check if titration has any impact on kit dispensation category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-impact

Randomization and Supplies/Subject APIs/Get a list of all randomized subjects

The operations from the Randomization and Supplies/Subject APIs/Get a list of all randomized subjects category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/randomized

Randomization and Supplies/Subject APIs/Get a list of all subjects

The operations from the Randomization and Supplies/Subject APIs/Get a list of all subjects category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{siteId}/subjects

Randomization and Supplies/Subject APIs/Retrieves the visit date for a particular subject ID and visit ID

The operations from the Randomization and Supplies/Subject APIs/Retrieves the visit date for a particular subject ID and visit ID category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/visits/{visitId}/status

Randomization and Supplies/Titration APIs/Check if subject is eligible for titration

The operations from the Randomization and Supplies/Titration APIs/Check if subject is eligible for titration category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible

Randomization and Supplies/Visit APIs/Get code break

The operations from the Randomization and Supplies/Visit APIs/Get code break category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak

Randomization and Supplies/Visit APIs/Get code view

The operations from the Randomization and Supplies/Visit APIs/Get code view category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview

Randomization and Supplies/Visit APIs/Get dispensation history

The operations from the Randomization and Supplies/Visit APIs/Get dispensation history category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v10.0: Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v11.0: Method: get
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
v9.0: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Randomization and Supplies/Visit APIs/Get dispensation info for a subject

The operations from the Randomization and Supplies/Visit APIs/Get dispensation info for a subject category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/visits/{visitId}

Randomization and Supplies/Visit APIs/Get dose hold history

The operations from the Randomization and Supplies/Visit APIs/Get dose hold history category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld-history

Randomization and Supplies/Visit APIs/Get kits allowed for dose hold

The operations from the Randomization and Supplies/Visit APIs/Get kits allowed for dose hold category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds

Randomization and Supplies/Visit APIs/Get kits which are marked as dose hold

The operations from the Randomization and Supplies/Visit APIs/Get kits which are marked as dose hold category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld

Randomization and Supplies/Visit APIs/Get list of visits

The operations from the Randomization and Supplies/Visit APIs/Get list of visits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits

Randomization and Supplies/Visit APIs/Get randomization history

The operations from the Randomization and Supplies/Visit APIs/Get randomization history category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history

Randomization and Supplies/Visit APIs/Get reusable kits

The operations from the Randomization and Supplies/Visit APIs/Get reusable kits category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits

Randomization and Supplies/Visit APIs/Get reusable kits from a list of kit types

The operations from the Randomization and Supplies/Visit APIs/Get reusable kits from a list of kit types category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits

Randomization and Supplies/Visit APIs/Get subject treatment

The operations from the Randomization and Supplies/Visit APIs/Get subject treatment category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/treatment

Randomization and Supplies/Visit APIs/Get treatment arm and cohort for a subject

The operations from the Randomization and Supplies/Visit APIs/Get treatment arm and cohort for a subject category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/details

Randomization and Supplies/Visit APIs/Get treatment arm for a list of subjects

The operations from the Randomization and Supplies/Visit APIs/Get treatment arm for a list of subjects category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment

Randomization and Supplies/Visit APIs/Get treatment arm for a list of subjects IDs

The operations from the Randomization and Supplies/Visit APIs/Get treatment arm for a list of subjects IDs category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment

Randomization and Supplies/Visit APIs/Get unblinded dispensation history

The operations from the Randomization and Supplies/Visit APIs/Get unblinded dispensation history category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history

Randomization and Supplies/Visit APIs/Get unblinded dispensation history for all subjects

The operations from the Randomization and Supplies/Visit APIs/Get unblinded dispensation history for all subjects category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-disp-history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-disp-history
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/unblinded-disp-history
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/unblinded-disp-history
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/unblinded-disp-history

Randomization and Supplies/Visit APIs/Get unblinded randomization history

The operations from the Randomization and Supplies/Visit APIs/Get unblinded randomization history category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history

Randomization and Supplies/Visit APIs/Get unblinded randomization history for all subjects

The operations from the Randomization and Supplies/Visit APIs/Get unblinded randomization history for all subjects category.

v1.0: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-rand-history
v2.0: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-rand-history

Randomization and Supplies/Visit APIs/Get visit by visit ID

The operations from the Randomization and Supplies/Visit APIs/Get visit by visit ID category.

v10.0: Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit
v11.0: Method: get
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit
v12.0: Method: get
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit
v13.0: Method: get
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit
v14.0: Method: get
Path: /ec-ors-svc/rest/v14.0/studies/{studyId}/{mode}/visits/subjectvisit
v15.0: Method: get
Path: /ec-ors-svc/rest/v15.0/studies/{studyId}/{mode}/visits/subjectvisit
v16.0: Method: get
Path: /ec-ors-svc/rest/v16.0/studies/{studyId}/{mode}/visits/subjectvisit
v17.0: Method: get
Path: /ec-ors-svc/rest/v17.0/studies/{studyId}/{mode}/visits/subjectvisit
v3.0: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
v4.0: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
v5.0: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit
v6.0: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
v7.0: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
v8.0: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
v9.0: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/Migrate dispensation

The operations from the Randomization and Supplies/Visit APIs/Migrate dispensation category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits/migrateDispensation

Randomization and Supplies/Visit APIs/Randomize a subject or dispense a kit during a visit

The operations from the Randomization and Supplies/Visit APIs/Randomize a subject or dispense a kit during a visit category.

v10.0: Method: post
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit
v11.0: Method: post
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit
v12.0: Method: post
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit
v13.0: Method: post
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit
v14.0: Method: post
Path: /ec-ors-svc/rest/v14.0/studies/{studyId}/{mode}/visits/subjectvisit
v15.0: Method: post
Path: /ec-ors-svc/rest/v15.0/studies/{studyId}/{mode}/visits/subjectvisit
v16.0: Method: post
Path: /ec-ors-svc/rest/v16.0/studies/{studyId}/{mode}/visits/subjectvisit
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
v5.0: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit
v6.0: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
v7.0: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
v8.0: Method: post
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
v9.0: Method: post
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/Replace a subject's kits

The operations from the Randomization and Supplies/Visit APIs/Replace a subject's kits category.

v1.0: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
v2.0: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
v3.0: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits
v4.0: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits

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 report based on query parameters: Method: delete
Path: /ec-reporting-svc/rest/v1.0/reports
Generate a scheduled report: Method: post
Path: /ec-reporting-svc/rest/v1.0/scheduled/reports
Generate report based on search specifications and query parameters: Method: post
Path: /ec-reporting-svc/rest/v1.0/reports
Generate report based on the direct report payload: Method: post
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/direct
Get metadata for all reports based on query parameters: Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata
Kickstart the generation of report: Method: post
Path: /ec-reporting-svc/rest/v1.0/report/job/{jobId}
Submit request for sending notifications: Method: post
Path: /ec-reporting-svc/rest/v1.0/notification/{notificationType}

Reporting/v2.0

The operations from the Reporting/v2.0 category.

Download report for a given report job ID: Method: get
Path: /ec-reporting-svc/rest/v2.0/reports/download
Generate a scheduled report: Method: post
Path: /ec-reporting-svc/rest/v2.0/scheduled/reports
Generate report based on the direct report payload: Method: post
Path: /ec-reporting-svc/rest/v2.0/studies/{studyId}/{mode}/reports/direct
Get generated reports available for download: Method: get
Path: /ec-reporting-svc/rest/v2.0/reportmetadata/downloadList

Rules/Reporting/v1.0

The operations from the Rules/Reporting/v1.0 category.

[Deprecated]: Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Reporting/v2.0

The operations from the Rules/Reporting/v2.0 category.

[Deprecated]: Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Reporting/v3.0

The operations from the Rules/Reporting/v3.0 category.

[Deprecated]: Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Reporting/v4.0

The operations from the Rules/Reporting/v4.0 category.

[Deprecated]: Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v4.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Reporting/v5.0

The operations from the Rules/Reporting/v5.0 category.

Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v5.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Reporting/v6.0

The operations from the Rules/Reporting/v6.0 category.

Generate Rule Designer reports: Method: post
Path: /ec-rule-designer-svc/rest/v6.0/studies/{studyId}/{mode}/report/{reportName}

Rules/Rule Management/v1.0

The operations from the Rules/Rule Management/v1.0 category.

[Deprecated]: Copy rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/bulkcopy
[Deprecated]: Copy Rules to newly copied study: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/copyrules
[Deprecated]: 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
[Deprecated]: Get rule by item ID: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/item/{itemId}
[Deprecated]: Get rule by property: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
[Deprecated]: Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
[Deprecated]: Get rule job statuses: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/jobStatus
[Deprecated]: Get rule Operands list by rule IDs: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleIds/operands
[Deprecated]: Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkupdate
Allow rules to run on either All or Future data: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/{publishRun}
Cancel job: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/cancelRuleJob
Delete rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkdelete
Delete UI rules by 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}
Get all rule states: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/rulestates
Get all rules based on filter parameters: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/filteredlist
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 history by study ID, ruleid and optionally study mode: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{ruleId}/rulehistory
Get rules by study ID and study mode: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}
Get valid and enabled rules by form ID: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}/valid
Get visits and forms action information.: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/versions/{version}/formId/{formId}
Publish a collection of rules in Testing mode: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/publish
Rule re-run history: Method: get
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/rerunhistory/{ruleId}
Validate copied rules: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/validateCopiedRules

Rules/Rule Management/v2.0

The operations from the Rules/Rule Management/v2.0 category.

[Deprecated]: Copy rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/bulkcopy
[Deprecated]: Get rule by item ID: Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/item/{itemId}
[Deprecated]: Get rule by property: Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}
[Deprecated]: Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
[Deprecated]: Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/bulkupdate
Copy Rules to newly copied study: Method: post
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/copyrules
Get all rules by form ID, question ID, or other parameters.: Method: get
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/simple
Get rule job statuses: Method: put
Path: /ec-rule-svc/rest/v2.0/studies/{studyId}/{mode}/jobStatus
Get rule Operands list by rule IDs: Method: post
Path: /ec-rule-designer-svc/rest/v2.0/rule/studies/{studyId}/{mode}/ruleIds/operands

Rules/Rule Management/v3.0

The operations from the Rules/Rule Management/v3.0 category.

[Deprecated]: Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
[Deprecated]: Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/bulkupdate
Copy rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/bulkcopy
Get rule by item ID: Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/item/{itemId}
Get rule by property: Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/propertyType/{propertyType}

Rules/Rule Management/v4.0

The operations from the Rules/Rule Management/v4.0 category.

[Deprecated]: Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v4.0/rule/studies/{studyId}/{mode}/bulkupdate

Rules/Rule Management/v5.0

The operations from the Rules/Rule Management/v5.0 category.

Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v5.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v5.0/rule/studies/{studyId}/{mode}/bulkupdate

Rules/Rule Management/v6.0

The operations from the Rules/Rule Management/v6.0 category.

Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v6.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}
Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v6.0/rule/studies/{studyId}/{mode}/bulkupdate

Rules/Rule Management/v7.0

The operations from the Rules/Rule Management/v7.0 category.

Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v7.0/rule/studies/{studyId}/{mode}/bulkupdate

Sites and Depots/Addresses/v1.0

The operations from the Sites and Depots/Addresses/v1.0 category.

Get address details: Method: get
Path: /ec-site-svc/rest/v1.0/addresses

Sites and Depots/Contact/v1.0

The operations from the Sites and Depots/Contact/v1.0 category.

Create contact: Method: post
Path: /ec-site-svc/rest/v1.0/contacts
Delete contact by ID: Method: delete
Path: /ec-site-svc/rest/v1.0/contacts/contact/{contactId}
Delete contact by ID with a reason: Method: put
Path: /ec-site-svc/rest/v1.0/contacts/deleteContact/{id}
Get contacts: Method: get
Path: /ec-site-svc/rest/v1.0/contacts
Get contacts by contact ID: Method: get
Path: /ec-site-svc/rest/v1.0/contacts/{contactId}
Update contact: Method: put
Path: /ec-site-svc/rest/v1.0/contacts/{contactId}
Validate contact fields: Method: post
Path: /ec-site-svc/rest/v1.0/contacts/validateFields

Sites and Depots/Contact/v2.0

The operations from the Sites and Depots/Contact/v2.0 category.

Delete contact by ID with a reason: Method: put
Path: /ec-site-svc/rest/v2.0/contacts/deleteContact/{id}
Get contacts details: Method: get
Path: /ec-site-svc/rest/v2.0/contacts

Sites and Depots/Country/v1.0

The operations from the Sites and Depots/Country/v1.0 category.

[Deprecated]: Get association between country and site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfcountry
[Deprecated]: Get country name: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country
[Deprecated]: Get states based on country ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}/states
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 country based on country ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}
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.

[Deprecated]: Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfcountry
[Deprecated]: Get country name: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country
Associate countries and states to site or depot: Method: post
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{sdfId}
Get states with hidden flag based on country ID: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{countryId}/states
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.

[Deprecated]: Get country name: Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/country
Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/sdfcountry

Sites and Depots/Country/v4.0

The operations from the Sites and Depots/Country/v4.0 category.

[Deprecated]: Get country name: Method: get
Path: /ec-site-svc/rest/v4/studies/{studyId}/{mode}/country
Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v4/studies/{studyId}/{mode}/sdfcountry

Sites and Depots/Country/v5.0

The operations from the Sites and Depots/Country/v5.0 category.

Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v5.0/studies/{studyId}/{mode}/sdfcountry
Get country name: Method: get
Path: /ec-site-svc/rest/v5.0/studies/{studyId}/{mode}/country

Sites and Depots/EHR Connectors/v1.0

The operations from the Sites and Depots/EHR Connectors/v1.0 category.

Get EHR Connectors: Method: get
Path: /ec-site-svc/rest/v1.0/EHRConnectors

Sites and Depots/Entity Management/v1.0

The operations from the Sites and Depots/Entity Management/v1.0 category.

Get all study contacts or organization entities: Method: get
Path: /ec-site-svc/rest/v1.0/entitymanagement/studyentities/{entityType}/{tenantEntityId}/details
Get all tenant contacts or organization entities: Method: get
Path: /ec-site-svc/rest/v1.0/entitymanagement/tenantentities/{entityType}/{tenantEntityId}/details
Manage a given study entity associated with a contact or organization: Method: put
Path: /ec-site-svc/rest/v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage
Manage all associated entities with given contact or organization: Method: put
Path: /ec-site-svc/rest/v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage/all

Sites and Depots/Facilities/v1.0

The operations from the Sites and Depots/Facilities/v1.0 category.

Create facilities: Method: post
Path: /ec-site-svc/rest/v1.0/facilities/{InstitutionId}
Get facilities: Method: get
Path: /ec-site-svc/rest/v1.0/facilities/{InstitutionId}
Update facilities: Method: put
Path: /ec-site-svc/rest/v1.0/facilities/{InstitutionId}

Sites and Depots/Labs/v1.0

The operations from the Sites and Depots/Labs/v1.0 category.

[Deprecated]: Add an association between a lab and a site: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
[Deprecated]: Create a lab: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
[Deprecated]: Delete lab if site association does not exist: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
[Deprecated]: Delete the lab's association with the given site: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
[Deprecated]: Get all labs associated with a given site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
[Deprecated]: Update a lab: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Create or update lab normals: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals
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 lab normals for the given list of lab criteria: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals/bulkLookUp
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 lab ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}/history

Sites and Depots/Labs/v2.0

The operations from the Sites and Depots/Labs/v2.0 category.

Create a lab: Method: post
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs
Create an association between a lab and a study site: Method: post
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs/siteslabs
Create or update lab normals for a study lab: Method: put
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals
Delete the lab and study site association: Method: delete
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/siteslabs
Get all lab normals for a study lab: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals
Get all lab normals for given search criteria: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals/lookup
Get all labs associated with a given site: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs
Update a lab at tenant level: Method: put
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/labs/{studyLabId}

Sites and Depots/Labs/v3.0

The operations from the Sites and Depots/Labs/v3.0 category.

Create or update lab normals for a study lab: Method: put
Path: /ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/labs/{studyLabId}/labnormals
Get all labs associated with a given site: Method: get
Path: /ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/labs

Sites and Depots/Organizations/v1.0

The operations from the Sites and Depots/Organizations/v1.0 category.

Create organization: Method: post
Path: /ec-site-svc/rest/v1.0/organizations
Delete organization by ID: Method: delete
Path: /ec-site-svc/rest/v1.0/organizations/{id}
Delete organization by ID with reason: Method: put
Path: /ec-site-svc/rest/v1.0/organizations/deleteOrganization/{id}
Get organization by ID: Method: get
Path: /ec-site-svc/rest/v1.0/organizations/{id}
Get organizations: Method: get
Path: /ec-site-svc/rest/v1.0/organizations
Update organization by ID: Method: put
Path: /ec-site-svc/rest/v1.0/organizations/{id}
Validate organization fields: Method: post
Path: /ec-site-svc/rest/v1.0/organizations/validateFields

Sites and Depots/Organizations/v2.0

The operations from the Sites and Depots/Organizations/v2.0 category.

Delete organization by ID with reason: Method: put
Path: /ec-site-svc/rest/v2.0/organizations/deleteOrganization/{id}
Get organizations details: Method: get
Path: /ec-site-svc/rest/v2.0/organizations

Sites and Depots/Region/v1.0

The operations from the Sites and Depots/Region/v1.0 category.

[Deprecated]: Add a region: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
[Deprecated]: Get a region's details: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
[Deprecated]: Get list of countries associated to a region: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}/countries
[Deprecated]: Get list of regions: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
[Deprecated]: Get region by country: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/filter/countries/{countryId}
[Deprecated]: Update a region and associated countries: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Delete a region: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Get list of countries and states with hidden flag associated to a region: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/regions/countries/history
Get list of regions with history: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/regions/history

Sites and Depots/Region/v2.0

The operations from the Sites and Depots/Region/v2.0 category.

[Deprecated]: Get list of countries and states associated to a region: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}/countries
[Deprecated]: Get list of regions: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions
[Deprecated]: Get region details: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}
Add a region: Method: post
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}
Update region and its associated countries and states list: Method: put
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}

Sites and Depots/Region/v3.0

The operations from the Sites and Depots/Region/v3.0 category.

Get list of countries and states associated to a region: Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/regions/{regionId}/countries
Get list of regions: Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/regions
Get region details: Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/regions/{regionId}

Sites and Depots/Site or Depot (SDF)/Kit Settings/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/Kit Settings/v1.0 category.

Create kit settings by SDF ID: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Get all kit type IDs and main primary countries that are locally sourced and assigned to the sites: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/locallySourced
Get all sites main primary country having non locally sourced kits by kit type ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/kitSettings/{kitTypeId}
Get kit settings by SDF ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Update kit settings by SDF ID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Update Ship To Address of a kit Type: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{kitTypeId}/shipToAddress

Sites and Depots/Site or Depot (SDF)/Reporting/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/Reporting/v1.0 category.

Generate report for sites: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}
Generate specific report for sites: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/report/{reportName}

Sites and Depots/Site or Depot (SDF)/Reporting/v2.0

The operations from the Sites and Depots/Site or Depot (SDF)/Reporting/v2.0 category.

Generate report for sites: Method: post
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}

Sites and Depots/Site or Depot (SDF)/Reporting/v3.0

The operations from the Sites and Depots/Site or Depot (SDF)/Reporting/v3.0 category.

Generate report for sites: Method: post
Path: /ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}

Sites and Depots/Site or Depot (SDF)/SDF LOV/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/SDF 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 or Depot (SDF)/SDF LOV/v2.0

The operations from the Sites and Depots/Site or Depot (SDF)/SDF LOV/v2.0 category.

Get sites, depots and labs in a study by path attributes: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/lov/{pathAttr}

Sites and Depots/Site or Depot (SDF)/SDF Management/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/SDF Management/v1.0 category.

[Deprecated]: Create a site: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
[Deprecated]: Create a site and send notification: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf
[Deprecated]: Delete a site by ID: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
[Deprecated]: Delete depot email: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
[Deprecated]: Get a site by ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
[Deprecated]: Get a site by SDF ID for a tenant: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/tenant/{sdfId}
[Deprecated]: Get all sites by type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/all
[Deprecated]: Get countries for a site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/countries
[Deprecated]: Get site by filter parameters: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/siteFilterPaginated
[Deprecated]: Get site by site name or address and type of SDF: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/search
[Deprecated]: 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
[Deprecated]: Get sites by type or list of countries: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
[Deprecated]: Get sites on search key: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/searchSite
[Deprecated]: 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
[Deprecated]: Update a site: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
[Deprecated]: Update a site and send notification: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}
Clear site's SDFs cached data by study ID and mode: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/clearsitecache
Create depot association with country or state by GUID: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Create site or depot with study ID and master address: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}
Delete site, master address, properties and kit settings by SDF ID: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Get all return depot properties details: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/depot/{pathAttr}
Get all sites and depots details by study ID based on given filters: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}
Get all sites by type and study version: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/allstudyversions
Get all sites details or depots details by study ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allSdf/{sdfType}
Get all study versions for a site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allstudyversions/{sdfType}
Get countries for a site by SDF type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/countries
Get locally sourced kits by site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/locallySourcedKitsBySite
Get SDF countries or states associated with depot GUID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Get SDF details for IDs sent in payload: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/sdfDetails
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 site name and address: Method: get
Path: /ec-site-svc/rest/v1/tenant/sdfs/autoSuggest
Get site or depot details by SDF ID and SDF Type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Get site or depot information by ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/sdfRegion/{sdfId}
Get study site details with study version property by site ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/site/{mode}/{sdfId}
Update all sites with a new study version: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/versionupdate
Update or delete depot association with country or state by GUID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Update SDF status for the given study ID, mode ID and SDF type: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/status
Update site or depot with study ID and master address: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Update site properties for managing sites: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/multiple

Sites and Depots/Site or Depot (SDF)/SDF Management/v2.0

The operations from the Sites and Depots/Site or Depot (SDF)/SDF Management/v2.0 category.

[Deprecated]: Get a site by ID: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/{sdfId}
[Deprecated]: Get countries by type: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/countries
[Deprecated]: Get sites in a paginated format: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/paginated
Get all sites and depots details by study ID based on given filters: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}
Get principal investigator's name and site address: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/pinaddr
Get site or depot details by SDF ID and SDF Type: Method: get
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}

Sites and Depots/Site or Depot (SDF)/Site Address/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/Site Address/v1.0 category.

[Deprecated]: Create site address: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address
[Deprecated]: Delete site address by site and address ID: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}
[Deprecated]: 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 or Depot (SDF)/Site Extended Property/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/Site Extended Property/v1.0 category.

Create extended properties by site ID: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedProperties
Create or update extended properties for all sites: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedPropertiesByFilter
Update extended properties by site ID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedProperties

Sites and Depots/Site or Depot (SDF)/Site Property/v1.0

The operations from the Sites and Depots/Site or Depot (SDF)/Site Property/v1.0 category.

[Deprecated]: Create site property: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
[Deprecated]: Delete SDF property by property ID: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
[Deprecated]: Get all properties of the site by SDF ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
[Deprecated]: Get site property by SDF and property ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
[Deprecated]: Update the SDF property of the site by ID: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Create site global property: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties
Delete SDF global property by property ID: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propId}
Delete SDF property by property ID: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Get global site property by property name: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propName}
Update the site global property by ID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties

Sites and Depots/Sites and Depots/Facilities/v1.0

The operations from the Sites and Depots/Sites and Depots/Facilities/v1.0 category.

Validate fields for study labs, depots or sites: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/validateFields

Sites and Depots/Tenant Sites/v1.0

The operations from the Sites and Depots/Tenant Sites/v1.0 category.

Associate two entities: Method: post
Path: /ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations
Create study sites by association ID: Method: post
Path: /ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/studySites
Delete contact organization association if not used in site: Method: delete
Path: /ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}
Get all valid associations by Association Type: Method: get
Path: /ec-site-svc/rest/v1.0/tenantsite/{associationType}/associations
Get contacts and organization association list by ID: Method: get
Path: /ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations
Get study sites by mode ID and association ID: Method: get
Path: /ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/studySites
Get tenant first entity addresses by Association ID: Method: get
Path: /ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/addresses
Update the association between two entities: Method: put
Path: /ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations

Sites and Depots/v1.0

The operations from the Sites and Depots/v1.0 category.

Get site or depot details by SDF ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/id/{sdfId}

Sites/v1.0

The operations from the Sites/v1.0 category.

Get list of sites in a study: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/site/all

Users, Permissions and Roles/Data Classification/v1.0

The operations from the Users, Permissions and Roles/Data Classification/v1.0 category.

[Deprecated] Get list of data classification for a tenant: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification
[Deprecated]: Get list of data classification with levels: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/{mode}/user/{userId}
[Deprecated]: Get tenant data classifications for study role: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/studyrole/{studyRoleId}
Assign data classifications to study role for study ID: Method: put
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyrole/{studyRoleId}
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 a list of data classifications by study roles for a tenant: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/studyroles
Get data classifications for 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 specific data classifications for all study roles of a study: Method: put
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

Users, Permissions and Roles/Data Classification/v2.0

The operations from the Users, Permissions and Roles/Data Classification/v2.0 category.

Get list of data classification for a study ID: Method: get
Path: /ec-auth-svc/rest/v2.0/dataclassification/{studyId}
Get list of data classification for a tenant: Method: get
Path: /ec-auth-svc/rest/v2.0/dataclassification
Get list of data classification with levels: Method: get
Path: /ec-auth-svc/rest/v2.0/dataclassification/{studyId}/{mode}/user/{userId}
Get tenant data classifications for study role: Method: get
Path: /ec-auth-svc/rest/v2.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 rights for user in a study: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users/{userId}/userrights
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

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}
Generate a user assignment report (global level): Method: post
Path: /ec-auth-svc/rest/v1.0/report/globalstudyrole/{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 User Assignment Report: Method: post
Path: /ec-auth-svc/rest/v2.0/{studyId}/{mode}/report/{reportName}
Generate User Upload Error Report: Method: post
Path: /ec-auth-svc/rest/v2.0/{studyId}/{mode}/report/uploaderror/{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
Get the list of study roles containing particular rights: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}/rolesRights

Users, Permissions and Roles/Roles/Authorization Roles/v2.0

The operations from the Users, Permissions and Roles/Roles/Authorization Roles/v2.0 category.

[Deprecated]: Get the list of roles: Method: get
Path: /ec-auth-svc/rest/v2.0/authroles

Users, Permissions and Roles/Roles/Authorization Roles/v3.0

The operations from the Users, Permissions and Roles/Roles/Authorization Roles/v3.0 category.

Get list of roles for a study: Method: get
Path: /ec-auth-svc/rest/v3.0/authroles/{studyId}
Get the list of roles: Method: get
Path: /ec-auth-svc/rest/v3.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.

[Deprecated]: Get list of study roles for an organization: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles
[Deprecated]: Get the list of study roles for a study ID: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
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 for a study role for a study ID: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyroleId}/study/{studyId}/rightsgroups
Get list of study roles for study ID and study Role ID: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}/{studyRoleId}
Get study roles list for a study role ID: 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 role 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.

[Deprecated]: Get list of study roles for an organization: Method: get
Path: /ec-auth-svc/rest/v2.0/studyroles
[Deprecated]: Get the list of study roles for a study ID: Method: get
Path: /ec-auth-svc/rest/v2.0/studyroles/{studyId}

Users, Permissions and Roles/Roles/Study Roles/v3.0

The operations from the Users, Permissions and Roles/Roles/Study Roles/v3.0 category.

Get list of study roles for an organization: Method: get
Path: /ec-auth-svc/rest/v3.0/studyroles
Get the list of study roles for a study ID: Method: get
Path: /ec-auth-svc/rest/v3.0/studyroles/{studyId}

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.

[Deprecated]: Get a user's modes and roles: Method: get
Path: /ec-auth-svc/rest/v2.0/authusers/{userid}/studies/{studyId}
[Deprecated]: Get list of roles for a study: Method: get
Path: /ec-auth-svc/rest/v2.0/authroles/{studyId}
Get a global user's roles: Method: get
Path: /ec-auth-svc/rest/v2.0/globalusers/{userid}/roles
Get user roles in a study: Method: get
Path: /ec-auth-svc/rest/v2.0/authstudies/{studyId}/userroles

Users, Permissions and Roles/Roles/v3.0

The operations from the Users, Permissions and Roles/Roles/v3.0 category.

[Deprecated]: Get a user's modes and roles: Method: get
Path: /ec-auth-svc/rest/v3.0/authusers/{userid}/studies/{studyId}

Users, Permissions and Roles/Roles/v5.0

The operations from the Users, Permissions and Roles/Roles/v5.0 category.

Get a user's modes and roles: Method: get
Path: /ec-auth-svc/rest/v5.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 template API/v1.0

The operations from the Users, Permissions and Roles/Users template API/v1.0 category.

Download the Clinical One upload user template file to create users: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}/usersuploadtemplate
Download the Clinical One upload user template file to update users: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}/usersupdatetemplate

Users, Permissions and Roles/Users/v1.0

The operations from the Users, Permissions and Roles/Users/v1.0 category.

[Deprecated]: Get list of users: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers
[Deprecated]: Get user details by user ID: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}
Bulk user effective dates update: Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/users/effectivedates
Bulk user roles update: Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/users/roles
Bulk user sites update: Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/users/sites
Create and assign bulk users: Method: post
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/bulk
Delete user attributes by user ID: Method: delete
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/locale
Get a global user's details by user ID: Method: get
Path: /ec-auth-svc/rest/v1.0/globalusers/{userid}
Get all active and 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 study users' details: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users/detail
Get all users for a study: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/paginatedUsers
Get all users for a study mode: Method: post
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/userdetails
Get all users who has access to site and depot for a study as logged in user: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/siteDepot/users
Get requested active users for a study with study roles and email address: Method: post
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/users
Get user language by user ID: 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 site: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/sites/{siteId}/users
Get Users for Notification Right: Method: get
Path: /ec-auth-svc/rest/v1.0/notifications/{rightname}/users
Get users for rights list: Method: get
Path: /ec-auth-svc/rest/v1.0/userinfo/bulk
Get users with a certain role: Method: get
Path: /ec-auth-svc/rest/v1.0/users/role/{role}
Update auth user attributes by user ID: Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/locale
Verify Right Name: Method: get
Path: /ec-auth-svc/rest/v1.0/rightname/{rightname}

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
[Deprecated]: Get global roles users: Method: get
Path: /ec-auth-svc/rest/v2.0/globalroles/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 active users for a study with study roles and email address: Method: post
Path: /ec-auth-svc/rest/v2.0/authstudies/{studyId}/{mode}/users/studyroles
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/globalusers
Get global users unassigned to a study: Method: get
Path: /ec-auth-svc/rest/v2.0/globalroles/users/unassigned
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}
Get users for rights list: Method: get
Path: /ec-auth-svc/rest/v2.0/userinfo/bulk

Users, Permissions and Roles/Users/v3.0

The operations from the Users, Permissions and Roles/Users/v3.0 category.

[Deprecated]: Get all users for a study: Method: get
Path: /ec-auth-svc/rest/v3.0/authstudies/{studyId}/users
Get global roles 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