1. REST API for Oracle Clinical One PlatformREST API for Clinical One Platform
  2. Use cases
  3. Retrieve study information
  4. Get form information

Get form information

Retrieve information about forms and form items.

Note:

  • To run these Oracle Clinical One Platform API calls, you need to include an authentication token. For instructions on how to generate your authentication token, see Get a token for authentication and Use the token to make an API request.
  • For every API call make sure you construct the URL using the correct server URL and path parameters values.
For the following API calls, you need the studyID, version and mode. These values are retrieved as part of a previous task, see Get study information.

Get a list of forms in a study

Run the following cURL command to get a list of forms in a study:

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v15.0/studies/{studyID}/versions/{version}/forms"

If you want to make subsequent calls for a specific form, take note of the id associated with the form of your interest.

For more details on this API, like its parameters and response objects, see Get a list of forms in a study.

Get a specific form

Given a formID, run the following cURL command to get a specific form: 

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-designer-svc/rest/v16.0/studies/{studyId}/versions/{version}/forms/{formId}"

If you want to make subsequent calls for a specific question, take note of the itemID values associated with the question of your interest.

For more details on this API, like its parameters and response objects, see Get a specific form.

Get rules in a form

Given a formID, run the following cURL command to get rule information: 

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-rule-designer-svc/rest/v1.0/rule/studies/{studyId}/{mode}/form/{formId}"

For more details on this API, like its parameters and response objects, see Get a rule by form ID.

Get rules associated with a question

Given an itemID, run the following cURL command to get rule information: 

curl -X GET "https://tenant.clinicalone.oraclecloud.com/ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/{mode}/item/{itemId}"

For more details on this API, like its parameters and response objects, see Get a rule by question ID.

Tip:

There are many different Clinical One APIs that could provide the information you are looking for. Browse for these and other related APIs under the Tasks section of this guide. If you see any deprecated endpoint, look for its newest version.