APIs

Upload a Document to Job

post
https://api.avionte.com/front-office/v1/job//upload-document

Uploads the provided document to the job.

Path Params
string
required

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

Body Params
int32

The identifier for the job document.

int32
required

The identifier for the job.

string
required

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

string
required
length ≤ 255

The name of the document file.

string
length ≤ 50

The type of the document.

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.

string
length ≤ 50

The HCM ID of the user who uploaded the document.

int32
required

The identifier for the user who uploaded the document.

Headers
uuid

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

integer

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

string

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

Responses

401

Unauthorized

403

Access Denied

405

Unsupported method

406

Unsupported format(s) indicated by Accept header

415

Unsupported format(s) indicated by the Content-Type header

429

Too many requests

500

An unexpected error occurred

502

Service Unavailable

504

Gateway Timeout

Updated about 2 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago