Supported HTTP Methods
The most commonly used HTTP methods (or
verbs) are GET
, POST
, PATCH
, and DELETE.
The building blocks of
REST APIs, these methods define actions applied to REST resources
using their URLs. See Custom Actions for more information.
Note:
- REST API response time depends on several factors. Oracle recommends that you periodically review if your REST request requirements have changed. Also check with your service administrator if any capacity adjustments or other changes are required in your service configuration.
- Child resources usually inherit security privileges from their parent resource. Therefore, to use a method on a child resource, you may need to have access to use that method on the parent resource. However, some child resources may have different privilege requirements to access them.
This table lists the methods and their scope for singular and collection resources.
Method | Works with a Singular Resource | Works with a Collection Resource |
---|---|---|
Yes. Gets a single resource. |
Yes. Gets a subset, or all of the resources in the collection. |
|
No.
For a custom method, you can use the |
Yes. Creates a new resource in the collection. |
|
Yes. Updates a resource. |
No. |
|
Yes. Deletes a resource. |
No. |
Custom Actions
A resource might expose a custom action that isn't the standard Create, Read, Update, and Delete (CRUD) action. For example, any custom object functions that are created on standard objects using Application Composer are available as custom actions. A custom action is always initiated using a POST method.
The relevant request media type is:
application/vnd.oracle.adf.action+json
The response media type is:
application/vnd.oracle.adf.actionresult+json
The following request always contains a custom action and optionally, an array of input parameters for the custom action:
application/vnd.oracle.adf.action+json
The JSON schema of the media type is:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Action execution representation.",
"description": "Represents the action execution and its parameters.",
"properties": {
"name": {
"type": "string",
"description": "Action name."
},
"parameters": {
"type": "array",
"description": "Parameter name/value pair.",
}
},
"required": [
"name"
]
}