REST API for Oracle Fluid Recruiting Cloud

Resource Methods

You can execute the standard methods to interact with either a singular resource or a resource collection, using their URLs.

Get

Use this method to query and retrieve information. Parameters in a GET method are common for both singular resource and resource collection. However, the parameters used in the query to refine the search or filter the results in a singular resource are different from those used in a resource collection.

The following parameters are used in a GET method for querying a collection resource, in addition to the common parameters.

Parameter	Parameter
limit	A positive integer value that specifies the maximum number of items that a server returns. The server might override the value to improve performance. If the client doesn't specify a limit value, then the server uses a default limit value.
offset	A positive integer value that specifies the index of the first item to be returned. The offset index begins at 0. For example, to return items in a collection, use: offset=0 to return all items starting from the first item in the collection. offset=10 to return all items starting from the 11th item. Note: Specify values for both the limit and offset query parameters to obtain a paginated response. For example, if there are 100 opportunities and a client sends the request GET /opportunities?offset=10 &limit=20, then the response contains opportunities from 11 to 30. Note: There is no implicit ordering if the client specifies only the limit and offset parameter. For limit and offset parameters, the client may encounter inconsistencies if the collection resource is updated between paging requests.

Parameter

limit

A positive integer value that specifies the maximum number of items that a server returns. The server might override the value to improve performance. If the client doesn't specify a limit value, then the server uses a default limit value.

offset

A positive integer value that specifies the index of the first item to be returned. The offset index begins at 0. For example, to return items in a collection, use:

offset=0 to return all items starting from the first item in the collection.
offset=10 to return all items starting from the 11th item.

Note:

Specify values for both the limit and offset query parameters to obtain a paginated response.

For example, if there are 100 opportunities and a client sends the request GET /opportunities?offset=10 &limit=20, then the response contains opportunities from 11 to 30.

Note:

There is no implicit ordering if the client specifies only the limit and offset parameter.
For limit and offset parameters, the client may encounter inconsistencies if the collection resource is updated between paging requests.

Post

Use this method to create a new item. The request media type is as follows:

application/json

Patch

Use this method for making partial updates to a resource. Only the fields contained in the request body are updated. The request media type is as follows:

application/json

Put

Use this method for making partial updates to a resource. The request media type is as follows:

application/json

Delete

Use this method to delete a resource. It doesn't require a request body.