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}
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]: 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 code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v2.0/codelist/values/{fieldName}
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
Get code list matching the given parameters: Method: get
Path: /ec-codelist-svc/rest/v3.0/codelist/values/{fieldName}
Insert a new code in a code list: Method: post
Path: /ec-codelist-svc/rest/v3.0/codelist/code
Update code list with tags by code list ID: Method: put
Path: /ec-codelist-svc/rest/v3.0/codelist/code/{codeId}

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
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}

Coding/Query Resource/v1.0

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

Create queries/discrepancies: Method: post
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query
Get query details by query ID or discrepancyId and revision number: Method: post
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query/discrepancy
Get query details on a verbatim term from Clinical One: Method: get
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query/transaction
Update status of created queries/discrepancies: Method: put
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query

Coding/Service Status/v1.0

The operations from the Coding/Service Status/v1.0 category.

Get the list of verbatim terms to code: Method: get
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/verbatimTerms
Put coded verbatims terms in DCS: Method: put
Path: /ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/codedValues

Comments/v1.0

The operations from the Comments/v1.0 category.

Adds a comment or reply to an object.: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments
Delete a comment or reply.: Method: delete
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/{commentId}
Get all comments for a particular object.: Method: get
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/{objectId}
Get unread comments count for a particular object.: Method: get
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/{objectId}/unreadCount
Get unread comments count for list of objects.: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects/unreadCount
Marks comments for the user as read: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/markAsRead
Marks comments for the user as unread: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/markAsUnRead
Post a comment or reply.: Method: post
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/objects
Updates a comment.: Method: put
Path: /ec-comment-svc/rest/v1.0/studies/{studyId}/comments/{commentId}

Data Actions/Data Elements/v1.0

The operations from the Data Actions/Data Elements/v1.0 category.

[Deprecated]: Get data elements summary for locked or frozen items at row level: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Create data elements items summary for locked or frozen: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/validate/multipleitems
Get all items with source data verification information: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/sdv
Get data elements validation summary for locked or frozen items at row level: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/validate/dataelements

Data Actions/Freeze/v1.0

The operations from the Data Actions/Freeze/v1.0 category.

Freeze multiple data elements for a subject: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze
Unfreeze single data element of a visit: Method: put
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}

Data Actions/Lock/v1.0

The operations from the Data Actions/Lock/v1.0 category.

[Deprecated]: Get item level lock records for an item: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks
Get all Lock records for a visit: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/all
Get all Subject Lock records: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects-with-locked-data
Get item level Lock records for a subject: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/multipleitems/locks
Get visit level Lock records for a visit: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks/visits
Lock data elements in a visit: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/locks
Lock the subject level record for given Subject Id: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/lock
Locks data elements in a subject: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/lock/allvisit

Data Actions/Lock/v2.0

The operations from the Data Actions/Lock/v2.0 category.

Get item level lock records for an item: Method: get
Path: /ec-dataction-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks

Data Actions/Lock/v3.0

The operations from the Data Actions/Lock/v3.0 category.

Get item level lock records for an item: Method: get
Path: /ec-dataction-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/forms/{formId}/items/{itemId}/locks

Data Actions/Multiple Visits/v1.0

The operations from the Data Actions/Multiple Visits/v1.0 category.

Create request for multiple locked visits summary: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/validate/multiplevisits

Data Actions/Sign Evaluation/v1.0

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

Calculate overdue and trigger mail notification to users with the specified roleId: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/triggeremail
Process sign evaluation from data change event: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/processque

Data Actions/Sign Verify Resource/v1.0

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

Check if scope type (ITEM/VSD) item in request is eligible for clearing its data: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/cleardatacheck/{scope}
Get number of all due and overdue signatures for a study: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signevaluation/configchange/studysummary
Get sign information: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signinfo
Unsign and unverify data: Method: put
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverify
Unsign and unverify item: Method: put
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/unsign-unverifyforitem
Update sign information: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signinfo

Data Actions/Sign Verify Resource/v2.0

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

Check if scope type (ITEM/VSD) item in request is eligible for clearing its data: Method: post
Path: /ec-dataction-svc/rest/v2.0/studies/{studyId}/{mode}/cleardatacheck/{scope}

Data Actions/Signature Configuration/v1.0

The operations from the Data Actions/Signature Configuration/v1.0 category.

Delete record from sign configuration: Method: delete
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{id}
Get signature configuration of a study: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration
Save signature configuration of a study: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration
Update signature configuration of a study: Method: put
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signconfiguration/{signConfigurationId}

Data Actions/Subjects/Unlock Visits/v1.0

The operations from the Data Actions/Subjects/Unlock Visits/v1.0 category.

Unlock everything inside the subject for given subject ID: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlockvisits

Data Actions/Subjects/Unlock/v1.0

The operations from the Data Actions/Subjects/Unlock/v1.0 category.

Unlock the subject level record for given subject ID: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/unlock

Data Actions/Unlock/v1.0

The operations from the Data Actions/Unlock/v1.0 category.

Unlock the given records for a visit: Method: post
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/events/{eventId}/unlocks

Data Actions/v1.0

The operations from the Data Actions/v1.0 category.

Get list of svf by study: Method: get
Path: /ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/svf

Data Capture/Coding Status/v1.0

The operations from the Data Capture/Coding Status/v1.0 category.

[Deprecated]: Get data elements to be coded by codeType: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus
Get data elements to be coded using source IDs: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus
Update multiple coded data elements for a source data element: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus/codedItems

Data Capture/DCProperties APIs/v1.0

The operations from the Data Capture/DCProperties APIs/v1.0 category.

Get audit history of a property: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/history/{id}
Get Data Capture properties: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{id}

Data Capture/Data Elements/v1.0

The operations from the Data Capture/Data Elements/v1.0 category.

[Deprecate]: Get the deleted data element: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
[Deprecated]: Create multiple data elements for repeating form: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multirepeatingform
[Deprecated]: Delete the data elements for a visit and for a form: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all items with source data verification information: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/sdv
[Deprecated]: Get data elements by form ID, Subject ID, Event ID and Vendor code: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/vendorCode/{vendorCode}/dataelements/withvendorcode
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: Get data elements for multiple items: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/multiple
[Deprecated]: Get data elements history with pagination: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/all
[Deprecated]: Get form associations by study ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/formassociations
[Deprecated]: Get the deleted data elements in a form: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/form/dataelements
[Deprecated]: Update multiple data elements for a subject: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements
Clear data elements scope by study ID and mode: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
Create data elements for a visit and for a flat port of multi section form: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Create data elements for a visit and for a form: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode
Create data elements for a visit and for a repeat port of multi section form: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Create migrate data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/migratedata
Create multiple data elements for a subject in a form with form associations: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations
Create source data verification group: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup
Delete data elements for a visit and for a form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/dataelements/delete
Freeze multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/freeze
Get all existing data elements across all repeating form/visit instances: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/repeatinginstances/subjectId/{subjectId}
Get all source data verification groups: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup/all
Get data elements along with form associations: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get data elements based on subject, visit, and form: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/forms/{formId}/dataelements
Get data elements by subject and event ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
Get data elements for a list of items by subject ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get the audit history for a data element: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the audit history for a form association: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}
Get the current status of a data element: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataelementId}
Get the data element for a subject for a form and a site: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
Get the data elements for a subject for a given date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Gets all the child items, forms and visits required to be cleared for modifying the dataelement: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/{dataelementId}/{opeartionType}/childItems
Unfreeze single data element of a visit: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}
Update a single data element for a subject: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/{dataElementId}
Update data elements for a visit and for a flat part of multi section form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Update data elements for a visit and for a form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode
Update data elements for a visit for a repeating part of multi section form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Update multiple data elements for a given form, event and subject: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations
Update source data verification group: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup
Upsert data elements for a visit and for a flat part of multi section form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat
Upsert data elements for a visit and for a form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode
Upsert data elements for a visit and for a repeat part of multi section form: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat
Verify multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/verify

Data Capture/Data Elements/v10.0

The operations from the Data Capture/Data Elements/v10.0 category.

Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element: Method: put
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v11.0

The operations from the Data Capture/Data Elements/v11.0 category.

Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element: Method: put
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v12.0

The operations from the Data Capture/Data Elements/v12.0 category.

Update single data element: Method: put
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v2.0

The operations from the Data Capture/Data Elements/v2.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Freeze multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/freeze
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get data elements for a list of item IDs: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: Get data elements for multiple items: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multiple
[Deprecated]: Get data elements history with pagination: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/all
Clear data elements scope by study ID and mode: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
Create data elements for a visit and for a flat port of multi section form: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionflat
Create data elements for a visit and for a repeat port of multi section form: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/withvendorcode/multisectionrepeat
Create multiple data elements for a subject in a form with form associations: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations
Create multiple data elements for repeating form: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
Delete the data elements for a visit and for a form, including two section forms: Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Get all the latest datalement records for a subject for a given date range: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get data elements based on subject, visit, and form: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/forms/{formId}/dataelements
Get data elements by subject and event ID: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata
Get data elements with form associations: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get the audit history for a data element: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the audit history for a form association: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/formassociations/history/sourceForm/{sourceFormId}
Get the current status of a data element: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataelementId}
Get the data element for a subject, a form and a site: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/forms/{formId}/subjects/{subjectId}/dataelements
Get the deleted data element: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Update multiple data elements for a given form, event and subject: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/subject/{subjectId}/event/{eventId}/form/{formId}/formassociations
Update single data element: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Upsert data elements for a visit and for a flat part of multi section form: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionflat
Upsert data elements for a visit and for a repeat part of multi section form: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/upsert/withvendorcode/multisectionrepeat
Verify multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/dataelements/verify

Data Capture/Data Elements/v3.0

The operations from the Data Capture/Data Elements/v3.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get data elements for a list of items by subject ID: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: Get data elements history with pagination: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/all
Clear data elements return refreshVisit status: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/clear/{scope}
Create multiple data elements for repeating form: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multirepeatingform
Delete the data elements for a visit and for a form, including two section forms: Method: delete
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/dataelements
Freeze multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/freeze
Get all the latest datalement records for a subject for a given date range: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get data elements for multiple items: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/multiple
Get data elements with form associations: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/formassociations
Get the audit history for a data element: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Get the deleted data element: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Update single data element: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Verify multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/verify

Data Capture/Data Elements/v4.0

The operations from the Data Capture/Data Elements/v4.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all the latest datalement records for a subject for a given date range: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
[Deprecated]: Get data elements for a list of items by subject ID: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for multiple items: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/multiple
Get data elements that have been deleted: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Verify multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/verify

Data Capture/Data Elements/v5.0

The operations from the Data Capture/Data Elements/v5.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for a list of items by subject ID: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v6.0

The operations from the Data Capture/Data Elements/v6.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get data elements for a visit and form combination: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
[Deprecated]: Update single data element: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/{dataElementId}
Get data elements for a list of items by subject ID: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
List all visits of subject with the form in it: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/eventsCount

Data Capture/Data Elements/v7.0

The operations from the Data Capture/Data Elements/v7.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Return list of repeatFormNumber, formSectionId and repeatInstanceNumbers: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/repeatSection/repeatInstanceNumbers
Update single data element: Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v8.0

The operations from the Data Capture/Data Elements/v8.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get all data elements based on subject and visit: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
Update single data element: Method: put
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Data Elements/v9.0

The operations from the Data Capture/Data Elements/v9.0 category.

[Deprecated]: Create multiple data elements for a subject: Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements
[Deprecated]: Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}
[Deprecated]: Update single data element: Method: put
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/dataelements/{dataElementId}

Data Capture/Electronic Signature/v1.0

The operations from the Data Capture/Electronic Signature/v1.0 category.

Get URL for IAMS login page: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/esign/geturl/orgId/{orgId}/subjectId/{subjectId}

Data Capture/Enrollment Settings/v1.0

The operations from the Data Capture/Enrollment Settings/v1.0 category.

Create enrollment settings: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings
Get specific enrollment settings: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings
Update enrollment setting: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/enrollmentsettings

Data Capture/Lab/v1.0

The operations from the Data Capture/Lab/v1.0 category.

Create lab for a subject: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals
Update lab for a subject: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/labnormals

Data Capture/Lab/v2.0

The operations from the Data Capture/Lab/v2.0 category.

Create lab for a subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals
Update lab for a subject: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/labnormals

Data Capture/Lab/v3.0

The operations from the Data Capture/Lab/v3.0 category.

Create lab for a subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/labnormals

Data Capture/Properties/v1.0

The operations from the Data Capture/Properties/v1.0 category.

Update lab for a subject: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/properties/{type}/{subjectId}/{id}

Data Capture/Subject Reports/v1.0

The operations from the Data Capture/Subject Reports/v1.0 category.

[Deprecated]: Generate a report based on the path parameter: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/reports/{reportName}
[Deprecated]: Generate a specific report: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/report/{reportName}
[Deprecated]: Generate asynchronized report for a subject's data and events: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/asynch/report/{reportName}
[Deprecated]: Generate report for a subject's data and events: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Data Capture/Subject Reports/v2.0

The operations from the Data Capture/Subject Reports/v2.0 category.

[Deprecated]: Generate a report based on the path parameter: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}

Data Capture/Subject Reports/v3.0

The operations from the Data Capture/Subject Reports/v3.0 category.

[Deprecated]: Generate reports based on the path parameter: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}

Data Capture/Subject Reports/v4.0

The operations from the Data Capture/Subject Reports/v4.0 category.

[Deprecated]: Generate a report based on the path parameter: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/report/{reportName}

Data Capture/Subject Settings/v1.0

The operations from the Data Capture/Subject Settings/v1.0 category.

Create subject settings: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Get all the mHealth settings: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings
Get all the source data verification settings: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings
Get specific subject settings: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Get the subject settings based on settings ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/{id}
Remove subject settings: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings
Update mHealth settings: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/mhealthsettings
Update source data verification settings: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings/sdvsettings
Update subject settings: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subject Settings/v2.0

The operations from the Data Capture/Subject Settings/v2.0 category.

Creates subject settings: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
Get all subject settings: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings
Update subject settings: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subject Settings/v3.0

The operations from the Data Capture/Subject Settings/v3.0 category.

Get all subject settings: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjectsettings

Data Capture/Subjects/v1.0

The operations from the Data Capture/Subjects/v1.0 category.

Get all subject Numbers for a Site, it does not check if site has any study version associated.: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screeningnumber
[Deprecated]: Add a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
[Deprecated]: Get a list of events by type: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/events
[Deprecated]: Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects
[Deprecated]: Get Clinical Data which is part of ODMSubmit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}
[Deprecated]: Get details for a subject: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: Get information for a transfer ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/{transferId}
[Deprecated]: Get latest records for sign, verify and freeze: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/svf
[Deprecated]: Get transfer records for a subject for a date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}
[Deprecated]: Get Visits MetaData which is part of ODMSubmit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}
[Deprecated]: Sign subject and visits: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
[Deprecated]: Update subject details: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: Update subject number: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/subjectnumber
Check status of study randomization limit or restriction: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randrestricted
Check the study randomization limit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randlimitexceeded
Code view on a subject: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Create a subject transfer: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
Enroll a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/enroll
Get a list of subject numbers: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/numberstatus
Get a list of subject-related values: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/lov/{pathAttr}
Get a subject's events within a date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get all subjects for a specific study version: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sitestudyversion
Get events within a date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/dateRange
Get history for a specific subject: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get last added subject number: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/availableSubjectNumbers
Get latest audit records for Source Data Verification: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/sdvselected
Get latest audit records for visit verification: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history
Get OrgId used to generate subject number: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/orgid
Get source data verification selection status for all subjects: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/selectionStatus/{siteId}
Get Subject count: Method: get
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/count
Get subjects and their visit schedule: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/visitschedule
Get the history of all subjects in a mode: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/history/all
Get transfer records for a study: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers
Get transfer records for a subject: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
List all subjects for the study and mode: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/idsforsitestudyversion
Migrate a subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/migratesubject
Perform code break on a subject: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Randomize or dispense subject: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/randomizeordispense
Register subject to mHealth: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/mhealthRegister
Undo the Added subject from a study: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/undoSubject
Undo the latest operation applied to the subject: Method: delete
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/state/{subjectId}
Update randNumber: Method: put
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/randomizationnumber/{randNumber}
Update subject numbers: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/subjectnumber

Data Capture/Subjects/v2.0

The operations from the Data Capture/Subjects/v2.0 category.

[Deprecated]: Add a subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
[Deprecated]: Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects
[Deprecated]: Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]: Get a subject's events within a date range: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
[Deprecated]: Get details for a subject: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
[Deprecated]: Get latest audit records for Source Data Verification on completed visits: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visit/verify/history
[Deprecated]: Get transfer records for a study: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers
[Deprecated]: Sign subject and visits: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
[Deprecated]: Unfreeze single data element of a visit: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/unfreeze/{dataElementId}
[Deprecated]: Update subject details: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}
Add a subject as migartion: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/migratesubject
Code break a subject: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Code view on a subject: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Get a list of subjects for the site study version: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get all the transfer records for a subject ID: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
Get events within a date range: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange
Get history for a subject: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get subjects and their visit schedule: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/visitschedule
Get visit data by subject ID: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dispensedvisits/{subjectId}
Randomize or dispense subject: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/randomizeordispense
Revert the latest subject state: Method: delete
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/state/{subjectId}

Data Capture/Subjects/v3.0

The operations from the Data Capture/Subjects/v3.0 category.

[Deprecated]: Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/all
[Deprecated]: Get all the transfer records for a subject ID: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
[Deprecated]: Get subject based on ID: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}
Add a subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
Add a subject as migartion: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/migratesubject
Code view on a subject: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codeview
Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects
Get a subject's events within a date range: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get or search list of subjects: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject history: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get subjects and their visit schedule: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/visitschedule
Perform code break on a subject: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Randomize or dispense subject: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/randomizeordispense
Sign subject and visits: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Update subject information: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Capture/Subjects/v4.0

The operations from the Data Capture/Subjects/v4.0 category.

[Deprecated]: Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/all
Get a list of subjects with lock status for the specified study and mode: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects
Get or search list of subjects: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject based on ID: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get subject history: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get subjects and their visit schedule: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/visitschedule
Perform code break on a subject: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/codebreak
Randomize or dispense subject: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/randomizeordispense
Sign subject and visits: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}
Update subject screenfailure date: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}

Data Capture/Subjects/v5.0

The operations from the Data Capture/Subjects/v5.0 category.

Get or search list of subjects: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject based on ID: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get subject history: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Randomize or dispense subject: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/randomizeordispense

Data Capture/Subjects/v6.0

The operations from the Data Capture/Subjects/v6.0 category.

Get or search list of subjects: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject history: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Capture/Subjects/v7.0

The operations from the Data Capture/Subjects/v7.0 category.

[Deprecated]: Get subject history: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get or search list of subjects: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/sitestudyversion

Data Capture/Subjects/v8.0

The operations from the Data Capture/Subjects/v8.0 category.

Get or search or filter list of subjects: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject history: Method: get
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Capture/Subjects/v9.0

The operations from the Data Capture/Subjects/v9.0 category.

Get subject history: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/history/{subjectId}

Data Capture/Visits Status/v1.0

The operations from the Data Capture/Visits Status/v1.0 category.

[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Create a new visit status record: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
Get list of adverse event visit counts for a list of subjects: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects/aeCount
Get list of visit statuses for given entries: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/multiple
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a date range: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
Get list of visits status for a list of subjects: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/subjects
Get list of visits visits start date for subjects: Method: post
Path: /ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/visits/subjectvisitsinfo
Get the audit/history visits status for the given visit ID: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Post migrated visit data: Method: post
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/migratevisit
Retrieve the Associated and Dynamic forms for a subject visit: Method: get
Path: /ec-dc-svc/rest/v1/studies/{studyId}/{mode}/visitstatus/forms/studyVersion/{studyVersion}/subject/{subjectId}/event/{eventId}

Data Capture/Visits Status/v10.0

The operations from the Data Capture/Visits Status/v10.0 category.

Get list of visits status along with Locked status: Method: get
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus/subjects
Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v10.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}

Data Capture/Visits Status/v11.0

The operations from the Data Capture/Visits Status/v11.0 category.

Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v11.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v12.0

The operations from the Data Capture/Visits Status/v12.0 category.

Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v12.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v13.0

The operations from the Data Capture/Visits Status/v13.0 category.

Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v13.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v2.0

The operations from the Data Capture/Visits Status/v2.0 category.

[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Create visit status record: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visit statuses for given entries: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/multiple
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a data range: Method: get
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/dateRange
Get subject's visits list and the current state's study version: Method: post
Path: /ec-dc-svc/rest/v2.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v3.0

The operations from the Data Capture/Visits Status/v3.0 category.

[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Create visit status record: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus
Get subject's visits list and the current state's study version: Method: post
Path: /ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v4.0

The operations from the Data Capture/Visits Status/v4.0 category.

[Deprecated]: Get list of visits status for a date range: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Create visit status record: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v5.0

The operations from the Data Capture/Visits Status/v5.0 category.

[Deprecated]: Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Create visit status record: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/subjects
Update and remove the visit status rule error: Method: put
Path: /ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}

Data Capture/Visits Status/v6.0

The operations from the Data Capture/Visits Status/v6.0 category.

[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus
Update and remove the visit status rule error: Method: put
Path: /ec-dc-svc/rest/v6.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}/clearruleerror/{message}

Data Capture/Visits Status/v7.0

The operations from the Data Capture/Visits Status/v7.0 category.

[Deprecated]: Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Get audit/history records for the given visit status ID: Method: get
Path: /ec-dc-svc/rest/v7.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}

Data Capture/Visits Status/v8.0

The operations from the Data Capture/Visits Status/v8.0 category.

[Deprecated]: Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}
Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v8.0/studies/{studyId}/{mode}/visitstatus/subjects

Data Capture/Visits Status/v9.0

The operations from the Data Capture/Visits Status/v9.0 category.

[Deprecated]: Get list of visits status: Method: get
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus
[Deprecated]: Get list of visits status for subjects: Method: post
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/subjects
Update the visit status for a given ID: Method: put
Path: /ec-dc-svc/rest/v9.0/studies/{studyId}/{mode}/visitstatus/{visitStatusId}

Data Hub/v1.0

Get Blinded kits for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/blindedKits
Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get codelists for a study and a given mode: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/codelists
Get codelists for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/codelists
Get codelists for tenant: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/codelists
Get data collection for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Get kits and randomization design data for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v1.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for admin data: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/admin
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data: Method: get
Path: /ec-datahub-svc/rest/v1.0/studies/{studyId}/{mode}/odm/metadata

Data Hub/v2.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get codelists for study: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/codelists
Get data collection for study: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Get kits and randomization design data for study: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v2.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data: Method: get
Path: /ec-datahub-svc/rest/v2.0/studies/{studyId}/{mode}/odm/metadata

Data Hub/v3.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get data collection for study: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Get kits and randomization design data for study: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/kitsAndRandomizations
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v3.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data: Method: get
Path: /ec-datahub-svc/rest/v3.0/studies/{studyId}/{mode}/odm/metadata

Data Hub/v3.1

Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v3.1/tenant/{tenantId}/studies/{studyId}/{mode}/subjects

Data Hub/v4.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get data collection for study: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/dataCollection
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v4.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data: Method: get
Path: /ec-datahub-svc/rest/v4.0/studies/{studyId}/{mode}/odm/metadata

Data Hub/v5.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject data details: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v5.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/clinicalData/blinded
ODM extract for meta data: Method: get
Path: /ec-datahub-svc/rest/v5.0/studies/{studyId}/{mode}/odm/metadata

Data Hub/v6.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get queries raised for study: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/queries
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get Unblided kits for study: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/unblindedKits
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v6.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits
ODM extract for clinical data with hidden data: Method: get
Path: /ec-datahub-svc/rest/v6.0/studies/{studyId}/{mode}/odm/clinicalData/unblinded
ODM extract for clinical data without hidden data: Method: get
Path: /ec-datahub-svc/rest/v6.0/studies/{studyId}/{mode}/odm/clinicalData/blinded

Data Hub/v7.0

Get blinded visit details: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/blindedVisits
Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get subject forms data details: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/forms
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v7.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Hub/v8.0

Get subject form items data details: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/formItems
Get unblinded subject data details: Method: post
Path: /ec-datahub-svc/rest/v8.0/tenant/{tenantId}/studies/{studyId}/{mode}/subjects/unblindedVisits

Data Integration/Coding Status/v1.0

The operations from the Data Integration/Coding Status/v1.0 category.

Get data elements to be coded by codeType: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Data Integration/DCProperties APIs/v1.0

The operations from the Data Integration/DCProperties APIs/v1.0 category.

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

Data Integration/Data Elements/v1.0

The operations from the Data Integration/Data Elements/v1.0 category.

Get data element records for subject inserted or updated after visit completion for a given date range: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/subjectId/{subjectId}
Get data elements by form ID, Subject ID, Event ID and Vendor code: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/events/{eventId}/vendorCode/{vendorCode}/dataelements/withvendorcode
Get data elements for a list of items by subject ID: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/subjects/{subjectId}/items
Get data elements for a visit and form combination: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/subjects/{subjectId}/dataelements
Get data elements for one or multiple subjects and their visits: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements
Get data elements history with pagination: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/all
Get data elements that have been deleted: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/deleted/dataelements
Get form associations by study ID: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/formassociations
Get Form Statuses for list of event/form ids: Method: put
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/formStatus
Get latest/audit records for Source Data Verification group: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/sdvGroup
Get the audit history for a data element with sign/verify history: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/history/{dataElementId}

Data Integration/Signature Configuration/v1.0

The operations from the Data Integration/Signature Configuration/v1.0 category.

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

Data Integration/Signature Eligibility/v1.0

The operations from the Data Integration/Signature Eligibility/v1.0 category.

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

Data Integration/Subject Reports/v1.0

The operations from the Data Integration/Subject Reports/v1.0 category.

Async API to be invoked by ORS for RTSM Data Extract processing: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/report/rtsmdataextract
Asynchronous call to generate report for a subject's data and events: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/asynch/report/{reportName}
Generate a report based on the path parameter: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/report/{reportName}

Data Integration/Subject Transfer/v1.0

The operations from the Data Integration/Subject Transfer/v1.0 category.

Get all the transfer records for a subject ID: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/subjects/{subjectId}
Get information for a transfer ID: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/{transferId}
Get transfer records for a study: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers
Get transfer records for a subject for a date range: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjecttransfers/dateRange/{subjectId}

Data Integration/Subjects Lock Status/v1.0

The operations from the Data Integration/Subjects Lock Status/v1.0 category.

Add subject lock status for given subject list: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lock/subjects
Get subject lock status for given subject list: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lock/subjects

Data Integration/Subjects/v1.0

The operations from the Data Integration/Subjects/v1.0 category.

Get a list of events by type: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/events
Get a list of subject-related values: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/lov/{pathAttr}
Get a list of subjects for the specified study and mode: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects
Get a subject's events within a date range: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get Clinical Data which is part of ODMSubmit: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}
Get details for a subject: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}
Get Latest lock records for all subjects under a study: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/lockedstatus
Get latest records for sign, verify and freeze: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/svf
Get latest/audit records for Source Data Verification with site information where visit was completed: Method: post
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visit/verify/history
Get or search or filter list of subjects: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/sitestudyversion
Get subject history: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get the history of all subjects in a mode: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/history/all
Get Visits MetaData which is part of ODMSubmit: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/visitsMetadata/{subjectId}

Data Integration/Subjects/v2.0

The operations from the Data Integration/Subjects/v2.0 category.

Get a subject's events within a date range: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}
Get subject history: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/{subjectId}
Get the history of all subjects in a mode: Method: get
Path: /ec-dataintegration-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/history/all

Data Integration/Visits Status History/v1.0

The operations from the Data Integration/Visits Status History/v1.0 category.

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

Data Integration/Visits Status/v1.0

The operations from the Data Integration/Visits Status/v1.0 category.

Get audit/history records for the given visit status ID: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/history/{visitsStatusId}
Get list of visits status: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus
Get list of visits status for a date range: Method: get
Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/dateRange/{subjectId}
Get list of visits status for subjects: Method: post
Path: /ec-dataintegration-svc/rest/v1.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/Dispensing APIs/v1.0

The operations from the Designer/Dispensing APIs/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
Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/dispensings

Designer/Dispensing APIs/v2.0

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

[Deprecated]: 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/Dispensing APIs/v3.0

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

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

The operations from the Designer/Dispensing APIs/v5.0 category.

Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/dispensings

Designer/Dispensing APIs/v6.0

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

Get list of dispensation visits in a study version: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/dispensings
Update list of dispensation visits: Method: put
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/dispensings

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

The operations from the Designer/Form Item APIs - [Deprecated]/v1.0 category.

[Deprecated]: Add a question in a form: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}

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

The operations from the Designer/Form Item APIs - [Deprecated]/v2.0 category.

[Deprecated]: Add a question in a form: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: 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 Item APIs - [Deprecated]/v3.0

The operations from the Designer/Form Item APIs - [Deprecated]/v3.0 category.

[Deprecated]: Add a question in a form: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}

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

The operations from the Designer/Form Item APIs - [Deprecated]/v4.0 category.

[Deprecated]: Add a question in a form: Method: post
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form: Method: delete
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form: Method: put
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}

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

The operations from the Designer/Form Item APIs - [Deprecated]/v5.0 category.

[Deprecated]: Add a question in a form: Method: post
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Delete a question from a form: Method: delete
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get a question for a form: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}
[Deprecated]: Get questions for a form: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items
[Deprecated]: Update a question in a form: Method: put
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/forms/{formId}/items/{itemId}

Designer/Form Item History APIs/v1.0

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

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

Designer/Form Item History APIs/v2.0

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

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

[Deprecated]: Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
[Deprecated]: Process visits to associate with a specific form: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Get a list of study form visits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/{mode}/forms/{formId}/visits

Designer/Form Visit APIs/v10.0

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

Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form: Method: post
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/forms/{formId}/visits

Designer/Form Visit APIs/v5.0

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

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

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

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

Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/forms/{formId}/visits

Designer/Form Visit APIs/v9.0

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

Get visits associated with a form: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits
Process visits to associate with a specific form: Method: post
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/forms/{formId}/visits

Designer/Forms APIs/v1.0

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

[Deprecated]: 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 or specified form items in a study: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/formSummaryInfo
Get all study forms: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/allstudiesforms
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 and questions used in dosing calculations: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/numericItems
Get forms with item IDs and types for the given mode of study: Method: get
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/{mode}/forms/formitems
Get list of associated forms: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/forms/associateForms
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 visit summary with form and item IDs: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/formitems

Designer/Forms APIs/v10.0

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

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

Designer/Forms APIs/v11.0

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

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

Designer/Forms APIs/v12.0

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

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

Designer/Forms APIs/v14.0

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

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

Designer/Forms APIs/v15.0

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

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

Designer/Forms APIs/v16.0

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

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

Designer/Forms APIs/v17.0

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

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

Designer/Forms APIs/v2.0

The operations from the Designer/Forms APIs/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}
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/Forms APIs/v3.0

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

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

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

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

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

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

The operations from the Designer/Forms APIs/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/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 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
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 list of all kits: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/kits

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-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits
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-svc/rest/v9.0/studies/{studyId}/versions/{version}/kits/{kitId}
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-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/Preview Form APIs/v1.0

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

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

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

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

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

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

Designer/Randomization APIs/v5.0

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

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

Designer/Randomization Cohorts APIs/v1.0

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

Create a single cohort group: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts
Create multiple cohort groups: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Delete cohort group: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Delete multiple existing cohort groups: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk
Get a list of all cohort groups in a randomization: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts
Get cohort group in a randomization: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Update existing cohort group: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/{cohortId}
Update multiple existing cohort groups: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/cohorts/bulk

Designer/Randomization Ratios APIs/v1.0

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

[Deprecated]: Create treatment arms ratios: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete all treatment arm ratios: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete treatment arm ratios: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
[Deprecated]: Get list of all treatment arm ratios for cohort or stratum groups by randomization Id: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Update treatment arm ratios for adaptive cohorts: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizationRatios
Get list of 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 Ratios APIs/v2.0

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

[Deprecated]: Delete all treatment arm ratios: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
[Deprecated]: Delete treatment arm ratios: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios/{groupingsId}
Create treatment arms ratios: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups by randomization Id: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of treatment 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 Ratios APIs/v3.0

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

[Deprecated]: Delete all treatment arm ratios: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Create treatment arms ratios: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/ratios
Get list of all treatment arm ratios for cohort or stratum groups 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/Reporting APIs/v1.0

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

Generate study design reports: Method: post
Path: /ec-designer-svc/rest/v1.0/report/{reportName}

Designer/Reporting APIs/v2.0

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

Generate study design reports: Method: post
Path: /ec-designer-svc/rest/v2.0/report/{reportName}

Designer/Reporting APIs/v3.0

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

Generate study design reports: Method: post
Path: /ec-designer-svc/rest/v3.0/report/{reportName}

Designer/Rollback APIs/v1.0

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

Rollback tracked transaction: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/rollback/{trackingId}
Start tracking transaction: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/start
Stop tracking transaction: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/tracking/stop/{trackingId}

Designer/Strata APIs/Study Strata APIs/v1.0

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

Get all active strata in a study: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/strata
Get stratum items of given randomized visits and study version: Method: post
Path: /ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/strata

Designer/Strata APIs/v1.0

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

Create list of cohort groups: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Create randomization stratum group: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Delete a stratum group: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Delete cohort groups: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get a stratum group: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Get list of all strata groups: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Update existing stratum group: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Update randomization cohort groups: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk

Designer/Strata APIs/v2.0

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

Create list of cohort groups: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Create randomization stratum group: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Delete a stratum group: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Delete cohort groups: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk
Get a stratum group: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Get list of all strata groups: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata
Update existing stratum group: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/{stratumId}
Update randomization cohort groups: Method: put
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/randomizations/{randomId}/strata/bulk

Designer/Study APIs/v1.0

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

[Deprecated]: 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 the 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 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/v2.0

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

The operations from the Designer/Study APIs/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
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 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
Update existing study: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}

Designer/Study APIs/v4.0

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

[Deprecated]: Get all visits, forms and questionnaires: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/studyDesign
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 status of latest study version: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/statuses/{version}

Designer/Study APIs/v5.0

The operations from the Designer/Study APIs/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}

Designer/Study APIs/v6.0

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

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

Designer/Study APIs/v7.0

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

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/studyDesign
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

Designer/Study APIs/v8.0

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

Create all visits, forms and questionnaires: Method: post
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/studyDesign
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

Designer/Study APIs/v9.0

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

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

Designer/Study Cohorts APIs/v1.0

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

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

Designer/Study Lock APIs/v1.0

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

[Deprecated]: Create study lock: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Delete study lock: Method: delete
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Get study lock: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
[Deprecated]: Update study lock: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/lock
Acquire lock: Method: post
Path: /ec-designer-svc/rest/locks/acquireLock/{studyId}
Get all the active locks on the study: Method: get
Path: /ec-designer-svc/rest/locks/childLocks/{studyId}
Release lock: Method: put
Path: /ec-designer-svc/rest/locks/releaseLock/{studyId}

Designer/Study Metadata APIs/v1.0

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

Get metadata of a specified study ID and study version: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/studyMetadata

Designer/Study Metadata APIs/v2.0

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

Get metadata of a specified study ID and study version: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/studyMetadata

Designer/Study Randomization Factors APIs/v1.0

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

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

Designer/Study Randomization Factors APIs/v2.0

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

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

Designer/Study Version Object APIs/v2.0

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

Get items with ASVs within a date range: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/studyversionobjects/formitems

Designer/Study Version Object APIs/v5.0

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

Get study version objects: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/studyversionobjects

Designer/Study Version Object APIs/v6.0

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

Get study version objects: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/studyversionobjects

Designer/Study Versions History APIs/v1.0

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

Get history of all versions for a study as of a certain date: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versionshistory/asofdate/{asofdate}

Designer/Study Versions Randomization APIs/v1.0

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

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

The operations from the Designer/Visit APIs/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 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 all visits, forms, and questions by study ID: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visitsforms
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/v2.0

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

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

[Deprecated]: Add a visit: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Delete a visit: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Get a list of study visits: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits
[Deprecated]: Get study visit: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
[Deprecated]: Update a visit: Method: put
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}
Clear visit schedule: Method: delete
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Create visit schedule: Method: post
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/schedule/{fromEventRefId}
Get dispensation visits: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/visits/{visitid}/dispensings
Get 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/v4.0

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

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

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

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

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

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

The operations from the Designer/Visit Design APIs/v1.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design
Assign kit type titration to a visit: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/kits/{kitId}
Assign randomization to visit: Method: put
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/randomizations/{randomizationId}
Get titration dispensation data: Method: get
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/dispense/kits/{kitId}
Validate assigning randomization: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}

Designer/Visit Design APIs/v2.0

The operations from the Designer/Visit Design APIs/v2.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design
Assign kit type titration to a visit: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/kits/{kitId}
Get titration dispensation data: Method: get
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/dispense/kits/{kitId}
Validate assigning randomization: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/design/visits/{visitId}/validate/assign/randomization/{randomizationId}

Designer/Visit Design APIs/v3.0

The operations from the Designer/Visit Design APIs/v3.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v3.0/studies/{studyId}/versions/{version}/design
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 Design APIs/v4.0

The operations from the Designer/Visit Design APIs/v4.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/design

Designer/Visit Design APIs/v5.0

The operations from the Designer/Visit Design APIs/v5.0 category.

[Deprecated]: Get study design visits: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/design

Designer/Visit Design APIs/v6.0

The operations from the Designer/Visit Design APIs/v6.0 category.

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 Design APIs/v7.0

The operations from the Designer/Visit Design APIs/v7.0 category.

Get study design visits: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/design
Get study design visits for multiple versions: Method: post
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/design

Designer/Visit Design APIs/v8.0

The operations from the Designer/Visit Design APIs/v8.0 category.

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 Design APIs/v9.0

The operations from the Designer/Visit Design APIs/v9.0 category.

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 Form APIs/V11.0

The operations from the Designer/Visit Form APIs/V11.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v11.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/V12.0

The operations from the Designer/Visit Form APIs/V12.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v12.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/V13.0

The operations from the Designer/Visit Form APIs/V13.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v13.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/V14.0

The operations from the Designer/Visit Form APIs/V14.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v14.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/V15.0

The operations from the Designer/Visit Form APIs/V15.0 category.

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v15.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/V16.0

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

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

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

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

Designer/Visit Form APIs/v10.0

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

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v10.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/v2.0

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

[Deprecated]: Delete form from a specific visit: Method: delete
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms/{formId}
[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 Form APIs/v3.0

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

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

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

Designer/Visit Form APIs/v5.0

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

Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/v6.0

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

Get list of forms in a study: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Form APIs/v7.0

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

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

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

Get list of forms in a visit: Method: get
Path: /ec-designer-svc/rest/v9.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Designer/Visit Metadata APIs/v1.0

The operations from the Designer/Visit Metadata APIs/v1.0 category.

Get the metadata of specified visits by study ID and study version: Method: post
Path: /ec-designer-svc/rest/v1.0/studies/{studyId}/visitsMetadata

Designer/Visit Metadata APIs/v2.0

The operations from the Designer/Visit Metadata APIs/v2.0 category.

Get the metadata of specified visits by study ID and study version: Method: post
Path: /ec-designer-svc/rest/v2.0/studies/{studyId}/visitsMetadata

Designer/Visit Schedules APIs/v1.0

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

The operations from the Designer/Visit Schedules APIs/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 Schedules APIs/v4.0

The operations from the Designer/Visit Schedules APIs/v4.0 category.

[Deprecated]: Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v4.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit Schedules APIs/v5.0

The operations from the Designer/Visit Schedules APIs/v5.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v5.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit Schedules APIs/v6.0

The operations from the Designer/Visit Schedules APIs/v6.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v6.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit Schedules APIs/v7.0

The operations from the Designer/Visit Schedules APIs/v7.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v7.0/studies/{studyId}/versions/{version}/visitschedules

Designer/Visit Schedules APIs/v8.0

The operations from the Designer/Visit Schedules APIs/v8.0 category.

Get visit schedule: Method: get
Path: /ec-designer-svc/rest/v8.0/studies/{studyId}/versions/{version}/visitschedules

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 the 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 a 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 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
Get the history of all library kits: Method: get
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}/history
Update library kit status in bulk: Method: post
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/bulk/{status}
Update the library Kit: Method: put
Path: /ec-library-svc/rest/v1.0/libraryObjects/kits/{libraryKitId}

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.

Delete library object: Method: delete
Path: /ec-library-svc/rest/v1.0/libraryObjects/{libraryId}
Get library object: Method: get
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 a 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/Auth/v1.0

The operations from the Notifications/Auth/v1.0 category.

List users to send notifications to: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/{rightname}

Notifications/Broadcast/v1.0

The operations from the Notifications/Broadcast/v1.0 category.

Delete a notification for an ID: Method: delete
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
Display the number of unread and read notifications in the inbox: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/notificationCount
Get a specific notification by ID: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
Post notification broadcast for a user: Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast
Update the notification broadcast with an ID: Method: put
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast/{id}
View a user's inbox: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast

Notifications/Broadcast/v2.0

The operations from the Notifications/Broadcast/v2.0 category.

Post a notification broadcast for a user: Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationsbroadcast

Notifications/Email/v1.0

The operations from the Notifications/Email/v1.0 category.

Use a template to send email to a user: Method: post
Path: /ec-notifications-svc/rest/v1.0/email/{templatetype}

Notifications/Email/v2.0

The operations from the Notifications/Email/v2.0 category.

Use a template to send email to a user: Method: post
Path: /ec-notifications-svc/rest/v2.0/email/{templatetype}

Notifications/Email/v3.0

The operations from the Notifications/Email/v3.0 category.

Use a template to send email to a user: Method: post
Path: /ec-notifications-svc/rest/v3.0/email/{templatetype}

Notifications/Email/v4.0

The operations from the Notifications/Email/v4.0 category.

Use a template to send email to a user: Method: post
Path: /ec-notifications-svc/rest/v4.0/email/{templatetype}

Notifications/Internationalization Support/Email/v1.0

The operations from the Notifications/Internationalization Support/Email/v1.0 category.

Use a template to send email to a user: Method: post
Path: /ec-notifications-svc/rest/v1.0/i18support/email/{templatetype}

Notifications/Log/v1.0

The operations from the Notifications/Log/v1.0 category.

Create a log entry and send it or schedule it: Method: post
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog
Lists all the notification logs: Method: get
Path: /ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/v2.0

The operations from the Notifications/Log/v2.0 category.

Create a log entry and send it or schedule it: Method: post
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog
List all the notification logs: Method: get
Path: /ec-notifications-svc/rest/v2.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/v3.0

The operations from the Notifications/Log/v3.0 category.

Create a log entry and send it or schedule it: Method: post
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog
List all the notification logs: Method: get
Path: /ec-notifications-svc/rest/v3.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/v4.0

The operations from the Notifications/Log/v4.0 category.

Create a log entry and send it or schedule it: Method: post
Path: /ec-notifications-svc/rest/v4.0/studies/{studyId}/{mode}/notificationlog

Notifications/Log/v5.0

The operations from the Notifications/Log/v5.0 category.

Create a log entry and send it or schedule it: Method: post
Path: /ec-notifications-svc/rest/v5.0/studies/{studyId}/{mode}/notificationlog

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.

Generate Subject Queries report: Method: post
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/report/{reportName}

Query/v1.0

The operations from the Query/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 the list of all query states: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/state
Closes or deletes multiple queries for a given subject: Method: put
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/bulkCloseDelete
Get all historical records on table DC_Query_Study_Roles: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/queryStudyRolesTable
Get subject and user information for queries in a study and mode: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/querymgmt/filteredList
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
Get the subjects having open queries in a study: Method: get
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/subjects
Update subject's site transfer information: Method: post
Path: /ec-query-svc/rest/v1.0/studies/{studyId}/{mode}/queries/subjectsitetransfer

Query/v10.0

The operations from the Query/v10.0 category.

Get details on an opened query: Method: get
Path: /ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v10.0/studies/{studyId}/{mode}/queryDetails

Query/v2.0

The operations from the Query/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 query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queryDetails
Get all historical records on DC_Query table: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/queryTable
Get number of queries in a study: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queryCount
Get the list of all query states: Method: get
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/queries/state
Get the number of open queries in a study for selected subjects: Method: post
Path: /ec-query-svc/rest/v2.0/studies/{studyId}/{mode}/openQueryCount

Query/v3.0

The operations from the Query/v3.0 category.

[Deprecated]: Create a query with the status Candidate: Method: post
Path: /ec-query-svc/rest/v3.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create an 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/v4.0

The operations from the Query/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 a query by ID: Method: get
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/openQueryDetails
[Deprecated]: Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v4.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/v5.0

The operations from the Query/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 a query with the status Candidate: Method: post
Path: /ec-query-svc/rest/v5.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create an 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/v6.0

The operations from the Query/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 a query with the status Candidate: Method: post
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/candidate
[Deprecated]: Create an 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 a query by ID: Method: get
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v6.0/studies/{studyId}/{mode}/openQueryDetails
[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/v7.0

The operations from the Query/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 an open query: Method: post
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/open
[Deprecated]: Get a query by ID: Method: get
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/queries/{queryId}
[Deprecated]: Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v7.0/studies/{studyId}/{mode}/openQueryDetails
[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/v8.0

The operations from the Query/v8.0 category.

Answer an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/answer
Close an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create a query with the status Candidate: Method: post
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/candidate
Create an open query: Method: post
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/open
Delete an existing query: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/delete
Get a query by ID: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v8.0/studies/{studyId}/{mode}/queries/{queryId}/open

Query/v9.0

The operations from the Query/v9.0 category.

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
Close an existing query: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/close
Create a query with the status Candidate: Method: post
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/candidate
Create an 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 a query by ID: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}
Get details of an opened query: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/openQueryDetails
Get query data based on multiple parameters: Method: get
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queryDetails
Update a query's status to Open: Method: put
Path: /ec-query-svc/rest/v9.0/studies/{studyId}/{mode}/queries/{queryId}/open

Randomization and Supplies/Blinded Lot APIs/v3.0

The operations from the Randomization and Supplies/Blinded Lot APIs/v3.0 category.

Create blinded lot: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots
Get blinded lot by ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots/{blindedLotId}
Get blinded lots: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots
Update blinded lot: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/blinded-lots/{blindedLotId}

Randomization and Supplies/Cohort APIs/v1.0

The operations from the Randomization and Supplies/Cohort APIs/v1.0 category.

Get cohort enrollments by study, mode and cohort ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/cohortenrollments/{cohortid}
Get cohort limits by study and mode: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits
Save cohort limits by study and mode: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings/cohortlimits

Randomization and Supplies/Device Management APIs/v1.0

The operations from the Randomization and Supplies/Device Management APIs/v1.0 category.

Deregister an mHealth device: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}
Recreate an accessId and One-Time Password of a bootstrap device: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/devices/{inventoryId}/access-code
Register mHealth device: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/register-device

Randomization and Supplies/Dispensation Logic APIs/v1.0

The operations from the Randomization and Supplies/Dispensation Logic APIs/v1.0 category.

Create a DNDException: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception
Delete a DNDException: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}
Get All DNDExceptions: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception
Get DNDException details by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}
Update a DNDException: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dndexception/{id}

Randomization and Supplies/Dose Hold Settings APIs/v1.0

The operations from the Randomization and Supplies/Dose Hold Settings APIs/v1.0 category.

Create dose hold settings for the given dose hold: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
Delete dose hold settings of a given dose hold by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Get all dose hold settings details: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings
Get dose hold setting details of given dose hold by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Update dose hold settings of a given dose hold by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/doseholdsettings/{id}

Randomization and Supplies/Dose Hold Settings APIs/v2.0

The operations from the Randomization and Supplies/Dose Hold Settings APIs/v2.0 category.

Create dose hold settings for the given dose hold: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings
Get all dose hold settings details including last visit: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings
Get dose hold setting details of given dose hold by ID including last visit: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}
Update dose hold settings of a given dose hold by ID: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/doseholdsettings/{id}

Randomization and Supplies/Dose Hold Subject Visits APIs/v1.0

The operations from the Randomization and Supplies/Dose Hold Subject Visits APIs/v1.0 category.

Get visits on dose hold for all subjects: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-doseholds

Randomization and Supplies/Event APIs/v1.0

The operations from the Randomization and Supplies/Event APIs/v1.0 category.

Get details about a Code Break event: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/codebreak/{eventId}
Get details about a Kit Replacement event: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/kitreplacement/{eventId}
Get details about a Resume Dosehold Dispensation event: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/resume_dosehold_dispensation/{eventId}
Get details about a Resume Partial Dispensation event: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events/resume_partial_dispensation/{eventId}
Get list of events in a study: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/events

Randomization and Supplies/Event APIs/v2.0

The operations from the Randomization and Supplies/Event APIs/v2.0 category.

Get details about a Code Break event: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/events/codebreak/{eventId}

Randomization and Supplies/Inventory APIs/v1.0

The operations from the Randomization and Supplies/Inventory APIs/v1.0 category.

[Deprecated]: Create randomization list from uploaded file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/fileupload/rndlists/{rndListId}
[Deprecated]: Get a kit's last status by kit number: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/lastStatus
[Deprecated]: Get kit history: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
[Deprecated]: Get kit history by ID for a site: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
[Deprecated]: Get kit history by kit number for a site: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
[Deprecated]: Get latest status of kit in site inventory: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/lastStatus
Create blinded lot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Create label groups: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Create manufacturing lot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Delete blinded lot: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Delete kit list file: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/file/{fileId}
Delete label groups: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Delete manufacturing lot by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Disable kitlist with inventories: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists/{listId}/disable
Export kit details for the inventory: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Generate kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/generate
Get a kit's barcode by kit ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Get a kit's last status by inventory ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/lastStatusById
Get a site inventory's status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/site
Get all manufacturing lots: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get blinded lot by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Get cancelled inventory status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/cancelledshipment
Get destruction inventory statuses: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventorystatuses/destruction
Get dispensation details by inventory ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Get generated/uploaded kit lists details in a study: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kitlists
Get inventory database headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadkits
Get kit details by kit number: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kitDetails
Get Kit History by depotId and kitId: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits/{inventoryId}/historyById
Get kit history by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
Get kit summary by kit type ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get kit types: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kit-types
Get kits from depot inventory by depot ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
Get label groups: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups
Get label groups by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Get latest status of kit in site inventory: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/lastStatusById
Get list of blinded lots: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots
Get list of filtered kits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/qualified-kits
Get lots with kits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lotsWithKits
Get manufacturing lot by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get max kit number: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/suggested-max-numbers
Get pending Destruction count by location ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kit-types/location/{locationId}/pendingdestructioncount
Get randomization list database headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
Get single kit settings: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/singlekitsettings
Get sites: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites
Get study settings: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/settings
Get types of packages: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/packagetypes
Kitlist details of each kit: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/audit
Parse file headers: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/{fileId}/fileheaders
Set kit verification status: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}/verify
Update a kit's barcode: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/barcode
Update a kit's barcode by kit ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/barcode
Update a kit's dispensation confirmation: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/{kitId}/confirmDispensation
Update blinded lot: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/blinded-lots/{id}
Update kit attributes: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits
Update kit attributes from depot inventory by depot ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depots/{depotId}/inventory/kits
Update kit label group: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/label-group
Update kit location: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/location
Update kit manufactoring lot: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/manufacturing-lot
Update kit status: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/inventory/kits/status
Update label groups: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups/{id}
Update manufacturing lot by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Upload inventory data as CSV file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadinventory
Upload kit list file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/uploadfile
Upload kit types data: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/upload/kittypesfromfile

Randomization and Supplies/Inventory APIs/v2.0

The operations from the Randomization and Supplies/Inventory APIs/v2.0 category.

[Deprecated]: Get a kit's last status: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/lastStatus
[Deprecated]: Get kit history: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{kitNumber}/history
[Deprecated]: Get kit history by ID for a site: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{inventoryId}/historyById
[Deprecated]: Get kit history by kit number for a site: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumber}/history
[Deprecated]: Get latest status of kit: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/lastStatus
Create manufacturing lot: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Export kit details with barcodes for the inventory: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Generate kits: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/generate
Get all manufacturing lots: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get dispensation details by inventory ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/{inventoryId}/dispensation
Get generated/uploaded kit lists details in a study: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kitlists
Get inventory database headers with barcodes: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadkits
Get inventory status: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit history by ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kits/{inventoryId}/historyById
Get kit summary: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types
Get kit summary by kit type ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get kit types: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/kit-types
Get list of filtered kits: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/qualified-kits
Get manufacturing lot by ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get randomization list database headers: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/dbheaders/uploadrndlist
Get received inventory status: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventorystatuses/receivedshipment
Kitlist details of each kit: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits/audit
Update a kit's barcode: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/barcode
Update kit attributes: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/inventory/kits
Update kit status for a site: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
Update manufacturing lot by ID: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Update status for kits in a site: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/v3.0

The operations from the Randomization and Supplies/Inventory APIs/v3.0 category.

[Deprecated]: Get kit history by KitNumberUTF: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kits/{kitNumberUTF}/history
[Deprecated]: Get kit history for a site by kitNumberUTF: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitNumberUTF}/history
[Deprecated]: Search for kits in a given range for a site: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Export kit details for the inventory: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kits/{sourceId}/export
Get all manufacturing lots: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots
Get allowed inventory status: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses/allowed/{fromInventoryStatusId}
Get inventory status: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit summary: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kit-types
Get kit summary by kit type ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Get manufacturing lot by ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/lots/manufacturing-lots/{id}
Get Pooled/non Pooled generated/uploaded kit lists details in a study: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/kitlists
Kitlist details of each kit: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits/audit
Update kit attributes: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/inventory/kits
Update kit status for a site: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
Update kit status for a site. If the kit is quarantined it will generate a temperature excursion number and return it into response: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}
Update status for kits in a site. If TO status is quarantined it will generate a temperature excursion number: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/v4.0

The operations from the Randomization and Supplies/Inventory APIs/v4.0 category.

[Deprecated]: Search for kits in a given range for a site.: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Get inventory status: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventorystatuses
Get kit details by kit number: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kitDetails
Get kit summary: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kit-types
Get kit summary by kit type ID: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kit-types/{kitTypeId}/kits
Kitlist details of each kit: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kits/audit
Update kit attributes: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/inventory/kits
Update status for kits in a site. returns formInstanceId when user updates kits to pendingDestruction: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/v5.0

The operations from the Randomization and Supplies/Inventory APIs/v5.0 category.

Get kit summary: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/inventory/kit-types
Search for kits in a given range for a site: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits
Update kit status for a site. Added formInstanceId in response when kits are updated to pending destruction: Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits/{kitId}

Randomization and Supplies/Inventory APIs/v6.0

The operations from the Randomization and Supplies/Inventory APIs/v6.0 category.

Get kit summary: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/inventory/kit-types
Search for kits in a given range for a site: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/Inventory APIs/v7.0

The operations from the Randomization and Supplies/Inventory APIs/v7.0 category.

Search for kits in a given range for a site: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/sites/{siteId}/inventory/kits

Randomization and Supplies/NonSubjectForm APIs/v1.0

The operations from the Randomization and Supplies/NonSubjectForm APIs/v1.0 category.

Get NonSubjectForm existingData for kitIds: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kits/existingdata

Randomization and Supplies/Partial Dispensation Settings APIs/v1.0

The operations from the Randomization and Supplies/Partial Dispensation Settings APIs/v1.0 category.

Create partial dispensation settings: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings
Delete partial dispensation settings of a given partial dispensation definition by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
Get all partial dispensation details: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings
Get partial dispensation settings of a given partial dispensation by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}
Update partial dispensation settings of a given partial dispensation by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/partial-dispensation-settings/{id}

Randomization and Supplies/Partial Dispensation Subject Visits APIs/v1.0

The operations from the Randomization and Supplies/Partial Dispensation Subject Visits APIs/v1.0 category.

Get visits with partial dispensation for all subjects: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations

Randomization and Supplies/Randomization APIs/v1.0

The operations from the Randomization and Supplies/Randomization APIs/v1.0 category.

Get list of all treatment arms for a randomization: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/treatments
Get list of headers from a CSV file: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/{fileId}/fileheaders
Get unique values for treatments, stratums or cohorts from a CSV file: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/csvuniquevalues
Upload randomization list based on header mappings and treatment, cohort, stratum mappings: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadrndlist
Upload randomization list file from a file service into RTSM: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/rnddesign/{rndDesignId}/rndlist/upload/uploadfile

Randomization and Supplies/Randomization List APIs/v1.0

The operations from the Randomization and Supplies/Randomization List APIs/v1.0 category.

Associate randomization design to randomization list: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}
Check randomization design is block by region: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/rndListsByRegion/regions/{regionId}
Create randomization list: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
Delete randomization list file: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/file/{fileId}
Dissociate randomization design from randomization list: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns/randlists/{listId}/studyversions/{studyVersion}
Export randomization list: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/export
Get list of randomization blocks: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks
Get random number statuses: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randnumberstatuses
Get randomization design list: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlistdesigns
Update randomization list blocks: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/blocks
Update randomization status: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumber/randstatus

Randomization and Supplies/Randomization List APIs/v2.0

The operations from the Randomization and Supplies/Randomization List APIs/v2.0 category.

Create randomization list: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/{studyVersion}/randlist/generate
Get randomization design list: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/randlistdesigns

Randomization and Supplies/Randomization List APIs/v3.0

The operations from the Randomization and Supplies/Randomization List APIs/v3.0 category.

Get randomization list: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists
Get randomization list by ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}
Get randomization number: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers

Randomization and Supplies/Randomization List APIs/v4.0

The operations from the Randomization and Supplies/Randomization List APIs/v4.0 category.

Get randomization list: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists
Get randomization list by ID: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}
Get randomization number: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/randlists/{rndlistid}/randnumbers

Randomization and Supplies/Randomization List APIs/v5.0

The operations from the Randomization and Supplies/Randomization List APIs/v5.0 category.

Get randomization list based on query parameter: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/randlists

Randomization and Supplies/Report APIs/v1.0

The operations from the Randomization and Supplies/Report APIs/v1.0 category.

Get (Dynamic DND)/DNDExceptions report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/dndexceptions
Get Blinded Randomization List report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/blindedrandreport
Get Cohort Enrollment Audit Trail report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments/history
Get Cohort Enrollment report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/cohortenrollments
Get dose hold settings report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/doseholdsettings
Get Kit Blinded Chain of Custody report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Inventory Blinded report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
Get Kit Inventory Unblinded report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
Get Kit Reconciliation report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/recon
Get local source settings report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/locallysourcedkits
Get minimizatoin list report.: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/minimization
Get Order Summary report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/order-summary
Get partial dispensation settings report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/partialdispensations
Get Randomization List report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/randList
Get Study Design kit list report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/kitlist
Get Study Design report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/supplysettings
Get Study Inventory Settings report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/inventorysettings
Get System Usage report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/shipments
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/dispensations-audit
Get Titration Summary (Blinded) report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/blinded-titration-summary
Get Titration Summary (Unblinded) report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/titration-summary
Get Unblinded Visit Schedule report: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule

Randomization and Supplies/Report APIs/v2.0

The operations from the Randomization and Supplies/Report APIs/v2.0 category.

Get dose hold settings report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/doseholdsettings
Get Kit Blinded Chain of Custody report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Inventory Blinded report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
Get Kit Inventory Unblinded report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
Get Kit Reconciliation report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/recon
Get Order Summary report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/order-summary
Get Randomization List report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get Study Design report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/supplysettings
Get Study Inventory Settings report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/inventorysettings
Get Subject Data report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/subjects
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/dispensations
Get Titration Summary (Unblinded) report, added dosingCalculations in response: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/titration-summary
Get Unblinded Visit Schedule report. new fields Kit Replacement, Dispensed Date.: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/reports/unblinded-visit-schedule

Randomization and Supplies/Report APIs/v3.0

The operations from the Randomization and Supplies/Report APIs/v3.0 category.

Get Kit Blinded Chain of Custody report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/blindedchainofcustody
Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Inventory Blinded report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/blindedInventory
Get Kit Inventory Unblinded report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/kits/unblindedInventory
Get Kit Reconciliation report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/recon
Get Order Summary report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/order-summary
Get Randomization List report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get Study Inventory Settings report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/inventorysettings
Get Subject Data report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/subjects
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Report APIs/v4.0

The operations from the Randomization and Supplies/Report APIs/v4.0 category.

Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Kit Reconciliation report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/recon
Get Order Summary report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/order-summary
Get Randomization List report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/unblindedrandreport
Get Subject Data report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/subjects
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Report APIs/v5.0

The operations from the Randomization and Supplies/Report APIs/v5.0 category.

Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get Order Summary report: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/order-summary
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Report APIs/v6.0

The operations from the Randomization and Supplies/Report APIs/v6.0 category.

Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Report APIs/v7.0

The operations from the Randomization and Supplies/Report APIs/v7.0 category.

Get Kit Chain of Custody Unblinded report: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/reports/kits/chainofcustody
Get the Subject Dispensation report: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/reports/dispensations

Randomization and Supplies/Settings APIs/v1.0

The operations from the Randomization and Supplies/Settings APIs/v1.0 category.

Create a resupply group: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
Create blinding group: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups
Create or update selected depot resupply associations: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies/updateselected
Create or update selected site resupply associations: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies/updateselected
Delete a resupply by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Delete blinding group by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Get a resupply group by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Get all blinding groups: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups
Get all depot resupplies: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/depot/resupplies
Get all resupply groups: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies
Get all site resupplies: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/site/resupplies
Get blinding group by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Get kit types which do not belong to any blinding group: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/kittypes/noblindinggroup
Update a resupply by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Update blinding group: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}

Randomization and Supplies/Settings APIs/v2.0

The operations from the Randomization and Supplies/Settings APIs/v2.0 category.

[Deprecated]: Get supply settings: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
[Deprecated]: Update supply settings: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/supply/settings
Create a resupply group: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
Get a resupply group by ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}
Get all blinding groups: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups
Get all resupply groups: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies
Get blinding group by ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/blindinggroups/{blindingGroupId}
Update a resupply by ID: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupplies/{resupplyId}

Randomization and Supplies/Settings APIs/v3.0

The operations from the Randomization and Supplies/Settings APIs/v3.0 category.

[Deprecated]: Get supply settings: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings
[Deprecated]: Update supply settings: Method: put
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v4.0

The operations from the Randomization and Supplies/Settings APIs/v4.0 category.

Get supply settings: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings
Update supply settings: Method: put
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v5.0

The operations from the Randomization and Supplies/Settings APIs/v5.0 category.

Get supply settings: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings
Update supply settings: Method: put
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v6.0

The operations from the Randomization and Supplies/Settings APIs/v6.0 category.

Get supply settings: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings
Update supply settings: Method: put
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v7.0

The operations from the Randomization and Supplies/Settings APIs/v7.0 category.

Update supply settings: Method: put
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v8.0

The operations from the Randomization and Supplies/Settings APIs/v8.0 category.

Update supply settings: Method: put
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Settings APIs/v9.0

The operations from the Randomization and Supplies/Settings APIs/v9.0 category.

Update supply settings: Method: put
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/supply/settings

Randomization and Supplies/Shipment APIs/v1.0

The operations from the Randomization and Supplies/Shipment APIs/v1.0 category.

[Deprecated]: Add additional kits to a received shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
[Deprecated]: Mark kits as received for a given site: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
[Deprecated]: Update status of a received kit: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/kits
Add kits to an order shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Assign Pooling Shipment kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentNumber}/assignkits
Cancel recon shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/cancel
Cancel shipments: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/cancel
Confim order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/confirmed
Create a manual depot shipment in resupply strategy: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/resupply/depotmanual
Create shipment for kits marked for destruction from a given site to depot: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments
Create shipment for kits marked for destruction in a study: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments
Get kit details by order: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits eligible to be received against a shipment: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received/eligible-kits
Get kits or a specific kit for a shipment: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get list of lost shipments: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/mark-lost
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get order items: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders-inventory/audit
Invalidate order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}/invalid
Mark kits as received: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
Mark shipments as lost: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/mark-lost
Received shipment for destruction: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/destroyed
Regenerate order form: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/regenerate-order-form
Remove kits from an order shipment: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/removeKits
Search kits by kit type or shipment details: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Search orders in the given date range matching the status: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders
Update a Qurantine shipment and its kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/receive-quarantined
Update a shipment's ship date: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/ship-date
Update a shipment's tracking details: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/tracking
Update shipment and its kits as quarantined: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
Update shipment as received for destruction: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/recon/shipments/{shipmentId}/received
Update shipment details for an order: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/orders/{shipmentId}
Update shipping date: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/ship-date
Update tracking details for an order shipment: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/shipments/{shipmentId}/tracking

Randomization and Supplies/Shipment APIs/v2.0

The operations from the Randomization and Supplies/Shipment APIs/v2.0 category.

[Deprecated]: Mark kits as received for a given site: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/received
Create a resupply strategy: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/resupply
Create first shipment in resupply strategy: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/initial
Create manual shipment in resupply strategy: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/resupply/manual
Create shipment for kits marked for destruction from a given site to depot: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/recon/shipments
Get a shipment's details by ID for a site: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits or a specific kit for a shipment: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get shipment by shipment ID: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}
Initiate manual resupply to a site: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/resupply/manual
List available order status values: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipment-statuses
Mark kits as received: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/received
Search kits by kit type or shipment details: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Search orders in the given date range matching the status: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders
Search shipments for a site: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/sites/{siteId}/shipments
Search shipments for a study: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments
Update shipment and its kits as quarantined: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/shipments/{shipmentId}/quarantined
Update shipment details for an order with deliveryNumber: Method: put
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/orders/{shipmentId}

Randomization and Supplies/Shipment APIs/v3.0

The operations from the Randomization and Supplies/Shipment APIs/v3.0 category.

Create a async resupply strategy: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupply/resupply
Create manual shipment in resupply strategy: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/resupply/manual
Get a shipment's details by ID for a site: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get kits or a specific kit for a shipment: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}/kits
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get orders: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/orders
Get shipment by shipment ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}
List available order status values: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipment-statuses
Search kits by kit type or shipment details: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments/{shipmentId}/eligible-kits
Search shipments for a site: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/sites/{siteId}/shipments
Search shipments for a study: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/shipments

Randomization and Supplies/Shipment APIs/v4.0

The operations from the Randomization and Supplies/Shipment APIs/v4.0 category.

Get a shipment's details by ID for a site: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/sites/{siteId}/shipments/{shipmentId}
Get kit details by order: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}/kits
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders/{shipmentId}
Get orders: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/orders
Get shipment by shipment ID: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments/{shipmentId}
List available order status values: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipment-statuses
Search shipments for a study: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/shipments

Randomization and Supplies/Shipment APIs/v5.0

The operations from the Randomization and Supplies/Shipment APIs/v5.0 category.

Get details of orders: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/orders
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/orders/{shipmentId}
Search shipments for a study: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/shipments

Randomization and Supplies/Shipment APIs/v6.0

The operations from the Randomization and Supplies/Shipment APIs/v6.0 category.

Get details of orders: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/orders
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/orders/{shipmentId}
Search shipments for a study: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/shipments

Randomization and Supplies/Shipment APIs/v7.0

The operations from the Randomization and Supplies/Shipment APIs/v7.0 category.

Get details of orders: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/orders
Get order details by a shipment ID: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/orders/{shipmentId}

Randomization and Supplies/Study Import APIs/v1.0

The operations from the Randomization and Supplies/Study Import APIs/v1.0 category.

Get unique values for treatments, stratums or cohorts from a CSV file: Method: post
Path: /ec-ors-svc/rest/v1.0/import/{studyId}/{version}
Update study version: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/studyversions/{version}

Randomization and Supplies/Subject APIs/v1.0

The operations from the Randomization and Supplies/Subject APIs/v1.0 category.

Retrieves VisitDate for particular subejctID and VisitID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/visits/{visitId}/status
Check if titration has any impact on kit dispensation: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-impact
Get a list of all randomized subjects: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/randomized
Get a list of all subjects: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/{siteId}/subjects

Randomization and Supplies/Supply Settings APIs/v1.0

The operations from the Randomization and Supplies/Supply Settings APIs/v1.0 category.

Create local source settings for kit types: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits
Delete local source settings by ID: Method: delete
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}
Get all local source settings: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits
Get local source settings by ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}
Get local source settings for a Subject ID: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/locally-sourced-kits
Update local source settings by ID: Method: put
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/locally-sourced-kits/{id}

Randomization and Supplies/Titration APIs/v1.0

The operations from the Randomization and Supplies/Titration APIs/v1.0 category.

[Deprecated]: Check if subject is eligible for titration: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible

Randomization and Supplies/Titration APIs/v2.0

The operations from the Randomization and Supplies/Titration APIs/v2.0 category.

[Deprecated]: Check if subject is eligible for titration: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible

Randomization and Supplies/Titration APIs/v3.0

The operations from the Randomization and Supplies/Titration APIs/v3.0 category.

Check if subject is eligible for titration: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible

Randomization and Supplies/Visit APIs/v1.0

The operations from the Randomization and Supplies/Visit APIs/v1.0 category.

Get code break: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
Get code view: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
Get dose hold history: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld-history
Get kits allowed for dose hold: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
Get kits which are marked as dose hold: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get list of visits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits
Get randomization history: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history
Get reusable kits: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get reusable kits from a list of kit types: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get subject treatment: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/treatment
Get treatment arm and cohort for a subject: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/details
Get treatment arm for a list of subjects: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment
Get treatment arm for a subject: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-treatment
Get unblinded dispensation history: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-disp-history
Get unblinded dispensation history for all subjects: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-disp-history
Get unblinded randomization history: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history
Get unblinded randomization history for all subjects: Method: get
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/unblinded-rand-history
Replace a subject's kits: Method: post
Path: /ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits

Randomization and Supplies/Visit APIs/v10.0

The operations from the Randomization and Supplies/Visit APIs/v10.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v10.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v11.0

The operations from the Randomization and Supplies/Visit APIs/v11.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v11.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v12.0

The operations from the Randomization and Supplies/Visit APIs/v12.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v12.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v13.0

The operations from the Randomization and Supplies/Visit APIs/v13.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v13.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v14.0

The operations from the Randomization and Supplies/Visit APIs/v14.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v14.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v14.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v15.0

The operations from the Randomization and Supplies/Visit APIs/v15.0 category.

Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v15.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomize subject or dispense kit during visit: Method: post
Path: /ec-ors-svc/rest/v15.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v16.0

The operations from the Randomization and Supplies/Visit APIs/v16.0 category.

Randomize subject or dispense kit during visit: Method: post
Path: /ec-ors-svc/rest/v16.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v2.0

The operations from the Randomization and Supplies/Visit APIs/v2.0 category.

Get code break: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codebreak
Get code view: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/codeview
Get kits allowed for dose hold: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds
Get kits which are marked as dose hold: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get randomization history: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/randomization-history
Get reusable kits from a list of kit types: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get unblinded dispensation history for all subjects: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-disp-history
Get unblinded randomization history: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/unblinded-rand-history
Get unblinded randomization history for all subjects: Method: get
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/unblinded-rand-history
Replace a subject's kit KitNumber: Method: post
Path: /ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits

Randomization and Supplies/Visit APIs/v3.0

The operations from the Randomization and Supplies/Visit APIs/v3.0 category.

[Deprecated]: Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit
Get kits which are marked as dose hold: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld
Get reusable kits from a list of kit types: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits
Get unblinded dispensation history for all subjects: Method: get
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/unblinded-disp-history
Replace a subject's kit KitNumber: Method: post
Path: /ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{srcSubjectId}/replacekits

Randomization and Supplies/Visit APIs/v4.0

The operations from the Randomization and Supplies/Visit APIs/v4.0 category.

[Deprecated]: Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/visits/subjectvisit
Get unblinded dispensation history for all subjects: Method: get
Path: /ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/unblinded-disp-history

Randomization and Supplies/Visit APIs/v5.0

The operations from the Randomization and Supplies/Visit APIs/v5.0 category.

[Deprecated]: Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v5.0/studies/{studyId}/{mode}/visits/subjectvisit

Randomization and Supplies/Visit APIs/v6.0

The operations from the Randomization and Supplies/Visit APIs/v6.0 category.

[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/visits/subjectvisit
Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v6.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Randomization and Supplies/Visit APIs/v7.0

The operations from the Randomization and Supplies/Visit APIs/v7.0 category.

[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Randomization and Supplies/Visit APIs/v8.0

The operations from the Randomization and Supplies/Visit APIs/v8.0 category.

[Deprecated]: Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
[Deprecated]: Schedule visit: Method: post
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/visits/subjectvisit
Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v8.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Randomization and Supplies/Visit APIs/v9.0

The operations from the Randomization and Supplies/Visit APIs/v9.0 category.

Get dispensation history: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Get visit by visit ID: Method: get
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit
Schedule visit: Method: post
Path: /ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/visits/subjectvisit

Reporting/v1.0

The operations from the Reporting/v1.0 category.

[Deprecated]: Delete a report based on path parameters: Method: delete
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports
[Deprecated]: Download generated report based on query parameters: Method: get
Path: /ec-reporting-svc/rest/v1.0/reports/download
[Deprecated]: Download report for a given report job id: Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/download
[Deprecated]: Generate a report based on search specifications and path parameters: Method: post
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports
[Deprecated]: Generate and paginate a report: Method: post
Path: /ec-reporting-svc/rest/v1.0/reports/page
[Deprecated]: Get generated reports available for download: Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata/downloadList
[Deprecated]: Get metadata for a specific report based on query parameters: Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata/reportId/{id}
[Deprecated]: Get metadata for a specific report by ID: Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reportmetadata/reportId/{id}
[Deprecated]: Get metdata for all reports based on path paramaters: Method: get
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reportmetadata
Aggregate data for Oracle CRF Submit: Method: post
Path: /ec-reporting-svc/rest/v1.0/crf/reports
Delete a report based on query parameters: Method: delete
Path: /ec-reporting-svc/rest/v1.0/reports
Generate a report based on search specifications and query parameters: Method: post
Path: /ec-reporting-svc/rest/v1.0/reports
Generate a report based on the direct report payload: Method: post
Path: /ec-reporting-svc/rest/v1.0/studies/{studyId}/{mode}/reports/direct
Generate a scheduled report: Method: post
Path: /ec-reporting-svc/rest/v1.0/scheduled/reports
Get metdata for all reports based on query paramaters: Method: get
Path: /ec-reporting-svc/rest/v1.0/reportmetadata
Kickstarts the generation of report: Method: post
Path: /ec-reporting-svc/rest/v1.0/report/job/{jobId}
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.

[Deprecated]: Download report generated for a given study ID and mode: Method: get
Path: /ec-reporting-svc/rest/v2.0/studies/{studyId}/{mode}/reports/download
[Deprecated]: Generate and paginate a report: Method: post
Path: /ec-reporting-svc/rest/v2.0/reports/page
Download report for a given report job id: Method: get
Path: /ec-reporting-svc/rest/v2.0/reports/download
Generate a report based on the direct report payload: Method: post
Path: /ec-reporting-svc/rest/v2.0/studies/{studyId}/{mode}/reports/direct
Generate a scheduled report: Method: post
Path: /ec-reporting-svc/rest/v2.0/scheduled/reports
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/v1.0

The operations from the Rules/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]: Job Status rules: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/jobStatus
[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 All or Future data: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rulemgt/studies/{studyId}/{mode}/{publishRun}
Cancel jobs: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/cancelRuleJob
Copy all rules from one study mode to another: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/copy
Debug a rule: Method: put
Path: /ec-rule-svc/rest/v1.0/studies/{studyId}/{mode}/debugRule
Delete rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/bulkdelete
Delete UI rules 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 by study ID based on study mode: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}
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 rule Operands list by rule IDs: Method: post
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/ruleIds/operands
Get rules by form ID which are in both valid and enabled states: Method: get
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}/valid
Get visits/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}
Update rule states in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/from/{fromState}/to/{toState}/bulkstateupdate
Validate copied rules: Method: put
Path: /ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/validateCopiedRules

Rules/v2.0

The operations from the Rules/v2.0 category.

[Deprecated]: 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
Job Status rules: Method: put
Path: /ec-rule-svc/rest/v2.0/studies/{studyId}/{mode}/jobStatus

Rules/v3.0

The operations from the Rules/v3.0 category.

[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}
Get rule by rule ID: Method: get
Path: /ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/ruleId/{ruleId}

Rules/v4.0

The operations from the Rules/v4.0 category.

Update rules in bulk: Method: put
Path: /ec-rule-designer-svc/rest/v4.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}

Sites and Depots/Country/v1.0

The operations from the Sites and Depots/Country/v1.0 category.

Add a region: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
Associate countries to site or depot: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{sdfId}
Disassociate country from site: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfcountry/{sdfCountryId}
Get association between country and site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfcountry
Get country based on country ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}
Get country name: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country
Get states based on country ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{countryId}/states
Update countries association to site: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/country/{sdfId}

Sites and Depots/Country/v2.0

The operations from the Sites and Depots/Country/v2.0 category.

Associate countries and states to site or depot: Method: post
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country/{sdfId}
Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfcountry
Get country name: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/country
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.

Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/sdfcountry
Get country name: Method: get
Path: /ec-site-svc/rest/v3/studies/{studyId}/{mode}/country

Sites and Depots/Country/v4.0

The operations from the Sites and Depots/Country/v4.0 category.

Get association between country and site (ISO3 codes): Method: get
Path: /ec-site-svc/rest/v4/studies/{studyId}/{mode}/sdfcountry
Get country name: Method: get
Path: /ec-site-svc/rest/v4/studies/{studyId}/{mode}/country

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/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 all associated entities with given contact or organization: Method: put
Path: /ec-site-svc/rest/v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage/all
Manage associated entities with given contact or organization: Method: put
Path: /ec-site-svc/rest/v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage

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.

Add an association between a lab and a site: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
Create or update lab normals: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals
Delete lab if site association with lab does not exist: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Delete the lab's association with the given site: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/siteslabs
Deprecated: Create a lab: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
Get all lab normals: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}/labnormals
Get all lab normals for given subject: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{labId}/labnormals/lookup
Get all labs associated with a given site: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs
Get lab details of a given lab ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}
Get lab history for the given labId: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}/history
Update a lab: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/labs/{id}

Sites and Depots/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 criterias: 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/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}

Sites and Depots/Region/v1.0

The operations from the Sites and Depots/Region/v1.0 category.

Delete a region: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Get a region's details: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}
Get history of regions: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/regions/history
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 countries associated to a region: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}/countries
Get list of regions: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions
Get region by country: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/filter/countries/{countryId}
Update a region and associated countries: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/regions/{regionId}

Sites and Depots/Region/v2.0

The operations from the Sites and Depots/Region/v2.0 category.

Add a region: Method: post
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions
Get list of countries and states associated to a region: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}/countries
Get list of regions: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions
Get region by country or state Id: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/filter/countries/{countryId}
Get region details: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/regions/{regionId}
Update 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/Site Address/v1.0

The operations from the Sites and Depots/Site/Site Address/v1.0 category.

Create site address: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address
Delete site address by site and address ID: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}
Update site address by site and address ID: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/address/{addressId}

Sites and Depots/Site/Site Extended Property/v1.0

The operations from the Sites and Depots/Site/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
Update extended properties by site ID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedProperties

Sites and Depots/Site/Site LOV/v1.0

The operations from the Sites and Depots/Site/Site LOV/v1.0 category.

Get sites by column, type and status: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/lov/{pathAttr}
Get the principal investigator's full name for all sites: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/properties/piname

Sites and Depots/Site/Site Property/v1.0

The operations from the Sites and Depots/Site/Site Property/v1.0 category.

[Deprecated]: Delete SDF property by property ID: Method: delete
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
Create site property: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
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 all properties of the site by SDF ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property
Get global site property by property name: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties/{propName}
Get site property by SDF and property ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}/property/{propId}
Update the site global property by ID: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/globalProperties

Sites and Depots/Site/v1.0

The operations from the Sites and Depots/Site/v1.0 category.

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 a site: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
Create a site and send notification: Method: post
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf
Delete a site by ID: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Delete depot email: Method: delete
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/deleteDepotEmail
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}
Get a site by ID: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Get a site by SDF ID for tenant: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/tenant/{sdfId}
Get all site study version: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allstudyversions/{sdfType}
Get all sites by type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/all
Get all sites by type and study version: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/allstudyversions
Get countries for a site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/countries
Get countries for a site by SDF type: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/countries
Get SDF information with creation date by SDF type: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/creationDate
Get site by filter parameters: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/siteFilterPaginated
Get site by site name and address: Method: get
Path: /ec-site-svc/rest/v1/tenant/sdfs/autoSuggest
Get site by site name or address and type of SDF: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/search
Get site by site name or address and type of SDF (UI search autocomplete): Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/autoSuggest
Get site details for IDs sent in payload: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/sdfDetails
Get sites by type or list of countries: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs
Get sites on search key: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/searchSite
Get the principal investigator's last name and address of the site: Method: get
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/pinaddr
Update a site: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/{sdfId}
Update a site and send notification: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/sdf/{sdfId}
Update all sites with a new study version: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/versionupdate
Update site properties for managing sites: Method: put
Path: /ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs/multiple

Sites and Depots/Site/v2.0

The operations from the Sites and Depots/Site/v2.0 category.

Generate report for sites: Method: post
Path: /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/report/{reportName}
Get a site by ID: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/{sdfId}
Get countries by type: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/countries
Get sites in a paginated format: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/paginated
Get the principal investigator's last name and address of the site: Method: get
Path: /ec-site-svc/rest/v2/studies/{studyId}/{mode}/sdfs/pinaddr

Sites and Depots/Site/v3.0

The operations from the Sites and Depots/Site/v3.0 category.

Generate report for sites: Method: post
Path: /ec-site-svc/rest/v3.0/studies/{studyId}/{mode}/report/{reportName}

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}
Filter by Mode ID and association ID to get Study Sites: Method: get
Path: /ec-site-svc/rest/v1.0/tenantsite/associations/{associationId}/studySites
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 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.

Create Depot Country/State association by depot GUID, country GUID, state GUID: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Create kit settings by sdfId: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Create or Update Extended Properties for all Sites filtered by paramaters passed: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/extendedPropertiesByFilter
Create site/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 sdfId: Method: delete
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Fetch kit settings by sdfId: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Get a 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 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 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 details by study ID and filters or all depots details by study ID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/allSdf/{sdfType}
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 site or depot information by Id: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/sdfRegion/{sdfId}
Paginated API to get SDF Countries or States associated for depot GUID: Method: get
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/country/{sdfId}
Update kit settings by sdfId: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/kitSettings/{sdfId}
Update or Remove Depot Country/State association by depot GUID, country GUID, state 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 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
Update site/depot with study id and master address: Method: put
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}/{sdfId}
Validate fields for Study Labs/Depots/Sites: Method: post
Path: /ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/{sdfType}/validateFields

Users, Permissions and Roles/Data Classification/v1.0

The operations from the Users, Permissions and Roles/Data Classification/v1.0 category.

Assign data classifications to 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 list of data classification for a tenant: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification
Get list of data classification with levels: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/{studyId}/{mode}/user/{userId}
Get specific data classifications for all study roles 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
Get tenant data classifications for study role: Method: get
Path: /ec-auth-svc/rest/v1.0/dataclassification/studyrole/{studyRoleId}

Users, Permissions and Roles/Permissions/v1.0

The operations from the Users, Permissions and Roles/Permissions/v1.0 category.

Get a user's global rights: Method: get
Path: /ec-auth-svc/rest/v1.0/globalrights
Get a user's ID: Method: get
Path: /ec-auth-svc/rest/v1.0/userids/{username}
Get a user's info: Method: get
Path: /ec-auth-svc/rest/v1.0/userinfo
Get a user's permissions: Method: get
Path: /ec-auth-svc/rest/v1.0/rights
Get a user's rights: Method: get
Path: /ec-auth-svc/rest/v1.0/allrights
Get a user's rights for all studies: Method: get
Path: /ec-auth-svc/rest/v1.0/allStudyRights
Get studies and modes: Method: get
Path: /ec-auth-svc/rest/v1.0/studies
Get user name: Method: get
Path: /ec-auth-svc/rest/v1.0/usernames/{userid}
Get users and rights in a study: Method: get
Path: /ec-auth-svc/rest/v1.0/{studyId}/userrights
Verify right name: Method: get
Path: /ec-auth-svc/rest/v1.0/rightname/{rightname}

Users, Permissions and Roles/Permissions/v2.0

The operations from the Users, Permissions and Roles/Permissions/v2.0 category.

Get a user's info: Method: get
Path: /ec-auth-svc/rest/v2.0/userinfo

Users, Permissions and Roles/Reports/v1.0

The operations from the Users, Permissions and Roles/Reports/v1.0 category.

[Deprecated]: Generate a user assignment report: Method: post
Path: /ec-auth-svc/rest/v1.0/report/globalstudyrole/{reportName}
[Deprecated]: Generate a user assignment report: Method: post
Path: /ec-auth-svc/rest/v1.0/{studyId}/{mode}/report/{reportName}
Generate a global report: Method: post
Path: /ec-auth-svc/rest/v1.0/report/{reportName}
Generates the user upload error report: Method: post
Path: /ec-auth-svc/rest/v1.0/{studyId}/{mode}/report/uploaderror/{reportName}

Users, Permissions and Roles/Reports/v2.0

The operations from the Users, Permissions and Roles/Reports/v2.0 category.

Generate a user assignment report: Method: post
Path: /ec-auth-svc/rest/v2.0/{studyId}/{mode}/report/{reportName}
Generates the 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.

Get the list of roles: Method: get
Path: /ec-auth-svc/rest/v2.0/authroles

Users, Permissions and Roles/Roles/Study Roles/v1.0

The operations from the Users, Permissions and Roles/Roles/Study Roles/v1.0 category.

Create a study role group for a study: Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
Create a study role group for an organization: Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles
Create study roles list for a study: Method: post
Path: /ec-auth-svc/rest/v1.0/studyroles/copy/{studyId}
Delete study roles list for a study: Method: delete
Path: /ec-auth-svc/rest/v1.0/studyroles/remove/{studyId}
Get groups of permissions: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyroleid}/rightsgroups
Get groups of permissions 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 an organization: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles
Get list of study roles for studyId and studyRoleId: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}/{studyRoleId}
Get study roles list for studyRoleId: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/studyroleid/{studyRoleId}
Get the list of study roles for a studyId: Method: get
Path: /ec-auth-svc/rest/v1.0/studyroles/{studyId}
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.

Get list of study roles for an organization: Method: get
Path: /ec-auth-svc/rest/v2.0/studyroles
Get the list of study roles for a studyId: Method: get
Path: /ec-auth-svc/rest/v2.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}
Get a global user's roles: Method: get
Path: /ec-auth-svc/rest/v2.0/globalusers/{userid}/roles
Get list of roles for a study: Method: get
Path: /ec-auth-svc/rest/v2.0/authroles/{studyId}
Get 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.

Get a user's modes and roles: Method: get
Path: /ec-auth-svc/rest/v3.0/authusers/{userid}/studies/{studyId}
Get list of roles for a study: Method: get
Path: /ec-auth-svc/rest/v3.0/authroles/{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/Upload Users template/v1.0

The operations from the Users, Permissions and Roles/Upload Users template/v1.0 category.

Download the Clinical One upload user template file: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/studies/{studyId}/usersuploadtemplate

Users, Permissions and Roles/Users/v1.0

The operations from the Users, Permissions and Roles/Users/v1.0 category.

Create and assign bulk users: Method: post
Path: /ec-auth-svc/rest/v1.0/authusers/studies/{studyId}/bulk
Delete user attributes by userId: 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 list of users: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers
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 details by user ID: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}
Get user language by userId: Method: get
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/language
Get users for a depot: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/depots/{depotId}/users
Get users for a right: Method: get
Path: /ec-auth-svc/rest/v1.0/notifications/{rightname}/users
Get users for a site: Method: get
Path: /ec-auth-svc/rest/v1.0/authstudies/{studyId}/sites/{siteId}/users
Get users 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 userId: Method: put
Path: /ec-auth-svc/rest/v1.0/authusers/{userid}/locale

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.

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