Send Requests

Use the following guidelines when sending requests using the Fluid Recruiting REST API.

URL Structure

Access the Fluid Recruiting REST resources using the following URL structure:

https://<subdomain>.<domain>.com:<port>/<resource-path>

Where:

• <subdomain.domain>.com:<port>: Host and port where Fluid Recruiting is running.

• <resource-path>: Relative path that defines the resource.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP method requests, as summarized in the following table.

HTTP Method	Description
GET	Retrieve information about the Fluid Recruiting resource.
HEAD	Retrieve header information about the Fluid Recruiting resource.
POST	<Create, scale, backup, etc> the Fluid Recruiting resource.
PUT	Update the Fluid Recruiting resource.
PATCH	Patch the Fluid Recruiting resource.
OPTIONS	Retrieve information about the options and requirements for the Fluid Recruiting resource.
DELETE	Delete the Fluid Recruiting resource.

Media Types

The following media types are supported by the Fluid Recruiting REST API:

• application/json

Supported Headers

The Fluid Recruiting REST API supports the following headers that may be passed in the header section of the HTTP request or response.

Header	Description	Example
Accept-Encoding	List of acceptable encodings to support compression.	Accept-Encoding: gzip
Content-Encoding	List of acceptable encodings to support compression.	Content-Encoding: deflate
Content-Type	Media type of the body of the request. Required for POST and PUT requests.	Content-Type: application/json
X-ID-TENANT-NAME	Identity domain name of the Fluid Recruiting, used for authentication.	X-ID-TENANT-NAME:ExampleIdentityDomain