Returns a paginated list of Job instances. filter accepts a single filter term with a list of values separated by comma. eg: parentTemplateKey:ra151dddc007f947ce,ra151dddc007f947cb sort accepts a list of entries to sort on in order eg: jobName:asc,templateKey:desc asc - Ascending, desc - Descending
name | type | description | constraints |
---|---|---|---|
filter | query | ||
pageIndex | query | long | |
pageSize | query | long | |
sort | query |
media type | data type | description |
---|---|---|
application/json | PaginatedResponseOfJobDetailsTO (JSON) |
GET /v2/job/instances
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"totalCount" : 12345,
"list" : [ {
"templateKey" : "...",
"status" : "...",
"successCount" : "...",
"elapsedTime" : 12345,
"rootDataSourceType" : "...",
"cliArguments" : "...",
"sparkJob" : {
"message" : "...",
"type" : "...",
"state" : "..."
},
"principal" : "...",
"incompleteCount" : "...",
"key" : "...",
"sequence" : {
"name" : "...",
"key" : "..."
},
"jobSubmissionTime" : 12345,
"asset" : {
"assetPaths" : [ "...", "..." ],
"assetNames" : [ "...", "..." ],
"assetType" : "...",
"assetKeyList" : [ "...", "..." ]
},
"statusMsg" : "...",
"templateName" : "...",
"submittedBy" : "...",
"supportedDataSources" : [ "...", "..." ],
"skippedCount" : "...",
"agent" : {
"ipAddress" : "...",
"metaConnected" : true,
"connected" : true,
"description" : "...",
"lastSeen" : 12345,
"token" : "...",
"registered" : true,
"name" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
},
"jobDescription" : "...",
"jobName" : "...",
"createdBy" : "..."
}, {
"templateKey" : "...",
"status" : "...",
"successCount" : "...",
"elapsedTime" : 12345,
"rootDataSourceType" : "...",
"cliArguments" : "...",
"sparkJob" : {
"message" : "...",
"type" : "...",
"state" : "..."
},
"principal" : "...",
"incompleteCount" : "...",
"key" : "...",
"sequence" : {
"name" : "...",
"key" : "..."
},
"jobSubmissionTime" : 12345,
"asset" : {
"assetPaths" : [ "...", "..." ],
"assetNames" : [ "...", "..." ],
"assetType" : "...",
"assetKeyList" : [ "...", "..." ]
},
"statusMsg" : "...",
"templateName" : "...",
"submittedBy" : "...",
"supportedDataSources" : [ "...", "..." ],
"skippedCount" : "...",
"agent" : {
"ipAddress" : "...",
"metaConnected" : true,
"connected" : true,
"description" : "...",
"lastSeen" : 12345,
"token" : "...",
"registered" : true,
"name" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
},
"jobDescription" : "...",
"jobName" : "...",
"createdBy" : "..."
} ]
}
Returns a paginated list of Job instances for the current user. filter accepts a single filter term with a list of values separated by comma. eg: parentTemplateKey:ra151dddc007f947ce,ra151dddc007f947cb sort accepts a list of entries to sort on in order eg: jobName:asc,templateKey:desc asc - Ascending, desc - Descending
name | type | description | constraints |
---|---|---|---|
filter | query | ||
pageIndex | query | long | |
pageSize | query | long | |
sort | query |
media type | data type | description |
---|---|---|
application/json | PaginatedResponseOfJobDetailsTO (JSON) |
GET /v2/job/instances/currentuser
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"totalCount" : 12345,
"list" : [ {
"templateKey" : "...",
"status" : "...",
"successCount" : "...",
"elapsedTime" : 12345,
"rootDataSourceType" : "...",
"cliArguments" : "...",
"sparkJob" : {
"message" : "...",
"type" : "...",
"state" : "..."
},
"principal" : "...",
"incompleteCount" : "...",
"key" : "...",
"sequence" : {
"name" : "...",
"key" : "..."
},
"jobSubmissionTime" : 12345,
"asset" : {
"assetPaths" : [ "...", "..." ],
"assetNames" : [ "...", "..." ],
"assetType" : "...",
"assetKeyList" : [ "...", "..." ]
},
"statusMsg" : "...",
"templateName" : "...",
"submittedBy" : "...",
"supportedDataSources" : [ "...", "..." ],
"skippedCount" : "...",
"agent" : {
"ipAddress" : "...",
"metaConnected" : true,
"connected" : true,
"description" : "...",
"lastSeen" : 12345,
"token" : "...",
"registered" : true,
"name" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
},
"jobDescription" : "...",
"jobName" : "...",
"createdBy" : "..."
}, {
"templateKey" : "...",
"status" : "...",
"successCount" : "...",
"elapsedTime" : 12345,
"rootDataSourceType" : "...",
"cliArguments" : "...",
"sparkJob" : {
"message" : "...",
"type" : "...",
"state" : "..."
},
"principal" : "...",
"incompleteCount" : "...",
"key" : "...",
"sequence" : {
"name" : "...",
"key" : "..."
},
"jobSubmissionTime" : 12345,
"asset" : {
"assetPaths" : [ "...", "..." ],
"assetNames" : [ "...", "..." ],
"assetType" : "...",
"assetKeyList" : [ "...", "..." ]
},
"statusMsg" : "...",
"templateName" : "...",
"submittedBy" : "...",
"supportedDataSources" : [ "...", "..." ],
"skippedCount" : "...",
"agent" : {
"ipAddress" : "...",
"metaConnected" : true,
"connected" : true,
"description" : "...",
"lastSeen" : 12345,
"token" : "...",
"registered" : true,
"name" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
},
"jobDescription" : "...",
"jobName" : "...",
"createdBy" : "..."
} ]
}
media type | data type |
---|---|
application/json | array of object (JSON) |
media type | data type | description |
---|---|---|
application/json | array of object (JSON) |
DELETE /v2/job/instances/list
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Returns a single Job instance based on the provided key.
name | type | description |
---|---|---|
key | path |
media type | data type | description |
---|---|---|
application/json | JobDetailsTO (JSON) |
GET /v2/job/instances/{key}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"templateKey" : "...",
"status" : "...",
"successCount" : "...",
"elapsedTime" : 12345,
"rootDataSourceType" : "...",
"cliArguments" : "...",
"sparkJob" : {
"message" : "...",
"type" : "...",
"state" : "..."
},
"principal" : "...",
"incompleteCount" : "...",
"key" : "...",
"sequence" : {
"name" : "...",
"key" : "..."
},
"jobSubmissionTime" : 12345,
"asset" : {
"assetPaths" : [ "...", "..." ],
"assetNames" : [ "...", "..." ],
"assetType" : "...",
"assetKeyList" : [ "...", "..." ]
},
"statusMsg" : "...",
"templateName" : "...",
"submittedBy" : "...",
"supportedDataSources" : [ "...", "..." ],
"skippedCount" : "...",
"agent" : {
"ipAddress" : "...",
"metaConnected" : true,
"connected" : true,
"description" : "...",
"lastSeen" : 12345,
"token" : "...",
"registered" : true,
"name" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
},
"jobDescription" : "...",
"jobName" : "...",
"createdBy" : "..."
}
Returns the executions/steps for the provided job instance key.
name | type | description |
---|---|---|
key | path |
media type | data type | description |
---|---|---|
application/json | array of JobExecutionTO (JSON) |
GET /v2/job/instances/{key}/executions
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"sparkExecutionId" : "...",
"wldExecutionId" : "...",
"inputs" : [ "...", "..." ],
"executionMessage" : "...",
"outputs" : [ "...", "..." ],
"sparkJobType" : "...",
"sparkEventLogDir" : "...",
"status" : "...",
"sparkHistoryServer" : "...",
"startTime" : 12345,
"endTime" : 12345,
"key" : "...",
"operationKey" : "...",
"command" : "...",
"metrics" : {
"deletedResourcesCount" : 12345,
"lineageInsertedCount" : 12345,
"impactedResourcesCount" : 12345,
"skippedCount" : 12345,
"deletedVirtualFoldersCount" : 12345,
"totalSize" : 12345.0,
"tagAssociationInsertedCount" : 12345,
"incompleteCount" : 12345,
"tagAssociationRemovedCount" : 12345,
"successCount" : 12345
},
"description" : "...",
"jobLogPath" : "...",
"properties" : {
"property1" : { },
"property2" : { }
},
"principal" : "..."
} ]