{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Database Schemas API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Database Schemas",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get databaseSchema profile config",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/:id/databaseSchemaProfilerConfig",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the databaseSchema"
              }
            ]
          },
          "docs": "Get databaseSchema profile config to the table."
        },
        {
          "info": {
            "name": "Add databaseSchema profile config",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/:id/databaseSchemaProfilerConfig",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the databaseSchema"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add databaseSchema profile config to the table."
        },
        {
          "info": {
            "name": "Delete database profiler config",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/databaseSchemas/:id/databaseSchemaProfilerConfig",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the table"
              }
            ]
          },
          "docs": "delete database profile config to the database."
        },
        {
          "info": {
            "name": "Add a follower",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Database Schema"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user identified by `userId` as followed of this Database Schema"
        },
        {
          "info": {
            "name": "Bulk create or update databaseSchemas",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/bulk",
            "params": [
              {
                "name": "async",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update multiple databaseSchemas in a single operation. Returns a BulkOperationResult with success/failure details for each databaseSchema."
        },
        {
          "info": {
            "name": "List database schemas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "database",
                "value": "",
                "type": "query",
                "description": "Filter schemas by database name"
              },
              {
                "name": "databaseSchemaRegex",
                "value": "",
                "type": "query",
                "description": "Filter schemas by regex pattern applied to the schema `name` by default. To apply the regex to the fullyQualifiedName instead, set `regexFilterByFqn=true`. For better performance use in combination with the `database` query filter."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number schemas returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of schemas before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of schemas after this cursor"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Include all, deleted, or non-deleted entities."
              },
              {
                "name": "regexFilterByFqn",
                "value": "",
                "type": "query",
                "description": "When true, regex filters match against fullyQualifiedName instead of name. Default is false."
              },
              {
                "name": "regexMode",
                "value": "",
                "type": "query",
                "description": "Controls how regex filters are applied. 'include' returns matching entities, 'exclude' returns non-matching entities. Default is 'include'."
              }
            ]
          },
          "docs": "Get a list of database schemas, optionally filtered by `database` 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 schema",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/databaseSchemas",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a schema under an existing `service`."
        },
        {
          "info": {
            "name": "Create or update schema",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a database schema, if it does not exist or update an existing database schema."
        },
        {
          "info": {
            "name": "Get a schema by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the database schema"
              },
              {
                "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 database schema by fully qualified name."
        },
        {
          "info": {
            "name": "Update a database schema by name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/databaseSchemas/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Database schema name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing database schema using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a schema by fully qualified name",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/databaseSchemas/name/:fqn",
            "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": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the DBSchema"
              }
            ]
          },
          "docs": "Delete a schema by `fullyQualifiedName`. Schema can only be deleted if it has no tables."
        },
        {
          "info": {
            "name": "Get a schema by Id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Database schema Id"
              },
              {
                "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 database schema by `Id`."
        },
        {
          "info": {
            "name": "Update a database schema",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/databaseSchemas/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Database schema Id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing database schema using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a schema by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/databaseSchemas/: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": "Database schema Id"
              }
            ]
          },
          "docs": "Delete a schema by `Id`. Schema can only be deleted if it has no tables."
        },
        {
          "info": {
            "name": "Asynchronously delete a schema by Id",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/databaseSchemas/async/: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": "Database schema Id"
              }
            ]
          },
          "docs": "Asynchronously delete a schema by `Id`. Schema can only be deleted if it has no tables."
        },
        {
          "info": {
            "name": "Remove a follower",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/databaseSchemas/:id/followers/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Entity"
              },
              {
                "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 entity."
        },
        {
          "info": {
            "name": "Export database schema in CSV format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/name/:name/export",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Database schema"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "If true, export will include child entities (schemas, tables, columns)"
              }
            ]
          },
          "docs": "Export database schema in CSV format"
        },
        {
          "info": {
            "name": "Export database schema in CSV format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/name/:name/exportAsync",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Database schema"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "If true, export will include child entities (schemas, tables, columns)"
              }
            ]
          },
          "docs": "Export database schema in CSV format"
        },
        {
          "info": {
            "name": "Get a version of the schema",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Database schema Id"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Database schema version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the database schema by given `Id`"
        },
        {
          "info": {
            "name": "Import tables from CSV to update database schema (no creation allowed)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/name/:name/import",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Database schema"
              },
              {
                "name": "dryRun",
                "value": "",
                "type": "query",
                "description": "Dry-run when true is used for validating the CSV without really importing it. (default=true)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "If true, recursive import"
              }
            ]
          },
          "docs": "Import tables from CSV to update database schema (no creation allowed)"
        },
        {
          "info": {
            "name": "Import tables from CSV to update database schema asynchronously (no creation allowed)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/name/:name/importAsync",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "path",
                "description": "Name of the Database schema"
              },
              {
                "name": "dryRun",
                "value": "",
                "type": "query",
                "description": "Dry-run when true is used for validating the CSV without really importing it. (default=true)"
              },
              {
                "name": "recursive",
                "value": "",
                "type": "query",
                "description": "If true, recursive import"
              }
            ]
          },
          "docs": "Import tables from CSV to update database schema asynchronously (no creation allowed)"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/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 schema versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Database schema Id"
              }
            ]
          },
          "docs": "Get a list of all the versions of a schema identified by `Id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted database schema.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted database schema."
        },
        {
          "info": {
            "name": "Search Schema Entity Relationship",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/databaseSchemas/entityRelationship",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "query",
                "description": "fqn"
              },
              {
                "name": "query_filter",
                "value": "",
                "type": "query",
                "description": "Elasticsearch query that will be combined with the query_string query generator from the `query` argument"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Source Fields to Include"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Offset for pagination"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number of tables returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "From field to paginate the results, defaults to 0"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Size field to limit the no.of results returned, defaults to 1000"
              },
              {
                "name": "includeDeleted",
                "value": "",
                "type": "query",
                "description": "Filter documents by deleted param. By default deleted is false"
              }
            ]
          },
          "docs": "Search Schema Entity Relationship"
        },
        {
          "info": {
            "name": "Update Vote for a Entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/databaseSchemas/:id/vote",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Entity"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update vote for a Entity"
        }
      ]
    }
  ],
  "bundled": true
}