JobManagement Resource

POST /v2/job/execution

A POST call to execute a Job. Execution is asynchronous. Hence, any problems during Job execution can fail the execution itself even though this API responds with a OK.

Request Body
media type data type
application/json JobDetailsTO (JSON)
Response Body
media type data type description
application/json JobExecutionResultTO (JSON)

Example

Request
POST /v2/job/execution
Content-Type: application/json
Accept: application/json

                
{
  "key" : "..."
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }
                
              

PUT /v2/job/execution/terminate/{jobInstanceId}

REST API to terminate a running Job execution. Since Job executions are asynchronous in behaviour, this API call is a Non-Guaranteed termination

Request Parameters
name type description
jobInstanceId path
Response Body
media type data type description
application/json OperationExecution (JSON)

Example

Request
PUT /v2/job/execution/terminate/{jobInstanceId}
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "executionId" : "...",
  "endTime" : 12345,
  "operationExecMessage" : "...",
  "startTime" : 12345,
  "executionRunId" : "...",
  "sparkJobType" : "...",
  "properties" : {
    "names" : { }
  },
  "operationKey" : "...",
  "operationExecState" : "...",
  "inputs" : [ "...", "..." ],
  "outputs" : [ "...", "..." ],
  "principal" : "..."
}
                
              

GET /v2/job/execution/{key}/resources

Returns a list of resources that are processed as part of the job for the provided execution key.

Request Parameters
name type description
key path
status query
Response Body
media type data type description
application/json array of DataResource (JSON)

Example

Request
GET /v2/job/execution/{key}/resources
Content-Type: application/json
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "permToReadMap" : {
    "property1" : true,
    "property2" : true
  },
  "dataSourceUri" : "...",
  "dataSourceType" : "...",
  "dataSourceName" : "...",
  "dataSetMember" : true,
  "dataSetId" : "...",
  "dataSetSchemaVersion" : 12345,
  "reportedFields" : [ {
    "dataType" : "...",
    "name" : "...",
    "label" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "name" : "...",
    "label" : "...",
    "description" : "..."
  } ],
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    }, {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    }, {
      "sourcePath" : "...",
      "includePattern" : "...",
      "excludePattern" : "..."
    } ]
  },
  "name" : "...",
  "dataSetRootResource" : "...",
  "dataSetRoot" : true,
  "dataSetVirtualFolders" : [ "...", "..." ],
  "detailedStatus" : [ {
    "startTime" : 12345,
    "endTime" : 12345,
    "stageName" : "...",
    "status" : "...",
    "workflowId" : "...",
    "runId" : "...",
    "errorMsg" : "...",
    "numberSampledRows" : 12345,
    "lastPartitionProfile" : true
  }, {
    "startTime" : 12345,
    "endTime" : 12345,
    "stageName" : "...",
    "status" : "...",
    "workflowId" : "...",
    "runId" : "...",
    "errorMsg" : "...",
    "numberSampledRows" : 12345,
    "lastPartitionProfile" : true
  } ],
  "status" : "...",
  "errorMsg" : "...",
  "runId" : "...",
  "resourceType" : "...",
  "resourcePath" : "...",
  "dataSourceKey" : "...",
  "timeOfLastProfile" : 12345,
  "dataSchemaName" : "...",
  "fileFormat" : "...",
  "fileFormatDisplay" : "...",
  "resourceSize" : 12345,
  "tableName" : "...",
  "databaseName" : "...",
  "fields" : [ {
    "name" : "...",
    "nullable" : true,
    "properties" : [ {
      "name" : "...",
      "type" : "DOUBLE",
      "value" : { }
    }, {
      "name" : "...",
      "type" : "PROPERTIES",
      "value" : { }
    } ],
    "dataType" : "BINARY",
    "comment" : "...",
    "displayName" : "...",
    "importedComment" : "..."
  }, {
    "name" : "...",
    "nullable" : true,
    "properties" : [ {
      "name" : "...",
      "type" : "PROPERTIES",
      "value" : { }
    }, {
      "name" : "...",
      "type" : "ARRAY",
      "value" : { }
    } ],
    "dataType" : "SHORT",
    "comment" : "...",
    "displayName" : "...",
    "importedComment" : "..."
  } ],
  "owner" : "...",
  "tagAssociationViewList" : [ {
    "timeOfCreation" : 12345,
    "timeOfLastChange" : 12345,
    "tagKey" : "...",
    "tagName" : "...",
    "domainKey" : "...",
    "domainName" : "...",
    "field" : "...",
    "semantic" : "...",
    "state" : "...",
    "resourceKey" : "...",
    "key" : "...",
    "weight" : 12345.0,
    "rules" : [ "...", "..." ]
  }, {
    "timeOfCreation" : 12345,
    "timeOfLastChange" : 12345,
    "tagKey" : "...",
    "tagName" : "...",
    "domainKey" : "...",
    "domainName" : "...",
    "field" : "...",
    "semantic" : "...",
    "state" : "...",
    "resourceKey" : "...",
    "key" : "...",
    "weight" : 12345.0,
    "rules" : [ "...", "..." ]
  } ],
  "timeOfResourceCreation" : 12345,
  "timeOfResourceAccess" : 12345,
  "timeOfResourceChange" : 12345,
  "landing" : true,
  "ratingCount" : 12345,
  "averageRating" : 12345.0,
  "rowCount" : 12345,
  "favorite" : true,
  "canAssociateTag" : true,
  "canDisassociateTag" : true,
  "separator" : "...",
  "header" : true,
  "headerRow" : 12345,
  "xmlRootTag" : "...",
  "xmlRowTag" : "...",
  "collectionRoot" : true,
  "parquetBinaryAsString" : true,
  "origins" : [ "...", "..." ],
  "partitionCount" : 12345,
  "partitionDefinition" : [ "...", "..." ],
  "tableType" : "...",
  "logicalFolders" : [ "...", "..." ],
  "logicalFolderContext" : "...",
  "browseContextDataset" : "...",
  "datasetVirtualFolderName" : "...",
  "virtualFolderContextName" : "...",
  "lastPartitionProfile" : true,
  "joinResources" : [ "...", "..." ],
  "joinConditions" : [ {
    "leftOwner" : "...",
    "leftTimeOfLastChange" : 12345,
    "leftTimeOfResourceChange" : 12345,
    "leftPath" : "...",
    "leftSize" : 12345,
    "leftFileFormat" : "...",
    "rightOwner" : "...",
    "rightTimeOfLastChange" : 12345,
    "rightTimeOfResourceChange" : 12345,
    "rightPath" : "...",
    "rightSize" : 12345,
    "rightFileFormat" : "...",
    "joinCardinality" : "...",
    "joinOrder" : "...",
    "joinStatState" : "...",
    "leftCols" : [ "...", "..." ],
    "rightCols" : [ "...", "..." ],
    "leftResourceId" : "...",
    "rightResourceId" : "...",
    "joinOp" : "...",
    "stats" : {
      "property1" : "...",
      "property2" : "..."
    },
    "leftResourceName" : "...",
    "rightResourceName" : "...",
    "leftSourceName" : "...",
    "rightSourceName" : "...",
    "leftSourceId" : "...",
    "rightSourceId" : "...",
    "tags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "SUGGESTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "ACCEPTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "leftTags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "ACCEPTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "ACCEPTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "rightTags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "REJECTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "SUGGESTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "rightOrigin" : [ "...", "..." ],
    "leftOrigin" : [ "...", "..." ]
  }, {
    "leftOwner" : "...",
    "leftTimeOfLastChange" : 12345,
    "leftTimeOfResourceChange" : 12345,
    "leftPath" : "...",
    "leftSize" : 12345,
    "leftFileFormat" : "...",
    "rightOwner" : "...",
    "rightTimeOfLastChange" : 12345,
    "rightTimeOfResourceChange" : 12345,
    "rightPath" : "...",
    "rightSize" : 12345,
    "rightFileFormat" : "...",
    "joinCardinality" : "...",
    "joinOrder" : "...",
    "joinStatState" : "...",
    "leftCols" : [ "...", "..." ],
    "rightCols" : [ "...", "..." ],
    "leftResourceId" : "...",
    "rightResourceId" : "...",
    "joinOp" : "...",
    "stats" : {
      "property1" : "...",
      "property2" : "..."
    },
    "leftResourceName" : "...",
    "rightResourceName" : "...",
    "leftSourceName" : "...",
    "rightSourceName" : "...",
    "leftSourceId" : "...",
    "rightSourceId" : "...",
    "tags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "REJECTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "REJECTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "leftTags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "ACCEPTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "REJECTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "rightTags" : [ {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "VALUE",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "SUGGESTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    }, {
      "children" : [ { }, { } ],
      "domainKey" : "...",
      "parentKey" : "...",
      "name" : "...",
      "tagState" : "REGEX",
      "minScore" : 12345.0,
      "regEx" : "...",
      "regexMinLen" : 12345,
      "regexMaxLen" : 12345,
      "regexFilterClass" : "...",
      "learningEnabled" : true,
      "immutable" : true,
      "enable" : true,
      "fullName" : "...",
      "state" : "SUGGESTED",
      "externalId" : "...",
      "externalSourceName" : "...",
      "synonyms" : [ "...", "..." ],
      "key" : "...",
      "type" : "...",
      "description" : "...",
      "timeOfLastChange" : 12345,
      "timeOfCreation" : 12345,
      "restricted" : [ "...", "..." ],
      "updateable" : [ "...", "..." ],
      "viewAble" : [ "...", "..." ],
      "customProperties" : [ { }, { } ]
    } ],
    "rightOrigin" : [ "...", "..." ],
    "leftOrigin" : [ "...", "..." ]
  } ],
  "canRunJob" : true,
  "canAddOrRemoveResourceFromDataset" : true,
  "allowedTagDomainKeys" : [ "...", "..." ],
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
} ]