REST API Reference

Back Next

Stop a database or application ingestion and replication job

Use the stop action of the job resource to stop a

database ingestion and replication

job or

application ingestion and replication

job that has the status Up and Running, Running with Warning, or On Hold.

POST request

Use the following POST request to stop a job:

POST /dbmi/public/api/v2/job/stop

Include the following attribute in the request body:

Field	Type	Description
jobId	integer	The ID of the job that you want to stop.

Request body

Use the following request body to pass the job ID to the resource:

{
  "jobId": "<jobId>"
}

Success response

A successful response returns a status indicating the job has been accepted to stop.

{
  "status": "Success",
  "code": 202,
  "message": "Job with org id 2HimcQ9cXW5kLUCOUkXGi8 and job name zendeskToSlfk-UserA-test_8 has been accepted to stop successfully."
}

The stop job API processes requests asynchronously. To verify whether the job stopped successfully, 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_MISSING_FIELD	Required parameter {field} is missing.
400	CDIR_VALIDATION_INVALID_VALUE	Value for {field} is invalid.
401	CDIR_AUTH_UNAUTHORIZED	Authentication failed. Access token is missing or expired.
403	CDIR_AUTHZ_FORBIDDEN	You do not have the required permissions for this request.
404	CDIR_JOB_NOT_FOUND	Job {jobId} was not found.
409	CDIR_JOB_NOT_DEPLOYED	Deploy the job {jobId} before performing this operation.
409	CDIR_JOB_INVALID_STATE like failed, aborted	Job {jobId} cannot perform the requested action while in state {state}. Verify the job's status before retrying.
500	CDIR_INTERNAL_ERROR	An unexpected internal error occurred with this job.
503	CDIR_SERVICE_UNAVAILABLE	Service is temporarily unavailable.

The following example shows a sample error response when you stop a job that is in a deployed state:

{
    "error": {
        "httpStatus": 409,
        "code": "CDIR_JOB_INVALID_STATE",
        "message": "Job {135332} cannot perform the requested action while in an unexpected state. Verify the job's status before retrying.",
        "details": [
            {
                "jobId": "135332"
            }
        ],
        "traceId": "2a4d019f-fcc4-4eb9-9934-649f6a2e0ad3"
    }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Stop a database or application ingestion and replication job

Stop a database or application ingestion and replication job

POST request

Request body

Success response

Failed responses