Endpoints under /browse
allow you to list and manage metadata for data resources based commonalities of location.
Compare with the /search
functionality, that lists data resources which share some metadata characteristics.
Browse functionality depends on how data is stored and its location on a file system or database.
Browse facets are data resource attributes, such as file format, associated tags, size, and so on.
Facets provide a list of items or ranges that include the values represented in the browse context.
For example, the Content Type facet includes all file format types found in the catalog, but only the
values that apply to the current browse context are considered.
The browse call maintains state. The sequence of calls is important, as each call stores information that successive calls use.
A BrowseResult object contains path information, an array of facet names and categories, information about the
DataSource, and DataResource objects in JSON format.
The results of a browse operation can be huge, so results are paginated. The default page size is 25. A browse
request can specify a different page size, and after the first request, can specify the 0-based index of a
specific page of results to retrieve, or a number of pages to retrieve.
Browse calls return results based on the user credentials for the current authentication session.
A POST request to the browse/allvalues
endpoint initiates a get all pattern or values
from discovery cache.
media type | data type | description |
---|---|---|
application/json | AllValuesRequest (JSON) | Accepts resource Id, field name, and boolean (true - all patterns, false - all values). |
media type | data type | description |
---|---|---|
application/json | AllValuesTO (JSON) | A AllValuesTO result object containing the requested patterns aor values. |
POST /v2/browse/allvalues
Content-Type: application/json
Accept: application/json
{
"resourceKey" : "...",
"patternsOrValues" : true,
"fullFieldPath" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"patternList" : [ {
"value" : 12345,
"key" : "..."
}, {
"value" : 12345,
"key" : "..."
} ]
}
A POST request to the /browse/facet
endpoint initiates a browse operation that returns a set of resources based on facet values.
media type | data type | description |
---|---|---|
application/json | BrowseRequest (JSON) | A JSON object containing facet selections (facet names and categories) and paging criteria (page number and size of results). |
media type | data type | description |
---|---|---|
application/json | BrowseResult (JSON) | A BrowseResult object containing the requested page or pages of matching DataResource objects, in JSON format. |
POST /v2/browse/facet
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
{
"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" : "LONG",
"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" : "..."
} ]
}
A POST request to the /browse/new
endpoint initiates a browse operation. The initial call must specify a
"default root level folder". The results of this call are stored and used in subsequent browse operations.
media type | data type | description |
---|---|---|
application/json | BrowseRequest (JSON) | A JSON object that specifies facet names and categories to filter for. |
media type | data type | description |
---|---|---|
application/json | BrowseResult (JSON) | A BrowseResult object containing matching DataResource objects, in JSON format. |
POST /v2/browse/new
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
{
"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" : "INTEGER",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
}, {
"dataType" : "DATE",
"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" : "..."
} ]
}
A POST request to the browse/page
endpoint initiates a paged browse operation.
media type | data type | description |
---|---|---|
application/json | BrowseRequest (JSON) | Accepts paging criteria such as specific page numbers or a range of page numbers, along with facet names and categories. |
media type | data type | description |
---|---|---|
application/json | BrowseResult (JSON) | A BrowseResult object containing the requested page or pages of matching DataResource objects, in JSON format. |
POST /v2/browse/page
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
{
"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" : "DOUBLE",
"description" : "...",
"displayName" : "...",
"nullable" : true,
"name" : "...",
"comment" : "...",
"properties" : [ { }, { } ]
}, {
"dataType" : "BINARY",
"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" : "..."
} ]
}
A POST request to the browse/pattern
endpoint initiates a pattern browse operation.
media type | data type | description |
---|---|---|
application/json | BrowseRequest (JSON) | Accepts resource Id and number of patterns to display. along with facet names and categories. |
media type | data type | description |
---|---|---|
application/json | PatternTO (JSON) | A PatternTO result object containing the requested patterns. The patterns will be split into half top and half bottom patterns |
POST /v2/browse/pattern
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
{
"patternMapInPercent" : {
"property1" : { },
"property2" : { }
},
"patternMap" : {
"property1" : [ {
"key" : "...",
"value" : 12345
}, {
"key" : "...",
"value" : 12345
} ],
"property2" : [ {
"key" : "...",
"value" : 12345
}, {
"key" : "...",
"value" : 12345
} ]
}
}
A POST request to the browse/patterntopbottom
endpoint initiates a pattern browse operation.
media type | data type | description |
---|---|---|
application/json | BrowseRequest (JSON) | Accepts resource Id and number of patterns to display. along with facet names and categories. |
media type | data type | description |
---|---|---|
application/json | PatternTopBottomTO (JSON) | A PatternTO result object containing the requested patterns. Will return top (topPatternMap) and bottom (bottomPatternMap) patterns separately, split into half top and half bottom patterns. If all patterns count less than configured (see waterlinedata.web.pattern_top_and_bottom_k.count), will return all in top portion (topPatternMap) |
POST /v2/browse/patterntopbottom
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
{
"topPatternMap" : {
"property1" : [ {
"value" : 12345,
"key" : "..."
}, {
"value" : 12345,
"key" : "..."
} ],
"property2" : [ {
"value" : 12345,
"key" : "..."
}, {
"value" : 12345,
"key" : "..."
} ]
},
"bottomPatternMap" : {
"property1" : [ {
"value" : 12345,
"key" : "..."
}, {
"value" : 12345,
"key" : "..."
} ],
"property2" : [ {
"value" : 12345,
"key" : "..."
}, {
"value" : 12345,
"key" : "..."
} ]
}
}