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

Model Modification APIs

You can use the following Model Modification REST APIs to create, delete, or update information in the model:

Model Modification REST API	Description
POST models/attributes	Creates custom attributes
PUT models/attributes/{id}	Updates custom attributes
DELETE models/attributes/{id}	Deletes custom attributes
PUT models/classes/{id}	Update Class
POST models/facets/fieldFacets	Creates a field facet
PUT models/facets/fieldFacets/{id}	Updates field facet
DELETE models/facets/fieldFacets/{id}	Deletes a field facet definition
POST models/facets/queryFacets	Creates a query facet
PUT models/facets/queryFacets/{id}	Updates a query facet
DELETE models/facets/queryFacets/{id}	Deletes a query facet definition
POST models/facets/sliderFacets	Creates a slider facet
PUT models/facets/sliderFacets/{id}	Updates a slider facet
DELETE models/facets/sliderFacets/{id}	Deletes a slider facet definition
POST models/referenceAttributes	Creates custom reference attributes
DELETE models/referenceAttributes/{id}	Deletes custom reference attributes
PUT models/referenceAttributes/{id}	Updates custom reference attributes
POST models/searchTabs	Creates a search tab
PUT models/searchTabs/{id}	Updates a search tab
DELETE models/searchTabs/{id}	Deletes a search tab
PUT models/searchTabs/orderUpdate	Updates a search tab order

Create Custom Attributes

attributes: API to update a custom attribute.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
attribute	Required	Enter the attribute parameters for the custom attribute.	Body	Model

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
analyzer	Optional	Classification for the custom attribute type.	String	Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARCHY
boost	Optional	The search ranking priority for the custom attribute.	String	Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH
classes	Required	The list of classes with the custom attribute.	Array	Provide the list of classes in the following format: classes": [ { "id": "string", } ]
dataTypeId	Required	The ID of the model resource.	String	User to provide the ID.
description	Optional	Description for the custom attribute.	String	User to provide the description.
facetable	Optional	Choose true to use the attribute in facets and filter queries. Default is true.	Boolean	Provide one of the following values: - true - false
faceted	Optional	Choose true so that the catalog indexes the attribute to use it in facets and filter queries. By default, it is set to the facetable value.	Boolean	Provide one of the following values: - true - false
indexed	Optional	Choose true to use the attribute for advanced search queries. The catalog references and searches with the attribute in the format attributeId:<query text>. For example, when you set the q parameter as q=core.name:customer and choose true for the indexed parameter, the catalog searches for the word customer in the assets with the core.name attribute. By default, it is set to the searched value. Note: Re-index the attribute for advanced search If you change an existing attribute.	Boolean	Provide one of the following values: - true - false
multivalued	Optional	Specifies whether the custom attribute appears in the list of filters in Enterprise Data Catalog. Default is true.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the custom attribute.	String	User to provide the name.
resources	Optional	List the resources to update the custom attribute.	-	Provide the following values: - assignmentType. Enter ALL, NONE, or LIST. - values. Enter the list of resources that are applicable only to LIST assignment type.
searchable	Optional	Choose true to include the attribute in basic search. Default is true.	Boolean	Provide one of the following values: - true - false
searched	Optional	Choose true so that Enterprise Data Catalog uses this attribute for basic queries. By default, it is set to the searchable value.	Boolean	Provide one of the following values: - true - false
sortable	Optional	Choose true to use the attribute for sorting. Default is true.	Boolean	Provide one of the following values: - true - false
sorted	Optional	Choose true so that the catalog indexes the attribute to sort assets. By default, it is set to the sortable value.	Boolean	Provide one of the following values: - true - false
suggestable	Optional	Choose true to include the attribute in suggestions. Default is true.	Boolean	Provide one of the following values: - true - false
suggested	Optional	Choose true so that the catalog includes matches to this attribute in suggestions. By default, it is set to the suggestable value.	Boolean	Provide one of the following values: - true - false

Response Codes

Code	Reason
201	Custom attribute created.
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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/attributes" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"analyzer\": \"INT\", \"boost\": \"LOWEST\", \"classes\": [ { \"3\": \"second\" } ], \"dataTypeId\": \"a1\", \"description\": \"Desc\", \"facetable\": false, \"multivalued\": false, \"name\": \"string\", \"searchable\": false, \"sortable\": false, \"suggestable\": false } ]}"

Update Custom Attribute

attributes/{id}: API to update a custom attribute.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of custom attribute.	Path	String
attribute	Required	Enter the attribute parameters for the custom attribute.	Body	Model
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
analyzer	Optional	Classification for the custom attribute type.	String	Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARCHY
boost	Optional	The search ranking priority for the custom attribute.	String	Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH
classes	Required	The list of classes with the custom attribute.	Array	Provide the list of classes in the following format: classes": [ { "id": "string", } ]
description	Optional	Description for the custom attribute.	String	User to provide the description.
faceted	Optional	Choose true so that the catalog indexes the attribute to use it in facets and filter queries. By default, it is set to the facetable value.	Boolean	Provide one of the following values: - true - false
indexed	Optional	I Choose true to use the attribute for advanced search queries. The catalog references and searches with the attribute in the format attributeId:<query text>. For example, when you set the q parameter as q=core.name:customer and choose true for the indexed parameter, the catalog searches for the word customer in the assets with the core.name attribute. By default, it is set to the searched value. Note: Re-index the attribute for advanced search If you change an existing attribute.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the custom attribute.	String	User to provide the name.
resources	Optional	List the resources to update the custom attribute.	-	Provide the following values: - assignmentType. Enter ALL, NONE, or LIST. - values. Enter the list of resources that are applicable only to LIST assignment type.
searched	Optional	Choose true so that Enterprise Data Catalog uses this attribute for basic queries. Default is true	Boolean	Provide one of the following values: - true - false
sorted	Optional	Choose true so that the catalog indexes the attribute to sort assets. Default is true	Boolean	Provide one of the following values: - true - false
suggested	Optional	Choose true so that the catalog includes matches to this attribute in suggestions. Default is true	Boolean	Provide one of the following values: - true - false

Response Codes

Code	Reason
201	Custom attribute updated.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/attributes/34" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"analyzer\": \"INT\", \"boost\": \"LOWEST\", \"classes\": [ { \"1\": \"first\" } ], \"description\": \"Updating first attribute\", \"facetable\": false, \"name\": \"attr\"}"

Delete Custom Attribute

attributes/{id}: API to delete a custom attribute.

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

Request Parameters

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

Response Codes

Code	Reason
200	Custom attribute deleted.
204	No content.
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/attributes/234" -H "accept: application/json"

Update a Class

/models/classes/{id}: API to update a class.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of custom attribute.	Path	String
classPutRequest	Required	Enter the attribute parameters.	Body	Model
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
indexed	Optional	Indexes the attribute. Default is true.	Boolean	Provide one of the following values: - true - false
searched	Optional	Specifies whether the class can be searched in the catalog. Default is true.	Boolean	Provide one of the following values: - true - false

Response Codes

Code	Reason
201	Custom attribute updated.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/classes/33" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"indexed\": false, \"searched\": false}"

Create a Field Facet Definition

/models/facets/fieldFacets: API to create a field facet definition. When you create a field facet, you can specify one or more keywords to create the facet or filter.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
facet	Required	Enter the field facet attributes.	Body	-

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the facet or filter has to be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
field	Required	The attribute ID to create the facet or filter.	String	-
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Required	The display name of the group	String	-
groups	Optional	The groups that can use the facet.	String	-
limit	Optional	The number of buckets. The term buckets* refers to the count of results for a particular field. For example, if 3 assets have a rating of 5, the bucket value of rating 5 is 3.	String	-
mincount	Required	Returns the buckets if it has the minimum count. You cannot set a value lesser than 1 for mincount parameter.	Integer	-
name	Required	The name of the field facet.	String	-
owner	Optional	The user name who created the facet.	String	-
prefix	Optional	Creates buckets for terms which start with the configured prefix.	String	-
users	Optional	The users of the facet.	String	-

Response Codes

Code	Reason
201	Created 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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"facetByDefault\": false, \"field\": \"com.infa.ldm.entity.collaboration.certified\", \"global\": false, \"group\": \"UserFieldFacet\", \"groupLabel\": \"User Fields\", \"groups\": [], \"limit\": 10, \"mincount\": 1, \"name\": \"Userfield02\", \"owner\": \"system\", \"users\": [\"user2\"] }"

Update a Field Facet Definition

/models/facets/fieldFacets/{id}: API to update a field facet definition.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	Enter the field facet ID.	Path	String
facet	Required	Enter the field facet attributes.	Body	-
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the field facet or filter has to be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
field	Required	The attribute ID to create the facet or filter.	String	-
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Optional	The display name of the group	String	-
groups	Optional	The groups that can use the facet.	String	-
limit	Optional	The number of buckets. The term buckets* refers to the count of results for a particular field. For example, if 3 assets have a rating of 5, the bucket value of rating 5 is 3.	String	-
mincount	Optional	Returns the buckets if it has the minimum count. You cannot set a value lesser than 1 for mincount parameter.	Integer	-
name	Required	The name of the field facet.	String	-
owner	Optional	The user name who created the facet.	String	-
prefix	Optional	Creates buckets for terms which start with the configured prefix.	String	-
users	Optional	The users of the facet.	String	-

Response Codes

Code	Reason
201	Updated 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.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets/f-7dfc1da2-30e9-425b-9010-c6023b53fe09" -H "accept: application/json" -H "If-Match: "89462eaa04f877ac925149038ec14ea3"" -H "Content-Type: application/json" -d "{ \"facetByDefault\": false, \"field\": \"com.infa.ldm.entity.collaboration.certified\", \"global\": false, \"group\": \"UserFieldFacet\", \"groupLabel\": \"User Fields\", \"groups\": [], \"limit\": 7, \"mincount\": 2, \"name\": \"Userfield02\", \"owner\": \"system\", \"users\": [\"user2,user3\"] }"

Delete a Field Facet Definition

/models/facets/fieldFacets/{id}: API to delete a field facet definition.

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

Request Parameters

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

Response Codes

Code	Reason
200	Field facet definition deleted.
204	No content.
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/fieldFacets/f-7dfc1da2-30e9-425b-9010-c6023b53fe09" -H "accept: application/json"

Create a Query Facet

/models/facets/queryFacets: API to create a query facet. You can use Lucene Query to create or update a query facet. For more information, see Apache Lucene documentation.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
facet	Required	Enter the query facet definition attributes.	Body	-

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the query facet or filter has to be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Optional	The display name of the group.	String	-
groupOrder	Optional	The query facets in a groupLabel in ascending or descending order.	Integer	Provide one of the following values: - 0. Displays in ascending order. - 1. Displays in descending order.
groups	Optional	The groups that can use the facet.	String	-
name	Required	The name of the field facet.	String	-
owner	Optional	The user name who created the facet.	String	-
q	Required	Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query.	Query	String
users	Optional	The users who can use the facet.	String	-

Response Codes

Code	Reason
201	Query facet created.
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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"name\": \"UserQueryFacet\", \"groupLabel\": \"User Rating\", \"facetByDefault\": false, \"global\": true, \"users\": [], \"groups\": [], \"owner\": \"system\", \"id\": \"facet.query.collab.rating.any\", \"href\": \"/2/catalog/models/facets/queryFacets/facet~2e~query~2e~collab~2e~rating~2e~any\", \"facetType\": \"QueryFacet\", \"q\": \"com.infa.ldm.entity.collaboration.rating:[1.5 TO 3.5]\", \"groupOrder\": 3}"

Update a Query Facet

/models/facets/queryFacets/{id}: API to update a query facet.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	ID of the query facet definition.	Path	String
facet	Required	Enter the query facet attributes.	Body	-
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the query facet or filter can be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
global	Optional	Ignore users and groups so that the query facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the query facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Required	The display name of the group.	String	-
groupOrder	Optional	The query facets in a groupLabel in ascending or descending order.	Integer	Provide one of the following values: - 0. Displays in ascending order. - 1. Displays in descending order.
groups	Optional	The groups that can use the facet.	String	-
name	Required	The name of the field facet.	String	-
owner	Optional	The user name who created the facet.	String	-
q	Required	Use to create a query that searches matching objects. Uses Apache Lucene to interpret the query.	Query	String
users	Optional	The users who can use the facet.	String	-

Response Codes

Code	Reason
201	Query facet definition updated.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets/q-93dec604-13e4-400c-b796-91848778a811" -H "accept: application/json" -H "If-Match: "c4b10a5f05e3f7459dc4ceeed93df26f"" -H "Content-Type: application/json" -d "{ \"name\": \"UserQueryFacet\", \"groupLabel\": \"User Rating\", \"facetByDefault\": false, \"global\": true, \"users\": [], \"groups\": [], \"owner\": \"system\", \"id\": \"facet.query.collab.rating.any\", \"href\": \"/2/catalog/models/facets/queryFacets/facet~2e~query~2e~collab~2e~rating~2e~any\", \"facetType\": \"QueryFacet\", \"q\": \"com.infa.ldm.entity.collaboration.rating:[2.0 TO 4.0]\", \"groupOrder\": 3}"

Delete a Query Facet Definition

/models/facets/queryFacets/{id}: API to delete a query facet definition.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of a query facet definition.	Path	String

Response Codes

Code	Reason
200	Query facet definition deleted.
204	No content.
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/queryFacets/q-c604-13e4-400c-b796-91848778a811" -H "accept: application/json"

Create a Slider Facet

models/facets/sliderFacets: API to create a slider facet definition.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
facet	Required	Enter the slider facet parameters.	Body	Model

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the slider facet or filter has to be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
field	Required	The attribute ID to create the facet.	String	-
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Required	The display name of the group	String	-
groups	Optional	The groups that can use the facet.	String	-
name	Required	The name of the field facet.	String	-
owner	Optional	The user who created the facet.	String	-
users	Optional	The users of the facet.	String	-

Response Codes

Code	Reason
200	Slider facet
201	Created
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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"facetByDefault\": true, \"field\": \"string\", \"global\": true, \"group\": \"string\", \"groupLabel\": \"string\", \"groups\": [ \"string\" ], \"name\": \"string\", \"owner\": \"string\", \"users\": [ \"string\" ]}"

Update a Slider Facet

/models/facets/sliderFacets/{id}: API to update a slider facet.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	Enter the slider facet ID.	Path	String
facet	Required	Enter the slider facet attributes.	Body	-
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
facetByDefault	Optional	Specifies whether the slider facet or filter has to be applied to all the basic queries. Default is true.	Boolean	Provide one of the following values: - true - false
field	Required	The attribute ID to create the facet or filter.	String	-
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	Boolean	Provide one of the following values: - true - false
group	Optional	The group that the facet belongs to. You can select one or more facets or filters in a group.	String	-
groupLabel	Optional	The display name of the group	String	-
groups	Optional	The groups that can use the facet.	String	-
name	Required	The name of the slider facet.	String	-
owner	Optional	The user who created the facet.	String	-
users	Optional	The users of the facet.	String	-

Response Codes

Code	Reason
201	Updated the slider facet definition
400	Missing or invalid parameter
401	Missing credentials
403	User does not have the required access permissions
404	Requested object not found
412	Conflicting update detected
429	Rate limit for requests encountered

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets/453234" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"facetByDefault\": true, \"field\": \"string\", \"global\": true, \"group\": \"string\", \"groupLabel\": \"string\", \"groups\": [ \"string\" ], \"name\": \"string\", \"owner\": \"string\", \"users\": [ \"string\" ]}"

Delete a Slider Facet

models/facets/sliderFacets/{id}: API to delete a slider facet.

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

Request Parameters

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

Response Codes

Code	Reason
200	Deleted the slider facet
204	No content
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/facets/sliderFacets/5645643" -H "accept: application/json"

Create Custom Reference Attribute

referenceAttributes: API to create a custom reference attribute.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
attributes	Required	Enter the attribute parameters.	Body	Model

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
analyzer	Optional	Classification for the custom reference attribute type.	String	Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARCHY
boost	Optional	The search ranking priority for the custom reference attribute.	String	Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH
classes	Optional	The list of classes with the custom reference attribute.	Array	Provide the list of classes in the following format: classes": [ { "id": "string", } ]
id	Required	The ID of the model resource.	String	User to provide the ID.
description	Optional	Description for the custom reference attribute.	String	User to provide the description.
facetable	Optional	Choose true to use the attribute in facets and filter queries. Default is true.	Boolean	Provide one of the following values: - true - false
faceted	Optional	Choose true so that the catalog indexes the attribute to use it in facets and filter queries. By default, it is set to the facetable value.	Boolean	Provide one of the following values: - true - false
indexed	Optional	Choose true to use the attribute for advanced search queries. The catalog references and searches with the attribute in the format attributeId:<query text>. For example, when you set the q parameter as q=core.name:customer and choose true for the indexed parameter, the catalog searches for the word customer in the assets with the core.name attribute. By default, it is set to the searched value. Note: Re-index the attribute for advanced search If you change an existing attribute.	Boolean	Provide one of the following values: - true - false
multivalued	Optional	Specifies whether the custom reference attribute appears in the list of filters in Enterprise Data Catalog. Default is true.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the custom reference attribute.	String	User to provide the name.
refDataTypeId	Required	ID of the reference data type.	String	-
resources	Optional	List the resources to update the custom attribute.	-	Provide the following values: - assignmentType. Enter ALL, NONE, or LIST. - values. Enter the list of resources that are applicable only to LIST assignment type.
searchable	Optional	Choose true to include the attribute in basic search. Default is true.	Boolean	Provide one of the following values: - true - false
searched	Optional	Choose true so that Enterprise Data Catalog uses this attribute for basic queries. By default, it is set to the searchable value.	Boolean	Provide one of the following values: - true - false
sortable	Optional	Choose true to use the attribute for sorting. Default is true.	Boolean	Provide one of the following values: - true - false
sorted	Optional	Choose true so that the catalog indexes the attribute to sort assets. By default, it is set to the sortable value.	Boolean	Provide one of the following values: - true - false
suggestable	Optional	Choose true to include the attribute in suggestions. Default is true.	Boolean	Provide one of the following values: - true - false
suggested	Optional	Choose true so that the catalog includes matches to this attribute in suggestions. By default, it is set to the suggestable value.	Boolean	Provide one of the following values: - true - false

Response Codes

Code	Reason
201	Custom reference attribute created.
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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"analyzer\": \"7\", \"boost\": \"LOWEST\", \"classes\": [ { \"98\": \"one\" } ], \"description\": \"none\", \"facetable\": false, \"multivalued\": false, \"name\": \"one\", \"refDataTypeId\": \"one\", \"searchable\": false, \"sortable\": false, \"suggestable\": false } ]}"

Update a Custom Reference Attribute

referenceAttributes/{id}: API to update a custom reference attribute.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of custom reference attribute.	Path	String
attribute	Required	Enter the attribute parameters.	Body	Model
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
analyzer	Optional	Classification for the custom reference attribute type.	String	Provide one of the following values: - INT - LONG - FLOAT - DOUBLE - BOOLEAN - DATE - STRING - TEXT_GENERAL - PATH_HIERARCHY
boost	Optional	The search ranking priority for the custom reference attribute.	String	Provide one of the following values: - LOWEST - LOWER - LOW - MEDIUM - HIGH
classes	Optional	The list of classes with the custom reference attribute.	Array	Provide the list of classes in the following format: classes": [ { "id": "string", } ]
id	Required	The ID of the model resource.	String	User to provide the ID.
description	Optional	Description for the custom reference attribute.	String	User to provide the description.
faceted	Optional	Choose true so that the catalog indexes the attribute to use it in facets and filter queries. By default, it is set to the facetable value.	Boolean	Provide one of the following values: - true - false
indexed	Optional	Choose true to use the attribute for advanced search queries. The catalog references and searches with the attribute in the format attributeId:<query text>. For example, when you set the q parameter as q=core.name:customer and choose true for the indexed parameter, the catalog searches for the word customer in the assets with the core.name attribute. By default, it is set to the searched value. Note: Re-index the attribute for advanced search If you change an existing attribute.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the custom reference attribute.	String	User to provide the name.
resources	Optional	List the resources to update the custom attribute.	-	Provide the following values: - assignmentType. Enter ALL, NONE, or LIST. - values. Enter the list of resources that are applicable only to LIST assignment type.
refDataTypeId	Required	The ID of the reference data type.	String	-
searched	Optional	Choose true so that Enterprise Data Catalog uses this attribute for basic queries. Default is true	Boolean	Provide one of the following values: - true - false
sorted	Optional	Choose true so that the catalog indexes the attribute to sort assets. Default is true	Boolean	Provide one of the following values: - true - false
suggested	Optional	Choose true so that the catalog includes matches to this attribute in suggestions. Default is true	Boolean	Provide one of the following values: - true - false

Response Codes

Code	Reason
201	Custom reference attribute updated.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes/2" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"analyzer\": \"3\", \"boost\": \"LOWEST\", \"classes\": [ { \"2\": \"none\" } ], \"description\": \"none\", \"facetable\": false, \"name\": \"string\"}"

Delete Custom Reference Attribute

referenceAttributes/{id}: API to delete a custom reference attribute.

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

Request Parameters

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

Response Codes

Code	Reason
200	Custom attribute deleted.
204	No content.
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/referenceAttributes/167" -H "accept: application/json"

Create a New Search Tab

models/searchTabs: API to create a search tab.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
tab	Required	Enter the search tab attributes.	Body	Model

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
fieldFilters	Optional	The field facets to apply to the tab.	String	Provide the following values: - facetId - value
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	String	-
groups	Optional	The groups that can use the facet.	String	-
isDefault	Optional	Specifies whether the tab is the default tab. Default is true.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the tab.	String	-
order	Optional	Specifies the order to display the tab.	Integer	Provide one of the following values: - 0. Displays in ascending order. - 1. Displays in descending order.
owner	Optional	The user who owns the facet	String	-
queryFilters	Optional	The query facets to apply to the tab.	String	Enter the facetId value.
rootTo	Optional	Specifies whether the results are to be rooted to the parent level.	String	Provide one of the following values: - NONE - RESOURCE - DATA_SET
sliderFilters	Required	Specifies the slider facets to apply to the tab.	-	Provide the following values: - facetId - max - min
users	Optional	Specifies the users who can use the search tab.	String	-

Response Codes

Code	Reason
200	Created search tab.
201	Created search tab.
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 POST "http://<CatalogAdmin>:<port>/access/2/catalog/models//searchTabs" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"fieldFilters\": [ { \"facetId\": \"string\", \"value\": \"string\" } ], \"global\": false, \"groups\": [ \"string\" ], \"isDefault\": false, \"name\": \"string\", \"order\": 0, \"owner\": \"string\", \"queryFilters\": [ { \"facetId\": \"string\" } ], \"rootTo\": \"NONE\", \"users\": [ \"string\" ]}"

Update a Search Tab

models/searchTabs/{id}: API to update a search tab.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of search tab.	Path	String
tab	Required	Enter the search tab attributes.	Body	-
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type	Values
fieldFilters	Optional	The field facets to apply to the tab.	String	Provide the following values: - facetId. - value
global	Optional	Ignore users and groups so that the facet is visible to all users. Default is true.	String	-
groups	Optional	The groups that can use the facet.	String	-
isDefault	Optional	Specifies whether the tab is the default tab. Default is true.	Boolean	Provide one of the following values: - true - false
name	Required	The name of the tab.	String	-
order	Optional	Specifies the order to display the tab.	Integer	Provide one of the following values: - 0. Displays in ascending order. - 1. Displays in descending order.
owner	Optional	The user who owns the facet.	String	-
queryFilters	Optional	The query facets to apply to the tab.	String	Enter the facetId value.
rootTo	Optional	Specifies whether the results are to be rooted to a parent level.	String	Provide one of the following values: - NONE - RESOURCE - DATA_SET
sliderFilters	Optional	The slider facets to apply to the tab.	String	Provide the following values: - facetId - max - min
users	Optional	Specifies the users who can use the search tab.	String	-

Response Codes

Code	Reason
200	Updated the search tab.
201	Updated the search tab.
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 PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/tab123" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"fieldFilters\": [ { \"facetId\": \"string\", \"value\": \"string\" } ], \"global\": false, \"groups\": [ \"string\" ], \"isDefault\": false, \"name\": \"string\", \"order\": 0, \"owner\": \"string\", \"queryFilters\": [ { \"facetId\": \"string\" } ], \"rootTo\": \"NONE\", \"users\": [ \"string\" ]}"

Delete a Search Tab Definition

models/searchTabs/{id}: API to delete a search tab definition.

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of search tab.	Path	String

Response Codes

Code	Reason
200	Deleted a search tab definition.
204	No content.
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 DELETE "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/tab123" -H "accept: application/json"

Update 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	PUT

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
tabOrder	Required	Enter the search tab order attributes.	Path	String
if-Match	Optional	Identify the ETag for the resource. Enterprise Data Catalog does not update the resource if the ETag for the resource has changed.	Header	String

Attribute Parameters

Parameter	Required or Optional	Description	Data Type
order	Required	Specifies the order to display the tab.	Integer
tabId	Required	The ID of the search tab.	String

Response Codes

Code	Reason
200	Updated the search tab order.
201	Custom reference attribute updated.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting update detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/models/searchTabs/order" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"order\": 0, \"tabId\": \"string\" } ]}"