The server URL includes the name and region of the POD that your organization uses and the Informatica Intelligent Cloud Services domain, informaticacloud.com. If you don't know the name and region of your organization's POD, you can find it by logging in to Informatica Intelligent Cloud Services through the user interface. The POD information is located in the browser's address bar.
In the following example, https://usw3.dm-us.informaticacloud.com is the server URL:
Use the server URL as the base URL in the header of REST API calls.
Note: If you use a tool such as Postman that automatically includes the HTTP version, don't enter the HTTP version in the URL. If the HTTP version appears twice in the URL, the request fails.
Logging in
Use this resource to log into Informatica Intelligent Cloud Services when you use resources that require the IDS-SESSION-ID in the call header. The IDS-SESSION-ID is included in a successful login response.
POST request
Use the following URL:
<login URL>/identity-service/api/v1/Login
The login URL includes the region where your organization is located and the Informatica Intelligent Cloud Services domain, informaticacloud.com. You can find your organization's login region by opening the Informatica Intelligent Cloud Services log in page. The regional login URL is located in the browser's address bar before you log in to Informatica Intelligent Cloud Services.
In the following example, https://dm-us.informaticacloud.com, is the region URL:
The following table describes the fields to include in the request:
Field
Type
Required
Description
username
String
Yes
Informatica Intelligent Cloud Services user name.
Maximum length is 255 characters.
password
String
Yes
Informatica Intelligent Cloud Services password.
Maximum length is 255 characters.
POST response
Returns the user object if the request is successful. Returns the error object if errors occur.
Use the session ID returned in the response for subsequent requests.
The user object includes the following attributes:
Field
Type
Description
sessionId
String
REST API session ID for the current session. Use in most REST API request headers.
sessionExpireTime
String
Time the session expires.
id
String
User ID.
name
String
Informatica Intelligent Cloud Services user name.
currentOrgId
String
Current organization ID.
currentOrgName
String
Name of the current organization.
parentOrgId
String
ID of the parent organization.
orgId
String
ID of the organization the user belongs to.
orgName
String
Name of the organization the user belongs to.
groups
String
User group.
effectiveRoles
String
Roles assigned to the user.
effectivePrivileges
String
Privileges assigned to the user.
status
String
Status of the user.
timeZoneId
String
Time zone of the user. Time zone honors Daylight Saving Time. For more information, see Time zone codes.
authenticator
String
User authentication method.
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:
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 request:
GET <serverUrl>/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 Content-type: application/json Accept: application/json icSessionId: <SessionId>
•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 request:
GET >serverUrl>/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 Content-type: application/json Accept: application/json icSessionId: <SessionId>
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: