Catalog Events REST API | Description |
---|---|
GET /configuration/app_events | Lists the user configuration for application events |
PUT /configuration/app_events | Creates or updates the user configuration for application events |
GET /configuration/email_events | Lists the user configuration for email notifications |
PUT /configuration/email_events | Creates or updates the user configuration for email notifications |
GET /data/app_events | Lists the events for the objects that the user subscribed |
GET /data/app_events_class_types | Lists the class types of the events for the objects that the user subscribed |
GET /data/app_events/count | Lists the unread event counts since the last read time |
GET /data/subscriptions | Lists the user subscriptions for notifications |
PUT /data/subscriptions | Creates or updates user subscriptions for multiple objects |
DELETE /data/subscriptions | Deletes the subscription of objects for a user |
GET /data/subscriptions/{id} | Lists the user subscription details for the specified object |
PUT /data/subscriptions/{id} | Creates or updates the user subscription details for the specified object |
DELETE /data/subscriptions/{id} | Deletes the subscription details for the given subscription ID |
GET /data/subscriptions/{id}/subscribers | Lists the subscribers for the specified object or subscription ID |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/configuration/app_events |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Listed the user configuration for application events. |
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/configuration/app_events |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
_configuration | Required | Configuration for application. Read events till the specified time. Best practice is to pass the value of the until field that you get from the output of the List Application Events REST API. | 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 | Updated the user configuration for application events. |
201 | Created the application configuration. |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/configuration/email_events |
HTTP Method Type | GET |
Code | Reason |
---|---|
200 | Listed the user configuration for email notifications. |
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/configuration/email_events |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
_configuration | Required | Configuration for emails. Send emails at specified intervals. Enter one of the following frequency values:
| 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 |
Code | Reason |
---|---|
200 | Updated the user configuration for email notifications. |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/app_events |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
since | Optional | Time from which the event count needs to be returned. If you do not provide a value, the API returns the event count from the point of last read. | Query | Integer |
until | Optional | Time until which the event count needs to be returned. If you do not provide a value, the API returns the event count until the current time. | Query | Integer |
objectId | Optional | The ID of the object to filter the events. | ||
objectName | Optional | The name of the object to filter the events. | Query | String |
changeType | Required | Enter one or more change type of the events from the following list to filter the events:
You must enter SOURCE as a changeType parameter. | Query | Array [String] |
classType | Optional | The class type to filter the events. You must enter SOURCE as a classType parameter. | Query | Array [String] |
resourceName | Optional | The resource name to filter the events. | Query | Integer |
jobId | Optional | The job ID to filter the events. | Query | Integer |
sortBy | Optional | Enter one of the following parameters:
To list the results from oldest to latest, choose true for the ascending parameter. | Query | String |
ascending | Optional | Sort the filter results in ascending or descending order. Default is false. | Query | Boolean |
responseType | Optional | Select one of the following response types:
Note: Select DETAILED to view the changes in change summary. The eventCount property displays the number of changes in the change summary and events for the objects. Select EXPORT to export the change summary to a file. | Query | String |
pageSize | Optional | Number of results to display in a page. Default is 20 results per page. | Query | Integer |
offset | Optional | The offset position from which the API lists the results. Default is 0. | Query | Integer |
Code | Reason |
---|---|
200 | Listed the events for the objects that the user subscribed. |
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/app_events_class_types |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
resourceName | Optional | The resource name to filter the events. | Query | Integer |
Code | Reason |
---|---|
200 | Listed the class types of the events for the objects that the user subscribed. |
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/app_events/count |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
since | Optional | Time from which the event count needs to be returned. If you do not provide a value, the API returns the event count from the point of last read. | Query | Integer |
until | Optional | Time until which the event count needs to be returned. If you do not provide a value, the API returns the event count until the current time. | Query | Integer |
objectName | Optional | The name of the object to filter the events. | Query | String |
changeType | Required | Enter one or more change type of the events from the following list to filter the events:
| Query | Array [String] |
resourceName | Optional | Resource name of the events to filter the events. | Query | Integer |
jobId | Optional | Job ID of the events to filter the events. | Query | Integer |
Code | Reason |
---|---|
200 | Listed unread event counts since the last read time. |
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/subscriptions |
HTTP Method Type | GET |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
objectId | Optional | The ID of the data object. | Query | Array [String] |
resourceName | Optional | Resource name of the user subscription. Note: This parameter is ignored if you specify the object ID. | Query | Array [String] |
classType | Optional | Class type of the user subscription. Note: This parameter does not apply if you specify the object ID. | Query | Array [String] |
changeType | Optional | Change type of the user subscription. Note: This parameter does not apply if you specify the object ID. | Query | Array [String] |
pageSize | Optional | Number of results to display in a page. By default, you can view 20 results per page. | Query | Integer |
offset | Optional | The offset position from which the API lists the results. Default is 0. | Query | Integer |
Code | Reason |
---|---|
200 | Listed the user subscriptions for notifications. |
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. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/subscriptions |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
subscriptions | Required | Enter the subscription attributes for notifications on an 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 |
Parameter | Required or Optional | Description | Data Type |
---|---|---|---|
changeTypes | Required | Change type of the user subscription. Enter one of the following changeTypes:
| String |
objectId | Required | The ID of the data object. | String |
Code | Reason |
---|---|
200 | Updated the user subscriptions for multiple objects. |
201 | Created the subscriptions for multiple objects. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
404 | Requested object not found. |
409 | Object has an existing subscription. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/subscriptions |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
objectId | Required | The ID of the data object. | Query | Array [String] |
Code | Reason |
---|---|
200 | Deleted the subscription of objects for a user. |
204 | No content for the specified object ID. |
400 | Missing or invalid parameter. |
401 | Missing credentials. |
403 | User does not have the required access permissions. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/subscriptions/{id} |
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 subscription details for the specified subscription ID. |
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/subscriptions/{id} |
HTTP Method Type | PUT |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
subscription | Required | Enter the subscription details for an 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 |
Parameter | Required or Optional | Description | Data Type |
---|---|---|---|
changeTypes | Required | Change type of the user subscription. Enter one of the following changeTypes:
| String |
classType | Optional | Class type of the user subscription. | String |
href | Optional | Link to the resource. | String |
id | Optional | The unique ID of the resource. | String |
objectId | Optional | The ID of the data object. | String |
resourceName | Optional | The name of the resource. | String |
Code | Reason |
---|---|
200 | Updated the user subscription for the 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 update detected. |
429 | Rate limit for requests encountered. |
REST API Element | Input Format |
---|---|
Request URL | <CatalogAdmin>:<port>/access/2/catalog/data/subscriptions/{id} |
HTTP Method Type | DELETE |
Parameter | Required or Optional | Description | Parameter Type | Data Type |
---|---|---|---|---|
id | Required | The ID of the data object. | Path | String |
Code | Reason |
---|---|
200 | Deleted the subscription details for the specified object. |
204 | No content to delete. |
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/subscriptions/{id}/subscribers |
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 subscribers for the specified object ID or subscription ID. |
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. |