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.
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.
| 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. |
| media type | data type | description |
|---|---|---|
| application/json | map of object (JSON) | KeyValue map of properties to update |
| media type | data type | description |
|---|---|---|
| application/json | DataResource (JSON) |
PUT /v2/dataresource
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "MANUAL",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "DOUBLE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "INT"
}, {
"name" : "...",
"value" : { },
"type" : "STRING"
} ]
}, {
"dataType" : "STRING",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "INT"
}, {
"name" : "...",
"value" : { },
"type" : "DOUBLE"
} ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A GET call to the /fields endpoint returns the field associated with a given resource
and field path.
| name | type | description |
|---|---|---|
| fieldPath | query | |
| resourceKey | query |
| media type | data type | description |
|---|---|---|
| application/json | object (JSON) |
GET /v2/dataresource/fields
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
A POST call to the /fields endpoint returns the fields associated with a resource.
| media type | data type |
|---|---|
| application/json | BrowseRequest (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | object (JSON) |
POST /v2/dataresource/fields
Content-Type: application/json
Accept: application/json
{
"resourceKey" : "...",
"lfKey" : "...",
"facetSelections" : [ {
"facetName" : "...",
"displayName" : "...",
"facetCategories" : [ "...", "..." ]
}, {
"facetName" : "...",
"displayName" : "...",
"facetCategories" : [ "...", "..." ]
} ],
"searchPhrase" : "...",
"parentFieldPath" : "...",
"showMembers" : true,
"pagingCriteria" : {
"start" : 12345,
"size" : 12345
},
"dataSetKey" : "...",
"topAndBottomPatternCount" : 12345,
"forceNativeBrowse" : true,
"requestType" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
...
+ Listing down column names for generating hive table
| name | type | description |
|---|---|---|
| resourceID | query | resource id for the resource for which hive table is generated |
| media type | data type | description |
|---|---|---|
| application/json | map of array of string (JSON) | map of column to associated names |
GET /v2/dataresource/hivecolumns
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/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.
| 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 |
| 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. |
| media type | data type | description |
|---|---|---|
| application/json | PaginatedResponse2OfDataResourceFlexTO (JSON) |
GET /v2/dataresource/metadata
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pageToken" : "...",
"size" : 12345,
"list" : [ {
"timeOfLastChange" : 12345,
"path" : "...",
"key" : "...",
"viewProperties" : {
"property1" : "...",
"property2" : "..."
},
"viewTags" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"viewFields" : [ {
"dataType" : "INTEGER",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
}, {
"dataType" : "DECIMAL",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
} ],
"raw" : { },
"type" : "..."
}, {
"timeOfLastChange" : 12345,
"path" : "...",
"key" : "...",
"viewProperties" : {
"property1" : "...",
"property2" : "..."
},
"viewTags" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"viewFields" : [ {
"dataType" : "MAP",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
}, {
"dataType" : "MAP",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
} ],
"raw" : { },
"type" : "..."
} ]
}
A GET request to the /srv/origin endpoint fetch origin detail of a particular resource.
| name | type | description |
|---|---|---|
| resourceKey | query |
| media type | data type | description |
|---|---|---|
| application/json | string (JSON) | Integer |
GET /v2/dataresource/origin
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
A GET request to the /srv/popularity endpoint fetch counts for popularity of a particular resource.
| name | type | description |
|---|---|---|
| resourceKey | query |
| media type | data type | description |
|---|---|---|
| application/json | number (JSON) | Integer |
GET /v2/dataresource/popularity
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
...
API to save frequent patterns to a file based on the data resource
| media type | data type | description |
|---|---|---|
| application/json | map of string (JSON) | Input payload to save the file |
POST /v2/dataresource/savepatterns
Content-Type: application/json
...
HTTP/1.1 201 Created
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.
| name | type | description |
|---|---|---|
| key | path | The unique identifier of a data resource, as returned by a call to getResourcesByPath(). |
| media type | data type | description |
|---|---|---|
| application/json | DataResource (JSON) |
GET /v2/dataresource/{key}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "MANUAL",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "DOUBLE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "LONG"
}, {
"name" : "...",
"value" : { },
"type" : "BOOLEAN"
} ]
}, {
"dataType" : "STRING",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "DOUBLE"
}, {
"name" : "...",
"value" : { },
"type" : "INT"
} ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
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.
| name | type | description |
|---|---|---|
| key | path | The unique identifier of a data resource, as returned by a call to getResourcesByPath(). |
| 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. |
| media type | data type | description |
|---|---|---|
| application/json | DataResource (JSON) | The updated DataResource object in JSON format. |
PUT /v2/dataresource/{key}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "DERIVED",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "OBJECT",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "INT"
}, {
"name" : "...",
"value" : { },
"type" : "DOUBLE"
} ]
}, {
"dataType" : "BINARY",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "DOUBLE"
}, {
"name" : "...",
"value" : { },
"type" : "STRING"
} ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
A GET request to the /dataresource/browse/{resourceKey} endpoint retrieves a data resource identified by key.
| name | type | description |
|---|---|---|
| resourceKey | path | The unique identifier of a data resource, as returned by a call to getResourcesByPath(). |
| 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. |
GET /v2/dataresource/browse/{resourceKey}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"logicalFolderContext" : "...",
"resourceCount" : 12345,
"dataSource" : {
"hiveUrl" : "...",
"agentLocalUrl" : "...",
"jdbcUrl" : "...",
"sourceType" : "...",
"useWebHdfs" : true,
"agentName" : "...",
"configured" : true,
"webHdfsUri" : "...",
"rootResourceKey" : "...",
"permittedToRead" : true,
"skipConnectionTest" : true,
"hdfsUri" : "...",
"driverClass" : "...",
"name" : "...",
"agentKey" : "...",
"attributes" : {
"property1" : { },
"property2" : { }
},
"sourcePath" : "...",
"jdbcPassword" : "...",
"jdbcUsername" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
},
"resource" : {
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "DERIVED",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ { }, { } ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ { }, { } ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ { }, { } ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ { }, { } ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ { }, { } ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ { }, { } ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "BINARY",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
}, {
"dataType" : "TIMESTAMP",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
},
"dataSetKey" : "...",
"pathInfo" : {
"pathElements" : [ {
"type" : "...",
"key" : "...",
"name" : "...",
"path" : "..."
}, {
"type" : "...",
"key" : "...",
"name" : "...",
"path" : "..."
} ]
},
"children" : [ {
"dataSetRootResource" : "...",
"fileFormatDisplay" : "...",
"dataSourceType" : "...",
"resourcePath" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"fieldCount" : 12345,
"rowCount" : 12345,
"name" : "...",
"resourceSize" : 12345,
"ratingCount" : 12345,
"status" : "...",
"dataSetId" : "...",
"dataSetMember" : true,
"timeOfResourceChange" : 12345,
"topicsCount" : 12345,
"resourceType" : "...",
"canAssociateTag" : true,
"canRunJob" : true,
"dataSetSchemaVersion" : 12345,
"sensitivity" : "...",
"collectionRoot" : true,
"dataSourceKey" : "...",
"dataPermitted" : true,
"logicalFolderContext" : "...",
"dataSourceUri" : "...",
"commentsCount" : 12345,
"canDisassociateTag" : true,
"origins" : [ "...", "..." ],
"favorite" : true,
"resourceState" : "...",
"joinResources" : [ "...", "..." ],
"averageRating" : 12345.0,
"fileFormat" : "...",
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}, {
"dataSetRootResource" : "...",
"fileFormatDisplay" : "...",
"dataSourceType" : "...",
"resourcePath" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"fieldCount" : 12345,
"rowCount" : 12345,
"name" : "...",
"resourceSize" : 12345,
"ratingCount" : 12345,
"status" : "...",
"dataSetId" : "...",
"dataSetMember" : true,
"timeOfResourceChange" : 12345,
"topicsCount" : 12345,
"resourceType" : "...",
"canAssociateTag" : true,
"canRunJob" : true,
"dataSetSchemaVersion" : 12345,
"sensitivity" : "...",
"collectionRoot" : true,
"dataSourceKey" : "...",
"dataPermitted" : true,
"logicalFolderContext" : "...",
"dataSourceUri" : "...",
"commentsCount" : 12345,
"canDisassociateTag" : true,
"origins" : [ "...", "..." ],
"favorite" : true,
"resourceState" : "...",
"joinResources" : [ "...", "..." ],
"averageRating" : 12345.0,
"fileFormat" : "...",
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
} ],
"facetSelections" : [ {
"facetName" : "...",
"displayName" : "...",
"facetCategories" : [ "...", "..." ]
}, {
"facetName" : "...",
"displayName" : "...",
"facetCategories" : [ "...", "..." ]
} ],
"facetResults" : [ {
"categoryCounts" : {
"property1" : 12345,
"property2" : 12345
},
"displayName" : "...",
"totalCount" : 12345,
"name" : "..."
}, {
"categoryCounts" : {
"property1" : 12345,
"property2" : 12345
},
"displayName" : "...",
"totalCount" : 12345,
"name" : "..."
} ]
}
| name | type | description |
|---|---|---|
| resourceKey | path |
| media type | data type |
|---|---|
| application/json | AtomicField (JSON) |
| media type | data type | description |
|---|---|---|
| application/json | AtomicField (JSON) |
PUT /v2/dataresource/schema/{resourceKey}
Content-Type: application/json
Accept: application/json
{
"reportedDescription" : "...",
"reportedLabel" : "...",
"reportedDataType" : "...",
"dataType" : "DATE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "STRING"
}, {
"name" : "...",
"value" : { },
"type" : "LONG"
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"reportedDescription" : "...",
"reportedLabel" : "...",
"reportedDataType" : "...",
"dataType" : "DATE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "ARRAY"
}, {
"name" : "...",
"value" : { },
"type" : "INT"
} ]
}
A GET request to the /dataresource/source/{sourceName} endpoint retrieves data resources from
the given DataSource.
| 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. |
| media type | data type | description |
|---|---|---|
| application/json | DataResource (JSON) | A list of DataResource objects in JSON format. |
GET /v2/dataresource/source/{sourceName}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "MANUAL",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "LONG",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "BOOLEAN"
}, {
"name" : "...",
"value" : { },
"type" : "INT"
} ]
}, {
"dataType" : "DOUBLE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "ARRAY"
}, {
"name" : "...",
"value" : { },
"type" : "LONG"
} ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
This API is used to create a new hive external table with a given payload
| name | type | description |
|---|---|---|
| resourceKey | path | Resource key of the HDFS file |
| media type | data type | description |
|---|---|---|
| application/json | map of string (JSON) | Supporting data to POST call |
POST /v2/dataresource/table/{resourceKey}
Content-Type: application/json
...
HTTP/1.1 201 Created
A PUT request to the /dataresource/updateschema/{virtualFolderName} endpoint with map of resource path and list of respective resource fields will
* update the list of resources with all field related attributes i.e. label, description, imported description.
| name | type | description |
|---|---|---|
| virtualFolderName | path |
| media type | data type | description |
|---|---|---|
| application/json | map of array of AtomicField (JSON) | Map containing resource path as key and its respective fields list as value |
PUT /v2/dataresource/updateschema/{virtualFolderName}
Content-Type: application/json
[ {
"..." : {
"reportedDescription" : "...",
"reportedLabel" : "...",
"reportedDataType" : "...",
"dataType" : "ARRAY",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "INT"
}, {
"name" : "...",
"value" : { },
"type" : "LONG"
} ]
}
} ]
HTTP/1.1 204 No Content
This API is used to create a new hive view over DO
| name | type | description |
|---|---|---|
| resourceKey | path | Resource key of the DO |
| media type | data type | description |
|---|---|---|
| application/json | map of string (JSON) | Supporting data to POST call |
POST /v2/dataresource/view/{resourceKey}
Content-Type: application/json
...
HTTP/1.1 201 Created
A GET request to the /dataresource/virtualfolder/{virtualFolderName} endpoint retrieves data resources from
the given virtual Folder.
| 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. |
| media type | data type | description |
|---|---|---|
| application/json | DataResource (JSON) | DataResource object in JSON format. |
GET /v2/dataresource/virtualfolder/{virtualFolderName}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"permToReadMap" : {
"property1" : true,
"property2" : true
},
"dataSetId" : "...",
"canAssociateTag" : true,
"partitionCount" : 12345,
"owner" : "...",
"xmlRowTag" : "...",
"separator" : "...",
"dataSourceName" : "...",
"errorMsg" : "...",
"permittedToRead" : true,
"timeOfResourceChange" : 12345,
"resourcePath" : "...",
"allowedTagDomainKeys" : [ "...", "..." ],
"dataSetRoot" : true,
"timeOfResourceCreation" : 12345,
"timeOfResourceAccess" : 12345,
"dataSetMember" : true,
"subscribersCount" : 12345,
"dataSetVirtualFolders" : [ "...", "..." ],
"resourceState" : "...",
"datasetVirtualFolderName" : "...",
"name" : "...",
"reportedFields" : [ {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
}, {
"dataType" : "...",
"label" : "...",
"name" : "...",
"description" : "..."
} ],
"timeOfLastProfile" : 12345,
"dataSourceType" : "...",
"tableType" : "...",
"runId" : "...",
"joinResources" : [ "...", "..." ],
"collectionRoot" : true,
"parquetBinaryAsString" : true,
"partitionDefinition" : [ "...", "..." ],
"processedTime" : 12345,
"origins" : [ "...", "..." ],
"logicalFolderContext" : "...",
"dataSetPathSpecs" : {
"property1" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ],
"property2" : [ {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
}, {
"sourcePath" : "...",
"excludePattern" : "...",
"includePattern" : "..."
} ]
},
"fieldCount" : 12345,
"timeOfLastRefresh" : 12345,
"curationCount" : 12345,
"dataSetRootResource" : "...",
"browseContextDataset" : "...",
"canRunJob" : true,
"fileFormat" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"dataPermitted" : true,
"headerRow" : 12345,
"rowCount" : 12345,
"databaseName" : "...",
"experts" : {
"expertsType" : "DERIVED",
"experts" : [ "...", "..." ]
},
"favorite" : true,
"resourceType" : "...",
"xmlRootTag" : "...",
"joinConditions" : [ {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
}, {
"leftResourceName" : "...",
"leftFileFormat" : "...",
"rightTimeOfLastChange" : 12345,
"rightTimeOfResourceChange" : 12345,
"rightOwner" : "...",
"leftOrigin" : [ "...", "..." ],
"rightSize" : 12345,
"leftOwner" : "...",
"leftSourceId" : "...",
"rightTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightPath" : "...",
"rightFileFormat" : "...",
"leftSourceName" : "...",
"joinOp" : "...",
"leftTimeOfResourceChange" : 12345,
"rightCols" : [ "...", "..." ],
"leftCols" : [ "...", "..." ],
"joinStatState" : "...",
"joinOrder" : "...",
"stats" : {
"property1" : "...",
"property2" : "..."
},
"leftTimeOfLastChange" : 12345,
"rightSourceId" : "...",
"leftResourceId" : "...",
"leftPath" : "...",
"rightSourceName" : "...",
"rightResourceName" : "...",
"joinCardinality" : "...",
"leftSize" : 12345,
"leftTags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "SUGGESTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "REJECTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "VALUE",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightOrigin" : [ "...", "..." ],
"tags" : [ {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
}, {
"regexMaxLen" : 12345,
"parentKey" : "...",
"allSensitivities" : [ "...", "..." ],
"state" : "ACCEPTED",
"immutable" : true,
"synonyms" : [ "...", "..." ],
"externalSourceName" : "...",
"regEx" : "...",
"fullName" : "...",
"children" : [ { }, { } ],
"enable" : true,
"domainKey" : "...",
"externalId" : "...",
"learningEnabled" : true,
"name" : "...",
"regexMinLen" : 12345,
"regexFilterClass" : "...",
"tagState" : "REGEX",
"sensitivity" : "...",
"minScore" : 12345.0,
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ { }, { } ]
} ],
"rightResourceId" : "..."
} ],
"logicalFolders" : [ "...", "..." ],
"dataSetSchemaVersion" : 12345,
"header" : true,
"averageRating" : 12345.0,
"lastPartitionProfile" : true,
"sensitivity" : "...",
"dataSourceUri" : "...",
"canCreateHiveTableOrView" : true,
"landing" : true,
"fields" : [ {
"dataType" : "TIMESTAMP",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "BOOLEAN"
}, {
"name" : "...",
"value" : { },
"type" : "DOUBLE"
} ]
}, {
"dataType" : "DECIMAL",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ {
"name" : "...",
"value" : { },
"type" : "ARRAY"
}, {
"name" : "...",
"value" : { },
"type" : "LONG"
} ]
} ],
"resourceSize" : 12345,
"dataSchemaName" : "...",
"usageCount" : 12345,
"detailedStatus" : [ {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
}, {
"startTime" : 12345,
"stageName" : "...",
"errorMsg" : "...",
"status" : "...",
"runId" : "...",
"numberSampledRows" : 12345,
"workflowId" : "...",
"endTime" : 12345,
"lastPartitionProfile" : true
} ],
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"virtualFolderContextName" : "...",
"dataSourceKey" : "...",
"ratingCount" : 12345,
"fileFormatDisplay" : "...",
"canDisassociateTag" : true,
"tableName" : "...",
"status" : "...",
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}
| name | type | description | default | constraints |
|---|---|---|---|---|
| resourceKey | path | |||
| limit | query | 20000 | int | |
| offset | query | required |
| media type | data type | description |
|---|---|---|
| application/json | array of DataPartition (JSON) |
GET /v2/dataresource/{resourceKey}/partitions
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"timeOfCreation" : 12345,
"timeOfLastChange" : 12345,
"partitionKey" : [ "...", "..." ],
"location" : "..."
} ]
A GET request to the /{resourceKey}/relatedresources endpoint retrieves a list of all
related resources for the given resource.
relationType query parameter can be used to fetch the related resources based on relation.
Valid values can joinedResources and usedTogether
Like any other list services, it also supports pagination. Use start, size query parameters to
fetch page wise results.
| name | type | description | default |
|---|---|---|---|
| resourceKey | path | ||
| relationType | query | ||
| size | query | 25 | |
| sortColumns | query | ||
| sortDirection | query | ||
| start | query | 0 |
| media type | data type | description |
|---|---|---|
| application/json | PaginatedResponseOfDataResourceLite (JSON) |
GET /v2/dataresource/{resourceKey}/relatedresources
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"list" : [ {
"dataSetRootResource" : "...",
"fileFormatDisplay" : "...",
"dataSourceType" : "...",
"resourcePath" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"fieldCount" : 12345,
"rowCount" : 12345,
"name" : "...",
"resourceSize" : 12345,
"ratingCount" : 12345,
"status" : "...",
"dataSetId" : "...",
"dataSetMember" : true,
"timeOfResourceChange" : 12345,
"topicsCount" : 12345,
"resourceType" : "...",
"canAssociateTag" : true,
"canRunJob" : true,
"dataSetSchemaVersion" : 12345,
"sensitivity" : "...",
"collectionRoot" : true,
"dataSourceKey" : "...",
"dataPermitted" : true,
"logicalFolderContext" : "...",
"dataSourceUri" : "...",
"commentsCount" : 12345,
"canDisassociateTag" : true,
"origins" : [ "...", "..." ],
"favorite" : true,
"resourceState" : "...",
"joinResources" : [ "...", "..." ],
"averageRating" : 12345.0,
"fileFormat" : "...",
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
}, {
"dataSetRootResource" : "...",
"fileFormatDisplay" : "...",
"dataSourceType" : "...",
"resourcePath" : "...",
"canAddOrRemoveResourceFromDataset" : true,
"fieldCount" : 12345,
"rowCount" : 12345,
"name" : "...",
"resourceSize" : 12345,
"ratingCount" : 12345,
"status" : "...",
"dataSetId" : "...",
"dataSetMember" : true,
"timeOfResourceChange" : 12345,
"topicsCount" : 12345,
"resourceType" : "...",
"canAssociateTag" : true,
"canRunJob" : true,
"dataSetSchemaVersion" : 12345,
"sensitivity" : "...",
"collectionRoot" : true,
"dataSourceKey" : "...",
"dataPermitted" : true,
"logicalFolderContext" : "...",
"dataSourceUri" : "...",
"commentsCount" : 12345,
"canDisassociateTag" : true,
"origins" : [ "...", "..." ],
"favorite" : true,
"resourceState" : "...",
"joinResources" : [ "...", "..." ],
"averageRating" : 12345.0,
"fileFormat" : "...",
"tagAssociationViewList" : [ {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
}, {
"tagKey" : "...",
"rules" : [ "...", "..." ],
"key" : "...",
"state" : "...",
"timeOfLastChange" : 12345,
"tagName" : "...",
"timeOfCreation" : 12345,
"domainKey" : "...",
"domainName" : "...",
"resourceKey" : "...",
"semantic" : "...",
"weight" : 12345.0,
"field" : "..."
} ],
"timeOfLastChange" : 12345,
"timeOfCreation" : 12345,
"key" : "...",
"description" : "...",
"type" : "...",
"restricted" : [ "...", "..." ],
"viewAble" : [ "...", "..." ],
"updateable" : [ "...", "..." ],
"richDescription" : "...",
"score" : 12345.0,
"customProperties" : [ {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
}, {
"description" : "...",
"value" : { },
"facetAble" : true,
"name" : "...",
"type" : "...",
"displayName" : "..."
} ]
} ],
"totalCount" : 12345
}