Model Information REST API | Description |
---|---|
GET data/objects | Lists the objects |
GET data/objects/{id} | Lists the object details |
GET data/relationships | Lists the relationships between the objects |
GET catalog/data/search | Lists the search results |
GET catalog/data/suggest | Lists the suggestions |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
q | Optional | Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query. | Query | String |
fq | Optional | Enter one or more filter queries that you can apply to search query. | Query | Arrary [String] |
id | Optional | Enter one or more data object IDs. | Query | Arrary [String] |
offset | Optional | The starting point in the results. The results after the offset value is displayed. By default, the offset value is 0. | Query | Integer |
pageSize | Optional | The number of results to display in a page. Default is 20 results per page. | Query | Integer |
sort | Optional | Enter core.name_sort asc to sort the results in ascending order. Enter core.name_sort desc to sort the results in descending order. | Query | String |
relatedId | Optional | Enter one or more object IDs to display the results of related IDs. | Query | Arrary [String] |
cursor | Optional | Enter query for faster paginated results for deep paging. This parameter is an alternative to offset parameter. | Query | String |
associations | Optional | The list of association types to include in the response. By default, the links of all types are included in the parameter. | Query | Arrary [String] |
includeSrcLinks | Optional | Select true if you want to include source links. | Query | Boolean |
includeDstLinks | Optional | Select true if you want to include destination links. | Query | Boolean |
shards | Optional | The list of search shards to query. By default all shards are queried. | Query | Arrary [String] |
includeRefObjects | Optional | Include reference objects in the object details. Default is false. | Query | Boolean |
Code | Reason |
---|---|
200 | Returns objects and object details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id} |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
includeRefObjects | Optional | Include reference objects in the object details. Default is false. | Query | Boolean |
Code | Reason |
---|---|
200 | Returns the object and object details. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
Parameter | Description |
---|---|
id | The ID of the object resource. |
href | The URL of the object. |
nativeId | A unique ID for the object. |
seeAlsoHref | The URL of the alternative endpoint for the object. |
facts | The list of facts that apply to the object. |
facts : attributeId | The attribute ID. |
facts : value | The fact value. |
facts : label | The display name of the fact. |
facts : description | The fact description. |
facts : providerId | The asserter or provider ID of the fact. |
facts : xid | The ID of the exchange document containing the fact. |
facts : modifiedBy | The username of the user that modified a fact. |
facts : readOnly | Indicates if the fact can be modified. |
srcLinks | The upstream object. |
srcLinks : id | The ID of the resource object. |
srcLinks : association | The association ID. |
srcLinks : linkProperties | The property of the link. |
srcLinks : linkProperties : attributeId | The link property attribute ID. |
srcLinks : linkProperties : value | The link property value. |
srcLinks : linkProperties : label | The link property label. |
srcLinks : providerId | The asserter or provider ID of the link. |
srcLinks : xid | The ID of the exchange document containing the link. |
srcLinks : modifiedBy | The username of the user that modified the upstream object. |
srcLinks : readOnly | Indicates if the upstream object can be modified. |
srcLinks : name | The name of the object connected by the link. |
srcLinks : classType | The class type of the upstream object. |
srcLinks : href | The URL of the object. |
dstLinks | The downstream object. |
dstLinks : id | The ID of the resource object. |
dstLinks : association | The association ID. |
dstLinks : linkProperties | The property for the link. |
dstLinks : linkProperties : attributeId | The link property attribute ID. |
dstLinks : linkProperties : value | The link property value. |
dstLinks : linkProperties : label | The link property label. |
dstLinks : providerId | The asserter or provider ID of the link. |
dstLinks : xid | The ID of the exchange document containing the link. |
dstLinks : modifiedBy | The username of the user that modified the downstream object. |
dstLinks : readOnly | Indicates if the downstream object can be modified. |
dstLinks : name | The name of the object connected by the link. |
dstLinks : classType | The class type of the downstream object. |
dstLinks : href | The URL of the object. |
businessTerms | The associated business terms. |
commentHref | The URL to access the comments for the object. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/relationships |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
seed | Required | Enter one or more data asset IDs. | Query | Arrary [String] |
association | Required | Enter one or more association IDs or association kind IDs. Lineage or association displays where the data for an asset comes from and the assets that impact it. You can enter the association ID or association kind ID. | Query | Arrary [String] |
depth | Required | The depth of traversal which is the number of return links in the lineage. Enter one of the following Enter 0 or N as the depth of traversal, where N is an integer. Enter 0 to display complete lineage. Enter a number N to display the lineage for N hops from the seed node. | Query | Integer |
direction | Optional | Direction to traverse for lineage. Enter one of the following parameters:
Default is BOTH. | Query | String |
removeDuplicateAggregateLinks | Optional | Select true if you do not want the duplicate aggregate links to appear in the response. Default is true. Sometimes, the scanners create duplicate aggregate links. | Query | Boolean |
includeTerms | Optional | Select true if the connected business terms are to be embedded in the response. Default is false. | Query | Boolean |
includeAttribute | Optional | Enter one or more attribute IDs that you want to embed in the response. | Query | Array [String] |
includeRefObjects | Optional | Include reference objects in the object relationships details. Default is false. | Query | Boolean |
edgeQuery | Optional | Enter edges to filter the relationships. | Query | Array [String] |
Code | Reason |
---|---|
200 | Listed relationships. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
Parameter | Description |
---|---|
items | The list of lineage links or associations. |
items : associationId | The association type of the link. |
items : inEmbedded | The downstream object of the link. |
items : inEmbedded : businessTerms | The business terms associated with the downstream object. |
items : inEmbedded : businessTerms : classType | The class type of business terms associated with the downstream object. |
items : inEmbedded : businessTerms : href | The URL of business terms associated with the downstream object. |
items : inEmbedded : businessTerms : id | The ID of business terms associated with the downstream object. |
items : inEmbedded : businessTerms : name | The name of the business terms associated with the downstream object. |
items : inEmbedded : businessTerms : readOnly | Indicates if the business term is read only. |
items : inEmbedded : facts | The facts of the downstream object. |
items : inEmbedded : facts : attributeId | The attribute ID of facts of the downstream object. |
items : inEmbedded : facts : label | The label of the fact. |
items : inEmbedded : facts : projectedFrom | Indicates that if the attribute is a reference attribute, it is projected from the actual attribute. |
items : inEmbedded : facts : readOnly | Indicates if the fact is read only. |
items : inEmbedded : facts : value | The value of the fact. |
items : inId | The object ID of the downstream object. |
items : inResource | The resource name of the downstream object. |
items : outEmbedded | The upstream object of the link. |
items : outEmbedded : businessTerms | The business terms associated with the upstream object. |
items : outEmbedded : businessTerms : classType | The class type of business terms associated with the upstream object. |
items : outEmbedded : businessTerms : href | The URL of business terms associated with the upstream object. |
items : outEmbedded : businessTerms : id | The ID of business terms associated with the upstream object. |
items : outEmbedded : businessTerms : name | The name of the business terms associated with the upstream object. |
items : outEmbedded : businessTerms : readOnly | Indicates if the business term is read only. |
items : outEmbedded : facts | The facts of the upstream object. |
items : outEmbedded : facts : attributeId | The attribute ID of the fact. |
items : outEmbedded : facts : label | The label of the fact. |
items : outEmbedded : facts : projectedFrom | Indicates that if the attribute is a reference attribute, it is projected from the actual attribute. |
items : outEmbedded : facts : readOnly | Indicates if the fact is read only. |
items : outEmbedded : facts : value | The value of the fact. |
items : outId | The object ID of the upstream object. |
items : outResource | The resource name of the upstream object. |
items : properties | The properties of the link. |
items : properties : attributeId | The attribute ID of the link. |
items : properties : label | The label of the link. |
items : properties : value | The value of the link. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/search |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
q | Optional | Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query. | Query | String |
basicQuery | Optional | A query string. Uses blockjoin faceting to interpret the query. See Apache Lucene for more information. | Query | String |
fq | Optional | Filter queries to apply on the q parameter. Useful to apply facets. | Query | Array [String] |
facet | Optional | Select true to return facets for the query. | Query | Boolean |
defaultFacets | Optional | Select true to return facets for the query. | Query | Boolean |
facetId | Optional | Enter one or more facets to include in the query if the facet parameter is true. | Query | Array [String] |
queryFacetJson | Optional | Enter one or more query facets in JSON format to create an on-the-fly facet when the facet parameter is true. | Query | Array [String] |
fieldFacetJson | Optional | Enter one or more field facets in JSON format to create an on-the-fly facet when the facet parameter is true. | Query | Array [String] |
sliderFacetJson | Optional | Enter one or more slider facets in JSON format to create an on-the-fly facet when the facet parameter is true. | Query | Array [String] |
rootTo | Optional | Join results to resource or data set. Choose one of the following parameters:
| Query | String |
relatedId | Optional | Specifies the object ID for which the related assets appear. | Query | Array [String] |
highlight | Optional | Select true to highlight the tokens in different properties of an asset. | Query | Boolean |
offset | Optional | The starting point in the results. The results after the offset value is displayed. Default is 0. | Query | Integer |
pageSize | Optional | The number of results to display in a page. Default is 20 results per page. | Query | Integer |
sort | Optional | The filter to sort results. Choose one of the following parameters:
Default is relevance(score). | Query | String |
cursor | Optional | As an alternative to offset, this parameter can provide faster paginated results when Enterprise Data Catalog performs deep paging. | Query | String |
shards | Optional | The list of search shards to query. Default is queries all the shards. | Query | Array [String] |
tabId | Optional | The tab ID to apply the filters. | Query | String |
fl | Optional | Specifies the fields to include in the query response. | Query | Array [String] |
qf | Optional | Specifies the fields in the index to use in query. Enter index attributes that have index="true" in the view model. | Query | Array [String] |
enableLegacySearch | Optional | Search in legacy fields. Default is false. | Query | Boolean |
disableSemanticSearch | Optional | Semantic search or auto filter objects in search. Default is false. | Query | Boolean |
includeRefObjects | Optional | Include reference objects in search. Default is false. | Query | Boolean |
Code | Reason |
---|---|
200 | Returns the search results. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
Parameter | Description |
---|---|
metadata | The metadata of the search. |
metadata : totalCount | The total number of results. |
metadata : partialResults | If true, the response does not contain results from all the appropriate shards. |
metadata : nextCursorMark | Indicates that the request supports cursor pagination. |
tabRedirect | Indicates that the search prefilter is changed to All on the search results page. |
appliedFilters | If true, it indicates that semantic search is performed and objects are auto filtered. |
facetResults | The facets returned for the search query in the first page. |
hits | The total number of hits. |
hits : id | The external object ID of the searched object. |
hits : href | The URL of the searched object. |
hits : nativeId | The internal object ID of the searched object. |
hits : values | The indexed facts of the searched object. |
hits : values : attributeId | The attribute ID of the indexed fact. |
hits : values : label | The label of the indexed fact. |
hits : values : value | The value of the indexed fact. |
hits : values : highlights | Highlights the keyword that matches the search term. |
hits : subHits | The child object of objects that are returned on the search results page. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog//data/suggest |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
basicQuery | Required | The query string. All characters are treated as literals except the * character, which represents a wildcard | Query | String |
pageSize | Optional | The number of results to display in a page. Default is 20 results per page. | Query | Integer |
Code | Reason |
---|---|
200 | Returns suggestions. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
429 | Rate limit for requests encountered. |
Parameter | Description |
---|---|
suggestions | The list of suggestions. |