Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

Status of a code task

Status of a
code task

Use this GET request to check the
code task
job status.

GET request

To request the status of 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 get the
code task
job status parameters:
GET <server URL>/disnext/api/v1/CodeTask/JobStatus/<Code task job ID>

GET response

Returns the
code task
object for the requested job ID.
Returns the error object if errors occurred.
The following table describes the parameters in the response:
Field
Type
Description
codeTaskName
String
Name of the
code task
.
codeTaskId
Numeric
The
code task
identifier.
agentGroupId
String
Runtime environment that contains the Secure Agent used to run the
code task
.
executionState
String
The state of the job: QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELLED
Job status. A job can have one of the following statuses:
  • Starting. The job is starting.
  • Running. The job is still running.
  • Success. The job completed successfully.
  • Failed. The job did not complete because it encountered errors.
sessionLogUrl
String
URL of the session log file.
assignedServerlessComputeUnits
Double
Number of serverless compute units per hour that the task requested.
You can view the number of requested compute units if the task runs in a serverless runtime environment.
consumedServerlessComputeUnits
Double
Total number of serverless compute units that the task consumed.
You can view the number of consumed compute units if the task runs in a serverless runtime environment.
firstErrorMessage
String
Error message, if any, that is associated with the job.

GET request example

Use this sample as a reference to get the
code task
job status.
GET <server URL>/disnext/api/v1/CodeTask/JobStatus/<Code task job ID> Content-Type: application/json Accept: application/json IDS-SESSION-ID:{{IDS_SESSION_ID}}

GET response example

A successful GET response returns the
code task
job status, similar to the following example:
{ "status": "RUNNING", "startTime": "2022-04-04T20:23:57.000", "updateTime": "2022-04-04T20:23:58.000", "endTime": null, "instanceName": "Demo-2", "assetName": "Demo", "runId": 2, "orgId": "kuJVH54wm6gfhVj4QEdboY", "startedBy": "coder@examplecompany.com", "runtimeEnvId": "01000025000000000003", "codeTaskId": 2, "errorMessage": "", "sessionLogUrl": "logservice/api/v1/jobs/8zcuMdImeshidZ4XVExs20/logs", "agentJobLogUrl": null, "advancedLogLocation": null, "advancedLogDownloadUrl": null }
An error status GET response returns the
code task
job status, similar to the following example:
{ "status": "FAILED", "startTime": "2022-03-10T17:23:29.000", "updateTime": "2022-03-10T17:23:34.000", "endTime": "2022-03-10T17:23:34.000", "instanceName": "Demo-2", "assetName": "Demo", "runId": 2, "orgId": "4nuRA6NIsI6lvUBYamL76P", "startedBy": "coder@examplecompany.com", "runtimeEnvId": "01000025000000000003", "codeTaskId": 477, "errorMessage": "WES_internal_error_Failed to start cluster for [01000025000000000003]. Error reported while starting cluster [404 {\"code\":\"CONFIG.NOT_FOUND_id\",\"message\":\"Internal error. Cannot find an advanced configuration with ID 01000025000000000003. Contact Informatica Global Customer Support.\",\"debugMessage\":\"Internal error. Cannot find an advanced configurati[truncated]. For more information about the failure, check the application log.If the problem persists, contact Informatica Global Customer Support.", "sessionLogUrl": "logservice/api/v1//jobs/6pqqt9KTgi3l9jyVnAajei/logs", "agentJobLogUrl": null, "advancedLogLocation": null, "advancedLogDownloadUrl": null }

0 COMMENTS

We’d like to hear from you!