{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Notification Templates API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Notification Templates",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List notification templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "provider",
                "value": "",
                "type": "query",
                "description": "Filter templates by provider type (SYSTEM or USER)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of results. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of entities before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of entities after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a list of notification templates"
        },
        {
          "info": {
            "name": "Create a notification template",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/notificationTemplates",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new notification template"
        },
        {
          "info": {
            "name": "Create or update a notification template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/notificationTemplates",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a notification template, if it does not exist or update an existing notification template."
        },
        {
          "info": {
            "name": "Get a notification template by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the notification template"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              },
              {
                "name": "includeRelations",
                "value": "",
                "type": "query",
                "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value."
              }
            ]
          },
          "docs": "Get a notification template by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Update a notification template by name",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/notificationTemplates/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the notification template"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing notification template using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a notification template by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/notificationTemplates/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the notification template"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              }
            ]
          },
          "docs": "Delete a notification template by `fullyQualifiedName`. System templates cannot be deleted."
        },
        {
          "info": {
            "name": "Get a notification template by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              },
              {
                "name": "includeRelations",
                "value": "",
                "type": "query",
                "description": "Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value."
              }
            ]
          },
          "docs": "Get a notification template by `Id`."
        },
        {
          "info": {
            "name": "Update a notification template",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/notificationTemplates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing notification template using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a notification template by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/notificationTemplates/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              }
            ]
          },
          "docs": "Delete a notification template by `Id`. System templates cannot be deleted."
        },
        {
          "info": {
            "name": "Asynchronously delete a notification template by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/notificationTemplates/async/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete this entity and it's children. (Default `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              }
            ]
          },
          "docs": "Asynchronously delete a notification template by `Id`."
        },
        {
          "info": {
            "name": "Get available Handlebars helpers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/helpers"
          },
          "docs": "Returns a list of all available Handlebars helpers with their usage information. Requires VIEW_BASIC permission for notification templates."
        },
        {
          "info": {
            "name": "Get a version of the notification template",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Notification template version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the notification template by given `Id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/history",
            "params": [
              {
                "name": "startTs",
                "value": "",
                "type": "query",
                "description": "Start timestamp in milliseconds since epoch"
              },
              {
                "name": "endTs",
                "value": "",
                "type": "query",
                "description": "End timestamp in milliseconds since epoch"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of entity returned (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of entity versions after this cursor"
              }
            ]
          },
          "docs": "Get a paginated list of all entity versions within a given time range specified by `startTs` and `endTs` in milliseconds since epoch. "
        },
        {
          "info": {
            "name": "List notification template versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/notificationTemplates/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              }
            ]
          },
          "docs": "Get a list of all the versions of a notification template identified by `Id`"
        },
        {
          "info": {
            "name": "Render notification template with mock data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/notificationTemplates/render",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generates mock ChangeEvent data for the specified resource and eventType, then renders the template. Returns the rendered subject and body for preview. Does not send to any destination. Requires any of: CREATE, EDIT_ALL, EDIT_USER_NOTIFICATION_TEMPLATE."
        },
        {
          "info": {
            "name": "Reset a notification template to its default state by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/notificationTemplates/name/:fqn/reset",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the notification template to reset"
              }
            ]
          },
          "docs": "Reset a SYSTEM notification template to its original default state from seed data. Only SYSTEM templates can be reset. This operation requires EDIT permissions."
        },
        {
          "info": {
            "name": "Reset a notification template to its default state by Id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/notificationTemplates/:id/reset",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the notification template"
              }
            ]
          },
          "docs": "Reset a SYSTEM notification template to its original default state from seed data. Only SYSTEM templates can be reset. This operation requires EDIT permissions."
        },
        {
          "info": {
            "name": "Restore a soft deleted notification template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/notificationTemplates/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted notification template."
        },
        {
          "info": {
            "name": "Validate and send notification template to external destinations",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/notificationTemplates/send",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Validates template syntax, generates mock ChangeEvent data, and sends to specified external destinations. Returns validation status only. Delivery errors are logged server-side. Only external destinations (Email, Slack, Teams, GChat, Webhook) are supported. Requires any of: CREATE, EDIT_ALL, EDIT_USER_NOTIFICATION_TEMPLATE."
        },
        {
          "info": {
            "name": "Validate notification template syntax",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/notificationTemplates/validate",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Validates only the Handlebars syntax of template subject and body without generating mock data or sending. Requires any of: CREATE, EDIT_ALL, EDIT_USER_NOTIFICATION_TEMPLATE."
        }
      ]
    }
  ],
  "bundled": true
}