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

jobs resource

jobs resource

Use the
jobs
resource to get the details of a
streaming ingestion
job.

GET request

To request the details of a
streaming ingestion
job, use the following URL:
<server URI>/sisvc/monitor/v1/jobs/<dataflow ID>/<run ID of the job>

GET request example

To request the details of a
streaming ingestion
job, you might send a request similar to the following example:
POST https://usw1-ing.dm2-us.informaticacloud.com/sisvc/monitor/v1/jobs/1948938e-3923-4602-aba8-f122e3d66faf/42559 Content-Type: application/json Accept:application/json IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT

GET response

Returns the jobs object if successful or an error object if an error occurs.
If successful, the response includes the following information about a
streaming ingestion
job:
Parameter
Type
Description
assetId
String
ID of the
streaming ingestion
job.
assetName
String
Name of the
streaming ingestion
job.
duration
Integer
The time it took to deploy the job.
endTime
Integer
End time of deploying the job, in UTC time.
startTime
Integer
Start time of deploying the job, in UTC time.
extraData
String
Additional information including the task ID, deployed version, and the Secure Agent group ID.
runId
Integer
Run ID of the
streaming ingestion
job. The ID changes for every deployment.
orgId
String
ID of the organization the logged in user belongs to.
runtimeEnv
String
ID of the Secure Agent that deployed the
streaming ingestion
job.
startedBy
String
Name of the user who created the
streaming ingestion
task.
status
String
The status of the
streaming ingestion
job. A job can be in one of the following status:
  • Deploying. The job is being deployed.
  • Up and Running. The job is running.
  • Running with Warning. The job is running with warnings.
  • Running with Error. The job is running with error.
  • Undeployed. The job is undeployed.
  • Stopped. The job was intentionally stopped.

GET response example

If the request to get the details of a
streaming ingestion
job is successful, you might receive a response similar to the following example:
{ "assetId": "1948938e-3923-4602-aba8-f122e3d66faf", "assetName": "testmonitor", "assetType": "SI_DATAFLOW", "correlationId": null, "duration": 1543, "endTime": "2022-02-14T04:04:13.000+0000", "extraData": "{\"id\":\"0RwiUUb9bVwjL67dWOKjoI\",\"version\":1,\"agentGroupId\":null}", "location": "Default", "runId": 42559, "orgId": "2lFy0UUNnlnbjhaoT3TSqw", "runtimeEnv": "011ZFB2500000000000N", "startedBy": "siqa_new", "status": "Undeployed", "startTime": "2022-02-14T03:38:30.000+0000", "deployedVersion": 1 }

0 COMMENTS

We’d like to hear from you!