{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Directories API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Directories",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a follower",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user identified by `userId` as follower of this directory"
        },
        {
          "info": {
            "name": "Bulk create or update directories",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories/bulk",
            "params": [
              {
                "name": "async",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update multiple directories in a single operation."
        },
        {
          "info": {
            "name": "List directories",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter directories by service name"
              },
              {
                "name": "parent",
                "value": "",
                "type": "query",
                "description": "Filter directories by parent directory fully qualified name"
              },
              {
                "name": "root",
                "value": "",
                "type": "query",
                "description": "Include only root directories (directories without parent)"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number directories returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of directories before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of directories after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              }
            ]
          },
          "docs": "Get a list of directories, optionally filtered by `service` it belongs to. 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 directory",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/drives/directories",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new directory under an existing `service` or `parent` directory."
        },
        {
          "info": {
            "name": "Create or update a directory",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new directory, if it does not exist or update an existing directory."
        },
        {
          "info": {
            "name": "Get a directory by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the directory"
              },
              {
                "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 directory by fully qualified name."
        },
        {
          "info": {
            "name": "Update a directory by name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/drives/directories/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the directory"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing directory using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a directory by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/drives/directories/name/:fqn",
            "params": [
              {
                "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`)"
              },
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the directory"
              }
            ]
          },
          "docs": "Delete a directory by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Get a directory by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              },
              {
                "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 directory by `Id`."
        },
        {
          "info": {
            "name": "Update a directory",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/drives/directories/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing directory using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a directory by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/drives/directories/:id",
            "params": [
              {
                "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`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ]
          },
          "docs": "Delete a directory by `Id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a directory by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/drives/directories/async/:id",
            "params": [
              {
                "name": "hardDelete",
                "value": "",
                "type": "query",
                "description": "Hard delete the entity. (Default = `false`)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "Recursively delete related entities. (Default = `false`)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ]
          },
          "docs": "Asynchronously delete a directory by `Id`."
        },
        {
          "info": {
            "name": "Remove a follower",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/drives/directories/:id/followers/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              },
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "Id of the user being removed as follower"
              }
            ]
          },
          "docs": "Remove the user identified `userId` as a follower of the directory."
        },
        {
          "info": {
            "name": "Export directories to CSV",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/export",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Directory filter pattern"
              }
            ]
          },
          "docs": "Export directories to CSV file."
        },
        {
          "info": {
            "name": "Get a specific version of the directory",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Directory version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a specific version of the directory identified by `Id`"
        },
        {
          "info": {
            "name": "Import directory from CSV",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/drives/directories/import",
            "params": [
              {
                "name": "dryRun",
                "value": "",
                "type": "query",
                "description": "Dry run when true is passed for testing the CSV"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Import a CSV file generated by the export service endpoint."
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/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 directory versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/drives/directories/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ]
          },
          "docs": "Get a list of all the versions of a directory identified by `Id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted directory by id",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted directory by id."
        },
        {
          "info": {
            "name": "Restore a soft deleted directory",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories/:id/restore",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ]
          },
          "docs": "Restore a soft deleted directory."
        },
        {
          "info": {
            "name": "Update Vote for a directory",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/drives/directories/:id/vote",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the directory"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update vote for a directory"
        }
      ]
    }
  ],
  "bundled": true
}