REST API Reference

Back Next

Cancel a code task

Cancel a
code task

Use this PUT request to cancel the

code task

job.

PUT request

To cancel a

code task

job, use the

code task

job ID. The

code task

job ID is included in the response when you start a

code task

. For more information, see Start.

Use the following URI to cancel a

code task

job:

PUT <server URL>/disnext/api/v1/CodeTask/Cancel

Use the following field in the PUT request:

Field	Type	Required / Optional	Description
jobId	String	Required	The code task job ID from the start resource.

PUT response

Returns the

code task

cancellation state for the requested job ID.

Returns the error object if errors occurred.

PUT request example

Use this sample as a reference to cancel a

code task

job.

PUT <server URL>/disnext/api/v1/CodeTask/Cancel
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID:{{IDS_SESSION_ID}}
{
    "jobId" : {{CODE_TASK_JOB_ID}}
}

PUT response example

A successful PUT response returns the

code task

job cancellation information, similar to the following example:

{
    "state": "Code Task marked for cancellation.",
    "jobId": "6pqqt9KTgi3l9jyVnAajei"
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Cancel a code task

Cancel a code task

PUT request

PUT response

PUT request example

PUT response example

Cancel a
code task