execution

Get all executions

Securityapi_key
Request
query Parameters
job_id
integer <int32>

The ID of the job to get all executions for

page_number
integer <int64>
Default: 1

The page number for which to get executions. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

execution_status
string

The status of the job execution. Note that, if this parameter is excluded, then all executions will be returned..

Enum: "CANCELLED" "FAILED" "QUEUED" "RUNNING" "SUCCEEDED" "WAITING"
Responses
200

Success

400

Bad request

401

Unauthorized access

403

Forbidden access

get/executions
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create execution

Securityapi_key
Request
Request Body schema: application/json
required

The execution to create

jobId
required
integer <int32>

The ID of the job that is being executed.

connectorType
string

The type of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

Enum: "DATABASE" "FILE" "VSAM"
sourceConnectorId
integer <int32>

The ID of the source connector. This field is only used for multi-tenant jobs that are also on-the-fly.

targetConnectorId
integer <int32>

The ID of the target connector. This field is only used for multi-tenant jobs.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

Callbacks
post/notifications-callback
post/executions
Request samples
application/json
{
  • "jobId": 167
}
Response samples
application/json
{
  • "jobId": 167
}
Callback payload samples
POST: /notifications-callback
application/json
{
  • "timestamp": "2018-01-01T00:00:00.000Z",
  • "eventName": "JOB_CREATED",
  • "context": {
    }
}

Get execution by ID

Securityapi_key
Request
path Parameters
executionId
required
integer <int32>

The ID of the execution to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/executions/{executionId}
Response samples
application/json
{
  • "jobId": 167
}

Cancel execution by ID

Securityapi_key
Request
path Parameters
executionId
required
integer <int32>

The ID of the execution to cancel

query Parameters
expectedStatus
string

The expected status of the execution to cancel to prevent cancelling a queued job that has transitioned to a running state since the request was issued.

Enum: "QUEUED" "RUNNING"
graceful
boolean

A cancellation strategy to re-enable SQL objects that were disabled earlier in the execution before terminating.

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

post/executions/{executionId}/cancel
Response samples
application/json
{
  • "jobId": 167
}

Search executions

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get executions. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

execution_sort
string

The field to sort results by. A property name with a prepended '-' signifies a descending order.

Enum: "environmentId" "-environmentId" "executionId" "-executionId" "jobId" "-jobId"
Request Body schema: application/json
optional

A request body containing a filter expression. Refer to the documentation to learn the syntax for filter-queries. Supported filterable attributes: "environmentId", "executionId", "jobId"

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/executions/search
Request samples
application/json
{
  • "filter_expression": "<attribute> EQ 123"
}
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}
➔ Next to executionComponent