REST API Reference > PowerCenter Modernization REST API > Runtime and jobs
  

Runtime and jobs

Manage runtime and jobs programmatically.
Use the runtime and jobs REST APIs to programmatically perform the following tasks:

Get job summary for a task run

Retrieves the job summary for a specific task run.

API request

To retrieve job summary for a specific task run, send a GET request to the following API:
GET /public/api/v2/jobsummary/task('{taskId}')/run('{runId}')
Note:
If you have the admin role you can retrieve the job summary of all runs. Non-admin users can retrieve job summaries of the runs they initiated.

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task whose job summary you want to retrieve.
runId
String
Required
Unique identifier for the specific run of the task.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
taskId
String
Unique identifier for the task.
runId
Integer
Sequential number identifying this specific run of the task.
orgId
String
Unique identifier for the organization that owns the task.
taskType
String
Category of the task, such as ConversionTask.
status
String
Current execution status of the task run, such as Failed, Success, or Running.
startTime
String
ISO 8601 timestamp indicating when the task run started.
endTime
String
ISO 8601 timestamp indicating when the task run completed.
objectsProcessed
Integer
Number of objects successfully processed during the task run.
createdBy
String
Username of the user who initiated the task run.
errorMessage
String
Description of the error that caused the task run to fail, if applicable.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"https://qa-pod1-idms.rel.infaqa.com/workbench-service/public/api/v2/runtime/status/task('4w78CUOvHfjdBvQnOWqF8B')/run('1')" \
-H "IDS-SESSION-ID: eyJraW********"

Sample response

200 OK
{
"taskId": "4w78CUOvHfjdBvQnOWqF8B",
"runId": 1,
"orgId": "6SkMNqHiaLviL1UZGWngct",
"taskType": "ConversionTask",
"status": "Completed",
"startTime": "2026-09-28T09:58:22.000Z",
"endTime": "2026-09-28T09:59:49.000Z",
"objectsProcessed": 0,
"createdBy": "wb_rel",
"errorMessage": "Completed."
}
400 Bad Request
{
"message": "Bad request \u2013 invalid task id or run id"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Task or run not found"
}
500 Internal Server Error
{
"message": "Internal server error while fetching job summary"
}

Get runtime status for all tasks

Retrieves the runtime status for all tasks.

API request

To retrieve runtime status for all tasks, send a GET request to the following API:
GET /workbench-service/public/api/v2/runtime/status/tasks

Request parameters

Path parameters
No parameter.
Query parameters
The following table describes the query parameters that you specify in the API request:
Name
Type
Required or Optional
Description
limit
Integer
Optional
Maximum number of tasks to return per response.
taskType
String
Optional
Task type used to filter the returned results to only tasks of the specified type. Allowed values are AssessmentTask, ConversionTask, BulkUpdateTask, and ParameterFileConversionTask.
Body Parameters
This endpoint does not require any body parameters.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
total
Integer
Total number of task run records.
tasks
Array
List of task run records matching the request criteria.
tasks.taskId
String
Unique identifier for the task.
tasks.runId
Integer
Sequential run number for the task, incremented each time the task is executed.
tasks.orgId
String
Unique identifier for the organization that owns the task.
tasks.taskType
String
Type of the task.
tasks.status
String
Current execution sttaus of the task run.
tasks.startTime
String
ISO 8601 timestamp indicating when the task run started.
tasks.endTime
String
ISO 8601 timestamp indicating when the task run ended.
tasks.objectsProcessed
Integer
Number of objects successfully processed during the task run.
tasks.createdBy
String
Username of the user who created the task.
tasks.errorMessage
null
Error detail describing why the task run failed, or null if the run succeeded or was stopped without an error.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"https://qa-pod1-idms.rel.infaqa.com/workbench-service/public/api/v2/runtime/status/tasks?limit=2&taskType=ConversionTask" \
-H "IDS-SESSION-ID: eyJraW********"

Sample response

200 OK
{
"total": 3986,
"tasks": [
{
"taskId": "04GAwVGcJrkgFclzgFXnyv",
"runId": 1,
"orgId": "6SkMNqHiaLviL1UZGWngct",
"taskType": "ConversionTask",
"status": "Completed",
"startTime": "2026-09-07T09:21:19.000Z",
"endTime": "2026-09-07T09:42:48.000Z",
"objectsProcessed": 140,
"createdBy": "wb_rel",
"errorMessage": null
},
{
"taskId": "05jgjqUKPdkcVr526rc882",
"runId": 1,
"orgId": "6SkMNqHiaLviL1UZGWngct",
"taskType": "ConversionTask",
"status": "Failed",
"startTime": "2026-09-18T09:02:57.000Z",
"endTime": "2026-09-18T09:12:11.000Z",
"objectsProcessed": 0,
"createdBy": "wb_rel",
"errorMessage": "Failed to pre-process the workflow XML. For more information, refer to the error log in the job summary."
}
]
}

Get runtime status for a task run

Retrieves the runtime status of a specific task run.

API request

To retrieve runtime status of a specific task run, send a GET request to the following API:
GET /public/api/v2/runtime/status/task('{taskId}')/run('{runId}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task whose runtime status you want to retrieve.
runId
String
Required
Unique identifier for a specific instance of a task run.
Query parameters
No parameter.
Body Parameters
This endpoint does not require any body parameters.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
taskId
String
Unique identifier for the task associated with this run.
runId
Integer
Numeric identifier for this specific instance of the task run.
orgId
String
Unique identifier for the organization that owns the task.
taskType
String
Category of the task, such as CONVERSION.
status
String
Current execution state of the task run, such as RUNNING.
startTime
String
ISO 8601 timestamp indicating when the task run began.
endTime
String
ISO 8601 timestamp indicating when the task run completed, or an empty string if the run is still in progress.
objectsProcessed
Integer
Number of objects processed by the task run up to the time of the response.
createdBy
String
Email address of the user who created the task.
errorMessage
String
Description of the error encountered during the task run, or null if no error occurred.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"{base_url}/workbench-service/public/api/v2/runtime/status/task('2O8T9o3BkqaeV46K8qugY4')/run('1')"

Sample response

200 OK
{
"taskId": "0100000B00000000001A",
"runId": 1001,
"orgId": "a1b2c3d4",
"taskType": "CONVERSION",
"status": "RUNNING",
"startTime": "2025-03-15T10:30:00Z",
"endTime": "2025-03-15T11:45:00Z",
"objectsProcessed": 150,
"createdBy": "admin@example.com",
"errorMessage": "Connection timeout to source repository"
}
400 Bad Request
{
"message": "Bad request \u2013 invalid task id or run id"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Task run not found"
}
500 Internal Server Error
{
"message": "Internal server error while retrieving runtime status"
}

Get task steps status

Retrieves the step-by-step execution status for a specific task run.

API request

To retrieve step-by-step execution status of a task run, send a GET request to the following API:
GET /public/api/v2/runtime/stepstatus/task('{taskId}')/run('{runId}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task whose step status is being retrieved.
runId
String
Required
Unique identifier for a specific instance of a task run.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
compositeSteps
Array
Composite step details for the task run. Returns null when no composite steps are present.
orgId
String
Unique identifier for the organization that owns the task.
runId
Integer
Sequential numeric identifier for the specific task run.
steps
Array
List of individual execution steps and their statuses for the task run.
steps.endTime
String
ISO 8601 timestamp indicating when the step completed; empty string if the step has not yet finished.
steps.message
null
Informational or status message produced by the step; null if no message was generated.
steps.startTime
String
ISO 8601 timestamp indicating when the step began execution; empty string if the step has not yet started.
steps.status
String
Current execution status of the step.
steps.step
String
Machine-readable name identifying the execution step, such as exportMetadata or conversion.
taskId
String
Unique identifier for the task whose run status is returned.
taskType
String
Type classification of the task, such as ConversionTask.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"https://qa-pod1-idms.rel.infaqa.com/workbench-service/public/api/v2/runtime/stepstatus/task('2O8T9o3BkqaeV46K8qugY4')/run('1')" \
-H "IDS-SESSION-ID: eyJraW********"

Sample response

200 OK
{
"compositeSteps": null,
"orgId": "6SkMNqHiaLviL1UZGWngct",
"runId": 1,
"steps": [
{
"endTime": "2026-09-28T07:02:37.000Z",
"message": null,
"startTime": "2026-09-28T06:56:08.000Z",
"status": "Completed",
"step": "exportMetadata"
},
{
"endTime": "2026-09-28T07:03:12.000Z",
"message": null,
"startTime": "2026-09-28T07:02:40.000Z",
"status": "Completed",
"step": "uploadPCXML"
},
{
"endTime": "2026-09-28T07:09:40.000Z",
"message": "Successfully executed XML Preprocess.",
"startTime": "2026-09-28T07:09:40.000Z",
"status": "Completed",
"step": "xmlPreProcessing"
},
{
"endTime": "2026-09-28T07:15:10.000Z",
"message": "",
"startTime": "2026-09-28T07:12:39.000Z",
"status": "Completed",
"step": "conversion"
},
{
"endTime": "",
"message": null,
"startTime": "",
"status": "Not Started",
"step": "generateParameterFile"
}
],
"taskId": "2O8T9o3BkqaeV46K8qugY4",
"taskType": "ConversionTask"
}
400 Bad Request
{
"message": "Bad request \u2013 invalid task id or run id"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Task run not found"
}
500 Internal Server Error
{
"message": "Internal server error while retrieving step status"
}

Stop a running task

Stops an active run of a specified task.

API request

To stop a running task instance, send a POST request to the following API:
POST /public/api/v2/runtime/stop/task('{taskId}')/run('{runId}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task to be stopped.
runId
String
Required
Unique identifier for a specific run instance of the task.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
message
String
Confirmation message indicating the task run was stopped successfully.

Sample request

The following is a sample request based on the values provided:

curl -X POST \
"{base_url}/workbench-service/public/api/v2/runtime/stop/task('2O8T9o3BkqaeV46K8qugY4')/run('1')"

Sample response

200 OK
{
"message": "Task stopped successfully"
}
400 Bad Request
{
"message": "Bad request \u2013 invalid parameters or insufficient privileges"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
500 Internal Server Error
{
"message": "Internal server error while stopping task"
}

Download task run artifacts

Retrieves output runtime artifacts for a specific task run.

API request

To download task run artifacts, send a GET request to the following API:
GET /public/api/v2/download/task('{taskId}')/run('{runId}')/('{downloadType}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task whose run artifacts you want to download.
runId
String
Required
Unique identifier for the specific run of the task from which output artifacts will be downloaded.
downloadType
String
Required
Type of output files to be included in the download response. Allowed values are download_all, download_logs, download_reports, and download_input.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
message
String
Binary file contents returned as a downloadable artifact, such as a zip archive or xlsx file.

Sample request

The following is a sample request based on the values provided:

curl -X GET \
"{base_url}/workbench-service/public/api/v2/download/task('2O8T9o3BkqaeV46K8qugY4')/run('1')/('download_all')"

Sample response

200 OK
{
"message": "Binary file contents (zip / xlsx / etc.)"
}
400 Bad Request
{
"message": "Bad request \u2013 invalid task id, run id, or download type"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Task or run not found"
}
500 Internal Server Error
{
"message": "Internal server error while downloading files"
}

Delete task

Deletes a task by its unique ID.

API request

To delete task by ID, send a DELETE request to the following API:
DELETE /public/api/v2/task('{taskId}')

Request parameters

Path parameters
The following table describes the path parameters that you specify in the API request:
Name
Type
Required or Optional
Description
taskId
String
Required
Unique identifier for the task to be deleted.
Query parameters
No parameter.
Body Parameters
No parameter.

Request headers

The following table describes the headers that you specify in the API request:
Name
Required or Optional
Description
IDS-SESSION-ID
Required
Session token to authenticate the request.

Response parameters

The following table describes the parameters that are returned by the API:
Name
Type
Description
message
String
Confirmation message indicating the task was successfully deleted.

Sample request

The following is a sample request based on the values provided:

curl -X DELETE \
"{base_url}/workbench-service/public/api/v2/task('2O8T9o3BkqaeV46K8qugY4')"

Sample response

200 OK
{
"message": "Task deleted successfully"
}
400 Bad Request
{
"message": "Bad request \u2013 invalid task id or running instance present"
}
401 Unauthorized
{
"message": "Unauthorized \u2013 missing or invalid session credentials"
}
404 Not Found
{
"message": "Task not found"
}
500 Internal Server Error
{
"message": "Internal server error while deleting task"
}