Enterprise Data Catalog REST API Reference > Model REST APIs > Model Information APIs

Model Information APIs

You can use the following Model Information REST APIs to extract information from the model:

Model Information REST API	Description
GET models/associationKinds	Lists association types
GET models/associationKinds/{id}	Lists association type details
GET models/associations	Lists associations
GET models/associations/{id}	Lists association details
GET models/attributes	Lists attributes
GET models/attributes/{id}	Lists attribute details
GET models/classes	Lists classes
GET models/classes/{id}	Lists class details
GET models/dataTypes	Lists data types
GET models/dataTypes/{id}	Lists data type details
GET models/facets	Lists the facet definitions
GET models/facets/fieldFacets	Lists the field facet definitions
GET models/facets/fieldFacets/{id}	Lists a field facet definition
GET models/facets/queryFacets	Lists the query facet definitions
GET models/facets/queryFacets/{id}	Lists a query facet definition
GET models/facets/sliderFacets/{id}	Lists the definition for a slider facet
GET models/facets/sliderFacets/{id}	Lists the predefined slider facets
GET models/lineageFilters	Lists the definitions for lineage filters
GET models/referenceAttributes	Lists reference attributes
GET models/referenceAttributes/{id}	Lists reference attribute details
GET models/referenceDataTypes	Lists reference data types
GET models/referenceDataTypes{id}	Lists reference data type details
GET models/searchTabs	Lists search tabs
GET models/searchTabs/{id}	Lists search tab definitions
GET models/searchTabs/order	Lists search tab order

List Association Kinds

associationKinds: API to list types of association.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/associationKinds
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the association. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed association types.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/associationKinds?id=34&offset=0&pageSize=20" -H "accept: application/json"

Association Kind Details

associationKinds/{id}: API to list association type details.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/associationKinds/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the association.	Path	String

Response Codes

Code	Reason
200	Listed association type details.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/associationKinds/334" -H "accept: application/json"

List Associations

associations: API to list associations.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/associations
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the association. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer
isA	Optional	Displays associations that inherit the specified association types.	Query	Array [String]

Response Codes

Code	Reason
200	Listed association types.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/associations?id=32&offset=0&pageSize=20" -H "accept: application/json"

Association Kinds

associations/{id}: API to list details of an association.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/associations/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the association.	Path	String

Response Codes

Code	Reason
200	Listed association types.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/associations/324" -H "accept: application/json"

List Attributes

attributes: API to list the attributes.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/attributes
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more attribute IDs.	Query	Array [String]
classId	Optional	Enter one or more class IDs to filter the attributes.	Query	Array [String]
packageId	Optional	Enter the package ID to filter the attributes.	Query	Array [String]
name	Optional	Enter the name of the attribute to filter the attributes. You can also enter the package ID along with the name.	Query	Array [String]
resources	Optional	Enter the resource names to filter the attributes.	Query	Array [String]
offset	Optional	The offset position from which the attributes must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed the attributes.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/attributes?id=342&offset=0&pageSize=20" -H "accept: application/json"

Attribute Details

attributes/{id}: API to list details of an attribute.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/attributes/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the attribute.	Path	String

Note: Use com.infa.ldm.profiling.lastProfileTime as the attribute ID to view the last time you ran a profile.

Response Codes

Code	Reason
200	Listed attribute details.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/attributes/321" -H "accept: application/json"

List Classes

classes: API to list classes in a model.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/classes
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the class. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer
isA	Optional	Displays classes that inherit the specified class types.	Query	Array [String]

Response Codes

Code	Reason
200	Listed association types.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/classes?id=345&offset=0&pageSize=20" -H "accept: application/json"

Class Details

classes/{id}: API to list class details.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/classes/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the class.	Path	String

Response Codes

Code	Reason
200	Listed class details.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/classes/213" -H "accept: application/json"

List Data Types

dataTypes: API to list types of data.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/dataTypes
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the data type. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
offset	Optional	The offset position from which the data types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed association types.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/dataTypes?id=256&offset=0&pageSize=20" -H "accept: application/json"

Data Type Details

dataTypes{id}: API to list types of association.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/dataTypes{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the data type.	Path	String

Response Codes

Code	Reason
200	Listed association types.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/dataTypes/6786" -H "accept: application/json"

List the Facet Definitions

/models/facets: API to list the facets that you can use in asset search in the catalog.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog//models/facets
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more facet IDs.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer
attributeId	Optional	Enter the attribute ID to use as a filter. The API returns the facets that reference the attribute ID.	Query	String

Response Codes

Code	Reason
200	Listed all the facets.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets?offset=0&pageSize=20" -H "accept: application/json"

List Field Facet Definitions

/models/facets/fieldFacets: API to list the field facets that you can use to search for assets.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more field facet IDs.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed the field facet definitions.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets/core.classType" -H "accept: application/json"

List a Field Facet Definition

/models/facets/fieldFacets/{id}: API to list the definition for a field facet.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the field facet.	Query	Array [String]

Response Codes

Code	Reason
200	Listed the field facet definition.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets/asset1" -H "accept: application/json"

List the Query Facet Definitions

/models/facets/queryFacets: API to list the query facets that you can use to search for assets.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more predefined query facet IDs.	Query	Array [String]
offset	Optional	The offset position from which the association types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed all the query facets.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets?offset=0&pageSize=20" -H "accept: applicat

List a Query Facet Definition

/models/facets/queryFacets/{id}: API to list the definitions for a query facet.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the query facet.	Query	Array [String]

Response Codes

Code	Reason
200	Listed the query facet definition.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets/facet.query.collab.rating.any" -H "accept: application/json"

List Predefined Slider Facets

/models/facets/sliderFacets: API to list all the predefined slider facets to search for assets.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more predefined slider facet IDs.	Query	Array [String]
offset	Optional	The offset position from which the slider facets must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed all the slider facets
401	Missing credentials
403	User does not have the required access permissions
404	Requested object not found
429	Rate limit for requests encountered

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets?offset=0&pageSize=20" -H "accept: application/json"

List a Slider Facet Definition

/models/facets/sliderFacets/{id}: API to list the definition for a slider facet.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the slider facet.	Path	String

Response Codes

Code	Reason
200	Listed the slider facet definition.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets/534543" -H "accept: application/json"

List Lineage Filters

/models/lineageFilters: API to list the lineage filter definitions to use in lineage REST APIs.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilters
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more lineage filter IDs.	Query	Array [String]
offset	Optional	The offset position from which the lineage filters must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed all the lineage filters.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/lineageFilters?offset=0&pageSize=20" -H "accept: application/json"

List Reference Attributes

referenceAttributes: API to list reference attributes.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the reference attribute. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
classId	Optional	The ID of the class based on which you want to filter the reference attributes.	Query	Array [String]
packageId	Optional	Enter the package ID to filter the reference attributes.	Query	Array [String]
name	Optional	Enter the name of the reference attribute to filter the reference attributes. You can also enter the package ID along with the name.	Query	Array [String]
resources	Optional	Enter the resource names to filter the reference attributes.	Query	Array [String]
offset	Optional	The offset position from which the reference attributes must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed reference attributes.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes?id=234&classId=3&offset=0&pageSize=20" -H "accept: application/json"

Reference Attribute Details

referenceAttributes{id}: API to list details of a reference attribute.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the reference attribute.	Path	String

Response Codes

Code	Reason
200	Listed reference attribute types.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes/543" -H "accept: application/json"

List Reference Data Types

referenceDataTypes: API to list reference data types.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/referenceDataTypes
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	The ID of the reference data type. If you want to provide multiple IDs, verify that you provide each ID on another line.	Query	Array [String]
offset	Optional	The offset position from which the reference data types must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer

Response Codes

Code	Reason
200	Listed reference data types.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceDataTypes?id=323&offset=0&pageSize=20" -H "accept: application/json"

Reference Data Type Details

referenceDataTypes{id}: API to list details of a reference data type.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/referenceDataTypes{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the reference data type.	Path	String

Response Codes

Code	Reason
200	Listed reference data type details.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceDataTypes/34" -H "accept: application/json"

List the Search Tabs

models/searchTabs: API to list all the search tabs that you can access in Enterprise Data Catalog.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Optional	Enter one or more search tab IDs.	Query	Array [String]
offset	Optional	The offset position from which the search tabs must start for listing. Default is 0.	Query	Integer
pageSize	Optional	The number of results to be displayed on a page. Default is 20.	Query	Integer
includeHidden	Optional	Select one of the options: - true. The API includes the hidden predefined search tabs in the search tab list. - false. The API does not include the hidden predefined search tabs.	Query	Boolean

Response Codes

Code	Reason
200	Listed all the accessible search tabs.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs?offset=0&pageSize=20" -H "accept: application/json"

List the Definition for a Search Tab

models/searchTabs/{id}: API to list the definition for a search tab.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/{id}
HTTP Method Type	GET

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the search tab.	Query	Array [String]

Response Codes

Code	Reason
200	Listed the search tab definition
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/4t56" -H "accept: application/json"

Changing the Search Tab Order

models/searchTabs/order: API to change the order of the search tabs.

REST API Element	Input Format
Request URL	<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/order
HTTP Method Type	GET

Response Codes

Code	Reason
200	Changed the order of the search tabs.
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.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/order" -H "accept: application/json"