REST API Reference

Back Next

Deploy the task

After you get the

taskId

, deploy the task using the deploy resource.

Use the following POST request to deploy the task:

POST /dbmi/public/api/v2/task/deploy/{taskId}

Include the following attribute in the request:

Field	Type	Description
taskId	integer	The ID associated with the task.

Sample response

A successful deployment request returns a 202 status code with a summary including the job ID and deployment status, indicating that deployment has started:


         {
  "status": "success",
  "code": 202,
  "message": "Deployment started",
  "data": {
    "jobId": 4,
    "deploymentStatus": "processing_deploy"
  }
}

Deployment runs asynchronously. For tasks that include many tables, deployment might take longer. The API responds immediately with a "Deployment started" message. To monitor the status, query the Get Status Status API with the job ID. For more information, see Get Job Status API.

Failed responses

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

HTTP status code	Error code	Error message
400	CDIR_VALIDATION. INVALID_VALUE	Configuration value {field} is invalid.
401	CDIR_AUTH_UNAUTHORIZED	Authentication failed.
403	CDIR_AUTHZ_FORBIDDEN	You do not have the required permissions to perform this job.
404	CDIR_TASK_NOT_FOUND	Task{TaskId} was not found.
409	CDIR_JOB_ALREADY_DEPLOYED	Job {jobId} is already deployed.
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 you deploy a task that is in an error state:

{
    "error": {
        "httpStatus": 409,
        "code": "CDIR_JOB_ALREADY_DEPLOYED",
        "message": "Job {696921} is already deployed.",
        "details": [
            {
                "jobId": "696921"
            }
        ],
        "traceId": "62956502-7e13-4bfb-920a-6089f7396831"
    }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Deploy the task

Deploy the task

Sample response

Failed responses