REST API Reference

Back Next

Start a code task

Start a
code task

Use this POST request to start the

code task

job. The response includes the code task job ID that you can use in subsequent API calls.

POST request

To start a

code task

, use the task ID. The

code task

ID is included in the response when you create a

code task

. For more information, see Create.

Use the following URI to start a

code task

POST <server URL>/disnext/api/v1/CodeTask/Start

Use the following field in the POST request:

Field	Type	Required / Optional	Description
codeTaskId	String	Required	The code task ID from the create resource.

POST response

The following variable is set from the response attributes:

Name	Response Value	Note
CODE_TASK_JOB_ID	jobId	Used to cancel the code task job, or to get job status, session logs, or Spark task status.

POST request example

Use this sample as a reference to start a

code task

POST <server URL>/disnext/api/v1/CodeTask/Start
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID:{{IDS_SESSION_ID}}
{
    "codeTaskId" : {{CODE_TASK_ID}}
}

POST response example

A successful POST response returns the

code task

job ID and other information, similar to the following example:

{
    "summary": "Code Task started successfully",
    "jobId": "8zcuMdImeshidZ4XVExs20",
    "codeTaskInstanceName": "Demo-2",
    "sparkCodeTaskResponseBody": {
        "agentGroupId": "01000025000000000003",
        "clusterConfigId": "Default",
        "logLevel": "normal",
        "startRunTime": "2022-04-04T20:23:57.154+00:00",
        "submitTime": "2022-04-04T20:23:57.095+00:00"
    }
}

Code tasks

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage