REST API Reference

Back Next

Getting log information

Use the jobLogEntries resource to request log information for completed

Data Integration

jobs from

Operational Insights

. When you use this resource, include the organization ID in the URL.

GET Request

You can request all the log information or filter the log response. You can request data for the last 33 days. The response returns a maximum of 500 records for any applied filter.

To request information from the log, use the following URI:

/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries

To filter the log response, use the following URI:

/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?<query parameters>

You can include the following filters in the URI:

Parameter	Type	Description
filter	String	Query filter.
endTime	Date	Date and time the task ended. Include in the filter parameter.
startswith	String	Runtime environment, Secure Agent, or asset that started the task. Include in the filter parameter.
listfilter	String	Job status and asset type.
status in	String	Status of the task. You can filter by any of the following statuses: COMPLETED WARNING FAILED END SUCCESS STOPPED
assetType in	String	Type of asset: MTT. Mapping task. TASKFLOW. Advanced taskflow. MI_TASK. Mass ingestion task. DSS. Synchronization task. WORKFLOW. Linear taskflow. DRS. Replication task. PCS. PowerCenter task. DTT. Data transfer task. DLT. Data loader task. MAPPING BATCH_MAPPING. Dynamic mapping task. DMASK. Data masking task.
count	Int	If true, returns total records available for applied filter.
top	Int	Number of elements to return. For example, a value of 25 returns the first 25 records available for the applied filters. Max is 500.
skip	Int	Number of records to skip. For example, a value of 4 excludes the first four assets in the list.
orderby	String	Sort order in which to return the data.

GET request examples

The following examples show how you can use query parameters to request log information:

To request a list of

mapping

tasks that successfully completed between October 8, 2023 at 6am and October 9, 2023 at 6am, you might use the following URI:

/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?$filter=(endTime%20ge%202023-10-08T06:00:00Z)%20and%20(endTime%20le%202023-10-09T06:00:00Z)&listFilter=status%20in%20(SUCCESS)%20and%20assetType%20in%20(MTT)&$count=true&$top=500&$skip=0

To request a list of all jobs that completed between October 1, 2023 at 6am and October 31, 2023 at 6am and sort the jobs by descending end time, you might use the following URI:

/cdiinsights-service/api/v1/analytical/Orgs(<orgID>)/JobLogEntries?$filter=(endTime%20ge%202023-10-01T06:00:00Z)%20and%20(endTime%20le%202023-11-31T06:00:00Z)&listFilter=status%20in%20(COMPLETED,WARNING,FAILED,END,SUCCESS,STOPPED)%20and%20assetType%20in%20(MTT,DTT,DMASK,PCS,DRS,DSS,MTT_TEST,BATCH_MAPPING,MAPPING,command,MI_TASK)&$count=true&$top=500&$skip=0&$oderby=endTime desc

GET Response

Returns a jobLogEntry object for each row in the log. Returns the error object if errors occur.

When you request information for each row in the log, the jobLogEntry object includes the following attributes:

Field	Type	Description
logEntryId	String	Log entry ID.
assetId	String	ID for the task.
runId	Long	ID for the task run.
assetName	String	Name of the asset.
instanceName	String	Name of the job in the following format: <asset name>-<instance number>
orgId	String	Organization ID.
status	String	Whether the job completed successfully.
assetType	String	Type of task. For Data Integration jobs, returns one of the following codes: MTT. Mapping task. TASKFLOW. Advanced taskflow. MI_TASK. Mass ingestion task. DSS. Synchronization task. WORKFLOW. Linear taskflow. DRS. Replication task. PCS. PowerCenter task. DTT. Data transfer task. DLT. Data loader task. MAPPING. BATCH_MAPPING. Dynamic mapping task. DMASK. Data masking task.
startTime	Date/time	Start time for the task or linear taskflow. Uses Eastern Time Zone (ET).
endTime	Date/time	End time for the task or linear taskflow. Uses Eastern Time Zone (ET).
updateTime	String	Last time the task was updated.
duration	String	Time in seconds that the task ran.
errorMessage	String	Error message associated with the job.
location	String	Location of the asset.
rowsProcessed	String	Total number of rows processed by the task.
successRows	String	Number of rows that were successfully processed by the task.
errorRows	String	Number of rows that were not processed by the task.
runtimeEnv	String	Runtime environment where the task runs.
runtimeEnvName	String	Name of the runtime environment where the task runs.
startedBy	String	User or schedule that started the task.
subtasks	String	Number of subtasks that the task contains.
runContext	String	Method through which the task was initiated. Includes the following values: UI. Task was initiated through the user interface. SCHEDULER. Task was initiated through the task scheduler. REST-API. Task was initiated through the REST API. OUTBOUND MESSAGE. Task was initiated through an outbound message.
extraData	String	Additional information including the saasLogId and saasTaskId.
parentEntityId	String	ID of the parent task.
updateDayHour	Date/Time	Last time the task was updated.
taskId	String	ID of the task.
stopOnError	Boolean	Whether or not the runtime environment stops the task when a nonfatal error occurs.
isAtScale	Boolean	Whether or not the mapping associated with the task is in advanced mode.
parAssetName	String	Name of the parent asset.
parRunId	String	Run ID for the parent asset.
parLocation	String	Location of the parent asset.
parAssetType	String	Parent asset type.
agentId	String	Secure Agent that runs the task.
agentName	String	Name of the agent that runs the task.
projectName	String	Project in which the asset resides.

GET response example

You might get the following response when you request job log information for mapping tasks:

{
  "@odata.context": "$metadata#JobLogEntries",
  "@odata.count": 2,
  "value": [
    {
      "logEntryId": "9hQOSzOu0GSeG0r73CzK8L",
      "assetId": "jn94HPOUK4zlEoO07eGfEq",
      "runId": "148201",
      "assetName": "CDI_9102",
      "instanceName": "CDI_9102-148201",
      "orgId": "010cdi",
      "status": "COMPLETED",
      "assetType": "MTT",
      "correlationId": "ZGVmN2E3ZDEtMTE2MC00NT",
      "startTime": "2023-07-20T07:55:52Z",
      "endTime": "2023-07-20T07:56:09Z",
      "updateTime": null,
      "duration": 17,
      "errorMessage": "",
      "location": "9102",
      "rowsProcessed": 2,
      "successRows": 2,
      "errorRows": 0,
      "runtimeEnv": "runtime environment",
      "runtimeEnvName": "ASH0001",
      "startedBy": "every_day",
      "subtasks": 0,
      "runContext": "SCHEDULER",
      "extraData": "{\"saasLogId\":\"010AXYC100000000RC5Q\", \"runtimeType\":\"\", \"isServerless\":\"false\", \"releaseVersion\":\"4400\", \"saasTaskId\":\"010AXY0Z0000000005EM\"}",
      "parentEntityId": null,
      "statusDisplayName": "SUCCESS",
      "updateDayHour": "2023-07-20T07:00:00Z",
      "taskId": "010AXY0Z0000000005EM",
      "stopOnError": "0",
      "requestId": null,
      "isAtScale": 0,
      "parAssetName": null,
      "parRunId": null,
      "parLocation": "n/a",
      "parAssetType": null,
      "agentId": "010AXY08000000000003",
      "agentName": "ASH0001",
      "projectName": "9102"
    } 
{
      "logEntryId": "7gQRt15YPsBcdK6RsozzSJ",
      "assetId": "iwm48QrytmidcBrdpMElu6",
      "runId": "145708",
      "assetName": "CDI-9845_test2",
      "instanceName": "CDI-9845_test2-145708",
      "orgId": "010cdi",
      "status": "COMPLETED",
      "assetType": "MTT",
      "correlationId": "NjNlNGFhY2QtYzFjZC00MT",
      "startTime": "2023-07-20T07:55:52Z",
      "endTime": "2023-07-20T07:56:03Z",
      "updateTime": null,
      "duration": 11,
      "errorMessage": "",
      "location": "Default",
      "rowsProcessed": 1000,
      "successRows": 1000,
      "errorRows": 0,
      "runtimeEnv": "runtime environment",
      "runtimeEnvName": "ASH0001",
      "startedBy": "CDI-9845_scheduler",
      "subtasks": 0,
      "runContext": "SCHEDULER",
      "extraData": "{\"saasLogId\":\"010AXYC100000000RC5P\", \"runtimeType\":\"\", \"isServerless\":\"false\", \"releaseVersion\":\"4400\", \"saasTaskId\":\"010AXY0Z0000000005N4\"}",
      "parentEntityId": null,
      "statusDisplayName": "SUCCESS",
      "updateDayHour": "2023-07-20T07:00:00Z",
      "taskId": "010AXY0Z0000000005N4",
      "stopOnError": "0",
      "requestId": null,
      "isAtScale": 0,
      "parAssetName": null,
      "parRunId": null,
      "parLocation": "n/a",
      "parAssetType": null,
      "agentId": "agentID",
      "agentName": "ASH0001",
      "projectName": "Default"
    }

Job log files

Download Guide

Watch

Comments

Cloud B2B Gateway Homepage