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 |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm |
HTTP Method Type | PUT |
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 |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/acceptedBusinessTerm |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the object. | Path | String |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/inferredBusinessTerms |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object | Path | String |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms |
HTTP Method Type | GET |
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 |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms |
HTTP Method Type | PUT |
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 |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/objects/{id}/rejectedBusinessTerms |
HTTP Method Type | DELETE |
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] |
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. |