Enterprise Data Catalog REST API Reference > Business Terms REST APIs > Business Terms APIs
  

Business Terms APIs

You can use the following Business Term REST APIs for accepted, inferred, or rejected business term:
Catalog Events REST API
Description
GET /data/objects/{id}/acceptedBusinessTerm
Lists the accepted business term for the specified object
PUT /data/objects/{id}/acceptedBusinessTerm
Updates the accepted business term
DELETE /data/objects/{id}/acceptedBusinessTerm
Deletes the accepted business term
GET /data/objects/{id}/inferredBusinessTerms
Lists the inferred business terms
GET /data/objects/{id}/rejectedBusinessTerms
Lists the rejected business term
PUT /data/objects/{id}/rejectedBusinessTerms
Updates the rejected business term
DELETE data/objects/{id}/rejectedBusinessTerms
Deletes the business term

List Accepted Business Term

data/objects/{id}/acceptedBusinessTerm
API to list the accepted business terms for the specified object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm
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 accepted business term 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/323/acceptedBusinessTerm" -H "accept: application/json"

Update Accepted Business Term

data/objects/{id}/acceptedBusinessTerm
API to update the accepted business term for the specified object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm
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
Reference to an object resource.
Body
-
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Response Codes

Code
Reason
200
Business term accepted.
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/332/acceptedBusinessTerm" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"id\": \"2\", \"readOnly\": false}"

Delete Accepted Business Term

data/objects/{id}/acceptedBusinessTerm
API to delete the accepted business term for the specified object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm
HTTP Method Type
DELETE

Request Parameters

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

Response Codes

Code
Reason
200
Deleted business term.
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/data/objects/222/acceptedBusinessTerm" -H "accept: application/json"

List Inferred Business Terms

data/objects/{id}/inferredBusinessTerms
API to return the details of the inferred business terms for the specified data object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/inferredBusinessTerms
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 details of the inferred business terms.
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/332/inferredBusinessTerms" -H "accept: application/json"

List Rejected Business Terms

data/objects/{id}/rejectedBusinessTerms
API to list the rejected business terms for the specified data object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms
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
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 rejected business terms 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/432/rejectedBusinessTerms?offset=0&pageSize=20" -H "accept: application/json"

Update Rejected Business Terms

data/objects/{id}/rejectedBusinessTerms
API to update the rejected business term for the specified object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms
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
Object references.
Body
-
If-Match
Optional
Enter a value to display the results that match the value. Do not update if the entity tag or Etag for the resource has changed.
Header
String

Response Codes

Code
Reason
200
Business term rejected.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
409
Conflict.
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/12331/rejectedBusinessTerms" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"items\": [ { \"id\": \"3\", \"readOnly\": false } ]}"

Delete Rejected Business Terms

data/objects/{id}/rejectedBusinessTerms
API to delete the rejected business term for the specified object.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms
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
termId
Optional
IDs of rejected business terms to be deleted.
Query
Array [String]

Response Codes

Code
Reason
200
Deleted business term.
204
No content to display.
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/33/rejectedBusinessTerms?termId=" -H "accept: application/json"