This endpoint returns the schema details (i.e., what JSON schema should you expect when you ask for the particular data) for a specified profile type, search results, search filters, list of iForms, or specific iForm. Note: iCIMS utilizes the industry standard JSON schema as defined on http://json-schema.org.
Get the JSON schema for the specified profile type
This endpoint provides the JSON schema to expect when calling the Search API.
URL: https://api.icims.com/customers/{customerId}/profiledefinitions/v1/{profileType}/schema
{profileType}
The type of profile. Acceptable values include person, job, company, submittal, source, sourceworkflow, onboard, onboardworkflow, room and connectevent.
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/profiledefinitions/v1/job/schema HTTP/1.1 Example Response Payload (truncated): { |
Get the JSON schema for the specified field
This endpoint provides the JSON schema to expect when calling a specific field from the Profiles API.
URL: https://api.icims.com/customers/{customerId}/profiledefinitions/v1/{profileType}/{field}/schema
{field}
The WebService Field ID for the field.
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/profiledefinitions/v1/job/department/schema HTTP/1.1 Example Response Payload: { |
Get the JSON schema for search results
This endpoint provides the JSON schema to expect when calling the Search API.
URL: https://api.icims.com/customers/{customerId}/search/resultsSchema
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/search/resultsSchema HTTP/1.1 Example Response Payload: { |
Get the JSON schema for search filters
This endpoint provides the JSON schema to expect when calling the Search API.
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/search/filtersSchema HTTP/1.1 Example Response Payload: {
|
Get the JSON schema for iForms
This endpoint provides the JSON schema to expect when calling the "List all iForms accessible via web services" method described on iForms API.
URL: https://api.icims.com/customers/{customerId}/forms/list/schema
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/forms/list/schema HTTP/1.1 Example Response Payload: { |
Get the JSON-schema for a specific iForm
This endpoint provides the JSON schema to expect when calling the "List out all questions for a specified Form" method described on iForms API.
URL: https://api.icims.com/customers/{customerId}/forms/{formName}/meta/data_schema
| Action | Definition |
|---|---|
| Get: |
Example Request: GET /customers/1771/forms/Background_Check_template/meta/data_schema HTTP/1.1 Example Response Payload: { |