Data Sets Resource

Endpoints under /dataset provide access to Virtual Dataset objects. A Waterline Virtual Data Set allow users to create groups of resources having the same schema and spanning different folders in your data lake, into a single virtual unit for easier management. Virtual Data Sets are considered as user defined virtual collections that have the matching schema but may have different path specifications/hierarchy with respect to a data source.

GET /v2/dataset

A GET request to the /dataset endpoint retrieves a list of all datasets configured in the catalog.

Request Parameters
name type description default
browse query false
size query 25
start query 0
Response Body
media type data type description
application/json PaginatedResponseOfDataResource (JSON) A list of DataSet objects in JSON format.

Example

Request
GET /v2/dataset
Content-Type: */*
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" : "OBJECT",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "OBJECT",
      "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" : "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" : "DOUBLE",
      "description" : "...",
      "displayName" : "...",
      "nullable" : true,
      "name" : "...",
      "comment" : "...",
      "properties" : [ { }, { } ]
    }, {
      "dataType" : "INTEGER",
      "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
}

POST /v2/dataset

A POST request to the /dataset endpoint creates a dataset

Request Body
media type data type description
application/json DatasetRequest (JSON) request payload in JSON format
Response Body
media type data type description
application/json DataResource (JSON) newly created Dataset object in JSON format

Example

Request
POST /v2/dataset
Content-Type: application/json
Accept: application/json

                
{
  "dataSetId" : "...",
  "name" : "...",
  "pathSpecifications" : [ {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  }, {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  } ],
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ]
  },
  "members" : [ {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  }, {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  } ],
  "fields" : [ {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  } ],
  "dataSetSchemaVersion" : 12345,
  "deleteMembers" : true,
  "virtualFolderKey" : "...",
  "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" : "..."
  } ]
}
Response
HTTP/1.1 201 Created
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" : "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" : [ { }, { } ]
    } ],
    "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" : "ACCEPTED",
      "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" : "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" : [ { }, { } ]
    } ],
    "rightOrigin" : [ "...", "..." ],
    "tags" : [ {
      "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" : "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" : [ { }, { } ]
    } ],
    "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" : "REGEX",
      "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" : "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" : [ { }, { } ]
    }, {
      "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" : [ { }, { } ]
    } ],
    "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" : "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" : "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" : [ { }, { } ]
    } ],
    "rightResourceId" : "..."
  } ],
  "logicalFolders" : [ "...", "..." ],
  "dataSetSchemaVersion" : 12345,
  "header" : true,
  "averageRating" : 12345.0,
  "lastPartitionProfile" : true,
  "sensitivity" : "...",
  "dataSourceUri" : "...",
  "canCreateHiveTableOrView" : true,
  "landing" : true,
  "fields" : [ {
    "dataType" : "TIMESTAMP",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "DOUBLE"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "DOUBLE"
    } ]
  }, {
    "dataType" : "DOUBLE",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    }, {
      "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/dataset/name

A GET request to the /dataset/name endpoint retrieves details of a specific data set.

Request Parameters
name type description constraints
dsId query dataset Id  
dsName query dataset name  
dsVersion query dataset SchemaVersion required
vfName query virtualFolder name  
Response Body
media type data type description
application/json DataResource (JSON) The DataSet object in JSON format.

Example

Request
GET /v2/dataset/name
Content-Type: */*
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" : "DERIVED",
    "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : "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" : "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" : "ACCEPTED",
      "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" : "..."
  }, {
    "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" : "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" : "ACCEPTED",
      "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" : [ { }, { } ]
    } ],
    "rightOrigin" : [ "...", "..." ],
    "tags" : [ {
      "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" : "REGEX",
      "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" : "LONG",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "BOOLEAN"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "DOUBLE"
    } ]
  }, {
    "dataType" : "TIMESTAMP",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    } ]
  } ],
  "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" : "..."
  } ]
}

DELETE /v2/dataset/{key}

A DELETE request to the /dataset/{key} endpoint deletes specific data set, and all it's dependencies.

Request Parameters
name type description default constraints
key path The identifying key of a data set    
deleteMembers query delete Members flag false boolean

Example

Request
DELETE /v2/dataset/{key}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /v2/dataset/{key}

A GET request to the /dataset/{key} endpoint retrieves details of a specific data set.

Request Parameters
name type description
key path The unique identifier of the DataSet object, as returned in the call to listDatasets().
Response Body
media type data type description
application/json DataResource (JSON) The DataSet object in JSON format.

Example

Request
GET /v2/dataset/{key}
Content-Type: */*
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" : "DERIVED",
    "experts" : [ "...", "..." ]
  },
  "favorite" : true,
  "resourceType" : "...",
  "xmlRootTag" : "...",
  "joinConditions" : [ {
    "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" : "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" : "REGEX",
      "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : "ACCEPTED",
      "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : [ { }, { } ]
    } ],
    "rightResourceId" : "..."
  } ],
  "logicalFolders" : [ "...", "..." ],
  "dataSetSchemaVersion" : 12345,
  "header" : true,
  "averageRating" : 12345.0,
  "lastPartitionProfile" : true,
  "sensitivity" : "...",
  "dataSourceUri" : "...",
  "canCreateHiveTableOrView" : true,
  "landing" : true,
  "fields" : [ {
    "dataType" : "INTEGER",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "STRING"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "INT"
    } ]
  }, {
    "dataType" : "BYTE",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "ARRAY"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "DOUBLE"
    } ]
  } ],
  "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" : "..."
  } ]
}

PUT /v2/dataset/{key}

A PUT request to the /dataset/{key} endpoint updates specific data set. Only name, description and path specifications of data set that are present in the payload can be updated. Remaining fields if any are added as part of the update payload will be ignored and 200 success response is returned.

Request Parameters
name type description
key path The identifying key of a data set
Request Body
media type data type description
application/json DatasetRequest (JSON) object used to accept json payload
Response Body
media type data type description
application/json DataResource (JSON) The DataSet object in JSON format.

Example

Request
PUT /v2/dataset/{key}
Content-Type: application/json
Accept: application/json

                
{
  "dataSetId" : "...",
  "name" : "...",
  "pathSpecifications" : [ {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  }, {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  } ],
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ]
  },
  "members" : [ {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  }, {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  } ],
  "fields" : [ {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  } ],
  "dataSetSchemaVersion" : 12345,
  "deleteMembers" : true,
  "virtualFolderKey" : "...",
  "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" : "..."
  } ]
}
Response
HTTP/1.1 204 No Content
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" : "DERIVED",
    "experts" : [ "...", "..." ]
  },
  "favorite" : true,
  "resourceType" : "...",
  "xmlRootTag" : "...",
  "joinConditions" : [ {
    "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" : "ACCEPTED",
      "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : [ { }, { } ]
    } ],
    "rightResourceId" : "..."
  }, {
    "leftResourceName" : "...",
    "leftFileFormat" : "...",
    "rightTimeOfLastChange" : 12345,
    "rightTimeOfResourceChange" : 12345,
    "rightOwner" : "...",
    "leftOrigin" : [ "...", "..." ],
    "rightSize" : 12345,
    "leftOwner" : "...",
    "leftSourceId" : "...",
    "rightTags" : [ {
      "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" : "REGEX",
      "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" : "ACCEPTED",
      "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" : [ { }, { } ]
    } ],
    "rightOrigin" : [ "...", "..." ],
    "tags" : [ {
      "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" : "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" : "..."
  } ],
  "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" : [ {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    } ]
  }, {
    "dataType" : "LONG",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "INT"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "BOOLEAN"
    } ]
  } ],
  "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" : "..."
  } ]
}

POST /v2/dataset/members/add

A POST request to the /members/add endpoint is used to add multiple resources across multiple datasets in single call It also allows to specify custom properties of the members that can be set while adding member to the dataset. Being a bulk api, partial failures/success is possible. All requests are returned with original request information plus few status fields. STATUS is one of SUCCESS or ERROR MESSAGE (error message, if STATUS is ERROR) dataResourceId of the dataset member that is added. (null in case of ERROR)

Request Body
media type data type description
application/json DatasetRequest (JSON) payload in JSON format
Response Body
media type data type description
application/json array of DatasetMember (JSON) list of requests.

Example

Request
POST /v2/dataset/members/add
Content-Type: application/json
Accept: application/json

                
{
  "members" : [ {
    "datasetKey" : "ra718d00b7a98b4418",
    "resourcePath" : "/perfData/folder/bucket10K/1f55",
    "properties" : {
      "custom_property_foo" : "custom value",
      "custom_property_bar" : "some custom value"
    }
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "datasetId" : "ra5a6527dde1b94b43",
  "status" : "SUCCESS",
  "resourceId" : "20de6a9ecb84eb5a08a3e8fbb5608c83",
  "message" : null,
  "resourcePath" : "/user/cloudera/demo-data-19/pub/insurance/countries/Asia/transactions_china.csv",
  "properties" : null
}, {
  "datasetId" : "ra5a6527dde1b94b43",
  "status" : "ERROR",
  "resourceId" : null,
  "message" : "Resource path: /user/cloudera/demo-data-199/pub/insurance/countries/Asia/transactions_china.csv does not qualify as member of the data set: myCountry_DS501 as its not part of the underlying folders",
  "resourcePath" : "/user/cloudera/demo-data-199/pub/insurance/countries/Asia/transactions_china.csv",
  "properties" : null
} ]

POST /v2/dataset/members/remove

A POST request to the api/v2/dataset/members/remove endpoint is used to remove resources from dataset.

Request Body
media type data type
application/json DatasetRequest (JSON)
Response Body
media type data type description
application/json array of DatasetMember (JSON)

Example

Request
POST /v2/dataset/members/remove
Content-Type: application/json
Accept: application/json

                
{
  "members" : [ {
    "resourcePath" : "/user/cloudera/demo-data-19/pub/insurance/countries/Americas/transactions_brazil.csv",
    "dsetId" : "DSET0001"
  }, {
    "resourcePath" : "/user/cloudera/demo-data-19/pub/insurance/countries/Americas/transactions_US2.csv",
    "dsetId" : "DSET001"
  } ]
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
[ {
  "dsetId" : "DSET0001",
  "status" : "SUCCESS",
  "resourcePath" : "/user/cloudera/demo-data-19/pub/insurance/countries/Americas/transactions_brazil.csv"
}, {
  "dsetId" : "DSET001",
  "status" : "ERROR",
  "message" : "DSETID do not match, request:DSET001  actual:DSET0001",
  "resourcePath" : "/user/cloudera/demo-data-19/pub/insurance/countries/Americas/transactions_US2.csv"
} ]

PUT /v2/dataset/schema/{key}

A PUT request to the /dataset/schema/{key} endpoint is used to load reported-schema.

Request Parameters
name type description
key path The identifying key of a data set
Request Body
media type data type description
application/json DatasetRequest (JSON) object used to accept json payload
Response Body
media type data type description
application/json DataResource (JSON) The DataSet object in JSON format.

Example

Request
PUT /v2/dataset/schema/{key}
Content-Type: application/json
Accept: application/json

                
{
  "dataSetId" : "...",
  "name" : "...",
  "pathSpecifications" : [ {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  }, {
    "sourcePath" : "...",
    "excludePattern" : "...",
    "includePattern" : "..."
  } ],
  "dataSetPathSpecs" : {
    "property1" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ],
    "property2" : [ {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    }, {
      "sourcePath" : "...",
      "excludePattern" : "...",
      "includePattern" : "..."
    } ]
  },
  "members" : [ {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  }, {
    "properties" : {
      "property1" : "...",
      "property2" : "..."
    },
    "dsetId" : "...",
    "resourcePath" : "...",
    "datasetKey" : "..."
  } ],
  "fields" : [ {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  }, {
    "dataType" : "...",
    "label" : "...",
    "name" : "...",
    "description" : "..."
  } ],
  "dataSetSchemaVersion" : 12345,
  "deleteMembers" : true,
  "virtualFolderKey" : "...",
  "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" : "..."
  } ]
}
Response
HTTP/1.1 204 No Content
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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : "ACCEPTED",
      "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : [ { }, { } ]
    } ],
    "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" : "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" : [ { }, { } ]
    }, {
      "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" : [ { }, { } ]
    } ],
    "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" : "ACCEPTED",
      "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" : "STRING"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "INT"
    } ]
  }, {
    "dataType" : "LONG",
    "description" : "...",
    "displayName" : "...",
    "nullable" : true,
    "name" : "...",
    "comment" : "...",
    "properties" : [ {
      "name" : "...",
      "value" : { },
      "type" : "ARRAY"
    }, {
      "name" : "...",
      "value" : { },
      "type" : "LONG"
    } ]
  } ],
  "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/dataset/{key}/virtualfolder

API call to list down all compatible Virtual Folders.

Request Parameters
name type description
key path DataSet key for which the list is to be generated
Response Body
media type data type description
application/json array of VirtualFolder (JSON) List of compatible Virtual Folders

Example

Request
GET /v2/dataset/{key}/virtualfolder
Content-Type: */*
Accept: application/json

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

                
[ {
  "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" : "..."
  } ]
} ]

GET /v2/dataset/schema/version/max

A GET request to the /dataset/schema/version/max endpoint is used to get most recent schema version for the dataset.

Request Parameters
name type description
dsId query dataset Id
dsName query dataset name
vfName query virtualFolder name
Response Body
media type data type description
application/json number (JSON) most recent schema version for the dataset identified uniquely by virtualFolderName,datasetName and datasetId

Example

Request
GET /v2/dataset/schema/version/max
Content-Type: */*
Accept: application/json

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

                
...