Jobs API

The  vuuh.com  API to track when the job of adding products/order to the system completes (or fails).
﻿
Endpoint URIGET https://onix.vuuh.com/api/v1/jobs/{id}
﻿
Parameters{id} (path parameter, required): The unique identifier (ID) of the job you want to verify.
﻿
AuthenticationAuthentication is required to use this endpoint.   Read more on the ﻿ 🔒⁠⁠Authentication⁠  page.
﻿
Example HTTP Request (cURL)curl -X GET -H "Authorization: Bearer mytoken34" https://onix.vuuh.com/api/v1/jobs/core:ingestjob:234782
﻿
Response200 OK: The job with the specified ID exists in the system.
Example:
{
  "status": "success",
  "substatus": "job_found",
  "job": {
    "id": "core:ingestjob:234782",
    "state": "finished",
    "start_date": "2023-08-29T15:13:18.119189+00:00",
    "end_date": "2023-08-29T15:13:30.107010+00:00",
    "error": ""
  }
}
"job" is an object with the following structure:
key
description
id
The job ID.
state
The current state of the job. It can be: pending, running, failed or finished.
start_date
The date the job started.
end_date
The date the job stopped.
error
The error that caused the job to fail.
400 Bad Request: The job ID is invalid.
Example:
{
  "status": "error",
  "substatus": "invalid_job_id",
  "description": "Invalid ID core::234782 shape."
}
401 Unauthorized: Authentication is required and the provided credentials are missing.
Example:
{
  "status": "error",
  "substatus": "not_authenticated",
  "description": "Authentication credentials were not provided."
}
403 Forbidden: Authentication is required and the provided credentials are invalid.
Example:
{
  "status": "error",
  "substatus": "permission_denied",
  "description": "Invalid token."
}
404 Not Found: The job ID is not found.
Example:
{
  "status": "error",
  "substatus": "job_not_found",
  "description": "ID core:ingestjob:234782 not found."
}
500 Internal Server Error: An internal server error occurred.
Example:
{
  "status": "error",
  "substatus": "internal_error",
  "description": "An internal problem has occurred."
}