Administrator
- Administrator
- All Products
<Informatica Intelligent Cloud Services URL>/active-bpel/services/tf/status/<run ID>
https://na4.dm.us.informaticacloud.com/active-bpel/services/tf/status/20262247166322413568
Field
| Description
|
---|---|
runId
| Run ID for the taskflow.
For example, to get the status of a particular taskflow with a run ID, use the following URI:
https://na4.dm.us.informaticacloud.com/active-bpel/services/tf/status?runId=20262247166322413568
|
runStatus
| Execution status of the taskflow. You can specify the status as Success, Failed, Suspended, or Running.
For example, to get the status of all the taskflows that were successfully executed in the last 24 hours, use the following URl:
https://na4.dm.us.informaticacloud.com/active-bpel/services/tf/status?runStatus=Success
|
startTime
| Start time for the taskflow runs at the beginning of the date and time range. Use Coordinated Universal Time (UTC).
For example, to get the status of all the taskflows that started on or after 2021-06- 10 T05:48:28Z, use the following URl:
https://na4.dm.us.informaticacloud.com/active-bpel/services/tf/status?startTime=2021-06-
10 T05:48:28Z |
endTime
| Start time for the taskflow runs at the end of the date and time range. Use Coordinated Universal Time (UTC).
For example, to get the status of all the taskflows that started between 2021-06- 10 T05:48:28Z and 2021-06-11 T05:48:28Z, use the following URl:
https://na4.dm.us.informaticacloud.com/active-bpel/services/tf/status?startTime=2021-06-10T05:48:28Z&endTime=2021-06-
11 T05:48:28Z |
offset
| Number of rows to skip. For example, you might want to skip the first three rows.
|
rowLimit
| Maximum number of rows to return. The maximum number you can specify is 50. If you omit this parameter, the query returns all available rows, up to a maximum of 10 rows.
|
<Informatica Intelligent Cloud Services URL>/active-bpel/services/tf/status?startTime=<startTime>&runStatus=<runStatus>&endTime=<endTime>&rowLimit=<rowLimit>
GET <Informatica Intelligent Cloud Services URL>/active-bpel/services/tf/status/<run ID> Accept: application/json Authorization: Basic Auth username: <Informatica Intelligent Cloud Services user name> password: <Informatica Intelligent Cloud Services password>
GET <Informatica Intelligent Cloud Services URL>/active-bpel/services/tf/status/<run ID> Accept: application/json INFA-SESSION-ID: <sessionId>
Field
| Type
| Description
|
---|---|---|
assetName
| String
| Name of the taskflow.
The taskflow name also includes the custom name, if you had added a custom name to the taskflow using an API or the RunAJob utility.
|
assetType
| String
| Type of the object. Returns the value TASKFLOW.
|
duration
| String
| Time in seconds that the taskflow ran before it completed, was suspended, was failed, or was stopped.
|
endTime
| Date/time
| End time for the taskflow run. Uses Coordinated Universal Time (UTC).
|
location
| String
| Project and folder path where the taskflow is located.
|
runId
| Long
| Run ID for the taskflow.
|
runtimeEnv
| String
| ID of the runtime environment where the taskflow runs.
|
runtimeEnvName
| String
| Name of the runtime environment where the taskflow runs.
|
startTime
| Date/time
| Start time for the taskflow run. Uses Coordinated Universal Time (UTC).
|
startedBy
| String
| User who started the taskflow.
|
status
| String
| Execution status of the taskflow.
Returns one of the following values to indicate the taskflow status:
|
subtasks
| String
| Number of subtasks that the taskflow contains.
|
updateTime
| Date/time
| Last time the taskflow run status was updated. Uses Coordinated Universal Time (UTC).
|
errorMessage
| String
| Error message string.
|
subtaskDetails
| String
| Object that contains status details for all subtasks in the taskflow.
|
details
| String
| Status details. Includes status information for each subtask in the tasks object.
|
tasks
| Collection
| Status information for all subtasks that the taskflow contains.
|
Field
| Type
| Description
|
---|---|---|
assetName
| String
| Name of the subtask in the taskflow.
|
assetType
| String
| Type of the subtask. Returns one of the following values:
|
duration
| String
| Time in seconds that the subtask ran before it completed, was failed, or was stopped.
|
endTime
| Date/time
| End time for the subtask run. Uses Coordinated Universal Time (UTC).
|
errorMessage
| String
| Error message string.
|
errorRows
| String
| Total number of rows that resulted in errors in a subtask.
|
location
| String
| Project and folder path where the subtask is located.
|
rowsProcessed
| String
| Total number of rows that were processed in a subtask.
|
runId
| Long
| Run ID for the subtask.
|
runtimeEnv
| String
| ID of the runtime environment where the subtask runs.
|
runtimeEnvName
| String
| Name of the runtime environment where the subtask runs.
|
startTime
| Date/time
| Start time for the subtask run. Uses Coordinated Universal Time (UTC).
|
startedBy
| String
| User who started the task. This field is the same as the user who started the taskflow.
|
status
| String
| Execution status of the subtask.
Returns one of the following values to indicate the subtask status:
|
subtasks
| String
| Reserved for future use. When this field is returned for a subtask, the value is always 0.
|
successRows
| String
| Total number of rows that were processed successfully in a subtask.
|
updateTime
| Date/time
| Last time the subtask run status was updated. Uses Coordinated Universal Time (UTC).
|
Response
| Description
|
---|---|
Purged logs
| If logs are purged for the instance, the response is as follows:
The HTTP status code is
200 OK .
|
Invalid run ID
| If the run ID is not valid, the response is as follows:
The HTTP status code is
400 Bad Request(From JLS) .
|
Invalid filter clause
| If the parameter value is not valid, the response is as follows:
The HTTP status code is
400 Bad Request(From JLS) .
|
Unavailable JLS service
| If the JLS service is unavailable, the response is as follows:
The HTTP status code is
503 Service Unavailable .
|
GET https://pod.ics.dev:444/active-bpel/services/tf/status/20262247166322413568 Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3
{ "assetName": "Taskflow1", "assetType": "TASKFLOW", "duration": "2", "endTime": "2018-12-25T15:56:39Z", "location": "Default", "runId": "262247166322413568", "runtimeEnv": "tf_runtime", "runtimeEnvName": "", "startTime": "2018-12-25T15:56:37Z", "startedBy": "sb", "status": "SUCCESS", "subtasks": "0", "updateTime": "2018-12-25T15:56:39Z", "errorMessage": {}, "subtaskDetails": { "details": {} } }
{ "assetName": "Taskflow2", "assetType": "TASKFLOW", "duration": "89", "endTime": "2018-12-23T17:25:16Z", "location": "Default", "runId": 20262247166322413568, "runtimeEnv": "tf_runtime", "runtimeEnvName": "", "startTime": "2018-12-23T17:23:47Z", "startedBy": "sb", "status": "SUCCESS", "subtasks": "2", "updateTime": "2018-12-23T17:25:17Z", "errorMessage": {}, "subtaskDetails": { "details": { "tasks": [ { "assetName": "MTR", "assetType": "MTT", "duration": "3", "endTime": "2018-12-23T17:24:45Z", "errorMessage": "", "errorRows": "0", "location": "Default", "rowsProcessed": "7", "runId": "4", "runtimeEnv": "01001Q25000000000002", "runtimeEnvName": "tf_runtime_devagent", "startTime": "2018-12-23T17:24:42Z", "startedBy": "sb", "status": "COMPLETED", "subtasks": "0", "successRows": "7", "updateTime": "2018-12-23T17:24:46Z" }, { "assetName": "MTR", "assetType": "MTT", "duration": "10", "endTime": "2018-12-23T17:23:59Z", "errorMessage": "", "errorRows": "0", "location": "Default", "rowsProcessed": "7", "runId": "3", "runtimeEnv": "01001Q25000000000002", "runtimeEnvName": "tf_runtime_devagent", "startTime": "2018-12-23T17:23:49Z", "startedBy": "sb", "status": "COMPLETED", "subtasks": "0", "successRows": "7", "updateTime": "2018-12-23T17:24:00Z" } ] } } }
GET https://pod.ics.dev:444/active-bpel/services/tf/status?runId=20262247166322413568&runStatus=Success&rowLimit=3 Accept: application/json INFA-SESSION-ID: 9KA11tLGqxVcGeul8SQBK3
[ { "assetName": "Taskflow1", "assetType": "TASKFLOW", "duration": "2", "endTime": "2018-12-25T15:56:39Z", "location": "Default", "runId": 262247166322413568, "runtimeEnv": "tf_runtime", "runtimeEnvName": "", "startTime": "2018-12-25T15:56:37Z", "startedBy": "sb", "status": "SUCCESS", "subtasks": "0", "updateTime": "2018-12-25T15:56:39Z", "errorMessage": {}, "subtaskDetails": { "details": { "tasks": [] } } } ]
<Informatica Intelligent Cloud Services URL>/active-bpel/services/tf/status
{ "assetName": "waitStatus", "assetType": "TASKFLOW", "duration": 27, "endTime": null, "errorMessage": "", "location": "Default", "runId": 737194191850250240, "runtimeEnv": "taskflow-preview-usw1-r40-app02.infacloudops.net:4430", "runtimeEnvName": "", "startedBy": "sb", "startTime": "2022-07-28T06:26:32Z", "status": "RUNNING", "subtasks": 0, "updateTime": "2022-07-28T06:26:32Z", "subtaskDetails": { "details": { "tasks": [] } } }