Job

Varsha Neelesh
Varsha Neelesh
  • Updated

Get Job By Id

Use this endpoint to get details of a job by its id including the status of the queued job.

Request

Headers
 Name
 Type
 Required
syncariId

Id of the instance the api is to be run against

string
 
clientRequestId
Client side request id to be used for idempotency in the future

 

string
required-table (1).svg

Path Parameters

 Name
 Type
 Required
jobId

Id of the job

string
required-table (1).svg

Example

Request Sample

curl --request GET \
  --url https://api.syncari.com/api/v1/jobs/jobId \
  --header 'Accept: application/json' \
  --header 'Authorization: 1234' \
  --header 'syncariId: '

Response Sample

{
  "success": true,
  "requestId": "string",
  "timestamp": "string",
  "result": {
    "jobId": "string",
    "status": "string",
    "jobDetails": {
      "displayName": "string",
      "subscriptionName": "string",
      "name": "string",
      "planName": "string",
      "type": "string",
      "syncariId": "string"
    }
  }
}
Share this

Was this article helpful?

0 out of 0 found this helpful