Status codes for API calls

When you call any of the Oracle Clinical One Platform REST resources, the Response header returns one of the standard HTTP status codes defined in the following table:

HTTP Status Code Description
200 OK The request was completed successfully A 200 status is returned for a successful GET or POST method.
201 Created The request was fulfilled and resulted in a new resource being created. The response includes a Location header which contains the canonical URI for the newly created resource.

A 201 status is returned from a synchronous resource creation or an asynchronous resource creation that completed before the response was returned.

202 Accepted The request was accepted for processing, but the processing has not been completed. The request may or may not eventually be acted upon, as it may be disallowed at the time processing actually takes place.

When specifying an asynchronous (__detached=true) resource creation (for example, when deploying an application), or update (for example, when redeploying an application), a 202 is returned if the operation is still in progress. If __detached=false, a 202 may be returned if the underlying operation does not complete in a reasonable amount of time.

The response contains a Location header of a job resource that the client should poll to determine when the job has finished. It also returns an entity that contains the current state of the job

400 Bad Request The request could not be processed because it contains missing or invalid information (such as a validation error on a parameter or a missing required value).
401 Unauthorized The request is not authorized. The authentication credentials included with this request are missing or invalid.
403 Forbidden

The user can't be authenticated. The user does not have authorization to perform this request.

Note: Clinical One Cloud Service APIs are protected with access rights in the specific study mode. If the mode query parameter is not specified on the API request, then the default mode used is Design. Hence, if the user is not assigned a role in the Design mode, your call will most likely return a 403 Forbidden status. See About API tasks and corresponding permissions.

404 Not Found The request includes a resource URI that does not exist.
405 Method Not Allowed The HTTP verb specified in the request (DELETE, GET, POST, PUT) is not supported for this request URI.
406 Not Acceptable The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request. For example, the request's Accept header is set to XML but the operation only returns JSON.
415 Unsupported Media Type The client's Content-Type header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
429 Too Many Requests

The limit for external API requests is exceeded.

Throttling limits are configured as a centralized mechanism within Clinical One Cloud Service, and are applied per API category to maintain stability and prevent overload. Currently, these limits are implemented for the following API categories only:
  • Data Hub
  • Data Integration
  • Randomization and Supplies

If the limits are exceeded, the 429 response includes the details on when to retry the request.

This response is in the following format:

Response header: Retry-After: <seconds>

Response: Rate limit exceeded for tenant <tenantId> RetryAfter:<seconds>

Example:
Rate limit exceeded for tenant tenant1 RetryAfter:12
500 Internal Server Error The server encountered an unexpected condition that prevented it from fulfilling the request.
503 Service Unavailable The server is unable to handle the request due to temporary overloading or maintenance of the server. The <ProductName> REST service is not currently running.