Data Resources Resource

Endpoints under /dataresource provide access to DataResource objects in the Waterline Data repository. Waterline Data defines a data resource as an HDFS file or folder, a set of files that are organized in folders (known as a Waterline Data collection), as a Hive database or table, or as a relational database or table. DataResource objects are uniquely identified by a "key" value, assigned on creation.
Requests to to a {key} endpoint under /dataresource address a specific DataResource object. If a directory, file, database, or table has not yet been encountered in a format or schema discovery operation, it does not have a corresponding data resource entry in the Waterline Data catalog.
Data resource calls return results based on the user credentials for the current authentication session.

PUT /v2/dataresource

A PUT request to the /dataresource endpoint with virtual folder name and resource path values updates the content of the specified DataResource. Update a data resource to include a description of the resource or to set the value of a system or custom property for the resource.

Request Parameters
name type description
resourcePath query The path of the resource relative to the root of the data source.
virtualFolderName query The name of the virtual folder that includes the resources.
Request Body
media type data type description
application/json map of object (JSON) KeyValue map of properties to update
Response Body
media type data type description
application/json DataResource (JSON)

Example

Request
PUT /v2/dataresource
Content-Type: application/json
Accept: application/json

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

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

GET /v2/dataresource/hivecolumns

+ Listing down column names for generating hive table

Request Parameters
name type description
resourceID query resource id for the resource for which hive table is generated
Response Body
media type data type description
application/json map of array of string (JSON) map of column to associated names

Example

Request
GET /v2/dataresource/hivecolumns
Content-Type: */*
Accept: application/json

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

                
...
                
              

GET /v2/dataresource/metadata

Returns resources which qualify given scope and filters. Allows user to tune api response as per needs. User should have at least METADATA access.

Request Parameters
name type description default constraints
datasetKeys query scope limited to given dataset(s), multiple dataset keys can be specified as comma separated values    
pageSize query Number of records that client needs per call 25 long
pageToken query Represents pagination token. First time it can null/empty.Each successive request should include the pageToken returned in previous response.  
propertyFilter query supported properties {id, resource_type, resource_path, resource_owner, name, description, file_format, execution_status, resource_state} Filter are provided in the form property:property_value Multiple filters can be provided separated by comma. When multiple filters are provided, they will be AND-ed together Filter value itself can be multiple values, separated by semi-colon    
resourceModifiedDateFromL query resources created/modified during this date range (long format)   long
resourceModifiedDateToL query resources created/modified during this date range (long format)   long
taggedDateFromL query resources tagged during this date range (long format)   long
taggedDateToL query resources tagged during this date range (long format)   long
views query control views and fields returned in response object possible values are {"viewBasic","viewTags", "viewFields", "viewFieldsData", "viewProperties"} ViewFieldsData must be accompanied with ViewFields. viewProperties is populated with all individual properties that are specified in views parameter.    
virtualFolderKeys query scope limited to given virtual folder(s), multiple virtual folder keys can be specified as comma separated values    
Request Body
media type data type description
application/json object (JSON) Returns resources which qualify given scope and filters. Allows user to tune api response as per needs. User should have at least METADATA access.
Response Body
media type data type description
application/json PaginatedResponse2OfDataResourceFlexTO (JSON)

Example

Request
GET /v2/dataresource/metadata
Content-Type: application/json
Accept: application/json

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

                
{
  "list" : [ { }, { } ],
  "size" : 12345,
  "pageToken" : "..."
}
                
              

POST /v2/dataresource/savepatterns

API to save frequent patterns to a file based on the data resource

Request Body
media type data type description
application/json map of string (JSON) Input payload to save the file

Example

Request
POST /v2/dataresource/savepatterns
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

GET /v2/dataresource/{key}

A GET request to the /dataresource/{key} endpoint retrieves details of a specified data resource, including all Waterline Data metadata, such as tags, custom properties, or lineage. For a collection, it returns details about the aggregation schema and lists the files and folders that are contained in the collection.

Request Parameters
name type description
key path The unique identifier of a data resource, as returned by a call to getResourcesByPath().
Response Body
media type data type description
application/json DataResource (JSON)

Example

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

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

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

PUT /v2/dataresource/{key}

A PUT request to the /dataresource/{key} endpoint with a resource key updates the content of the specified DataResource. Update a data resource to include a description of the resource or to set the value of a system or custom property for the resource.

Request Parameters
name type description
key path The unique identifier of a data resource, as returned by a call to getResourcesByPath().
Request Body
media type data type description
application/json map of object (JSON) The new content for the data resource, specified as a map of property name strings and their new values. Properties that do not appear in the map are not changed.
Response Body
media type data type description
application/json DataResource (JSON) The updated DataResource object in JSON format.

Example

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

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

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

GET /v2/dataresource/browse/{resourceKey}

A GET request to the /dataresource/browse/{resourceKey} endpoint retrieves a data resource identified by key.

Request Parameters
name type description
resourceKey path The unique identifier of a data resource, as returned by a call to getResourcesByPath().
Response Body
media type data type description
application/json BrowseResult (JSON) A BrowseResult object in JSON format, containing the identified DataResource and all of its descendants in the resource hierarchy.

Example

Request
GET /v2/dataresource/browse/{resourceKey}
Content-Type: */*
Accept: application/json

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

                
{
  "facetResults" : [ {
    "name" : "...",
    "totalCount" : 12345,
    "categoryCounts" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "displayName" : "..."
  }, {
    "name" : "...",
    "totalCount" : 12345,
    "categoryCounts" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "displayName" : "..."
  } ],
  "resourceCount" : 12345,
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "dataSource" : {
    "name" : "...",
    "sourceType" : "...",
    "useWebHdfs" : true,
    "hdfsUri" : "...",
    "webHdfsUri" : "...",
    "hiveUrl" : "...",
    "jdbcUrl" : "...",
    "jdbcUsername" : "...",
    "jdbcPassword" : "...",
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "sourcePath" : "...",
    "rootResourceKey" : "...",
    "driverClass" : "...",
    "configured" : true,
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  },
  "resource" : {
    "permToReadMap" : {
      "property1" : true,
      "property2" : true
    },
    "dataSourceUri" : "...",
    "dataSourceType" : "...",
    "dataSourceName" : "...",
    "dataSetMember" : true,
    "dataSetId" : "...",
    "dataSetSchemaVersion" : 12345,
    "reportedFields" : [ {
      "dataType" : "...",
      "name" : "...",
      "label" : "...",
      "description" : "..."
    }, {
      "dataType" : "...",
      "name" : "...",
      "label" : "...",
      "description" : "..."
    } ],
    "dataSetPathSpecs" : {
      "property1" : [ {
        "sourcePath" : "...",
        "includePattern" : "...",
        "excludePattern" : "..."
      }, {
        "sourcePath" : "...",
        "includePattern" : "...",
        "excludePattern" : "..."
      } ],
      "property2" : [ {
        "sourcePath" : "...",
        "includePattern" : "...",
        "excludePattern" : "..."
      }, {
        "sourcePath" : "...",
        "includePattern" : "...",
        "excludePattern" : "..."
      } ]
    },
    "name" : "...",
    "dataSetRootResource" : "...",
    "dataSetRoot" : true,
    "dataSetVirtualFolders" : [ "...", "..." ],
    "detailedStatus" : [ {
      "startTime" : 12345,
      "endTime" : 12345,
      "stageName" : "...",
      "status" : "...",
      "workflowId" : "...",
      "runId" : "...",
      "errorMsg" : "...",
      "numberSampledRows" : 12345,
      "lastPartitionProfile" : true
    }, {
      "startTime" : 12345,
      "endTime" : 12345,
      "stageName" : "...",
      "status" : "...",
      "workflowId" : "...",
      "runId" : "...",
      "errorMsg" : "...",
      "numberSampledRows" : 12345,
      "lastPartitionProfile" : true
    } ],
    "status" : "...",
    "errorMsg" : "...",
    "runId" : "...",
    "resourceType" : "...",
    "resourcePath" : "...",
    "dataSourceKey" : "...",
    "timeOfLastProfile" : 12345,
    "dataSchemaName" : "...",
    "fileFormat" : "...",
    "fileFormatDisplay" : "...",
    "resourceSize" : 12345,
    "tableName" : "...",
    "databaseName" : "...",
    "fields" : [ {
      "name" : "...",
      "nullable" : true,
      "properties" : [ { }, { } ],
      "dataType" : "TIMESTAMP",
      "comment" : "...",
      "displayName" : "...",
      "importedComment" : "..."
    }, {
      "name" : "...",
      "nullable" : true,
      "properties" : [ { }, { } ],
      "dataType" : "SHORT",
      "comment" : "...",
      "displayName" : "...",
      "importedComment" : "..."
    } ],
    "owner" : "...",
    "tagAssociationViewList" : [ {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    }, {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    } ],
    "timeOfResourceCreation" : 12345,
    "timeOfResourceAccess" : 12345,
    "timeOfResourceChange" : 12345,
    "landing" : true,
    "ratingCount" : 12345,
    "averageRating" : 12345.0,
    "rowCount" : 12345,
    "favorite" : true,
    "canAssociateTag" : true,
    "canDisassociateTag" : true,
    "separator" : "...",
    "header" : true,
    "headerRow" : 12345,
    "xmlRootTag" : "...",
    "xmlRowTag" : "...",
    "collectionRoot" : true,
    "parquetBinaryAsString" : true,
    "origins" : [ "...", "..." ],
    "partitionCount" : 12345,
    "partitionDefinition" : [ "...", "..." ],
    "tableType" : "...",
    "logicalFolders" : [ "...", "..." ],
    "logicalFolderContext" : "...",
    "browseContextDataset" : "...",
    "datasetVirtualFolderName" : "...",
    "virtualFolderContextName" : "...",
    "lastPartitionProfile" : true,
    "joinResources" : [ "...", "..." ],
    "joinConditions" : [ {
      "leftOwner" : "...",
      "leftTimeOfLastChange" : 12345,
      "leftTimeOfResourceChange" : 12345,
      "leftPath" : "...",
      "leftSize" : 12345,
      "leftFileFormat" : "...",
      "rightOwner" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightPath" : "...",
      "rightSize" : 12345,
      "rightFileFormat" : "...",
      "joinCardinality" : "...",
      "joinOrder" : "...",
      "joinStatState" : "...",
      "leftCols" : [ "...", "..." ],
      "rightCols" : [ "...", "..." ],
      "leftResourceId" : "...",
      "rightResourceId" : "...",
      "joinOp" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftResourceName" : "...",
      "rightResourceName" : "...",
      "leftSourceName" : "...",
      "rightSourceName" : "...",
      "leftSourceId" : "...",
      "rightSourceId" : "...",
      "tags" : [ { }, { } ],
      "leftTags" : [ { }, { } ],
      "rightTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "leftOrigin" : [ "...", "..." ]
    }, {
      "leftOwner" : "...",
      "leftTimeOfLastChange" : 12345,
      "leftTimeOfResourceChange" : 12345,
      "leftPath" : "...",
      "leftSize" : 12345,
      "leftFileFormat" : "...",
      "rightOwner" : "...",
      "rightTimeOfLastChange" : 12345,
      "rightTimeOfResourceChange" : 12345,
      "rightPath" : "...",
      "rightSize" : 12345,
      "rightFileFormat" : "...",
      "joinCardinality" : "...",
      "joinOrder" : "...",
      "joinStatState" : "...",
      "leftCols" : [ "...", "..." ],
      "rightCols" : [ "...", "..." ],
      "leftResourceId" : "...",
      "rightResourceId" : "...",
      "joinOp" : "...",
      "stats" : {
        "property1" : "...",
        "property2" : "..."
      },
      "leftResourceName" : "...",
      "rightResourceName" : "...",
      "leftSourceName" : "...",
      "rightSourceName" : "...",
      "leftSourceId" : "...",
      "rightSourceId" : "...",
      "tags" : [ { }, { } ],
      "leftTags" : [ { }, { } ],
      "rightTags" : [ { }, { } ],
      "rightOrigin" : [ "...", "..." ],
      "leftOrigin" : [ "...", "..." ]
    } ],
    "canRunJob" : true,
    "canAddOrRemoveResourceFromDataset" : true,
    "allowedTagDomainKeys" : [ "...", "..." ],
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  },
  "children" : [ {
    "tagAssociationViewList" : [ {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    }, {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    } ],
    "name" : "...",
    "dataSetId" : "...",
    "dataSetSchemaVersion" : 12345,
    "resourceType" : "...",
    "resourcePath" : "...",
    "dataSourceKey" : "...",
    "canAssociateTag" : true,
    "canDisassociateTag" : true,
    "collectionRoot" : true,
    "dataSourceType" : "...",
    "canRunJob" : true,
    "logicalFolderContext" : "...",
    "status" : "...",
    "favorite" : true,
    "fileFormat" : "...",
    "fileFormatDisplay" : "...",
    "dataSourceUri" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "joinResources" : [ "...", "..." ],
    "averageRating" : 12345.0,
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  }, {
    "tagAssociationViewList" : [ {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    }, {
      "timeOfCreation" : 12345,
      "timeOfLastChange" : 12345,
      "tagKey" : "...",
      "tagName" : "...",
      "domainKey" : "...",
      "domainName" : "...",
      "field" : "...",
      "semantic" : "...",
      "state" : "...",
      "resourceKey" : "...",
      "key" : "...",
      "weight" : 12345.0,
      "rules" : [ "...", "..." ]
    } ],
    "name" : "...",
    "dataSetId" : "...",
    "dataSetSchemaVersion" : 12345,
    "resourceType" : "...",
    "resourcePath" : "...",
    "dataSourceKey" : "...",
    "canAssociateTag" : true,
    "canDisassociateTag" : true,
    "collectionRoot" : true,
    "dataSourceType" : "...",
    "canRunJob" : true,
    "logicalFolderContext" : "...",
    "status" : "...",
    "favorite" : true,
    "fileFormat" : "...",
    "fileFormatDisplay" : "...",
    "dataSourceUri" : "...",
    "canAddOrRemoveResourceFromDataset" : true,
    "joinResources" : [ "...", "..." ],
    "averageRating" : 12345.0,
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  } ],
  "pathInfo" : {
    "pathElements" : [ {
      "key" : "...",
      "name" : "...",
      "path" : "...",
      "type" : "..."
    }, {
      "key" : "...",
      "name" : "...",
      "path" : "...",
      "type" : "..."
    } ]
  },
  "logicalFolderContext" : "...",
  "dataSetKey" : "..."
}
                
              

PUT /v2/dataresource/schema/{resourceKey}

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

Example

Request
PUT /v2/dataresource/schema/{resourceKey}
Content-Type: application/json
Accept: application/json

                
{
  "dataType" : "DOUBLE",
  "reportedDataType" : "...",
  "reportedDescription" : "...",
  "reportedLabel" : "...",
  "name" : "...",
  "nullable" : true,
  "properties" : [ {
    "name" : "...",
    "type" : "PROPERTIES",
    "value" : { }
  }, {
    "name" : "...",
    "type" : "PROPERTIES",
    "value" : { }
  } ],
  "comment" : "...",
  "displayName" : "...",
  "importedComment" : "..."
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "dataType" : "BYTE",
  "reportedDataType" : "...",
  "reportedDescription" : "...",
  "reportedLabel" : "...",
  "name" : "...",
  "nullable" : true,
  "properties" : [ {
    "name" : "...",
    "type" : "INT",
    "value" : { }
  }, {
    "name" : "...",
    "type" : "LONG",
    "value" : { }
  } ],
  "comment" : "...",
  "displayName" : "...",
  "importedComment" : "..."
}
                
              

GET /v2/dataresource/source/{sourceName}

A GET request to the /dataresource/source/{sourceName} endpoint retrieves data resources from the given DataSource.

Request Parameters
name type description
sourceName path The name of the data source that includes the resources.
resourcePath query The path of the resource relative to the root of the data source.
Response Body
media type data type description
application/json DataResource (JSON) A list of DataResource objects in JSON format.

Example

Request
GET /v2/dataresource/source/{sourceName}
Content-Type: */*
Accept: application/json

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

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

POST /v2/dataresource/table/{resourceKey}

This API is used to create a new hive external table with a given payload

Request Parameters
name type description
resourceKey path Resource key of the HDFS file
Request Body
media type data type description
application/json map of string (JSON) Supporting data to POST call

Example

Request
POST /v2/dataresource/table/{resourceKey}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

POST /v2/dataresource/view/{resourceKey}

This API is used to create a new hive view over DO

Request Parameters
name type description
resourceKey path Resource key of the DO
Request Body
media type data type description
application/json map of string (JSON) Supporting data to POST call

Example

Request
POST /v2/dataresource/view/{resourceKey}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 201 Created

              

GET /v2/dataresource/virtualfolder/{virtualFolderName}

A GET request to the /dataresource/virtualfolder/{virtualFolderName} endpoint retrieves data resources from the given virtual Folder.

Request Parameters
name type description
virtualFolderName path The name of the virtual folder that includes the resources.
resourcePath query The path of the resource relative to the root of the data source.
Response Body
media type data type description
application/json DataResource (JSON) DataResource object in JSON format.

Example

Request
GET /v2/dataresource/virtualfolder/{virtualFolderName}
Content-Type: */*
Accept: application/json

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

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

GET /v2/dataresource/{resourceKey}/partitions

Request Parameters
name type description
resourceKey path
Response Body
media type data type description
application/json array of DataPartition (JSON)

Example

Request
GET /v2/dataresource/{resourceKey}/partitions
Content-Type: */*
Accept: application/json

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

                
[ {
  "location" : "...",
  "timeOfCreation" : 12345,
  "timeOfLastChange" : 12345,
  "partitionKey" : [ "...", "..." ]
} ]