{
  "opencollection": "1.0.0",
  "info": {
    "name": "OpenMetadata APIs Agent Executions Queries API",
    "version": "1.13"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Queries",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Add a follower",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/:id/followers",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a user identified by `userId` as follower of this model"
        },
        {
          "info": {
            "name": "Add query usage",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/:id/usage",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add query usage"
        },
        {
          "info": {
            "name": "remove query used in",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/queries/:id/usage",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "remove Query Used in"
        },
        {
          "info": {
            "name": "Populate Used By Field",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/:id/usedBy",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add query users"
        },
        {
          "info": {
            "name": "Add query users",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/:id/users",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add query users"
        },
        {
          "info": {
            "name": "Bulk create or update queries",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/bulk",
            "params": [
              {
                "name": "async",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create or update multiple queries in a single operation. Returns a BulkOperationResult with success/failure details for each query."
        },
        {
          "info": {
            "name": "Get a list of Queries",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              },
              {
                "name": "entityId",
                "value": "",
                "type": "query",
                "description": "UUID of the entity for which to list the Queries"
              },
              {
                "name": "entityType",
                "value": "",
                "type": "query",
                "description": "Type of the entity specified by entityId (e.g., 'table', 'storedProcedure'). Required when entityId is provided for proper authorization."
              },
              {
                "name": "service",
                "value": "",
                "type": "query",
                "description": "Filter Queries by service Fully Qualified Name"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the number queries returned. (1 to 1000000, default = 10)"
              },
              {
                "name": "before",
                "value": "",
                "type": "query",
                "description": "Returns list of queries before this cursor"
              },
              {
                "name": "after",
                "value": "",
                "type": "query",
                "description": "Returns list of queries after this cursor"
              }
            ]
          },
          "docs": "Get a list of queries. 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. When filtering by `entityId`, also provide `entityType` to enable proper authorization based on the parent entity's permissions."
        },
        {
          "info": {
            "name": "Create a query",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/v1/queries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a query under an existing entity."
        },
        {
          "info": {
            "name": "Create or update a query",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a query, if it does not exist. If a query already exists, update the query."
        },
        {
          "info": {
            "name": "Get a query by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the query"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              }
            ]
          },
          "docs": "Get a query by fully qualified table name."
        },
        {
          "info": {
            "name": "Update a query using name.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/queries/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Name of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing query using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a query",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/queries/name/:fqn",
            "params": [
              {
                "name": "fqn",
                "value": "",
                "type": "path",
                "description": "Fully qualified name of the location"
              }
            ]
          },
          "docs": "Delete a query by `fullyQualifiedName`."
        },
        {
          "info": {
            "name": "Get a query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "query Id"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Fields requested in the returned resource"
              }
            ]
          },
          "docs": "Get a Query by `id`"
        },
        {
          "info": {
            "name": "Update a query",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/v1/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing query using JsonPatch."
        },
        {
          "info": {
            "name": "Delete a query",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/queries/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ]
          },
          "docs": "Delete a query by `id`."
        },
        {
          "info": {
            "name": "Asynchronously delete a query",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/queries/async/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the query"
              }
            ]
          },
          "docs": "Asynchronously delete a query by `id`."
        },
        {
          "info": {
            "name": "Remove a follower",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/v1/queries/:id/followers/:userId",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Id of the Query"
              },
              {
                "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 model."
        },
        {
          "info": {
            "name": "Get a specific version of the query",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries/:id/versions/:version",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Query Id"
              },
              {
                "name": "version",
                "value": "",
                "type": "path",
                "description": "Query version number in the form `major`.`minor`"
              }
            ]
          },
          "docs": "Get a version of the query by given `id`"
        },
        {
          "info": {
            "name": "List all entity versions within a time range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries/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": "Get List of all query versions",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/v1/queries/:id/versions",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "Query Id"
              }
            ]
          },
          "docs": "Get a list of all the versions of a query identified by `id`"
        },
        {
          "info": {
            "name": "Restore a soft deleted Query",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/restore",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Restore a soft deleted Query."
        },
        {
          "info": {
            "name": "Update Vote for a Entity",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/v1/queries/: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
}