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

                
{
  "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" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "jobInstanceKey" : "...",
  "templateKey" : "..."
}

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

                
{
  "lineageExecCode" : "...",
  "executionId" : "...",
  "inputSources" : [ "...", "..." ],
  "lineageExecType" : "...",
  "groupByCondition" : "...",
  "lineageExternalId" : "...",
  "inputs" : [ "...", "..." ],
  "sparkJobType" : "...",
  "lineageExecState" : "...",
  "properties" : {
    "names" : { }
  },
  "endTime" : 12345,
  "lineageExternalSource" : "...",
  "operationExecMessage" : "...",
  "operationKey" : "...",
  "outputs" : [ "...", "..." ],
  "startTime" : 12345,
  "resourceLineageExecKey" : "...",
  "joinCondition" : "...",
  "filterCondition" : "...",
  "lineageHopLevel" : 12345,
  "overlapCounts" : [ 12345, 12345 ],
  "principal" : "...",
  "lineageExecComment" : "...",
  "lineageType" : "...",
  "expression" : "...",
  "executionRunId" : "...",
  "operationExecState" : "...",
  "lineageKind" : "..."
}

GET /v2/job/execution/{key}/paginated-details

Request Parameters
name type description default
key path  
filter query  
pageIndex query 0
pageSize query 25
sort query timeOfcreation:desc
Response Body
media type data type description
application/json PaginatedResponseOfPairOfStringAndString (JSON)

Example

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

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

                
{
  "totalCount" : 12345,
  "list" : [ {
    "right" : "...",
    "value" : "...",
    "left" : "...",
    "key" : "..."
  }, {
    "right" : "...",
    "value" : "...",
    "left" : "...",
    "key" : "..."
  } ]
}

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

Request Parameters
name type description default
key path  
filter query  
pageIndex query 0
pageSize query 25
sort query timeOfcreation:desc
Response Body
media type data type description
application/json PaginatedResponseOfDataResource (JSON)

Example

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

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

                
{
  "list" : [ {
    "permToReadMap" : {
      "property1" : true,
      "property2" : true
    },
    "dataSetId" : "...",
    "canAssociateTag" : true,
    "partitionCount" : 12345,
    "owner" : "...",
    "xmlRowTag" : "...",
    "separator" : "...",
    "dataSourceName" : "...",
    "errorMsg" : "...",
    "permittedToRead" : true,
    "timeOfResourceChange" : 12345,
    "resourcePath" : "...",
    "allowedTagDomainKeys" : [ "...", "..." ],
    "dataSetRoot" : true,
    "timeOfResourceCreation" : 12345,
    "timeOfResourceAccess" : 12345,
    "dataSetMember" : true,
    "subscribersCount" : 12345,
    "dataSetVirtualFolders" : [ "...", "..." ],
    "resourceState" : "...",
    "datasetVirtualFolderName" : "...",
    "name" : "...",
    "reportedFields" : [ {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    }, {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    } ],
    "timeOfLastProfile" : 12345,
    "dataSourceType" : "...",
    "tableType" : "...",
    "runId" : "...",
    "joinResources" : [ "...", "..." ],
    "collectionRoot" : true,
    "parquetBinaryAsString" : true,
    "partitionDefinition" : [ "...", "..." ],
    "processedTime" : 12345,
    "origins" : [ "...", "..." ],
    "logicalFolderContext" : "...",
    "dataSetPathSpecs" : {
      "property1" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ],
      "property2" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ]
    },
    "fieldCount" : 12345,
    "timeOfLastRefresh" : 12345,
    "curationCount" : 12345,
    "dataSetRootResource" : "...",
    "browseContextDataset" : "...",
    "canRunJob" : true,
    "fileFormat" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "dataPermitted" : true,
    "headerRow" : 12345,
    "rowCount" : 12345,
    "databaseName" : "...",
    "experts" : {
      "expertsType" : "DERIVED",
      "experts" : [ "...", "..." ]
    },
    "favorite" : true,
    "resourceType" : "...",
    "xmlRootTag" : "...",
    "joinConditions" : [ {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    }, {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    } ],
    "logicalFolders" : [ "...", "..." ],
    "dataSetSchemaVersion" : 12345,
    "header" : true,
    "averageRating" : 12345.0,
    "lastPartitionProfile" : true,
    "sensitivity" : "...",
    "dataSourceUri" : "...",
    "canCreateHiveTableOrView" : true,
    "landing" : true,
    "fields" : [ {
      "dataType" : "BINARY",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "ARRAY",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    } ],
    "resourceSize" : 12345,
    "dataSchemaName" : "...",
    "usageCount" : 12345,
    "detailedStatus" : [ {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    }, {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    } ],
    "tagAssociationViewList" : [ {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    }, {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    } ],
    "virtualFolderContextName" : "...",
    "dataSourceKey" : "...",
    "ratingCount" : 12345,
    "fileFormatDisplay" : "...",
    "canDisassociateTag" : true,
    "tableName" : "...",
    "status" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "permToReadMap" : {
      "property1" : true,
      "property2" : true
    },
    "dataSetId" : "...",
    "canAssociateTag" : true,
    "partitionCount" : 12345,
    "owner" : "...",
    "xmlRowTag" : "...",
    "separator" : "...",
    "dataSourceName" : "...",
    "errorMsg" : "...",
    "permittedToRead" : true,
    "timeOfResourceChange" : 12345,
    "resourcePath" : "...",
    "allowedTagDomainKeys" : [ "...", "..." ],
    "dataSetRoot" : true,
    "timeOfResourceCreation" : 12345,
    "timeOfResourceAccess" : 12345,
    "dataSetMember" : true,
    "subscribersCount" : 12345,
    "dataSetVirtualFolders" : [ "...", "..." ],
    "resourceState" : "...",
    "datasetVirtualFolderName" : "...",
    "name" : "...",
    "reportedFields" : [ {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    }, {
      "dataType" : "...",
      "label" : "...",
      "name" : "...",
      "description" : "..."
    } ],
    "timeOfLastProfile" : 12345,
    "dataSourceType" : "...",
    "tableType" : "...",
    "runId" : "...",
    "joinResources" : [ "...", "..." ],
    "collectionRoot" : true,
    "parquetBinaryAsString" : true,
    "partitionDefinition" : [ "...", "..." ],
    "processedTime" : 12345,
    "origins" : [ "...", "..." ],
    "logicalFolderContext" : "...",
    "dataSetPathSpecs" : {
      "property1" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ],
      "property2" : [ {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      }, {
        "sourcePath" : "...",
        "excludePattern" : "...",
        "includePattern" : "..."
      } ]
    },
    "fieldCount" : 12345,
    "timeOfLastRefresh" : 12345,
    "curationCount" : 12345,
    "dataSetRootResource" : "...",
    "browseContextDataset" : "...",
    "canRunJob" : true,
    "fileFormat" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "dataPermitted" : true,
    "headerRow" : 12345,
    "rowCount" : 12345,
    "databaseName" : "...",
    "experts" : {
      "expertsType" : "MANUAL",
      "experts" : [ "...", "..." ]
    },
    "favorite" : true,
    "resourceType" : "...",
    "xmlRootTag" : "...",
    "joinConditions" : [ {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    }, {
      "leftResourceName" : "...",
      "leftFileFormat" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightOwner" : "...",
      "leftOrigin" : [ "...", "..." ],
      "rightSize" : 12345,
      "leftOwner" : "...",
      "leftSourceId" : "...",
      "rightTags" : [ { }, { } ],
      "rightPath" : "...",
      "rightFileFormat" : "...",
      "leftSourceName" : "...",
      "joinOp" : "...",
      "leftTimeOfResourceChange" : 12345,
      "rightCols" : [ "...", "..." ],
      "leftCols" : [ "...", "..." ],
      "joinStatState" : "...",
      "joinOrder" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftTimeOfLastChange" : 12345,
      "rightSourceId" : "...",
      "leftResourceId" : "...",
      "leftPath" : "...",
      "rightSourceName" : "...",
      "rightResourceName" : "...",
      "joinCardinality" : "...",
      "leftSize" : 12345,
      "leftTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "tags" : [ { }, { } ],
      "rightResourceId" : "..."
    } ],
    "logicalFolders" : [ "...", "..." ],
    "dataSetSchemaVersion" : 12345,
    "header" : true,
    "averageRating" : 12345.0,
    "lastPartitionProfile" : true,
    "sensitivity" : "...",
    "dataSourceUri" : "...",
    "canCreateHiveTableOrView" : true,
    "landing" : true,
    "fields" : [ {
      "dataType" : "BYTE",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "STRING",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    } ],
    "resourceSize" : 12345,
    "dataSchemaName" : "...",
    "usageCount" : 12345,
    "detailedStatus" : [ {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    }, {
      "startTime" : 12345,
      "stageName" : "...",
      "errorMsg" : "...",
      "status" : "...",
      "runId" : "...",
      "numberSampledRows" : 12345,
      "workflowId" : "...",
      "endTime" : 12345,
      "lastPartitionProfile" : true
    } ],
    "tagAssociationViewList" : [ {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    }, {
      "tagKey" : "...",
      "rules" : [ "...", "..." ],
      "key" : "...",
      "state" : "...",
      "timeOfLastChange" : 12345,
      "tagName" : "...",
      "timeOfCreation" : 12345,
      "domainKey" : "...",
      "domainName" : "...",
      "resourceKey" : "...",
      "semantic" : "...",
      "weight" : 12345.0,
      "field" : "..."
    } ],
    "virtualFolderContextName" : "...",
    "dataSourceKey" : "...",
    "ratingCount" : 12345,
    "fileFormatDisplay" : "...",
    "canDisassociateTag" : true,
    "tableName" : "...",
    "status" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "totalCount" : 12345
}

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

GET /v2/job/execution/{key}/virtual-folders

Request Parameters
name type description default
key path  
filter query  
pageIndex query 0
pageSize query 25
sort query timeOfcreation:desc
Response Body
media type data type description
application/json PaginatedResponseOfVirtualFolder (JSON)

Example

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

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

                
{
  "list" : [ {
    "rootFolder" : true,
    "logicalFolderContext" : "...",
    "canRunJob" : true,
    "dataSourceRef" : "...",
    "parentKey" : "...",
    "name" : "...",
    "experts" : [ "...", "..." ],
    "pathSpecifications" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "dataSourceName" : "...",
    "skipValidateVF" : true,
    "resourcePath" : "...",
    "systemName" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  }, {
    "rootFolder" : true,
    "logicalFolderContext" : "...",
    "canRunJob" : true,
    "dataSourceRef" : "...",
    "parentKey" : "...",
    "name" : "...",
    "experts" : [ "...", "..." ],
    "pathSpecifications" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "dataSourceName" : "...",
    "skipValidateVF" : true,
    "resourcePath" : "...",
    "systemName" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "key" : "...",
    "description" : "...",
    "type" : "...",
    "restricted" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "richDescription" : "...",
    "score" : 12345.0,
    "customProperties" : [ {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    }, {
      "description" : "...",
      "value" : { },
      "facetAble" : true,
      "name" : "...",
      "type" : "...",
      "displayName" : "..."
    } ]
  } ],
  "totalCount" : 12345
}