v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Create Job External Reference

Use this endpoint to create a new external reference for a job to an external source and project.

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

post/jobs/external-references

Request body

jobIdstring uuid required

The unique ID for the job (within Acculynx)

sourcestring required

The external source name

projectIdstring required

The project identifier within the external source

Example request

{
  "jobId": "980783c8-7a34-4b20-a644-d6d94eff3b96",
  "source": "This is the source",
  "projectId": "This is the project id"
}

Response

Created

jobIdstring uuid

The unique ID for the job.

companyIdstring uuid

The unique ID for the company.

sourcestring

The source of the external reference

projectIdstring

The projectId of the external reference.

Example response

{
  "jobId": "980783c8-7a34-4b20-a644-d6d94eff3b96",
  "companyId": "980783c8-7a34-4b20-a644-d6d94eff3b96",
  "source": "The external reference source",
  "projectId": "This is the projectId"
}