Job Posting Types

Job Posting Types

Creates a new job posting type record that does not already exist.

This method will auto-generate an ID and create a new job posting type. If an ID is specified for the job posting type, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The job posting type that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this job posting type

name
required
string (Name)

The name of the job posting type

process_id
string (Process)

The process by which jobs of this type are posted

is_active
boolean (Is Active)

Whether or not this job posting type is active

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

Responses
200The job posting type was saved successfully.
400The job posting type you supplied was invalid.
401Unauthorized.
403Forbidden.
409The job posting type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add job posting type based on tenant limits.
500General server error.
post/jobPostingTypes/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}

Gets all of the job posting types in the system.

This method will scan all job posting types and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The job posting typeswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/jobPostingTypes/{tenantId}
Request samples
curl -i -X GET \
  'https://careers.api.756794052567.rhythmsoftware.com/jobPostingTypes/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a job posting type from the system by its ID.

This method will look up a job posting type by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the job posting type to return.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The job posting type was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The job posting type could not be found.
429Limit exceeded... unable to retrieve job posting type based on tenant limits.
500General server error.
get/jobPostingTypes/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://careers.api.756794052567.rhythmsoftware.com/jobPostingTypes/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}

Updates a job posting type with the specified ID.

This method will update an existing job posting type with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the job posting type to update.

Request Body schema: application/json

The updated job posting type that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this job posting type

name
required
string (Name)

The name of the job posting type

process_id
string (Process)

The process by which jobs of this type are posted

is_active
boolean (Is Active)

Whether or not this job posting type is active

sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

Responses
200The job posting type was updated successfully.
400The job posting type supplied was not valid.
401Unauthorized.
403Forbidden.
404The job posting type could not be found.
409The job posting type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve job posting type based on tenant limits.
500General server error.
put/jobPostingTypes/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}

Partially updates a job posting type with the specified ID.

This method will patch an existing job posting type with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the job posting type to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The job posting type was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The job posting type could not be found.
409The job posting type could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve job posting type based on tenant limits.
500General server error.
patch/jobPostingTypes/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "process_id": "string",
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_directive": "string"
}

Returns a job posting type from the system by its ID.

This method will delete a job posting type with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the job posting type to delete.

Responses
200The job posting type was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The job posting type could not be found.
409The job posting type could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete job posting type based on tenant limits.
500General server error.
delete/jobPostingTypes/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://careers.api.756794052567.rhythmsoftware.com/jobPostingTypes/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"