Object Certification APIs

You can use the following Object Certification REST APIs for the objects in the catalog:

Model Information REST API	Description
GET data/objects/{id}/certificate	Lists the certification properties for an object ID.
PUT data/objects/{id}/certificate	Updates the certification properties for an object ID
DELETE data/objects/{id}/certificate	Deletes the certification properties for an object ID

List the Certification Properties for an Object

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

Request Parameters

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

Response Codes

Code	Reason
200	Listed the certification properties for the specified object.
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/data/objects/1001/certificate" -H "accept: application/json"

Create or Update Certification Properties for an Object

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

Request Parameters

Parameter	Required or Optional	Description	Parameter Type	Data Type
id	Required	The ID of the data object.	Path	String
object	Required	Enter certification text and list of tags for the certified object.	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

Response Codes

Code	Reason
200	Updated the certification properties for the specified object.
201	Created the certification properties for the specified object.
400	Missing or invalid parameter.
401	Missing credentials.
403	User does not have the required access permissions.
404	Requested object not found.
412	Conflicting edit detected.
429	Rate limit for requests encountered.

Sample Call Using Curl

curl -X PUT "http://<CatalogAdmin>:<port>/access/2/catalog/data/objects/1001/certificate" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"certifyText\": \"Add certificate\", \"tags\": [ \"Update text\" ]}"

Delete Certification Properties for an Object

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

Request Parameters

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

Response Codes

Code	Reason
200	Deleted the certification properties for the specified object.
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/data/objects/1001/certificate" -H "accept: application/json"