{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Events API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Events",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get change events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events",
            "params": [
              {
                "name": "entityCreated",
                "value": "",
                "type": "query",
                "description": "List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned"
              },
              {
                "name": "entityUpdated",
                "value": "",
                "type": "query",
                "description": "List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned"
              },
              {
                "name": "entityRestored",
                "value": "",
                "type": "query",
                "description": "List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned"
              },
              {
                "name": "entityDeleted",
                "value": "",
                "type": "query",
                "description": "List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned"
              },
              {
                "name": "timestamp",
                "value": "",
                "type": "query",
                "description": "Events starting from this unix timestamp in milliseconds"
              }
            ]
          },
          "docs": "Get a list of change events matching event types, entity type, from a given date"
        },
        {
          "info": {
            "name": "Check If the Publisher Processed All Events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:id/processedEvents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              }
            ]
          },
          "docs": "Return a boolean 'true' or 'false' to indicate if the publisher processed all events"
        },
        {
          "info": {
            "name": "List all available Event Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number event subscriptions returned. (1 to 1000000, default = 10) "
              },
              {
                "name": "alertType",
                "value": "",
                "type": "query",
                "description": "alertType filter. Notification / Observability"
              },
              {
                "name": "notificationTemplate",
                "value": "",
                "type": "query",
                "description": "Filter subscriptions by notification template ID. Returns only subscriptions using the specified template."
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of event subscriptions before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of event subscriptions after this cursor"
              }
            ]
          },
          "docs": "Get a list of All available Event Subscriptions"
        },
        {
          "info": {
            "name": "Create a new Event Subscription",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/events/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Event Subscription"
        },
        {
          "info": {
            "name": "Updated an existing or create a new Event Subscription",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/events/subscriptions",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updated an existing or create a new Event Subscription"
        },
        {
          "info": {
            "name": "Get a event Subscription by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              }
            ]
          },
          "docs": "Get a event Subscription by given Id"
        },
        {
          "info": {
            "name": "Update an Event Subscriptions",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/events/subscriptions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the event Subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Event Subscriptions using JsonPatch."
        },
        {
          "info": {
            "name": "Delete an Event Subscription by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/events/subscriptions/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              }
            ]
          },
          "docs": "Delete an Event Subscription"
        },
        {
          "info": {
            "name": "Asynchronously delete an Event Subscription by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/events/subscriptions/async/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              }
            ]
          },
          "docs": "Asynchronously delete an Event Subscription"
        },
        {
          "info": {
            "name": "Delete an Event Subscription by name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/events/subscriptions/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              }
            ]
          },
          "docs": "Delete an Event Subscription by given `name`."
        },
        {
          "info": {
            "name": "Get the destinations for a specific Event Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:eventSubscriptionId/destinations",
            "params": [
              {
                "name": "eventSubscriptionId",
                "value": "",
                "type": "path",
                "description": "ID of the Event Subscription"
              }
            ]
          },
          "docs": "Retrieve the status of all destinations associated with the given Event Subscription ID"
        },
        {
          "info": {
            "name": "Get the destinations for a specific Event Subscription by its name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName/destinations",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              }
            ]
          },
          "docs": "Retrieve the status of all destinations associated with the given Event Subscription's fully qualified name (FQN)"
        },
        {
          "info": {
            "name": "Get all failed events",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/listAllFailedEvents",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of failed events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Source of the failed events"
              }
            ]
          },
          "docs": "Retrieve all failed events, optionally filtered by source, and apply a limit."
        },
        {
          "info": {
            "name": "Get event subscription diagnostic info",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:subscriptionId/diagnosticInfo",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of unprocessed events returned"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              },
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "UUID of the Event Subscription"
              },
              {
                "name": "listCountOnly",
                "value": "",
                "type": "query",
                "description": "Return only count if true"
              }
            ]
          },
          "docs": "Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more."
        },
        {
          "info": {
            "name": "Get event subscription diagnostic info by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:subscriptionName/diagnosticInfo",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of unprocessed events returned"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              },
              {
                "name": "subscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              },
              {
                "name": "listCountOnly",
                "value": "",
                "type": "query",
                "description": "Return only count if true"
              }
            ]
          },
          "docs": "Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more."
        },
        {
          "info": {
            "name": "Get event subscription events record",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:subscriptionId/eventsRecord",
            "params": [
              {
                "name": "subscriptionId",
                "value": "",
                "type": "path",
                "description": "UUID of the Event Subscription"
              }
            ]
          },
          "docs": "Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription ID."
        },
        {
          "info": {
            "name": "Get event subscription events record by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:subscriptionName/eventsRecord",
            "params": [
              {
                "name": "subscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              }
            ]
          },
          "docs": "Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription name."
        },
        {
          "info": {
            "name": "Get Event Subscription status by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:eventSubscriptionId/status/:destinationId",
            "params": [
              {
                "name": "eventSubscriptionId",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              },
              {
                "name": "destinationId",
                "value": "",
                "type": "path",
                "description": "Destination Id"
              }
            ]
          },
          "docs": "Get a event Subscription status by given Name"
        },
        {
          "info": {
            "name": "Get Event Subscription status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName/status/:destinationId",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              },
              {
                "name": "destinationId",
                "value": "",
                "type": "path",
                "description": "Destination Id"
              }
            ]
          },
          "docs": "Get a event Subscription status by given Name"
        },
        {
          "info": {
            "name": "Get a version of the Event Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Event Subscription version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the Event Subscription by given `Id`"
        },
        {
          "info": {
            "name": "Retrieve events based on various filters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:id/listEvents",
            "params": [
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Status of events to retrieve (failed, successful)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the alert or destination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              }
            ]
          },
          "docs": "Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp."
        },
        {
          "info": {
            "name": "Get an Event Subscription by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              }
            ]
          },
          "docs": "Get an Event Subscription by name."
        },
        {
          "info": {
            "name": "Get failed events for a subscription by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:id/failedEvents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of failed events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Source of the failed events"
              }
            ]
          },
          "docs": "Retrieve failed events for a given subscription id."
        },
        {
          "info": {
            "name": "Get failed events for a subscription by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName/failedEvents",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of failed events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              },
              {
                "name": "source",
                "value": "",
                "type": "query",
                "description": "Source of the failed events"
              }
            ]
          },
          "docs": "Retrieve failed events for a given subscription name."
        },
        {
          "info": {
            "name": "Get successfully sent change events for an alert",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/id/:id/listSuccessfullySentChangeEvents",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "ID of the alert to retrieve change events for"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of change events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              }
            ]
          },
          "docs": "Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit."
        },
        {
          "info": {
            "name": "Get successfully sent change events for an alert by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName/listSuccessfullySentChangeEvents",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the alert to retrieve change events for"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of change events to retrieve"
              },
              {
                "name": "paginationOffset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination (starting point for records)"
              }
            ]
          },
          "docs": "Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit."
        },
        {
          "info": {
            "name": "Get list of Event Subscriptions Resources used in filtering Event Subscription",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:alertType/resources",
            "params": [
              {
                "name": "alertType",
                "value": "",
                "type": "path",
                "description": "AlertType"
              }
            ]
          },
          "docs": "Get list of EventSubscription functions used in filtering conditions in Event Subscription"
        },
        {
          "info": {
            "name": "List Event Subscription versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/events/subscriptions/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Event Subscription"
              }
            ]
          },
          "docs": "Get a list of all the versions of an Event Subscription identified by `Id`"
        },
        {
          "info": {
            "name": "Update an Event Subscriptions by name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/events/subscriptions/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the event Subscription"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Event Subscriptions using JsonPatch."
        },
        {
          "info": {
            "name": "Send a test message alert to external destinations.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/events/subscriptions/testDestination",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a test message alert to external destinations of the alert."
        },
        {
          "info": {
            "name": "Sync Offset for a specific Event Subscription by its name",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/events/subscriptions/name/:eventSubscriptionName/syncOffset",
            "params": [
              {
                "name": "eventSubscriptionName",
                "value": "",
                "type": "path",
                "description": "Name of the Event Subscription"
              }
            ]
          },
          "docs": "Sync Offset for a specific Event Subscription by its name"
        }
      ]
    }
  ],
  "bundled": true
}