Waterline Data REST API Reference: Browse: Resource-level

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.

POST /v2/browse/facet

A POST request to the /browse/facet endpoint initiates a browse operation that returns a set of resources based on facet values.

Request Body
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).

Response Body
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.

Example

Request

POST /v2/browse/facet
Content-Type: application/json
Accept: application/json

                
{
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "pagingCriteria" : {
    "start" : 12345,
    "size" : 12345
  },
  "resourceKey" : "...",
  "lfKey" : "...",
  "requestType" : "...",
  "dataSetKey" : "...",
  "showMembers" : true,
  "topAndBottomPatternCount" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

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

POST /v2/browse/new

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.

Request Body
media type	data type	description
application/json	BrowseRequest (JSON)	A JSON object that specifies facet names and categories to filter for.

Response Body
media type	data type	description
application/json	BrowseResult (JSON)	A BrowseResult object containing matching DataResource objects, in JSON format.

Example

Request

POST /v2/browse/new
Content-Type: application/json
Accept: application/json

                
{
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "pagingCriteria" : {
    "start" : 12345,
    "size" : 12345
  },
  "resourceKey" : "...",
  "lfKey" : "...",
  "requestType" : "...",
  "dataSetKey" : "...",
  "showMembers" : true,
  "topAndBottomPatternCount" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

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

POST /v2/browse/page

A POST request to the browse/page endpoint initiates a paged browse operation.

Request Body
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.

Response Body
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.

Example

Request

POST /v2/browse/page
Content-Type: application/json
Accept: application/json

                
{
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "pagingCriteria" : {
    "start" : 12345,
    "size" : 12345
  },
  "resourceKey" : "...",
  "lfKey" : "...",
  "requestType" : "...",
  "dataSetKey" : "...",
  "showMembers" : true,
  "topAndBottomPatternCount" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

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

POST /v2/browse/pattern

A POST request to the browse/pattern endpoint initiates a pattern browse operation.

Request Body
media type	data type	description
application/json	BrowseRequest (JSON)	Accepts resource Id and number of patterns to display. along with facet names and categories.

Response Body
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

Example

Request

POST /v2/browse/pattern
Content-Type: application/json
Accept: application/json

                
{
  "facetSelections" : [ {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  }, {
    "facetCategories" : [ "...", "..." ],
    "facetName" : "...",
    "displayName" : "..."
  } ],
  "pagingCriteria" : {
    "start" : 12345,
    "size" : 12345
  },
  "resourceKey" : "...",
  "lfKey" : "...",
  "requestType" : "...",
  "dataSetKey" : "...",
  "showMembers" : true,
  "topAndBottomPatternCount" : 12345
}

Response

HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "patternMap" : {
    "property1" : [ { }, { } ],
    "property2" : [ { }, { } ]
  }
}

Browse: Resource-level Resource

POST /v2/browse/facet

Example

Request

Response

POST /v2/browse/new

Example

Request

Response

POST /v2/browse/page

Example

Request

Response

POST /v2/browse/pattern

Example

Request

Response