v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Jobs

Upload a Document to Job

Uploads the provided document to the job.

post/v1/job/{jobId}/upload-document

Path parameters

jobIdstring required

The unique identifier of the job to which the document will be uploaded.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

jobDocumentIDinteger

The identifier for the job document.

jobIDinteger required

The identifier for the job.

fileContentstring required

The content of the file to be uploaded. This should be a base64 encoded string.

documentTitlestring required

The name of the document file.

documentTypestring

The type of the document.

documentDatestring date-time required

The date the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

uploadedBystring

The HCM ID of the user who uploaded the document.

uploadUserIdinteger required

The identifier for the user who uploaded the document.

Example request

{
  "jobDocumentID": 123456,
  "jobID": 1289822,
  "documentTitle": "Job Description.pdf",
  "documentType": "Job Description",
  "uploadedBy": "JD28942",
  "uploadUserId": 12345
}

Response

The uploaded document.