hris
job

Update a job

Changed on
patch/hris/{connection_id}/job/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/hris/{connection_id}/job/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Job

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

the job or position title

descriptionstring
codestring

the integration's job code or position number, when it differs from id

is_activeboolean
employment_type'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
company_idstring

(reference to HrisCompany)

parent_idstring

the hris_job this job reports to (position hierarchy)

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

the job or position title

descriptionstring
codestring

the integration's job code or position number, when it differs from id

is_activeboolean
employment_type'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
company_idstring

(reference to HrisCompany)

parent_idstring

the hris_job this job reports to (position hierarchy)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 18cdc3570968Revision changes
    • info

      endpoint added