Use cases
As an API developer, there are several common use cases that will help you get started.
The information presented here is destined for API developers. System administrators or user administrators do not need to make API calls or learn Oracle Clinical One Platform use cases. However, they may use the information included in this section to understand the responsibilities of an API developers working with Oracle Clinical One Platform APIs.
The table below lists the list of use cases you have at your disposal to learn more about the main workflows in Oracle Clinical One Platform and the exact steps that you must take in order to make the appropriate API calls. Every use case contains a set of specific steps that are connected to a specific API endpoint in the Tasks chapter of this REST API User Guide. That way, you learn more about the context of the task and the API commands that you must follow.
Purpose | Use case | Study role to assign | More information on the role |
---|---|---|---|
Design a new study and perform the first steps |
As an API developer, you must be assigned the following study role template:
|
To learn more about the permissions included in this template study role, see the Study Designer template role. |
|
Add randomization to a study | Add randomization to a study | As an API developer, you must be assigned the following study role teamplate:
|
To learn more about the permissions included in this template study role, see the Study Designer template role. |
Create and download a standard reports |
There are specific reporting permissions that you can add to your study role to access reporting APIs. There is not one defined study template that can be assigned to specifically download reports. |
To establish which study role and permissions to assign for this use case, reach out to your Oracle project manager. |
|
Perform ODM-XML data extracts |
As an API developer, you must be assigned the following study role template:
|
To learn more about the permissions included in this template role, see the ODM Extract template role. |
|
Save data in a form |
As an API developer, you must be assigned the following study role template:
|
To learn more about the permissions included in this template role, see the Site User template role. |
|
Retrieve study information |
Retrieve study information |
As an API developer, you must be assigned the following study role template:
|
To learn more about the permissions included in this template study role, see the Study Designer template role. |