{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Document Store API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Document Store",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of personas returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "Filter docs by entityType"
              },
              {
                "name": "fqnPrefix",
                "value": "",
                "type": "query",
                "description": "Filter docs by fqnPrefix"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of personas before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of personas after this cursor"
              }
            ]
          },
          "docs": "Get a list of Documents. Use `fields` parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using `limit` and `before` or `after` query params."
        },
        {
          "info": {
            "name": "Create a Document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/docStore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new Document."
        },
        {
          "info": {
            "name": "Update Document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/docStore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or Update a Document."
        },
        {
          "info": {
            "name": "Get a Document by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Document"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a Document by `name`."
        },
        {
          "info": {
            "name": "Delete a Document by name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/docStore/name/:name",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Document"
              }
            ]
          },
          "docs": "Delete a Document by given `name`."
        },
        {
          "info": {
            "name": "Get a Document by id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a Document by `id`."
        },
        {
          "info": {
            "name": "Update a Document.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/docStore/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Document with JsonPatch."
        },
        {
          "info": {
            "name": "Delete a Document by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/docStore/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              }
            ]
          },
          "docs": "Delete a Document by given `id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a Document by id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/docStore/async/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              }
            ]
          },
          "docs": "Asynchronously delete a Document by given `id`."
        },
        {
          "info": {
            "name": "Get a version of the Document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Document version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the Document by given `id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore/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 Document versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/docStore/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Document"
              }
            ]
          },
          "docs": "Get a list of all the versions of a Document identified by `id`"
        },
        {
          "info": {
            "name": "Update a Document by name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/docStore/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the Document"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing Document with JsonPatch."
        },
        {
          "info": {
            "name": "Reset seed data of EmailTemplate type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/docStore/resetEmailTemplate"
          },
          "docs": "Deletes seed data of the EmailTemplate type from the document store and reinitializes it from resources."
        },
        {
          "info": {
            "name": "Validate Email Template",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/docStore/validateTemplate/:templateName",
            "params": [
              {
                "name": "templateName",
                "value": "",
                "type": "path",
                "description": "Template name for the email template to be validated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Validates is the give content is a valid Email Template."
        }
      ]
    }
  ],
  "bundled": true
}