1. REST APIs for Oracle Identity Role Intelligence
  2. Tasks
  3. ETL Jobs

Get ETL Job By ID

get

/oiri/api/v1/etl/jobs/{jobId}

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ETLJobDetails
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
Nested Schema : output
Type: array
Show Source
Nested Schema : databaseConfiguration
Type: object
Show Source
Nested Schema : entities
Type: array
Show Source
Nested Schema : globalEtlConfiguration
Type: object
Show Source
Nested Schema : sources
Type: object
Show Source
Nested Schema : sparkConfiguration
Type: object
Show Source
Nested Schema : sparkK8sConfiguration
Type: object
Show Source
Nested Schema : ETLEntity
Type: object
Show Source
Nested Schema : flatFile
Type: object
Show Source
Nested Schema : oracleIdentityGovernance
Type: object
Show Source
Nested Schema : option
Type: object
Show Source
Nested Schema : option
Type: object
Show Source
Nested Schema : ETLResult
Type: object
Show Source
Nested Schema : entities
Type: array
Show Source
Nested Schema : ETLEntityResult
Type: object
Show Source
Nested Schema : additionalDetails
Type: object
Nested Schema : details
Type: object
Back to Top

Examples

The following example shows how to retrieve a data import (ETL) job by ID.

curl -X GET 'http://locahost:port/oiri/api/v1/etl/jobs/1619030266311' \ 
-H "Authorization: Bearer $token"\

Example of the Response Body

The following is an example of the response body in JSON format.

{
"id": "1619030266311",
"sourceId": null,
"sourceName": null,
"name": "ETL 1619030266311",
"description": "Import data from Oracle Identity Governance and flat file",
"type": "ETL",
"status": "SUCCEEDED",
"message": null,
"createdDate": "2021-04-21T18:37:46.323Z",
"createdBy": "RFROST",
"lastUpdatedDate": "2021-04-21T18:38:28.959Z",
"startedDate": "2021-04-21T18:37:46.323Z",
"finishedData": "2021-04-21T18:38:28.959Z",
"input": {
"version": "1.0",
"walletDirectory": "/app/data/wallet",
"toBeDeletedOigDataDirectory": "/app/data/tobedeleted/oig",
"toBeDeletedFileDataDirectory": "/app/data/tobedeleted/file",
"sparkMode": "local",
"databaseConfiguration": {
"url": "jdbc:oracle:thin:@idmhost123.networkspeosubn.idmocihost123.example.com:PORT/oiripdb",
"driver": "oracle.jdbc.driver.OracleDriver",
"queryTimeout": 300,
"fetchSize": 50
},
"sparkConfiguration": {
"masterUrl": "local[2]",
"maxResultSize": "2G",
"eventLogOverwrite": false,
"eventLogEnabled": false,
"executorMemory": "2g",
"serializer": "org.apache.spark.serializer.KryoSerializer",
"eventLogPath": "/app/data/logs/events"
},
"globalEtlConfiguration": {
"organizationPathSplitSize": 10,
"maxOrganizationsInPath": 20,
"recordsCountInDryRunSummary": 20,
"validationFailureThresholdLimit": 100,
"maxJobRunningTimeInMinute": 720
},
"sparkK8sConfiguration": {
"master": null,
"namespace": null,
"containerImage": null,
"executorInstances": null,
"imagePullPolicy": "IfNotPresent",
"imagePullSecret": null,
"fileUploadPath": "/var/backup/ding/",
"k8sCaCertFile": "/app/",
"serviceAccountName": "ding-sa",
"driverPvcPath": "/app",
"driverPvcName": "ding-pvc",
"executorPvcPath": "/app",
"executorPvcName": "ding-pvc",
"driverRequestCores": null,
"driverLimitCores": null,
"executorRequestCores": null,
"executorLimitCores": null,
"driverMemory": null,
"executorMemory": null,
"driverMemoryOverhead": null,
"executorMemoryOverhead": null
},
"sources": {
"flatFile": {
"enabled": true,
"version": "1.0",
"format": "csv",
"option": {
"url": null,
"driver": null,
"queryTimeout": null,
"fetchSize": null,
"sep": ",",
"timestampFormat": "yyyy-MM-dd"
}
},
"oracleIdentityGovernance": {
"enabled": true,
"version": "12.2.1.3",
"format": "jdbc",
"option": {
"url": "jdbc:oracle:thin:@idmhost123.networkspeosubn.idmocihost123.example.com:PORT/oimdb.example.com",
"driver": "oracle.jdbc.driver.OracleDriver",
"queryTimeout": 300,
"fetchSize": 50,
"sep": null,
"timestampFormat": null
}
}
},
"entities": [
{
"name": "users",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/users/",
"batchSize": 100
},
{
"name": "applications",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/applications/",
"batchSize": 100
},
{
"name": "entitlements",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/entitlements/",
"batchSize": 100
},
{
"name": "assignedEntitlements",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/assignedentitlements/",
"batchSize": 100
},
{
"name": "roles",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/roles/",
"batchSize": 100
},
{
"name": "roleHierarchy",
"enabled": true,
"syncMode": "full",
"lowerBound": null,
"upperBound": null,
"numPartitions": 3,
"fileBasePath": "/app/data/input/rolehierarchy/",
"batchSize": 100
},
{
"name": "roleUserMemberships",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/roleusermemberships/",
"batchSize": 100
},
{
"name": "roleEntitlementCompositions",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/roleentitlementcompositions/",
"batchSize": 100
},
{
"name": "accounts",
"enabled": true,
"syncMode": "full",
"lowerBound": 0,
"upperBound": 10000,
"numPartitions": 3,
"fileBasePath": "/app/data/input/accounts/",
"batchSize": 100
}
]
},
"output": [
{
"source": "OIG",
"processingTime": 19314,
"entities": [
{
"entityType": "Role",
"processingTime": 890,
"details": {
"Data count": 33
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 73
}
},
{
"entityType": "Application",
"processingTime": 1232,
"details": {
"Data count": 3
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 86
}
},
{
"entityType": "User Entitlement Membership",
"processingTime": 1065,
"details": {
"Data count": 99
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 124
}
},
{
"entityType": "Role Entitlement Composition",
"processingTime": 966,
"details": {
"Data count": 108
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 52
}
},
{
"entityType": "Entitlement",
"processingTime": 1082,
"details": {
"Data count": 9
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 89
}
},
{
"entityType": "User",
"processingTime": 11110,
"details": {
"Data count": 27
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 2736
}
},
{
"entityType": "Account",
"processingTime": 1053,
"details": {
"Data count": 33
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 78
}
},
{
"entityType": "Role Hierarchy",
"processingTime": 659,
"details": {
"Data count": 2
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 61
}
},
{
"entityType": "Role User Membership",
"processingTime": 1245,
"details": {
"Data count": 35
},
"additionalDetails": {
"Time taken (in ms) in reading the data from source": 93,
"Role hierarchy processing time (in ms)": 17,
"Time taken (in ms) in indirect role user membership": 6,
"Role user membership processing time (in ms)": 19
}
}
]
},
{
"source": "File",
"processingTime": 23212,
"entities": [
{
"entityType": "Role Entitlement Composition",
"processingTime": 1768,
"details": {
"Insert data count": 0,
"Delete data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify probable data for delete": 239,
"Time taken (in ms) to identify insert/update/delete": 83,
"Time taken (in ms) in reading the data from OIRI": 83,
"Time taken (in ms) in reading the data from file": 32
}
},
{
"entityType": "User Entitlement Membership",
"processingTime": 2349,
"details": {
"Insert data count": 0,
"Delete data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify probable data for delete": 170,
"Time taken (in ms) to identify insert/update/delete": 42,
"Time taken (in ms) in reading the data from OIRI": 93,
"Time taken (in ms) in reading the data from file": 38
}
},
{
"entityType": "Application",
"processingTime": 2225,
"details": {
"Insert data count": 0,
"Update data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify insert/update/delete": 72,
"Time taken (in ms) in reading the data from OIRI": 66,
"Time taken (in ms) in reading the data from file": 34
}
},
{
"entityType": "Role User Membership",
"processingTime": 1893,
"details": {
"Insert data count": 0,
"Delete data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify probable data for delete": 209,
"Time taken (in ms) to identify insert/update/delete": 42,
"Role hierarchy processing time (in ms)": 2,
"Time taken (in ms) in reading the data from OIRI": 84,
"Time taken (in ms) in reading the data from file": 34,
"Time taken (in ms) in indirect role user membership": 2,
"Role user membership processing time (in ms)": 2
}
},
{
"entityType": "Role Hierarchy",
"processingTime": 1877,
"details": {
"Insert data count": 0,
"Delete data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify probable data for delete": 713,
"Time taken (in ms) to identify insert/update/delete": 1,
"Time taken (in ms) in reading the data from OIRI": 65,
"Time taken (in ms) in reading the data from file": 17
}
},
{
"entityType": "User",
"processingTime": 5335,
"details": {
"Insert data count": 0,
"Update data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify insert/update/delete": 161,
"Time taken (in ms) in reading the data from OIRI": 164,
"Time taken (in ms) in reading the data from file": 365
}
},
{
"entityType": "Entitlement",
"processingTime": 2497,
"details": {
"Insert data count": 0,
"Update data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify insert/update/delete": 55,
"Time taken (in ms) in reading the data from OIRI": 92,
"Time taken (in ms) in reading the data from file": 23
}
},
{
"entityType": "Account",
"processingTime": 2731,
"details": {
"Insert data count": 0,
"Update data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify insert/update/delete": 57,
"Time taken (in ms) in reading the data from OIRI": 82,
"Time taken (in ms) in reading the data from file": 28
}
},
{
"entityType": "Role",
"processingTime": 2531,
"details": {
"Insert data count": 0,
"Update data count": 0
},
"additionalDetails": {
"Time taken (in ms) to identify insert/update/delete": 40,
"Time taken (in ms) in reading the data from OIRI": 62,
"Time taken (in ms) in reading the data from file": 18
}
}
]
}
]
}
Back to Top