ACacculynx
jobs

Add Job Document

Use this endpoint to add a job document for a specific job. Special characters and spaces will be removed from the file name before upload.

This endpoint is rate limited. Use the RateLimit-* response headers to check current limits and remaining quota.

post/jobs/{jobId}/documents

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/documents
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Request body multipart/form-data

filestring binary required

The following file types are not allowed: .exe, .com, .dll, .msi, .bat, .cmd, .sh, .pl, .vbs, .py, .php

descriptionstring

A brief description of the file being uploaded

documentFolderIdstring uuid required

Indicates the folder ID where the job document will be saved.

externalIdstring

A field to link the file with a job external reference identifier

externalSourcestring

A field to link the file with a job external reference source

Example request

{
  "description": "invoice for the job XS-3448",
  "documentFolderId": "d3a049c5-49d2-474a-9dba-8fcde2a68587"
}

Response

Accepted

Changes

No recorded changes to this operation across all 2 revisions of this API.