REST API Reference

Back Next

Get the job ID

To start a job, you need to retrieve the job ID.

Use the following GET request to fetch the job ID:

GET /dbmi/public/api/v2/task/fetch/{taskId}/job

Include the following attribute in the request:

Field	Type	Description
taskId	integer	ID of the deployed task.

Sample request

Use the following sample as reference to get the job ID:

GET https://pod-ing.ics.dev:11447/dbmi/public/api/v2/task/fetch/2/job

Sample response

A successful response returns the job ID and related details for the specified task ID similar to the following example:


          {
  "jobId": 15,
  "assetName": "sftosnw_15",
  "location": "Default"
}

Only one job ID is returned for the specified task ID.

Failed responses and error codes

If the request fails, the API might return one of the following HTTP error codes:

HTTP status code	Error code	Error message
401	CDIR_AUTH_UNAUTHORIZED	Authentication failed.
403	CDIR_AUTHZ_FORBIDDEN	You do not have the required permissions to perform this job.
404	CDIR_JOB_NOT_FOUND	Job{JobId} was not found.
500	CDIR_INTERNAL_ERROR	Unexpected error occurred during deployment.
503	CDIR_SERVICE_ UNAVAILABLE	Service is temporarily unavailable.

The following example shows a sample error response when the request to get the job ID specifies a task ID that does not exist:

{
    "error": {
        "httpStatus": 404,
        "code": "CDIR_JOB_NOT_FOUND",
        "message": "Job {73512912} was not found.",
        "details": [
            {
                "jobId": "73512912"
            }
        ],
        "traceId": "bdcf8f6c-ccb0-4e6a-9c43-2b102f338980"
    }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Get the job ID

Get the job ID

Sample request

Sample response

Failed responses and error codes