openapi: 3.0.1
info:
  title: Query Service API
  description: |-
    Use the Adobe Experience Platform Query Service API to query Platform data with standard SQL. With this serverless tool, you can join any datasets in the [Experience Platform Data Lake](https://experienceleague.adobe.com/docs/experience-platform/landing/license/data-management-best-practices.html#understanding-adobe-experience-platform-data-storage) and capture the query results as a new dataset for use in reporting, Data Science Workspace, or for ingestion into Real-time Customer Profile.

    **Related Documentation**:
      * [Query Service documentation](http://www.adobe.com/go/query-service-home-en)

    **Visualize API calls with Postman (a free, third-party software)**:
      * [Query Service API Postman collection on GitHub](https://github.com/adobe/experience-platform-postman-samples/blob/master/apis/experience-platform/Query%20Service%20API.postman_collection.json)
      * [Video guide for creating the Postman environment](https://video.tv.adobe.com/v/28832)
      * [Steps for importing environments and collections in Postman](https://learning.getpostman.com/docs/postman/collection_runs/using_environments_in_collection_runs/)

    **API paths**:
      * PLATFORM Gateway URL: https://<span>platform.adobe.io/
      * Base path for this API: /data/foundation/query
      * Example of a complete path: https://<span>platform.adobe.io/data/foundation/query/queries

    **Required headers**:
      * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      * All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require the header `x-sandbox-name` whose value is the all-lowercase name of the sandbox the operation will take place in (for example, "prod"). See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.
      * All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include the header `Content-Type` with a value of `application/json`.

    **API error handling**:
      * Refer to the Experience Platform API troubleshooting guide for [FAQs](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#faq), [API status codes](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#api-status-codes), and [request header errors](https://experienceleague.adobe.com/docs/experience-platform/landing/troubleshooting.html?lang=en#request-header-errors).
      * Refer to the Query Service troubleshooting guide for [common query related FAQs](https://experienceleague.adobe.com/docs/experience-platform/query/troubleshooting-guide.html).
  version: "1.0"
servers:
- url: //{environment}.adobe.io/data/foundation/query
  variables:
    environment:
      default: platform
      enum: 
        - platform
        - platform-stage
tags:
- name: (NEW) Interactive API documentation
  description: You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your [authentication credentials](https://www.adobe.com/go/platform-api-get-credentials-en) and use the **Try it** functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.
- name: Queries
  description: The queries endpoint uses standard SQL to query data held in Adobe Experience Platform. For example, you can join any number of datasets in the data lake and capture the results as a new dataset.
- name: Connections
  description: The connections endpoint retrieves connection parameters for the interactive interface.
- name: Schedules
  description: Schedules let you perform SQL functions on a regular cadence from a start date to an end date or set a maximum number of runs.
- name: Alert Subscriptions
  description: Alert subscriptions allow you to receive notifications on the different statuses of both ad hoc and scheduled queries. Alerts can be received by email, within the Platform UI, or both.
- name: Query Templates
  description: Query templates let you create, store, and execute any query as an ad hoc or scheduled service.
- name: Accelerated Queries
  description: Query the accelerated store in a stateless manner to quickly return results based on aggregated data.
paths:
  /connection_parameters:
    get:
      tags:
      - Connections
      summary: List connection parameters
      description: This request lists the connection parameters used for the interactive interface.
      operationId: listConnectionParameters
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Connection Parameters Response for interactive interface
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_parameters'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /queries:
    get:
      tags:
      - Queries
      summary: List queries
      operationId: listQueries
      description: This request provides a list of queries for your organization.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: orderby
        in: query
        description: 'The field that specifies the order of results. The supported fields are `created` and `updated`. Prepend the property name with `+` for ascending and `-` for descending order. The default is `-created`. Note that the plus sign (`+`) has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending created order.'
        schema:
          type: string
      - name: limit
        in: query
        description: Restrict the maximum number of records that should be returned for a given request.
        schema:
          type: integer
      - name: start
        in: query
        description: The timestamp used with `orderby` to order the returned results.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. The examples below are given with unsafe
          HTML characters for clarity, but all content MUST be HTML escaped.\n\n\

          The following list of properties allow filtering with all operators: `created`,
          `updated`, `state`, `id`.\n\n\
          
          The following is a list of supported operators: `>` (greater than)
          `<` (less than), `>=` (greater than or equal to), `<=` (less than or equal to)
          `==` (equal to), `!=` (not equal to), `~` (contains)\n\n\

          Examples with filters that support all operators:\n 
          * Get query with a match on id:\n 
          `id==6ebd9c2d-494d-425a-aa91-24033f3abeec`\n 
          * Get queries created after a given timestamp, and with a specific state:\n 
          `created>=2017-04-05T13:30:00Z,state==IN_PROGRESS`\n
          Filtering is also allowed with limited operators on the following properties:\n
          * The `referenced_datasets` and `userId` property. This filter only allows
          the `==` equal to operator, and up to 10 dataset IDs can be included by
          using the `||` logical OR operator. \n 
          Example: `referenced_datasets==aabbcc||ddeeff`\n
          * The SQL property. This filter only allows the contains operator (`~`),
          and only one SQL string WITHOUT a comma (`,`) can be included.\n 
          Example: `sql~SELECT c1`\n 
          * the `templateId` property: This filter only allows the
          equal to operator (`==`), and only one template ID can be included.\n
          Example: `templateId=3e61c592-05de-422e-99be-24712c07fc29`\n
          * the `templateName` property: This filter only allows the contains operator (`~`),
          and only one templateName can be included.\n
          Example: `templateName~sample-template-name` \n
          * The `client` property. This filter only allows the `==` equal to operator, and
          only one SQL string WITHOUT a comma (`,`) can be included.\n
          Example: `client==API`\n
          * The `scheduleId` and `scheduleRunId` properties. These filters only allow
          the `==` equal to operator.\n
          Example: `scheduleId==bWFudWFsX18yMDE4LTEwLTEyVDA0OjM2OjE5LjkzNzI2Nw==,scheduleRunId==manual__2018-10-12T05:11:40.816520`\n
          Example of a complex search with multiple filters:\n 
          * Get me queries that utilize two specific datasets, submitted by a particular user, and
          that include the string `SELECT c1` in the SQL body: `referenced_datasets==aabbcc||ddeeff,userId=1234@AdobeId,sql~SELECTc1`"
        schema:
          type: string
      - name: excludeSoftDeleted
        in: query
        description: Whether to include any queries that have been soft deleted. Defaults
          to true. Soft-deleting stops the query from being returned on GET requests to 
          the `/queries` endpoint but does not delete it from the system.
        schema:
          type: boolean
      - name: excludeHidden
        in: query
        description: Whether to include any low-level queries issued as part of the Postgres protocol that were not user driven. Examples include CURSOR definitions,
          FETCH, and Metadata queries. `true` is the default value.
        schema:
          type: boolean
      - name: isPrevLink
        in: query
        description: >-
          `isPrevLink` is used in pagination. Results are sorted using the `created` timestamp and the `orderby` property. 
          When navigating pages of results, `isPrevLink` is set to true when paging backwards. It reverses the order of the query. See "next" and "prev" links as examples.
        schema:
          type: boolean
      responses:
        200:
          x-summary: "Success"
          description: Query List Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_list'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    post:
      tags:
      - Queries
      summary: Create a query
      operationId: createQuery
      description: This request creates a new query configured by the values provided in the payload. The query required in the request body can be either an SQL statement or a template ID.
      parameters:
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: Content-Type
        in: header
        description: The type of content being sent in the body of the request. The value should be 'application/json'.
        required: true
        schema:
          type: string
      requestBody:
        description: The request body for creating a query.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_def'
        required: true
      responses:
        202:
          x-summary: "Query status"
          description: Query status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query'
        400:
          x-summary: "Bad request"
          description: Bad Request. The payload may be malformed, or the SQL statement has been found to be syntactically incorrect.
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: query
  /queries/{queryid}:
    get:
      tags:
      - Queries
      summary: Retrieve a query
      operationId: retrieveQuery
      description: This endpoint provides the query information that relates to the query ID provided in the request.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: queryid
        in: path
        description: The query ID for the resource that you want to retrieve.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Query status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Query not found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    patch:
      tags:
      - Queries
      summary: Request cancellation or query soft delete
      operationId: cancelQuery
      description: This request cancels the execution of the query that relates to the query ID provided in the request.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: queryid
        in: path
        description: Query ID
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: The type of content being sent in the body of the request. The value should be 'application/json'.
        required: true
        schema:
          type: string
      requestBody:
        description: Use JSON Patch formatting to cancel or soft delete a query.
        content:
          application/json:
            schema:
              type: object
              properties:
                op:
                  type: string
                  enum:
                  - cancel
                  - soft_delete
                  description: The type of operation to perform on the resource.
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Query termination request submitted successfully
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        409:
          x-summary: "Failed"
          description: Query termination request failed because the job might already have terminated
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: operation
  /schedules:
    get:
      tags:
      - Schedules
      summary: List schedules
      operationId: listSchedules
      description: This request provides a list of all query schedules for your organization.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: orderby
        in: query
        description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
        schema:
          type: string
      - name: limit
        in: query
        description: Restrict the maximum number of records that should be returned for a given request.
        schema:
          type: integer
      - name: start
        in: query
        description: The timestamp used with `orderby` to order the returned results.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed.\n\n 
          Properties that allow filtering with all operators:\n 
          `created`\n\n 
          The list of supported operators:\n\n
          `>`  (greater than)\n
          `<`  (less than)\n\n
          Examples with filters that support all operators:\n
          * Get me schedules created after a timestamp:\n
          `created>2017-04-05T13:30:00Z`\n\n
          Filtering is also allowed with limited operators on the following properties:\n
          * The `templateId` property. This filter only allows the `==` equal to operator.\n
          Example: `templateId==123412354`\n
          * The `userId` property. This filter only allows the `==` equal to operator.\n
          Example: `userId==123412354`"
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Schedules List Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules_list'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    post:
      tags:
      - Schedules
      summary: Create a scheduled query
      operationId: createSchedule
      description: This request creates a new schedule for the query provided in the request payload. 
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      requestBody:
        description: The request body for creating a schedule.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schedules_create_request'
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Schedules Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules'
        400:
          x-summary: "Bad request"
          description: Bad Request. The payload may be malformed, or the SQL statement has been found to be syntactically incorrect.
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: schedule
  /schedules/{schedulesId}:
    get:
      tags:
      - Schedules
      summary: Retrieve a schedule
      operationId: retrieveSchedule
      description: This request lists the details for the schedule ID provided
        in the request path. It returns schedule information that includes the state, creation date, 
        and updated date of the scheduled query, as well as the cadence and user ID who created the schedule.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: The ID of the schedule you want to retrieve run information for.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Schedules Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Query not found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    delete:
      tags:
      - Schedules
      summary: Delete a schedule
      operationId: deleteSchedule
      description: This request deletes the query schedule for the schedule ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: The ID for the schedule you want to delete.
        required: true
        schema:
          type: string
      responses:
        202:
          x-summary: "Success"
          description: Schedule deleted successfully
          content: {}
        400:
          x-summary: "Request failed"
          description: Please disable the schedule before requesting delete operation OR There are active run(s) for this schedule, please wait for completion before requesting delete operation
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    patch:
      tags:
      - Schedules
      summary: Update a schedule
      operationId: updateSchedule
      description: This request updates the details of the schedule for the schedule ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: The ID for the schedule you want to update.
        required: true
        schema:
          type: string
      requestBody:
        description: Use JSON Patch formatting to update the schedule.
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: array
                  items:
                    $ref: '#/components/schemas/schedule_patch_operation'
                  description: The payload necessary to update the query schedule.
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Request to patch accepted
          content: {}
        400:
          x-summary: "Request failed"
          description: Schedule already in the state request OR Schedule is in Inactive state. Please try after sometime.
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: body
  /schedules/{schedulesId}/runs:
    get:
      tags:
      - Schedules
      summary: List all runs for a schedule
      operationId: listScheduleRuns
      description: This request lists the run details for the schedule ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: orderby
        in: query
        description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
        schema:
          type: string
      - name: limit
        in: query
        description: Restrict the maximum number of records that should be returned for a given request.
        schema:
          type: integer
      - name: start
        in: query
        description: The timestamp used with `orderby` to order the returned results.
        schema:
          type: string
      - name: property
        in: query
        description: |-
          Comma-separated filters. Multiple filters separated by commas can be passed. Examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.

           Properties that allow filtering :
           created
           Supported operators:
           '>'  (greater than)
           '<'  (less than)
           state
           Supported operators:
           '==' (equal to)
           '!=' (not equal to)
           externalTrigger
           List of supported operators:
           '==' (equal to)

           Examples with filters that support all operators:
           * Get me  runs created after a timestamp:
           created>2017-04-05T13:30:00Z
           * Get me  runs that have failed: state==FAILED * Get me runs that were manually triggered, and that succeeded: externalTrigger==true,state==SUCCESS
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: The ID for the schedule who's run you want to list.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: A list of schedule run information is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules_run_list'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    post:
      tags:
      - Schedules
      summary: Trigger an immediate run of a scheduled query
      operationId: triggerScheduleRun
      description: This request triggers an immediate run for the schedule ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: Schedule ID
        required: true
        schema:
          type: string
      responses:
        202:
          x-summary: "Success"
          description: Request to trigger run of a scheduled query accepted
          content: {}
        400:
          x-x-summary: "Request failed"
          description: Schedule is disabled. Immediate run cannot be triggered
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /schedules/{schedulesId}/runs/{runId}:
    get:
      tags:
      - Schedules
      summary: Retrieve details of a query schedule run
      operationId: retrieveScheduledQueryRun
      description: This request provides details about a specific run for a specific scheduled query. Both the schedule ID and the run ID must be provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: Schedule ID
        required: true
        schema:
          type: string
      - name: runId
        in: path
        description: Run ID
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Details of a specific scheduled run is returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schedules_run_details'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    patch:
      tags:
      - Schedules
      summary: Cancel a run of a scheduled query
      operationId: cancelScheduledQueryRun
      description: This request cancels a specific run for a specific scheduled query. Both the schedule ID and the run ID must be provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: schedulesId
        in: path
        description: Schedule ID
        required: true
        schema:
          type: string
      - name: runId
        in: path
        description: Run ID
        required: true
        schema:
          type: string
      requestBody:
        description: Use JSON PATCH formatting to cancel a scheduled query run.
        content:
          application/json:
            schema:
              type: object
              properties:
                op:
                  type: string
                  required:
                    - op
                  enum:
                  - cancel
                  example: cancel
                  description: The payload to cancel a scheduled query run.
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Request to cancel run of a scheduled query accepted
          content: {}
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: operation
  /query-templates:
    get:
      tags:
      - Query Templates
      summary: List query templates
      operationId: listQueryTemplates
      description: This request provides a list of every query template.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: isPrevLink
        in: query
        description: >-
          `isPrevLink` is part of pagination. Results are sorted using the `created` timestamp and the `orderby` property. 
          When navigating pages of results, `isPrevLink` is set to true when paging backwards. It reverses the order of the query. See "next" and "prev" links as examples.
        schema:
          type: boolean
      - name: orderby
        in: query
        description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
        schema:
          type: string
      - name: limit
        in: query
        description: Restrict the maximum number of records that should be returned for a given request.
        schema:
          type: integer
      - name: start
        in: query
        description: The timestamp used with `orderby` to order the returned results.
        schema:
          type: string
      - name: property
        in: query
        description: >- 
          Comma-separated filters. Multiple filters separated by commas can be passed.
          
            List of properties that allow filtering: `name`, `userId`, `lastUpdatedBy`.
          
            * The `name` property can only be filtered with the `~` (contains) operator.
            Only one name string WITHOUT a comma can be included. For example, `property=name~maria`.
          
            * The `userId` and the `lastUpdatedBy` properties can be used with the `==` (equal to) operator.
            Only one name string WITHOUT a comma can be included. For example, `property=userId==49D005796000B4B20A495J85@acme.adobe.com`
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_template_list'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    post:
      tags:
      - Query Templates
      summary: Create a query template
      operationId: createQueryTemplate
      description: This request creates a query template.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      requestBody:
        description: The query template to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_template_def'
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_template'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: queryTemplate
  /query-templates/count:
    get:
      tags:
      - Query Templates
      summary: Retrieve the count of query templates
      operationId: retrieveQueryTemplateCount
      description: This request retrieves the count of query templates.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. Examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n  Currently only `userId` is allowed in filtering count.\nExample: `property=userId=={USER_ID}`"
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/template_count'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /query-templates/{queryTemplateId}:
    get:
      tags:
      - Query Templates
      summary: Retrieve a query template
      operationId: retrieveQueryTemplate
      description: This request retrieves the query template for the template ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: queryTemplateId
        in: path
        description: The query template ID for the query template to be retrieved.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_template'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    put:
      tags:
      - Query Templates
      summary: Update a query template
      operationId: updateQueryTemplate
      description: This request updates the query template for the template ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: queryTemplateId
        in: path
        description: The query template ID for the template to be updated. 
        required: true
        schema:
          type: string
      requestBody:
        description: Query template to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_template_def'
        required: true
      responses:
        202:
          x-summary: "Success"
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_template'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: queryTemplate
    delete:
      tags:
      - Query Templates
      summary: Delete a query template
      operationId: deleteQueryTemplate
      description: This request deletes the query template for the template ID provided in the request path.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: queryTemplateId
        in: path
        description: The query template ID for the template to be deleted.
        required: true
        schema:
          type: string
      responses:
        202:
          x-summary: "Success"
          description: Query Template Delete
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/query_template_delete'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /alert-subscriptions:
    get:
      tags:
      - Alert Subscriptions
      summary: List alerts
      description: This request provides a list of alerts.
      operationId: listAlertsPerImsOrgAndSandbox
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: orderby
        in: query
        description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
        schema:
          type: string
      - name: pagesize
        in: query
        description: Control the number of records you want to fetch from the API call per page. The default limit is set to the maximum amount of 50 records per page.
        schema:
          type: integer
      - name: page
        in: query
        description: Indicate the page number of the returned results that you want to see the records for.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. The examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n 
          The properties that allow filtering:\n 
          * `id`\n
          * `assetId`\n
          * `status`\n
          * `alertType`\n\n 
          The list of supported operators:\n\n
          `==` (equal to)\n\n
          Examples with filters that support the (`==`)operator:\n
          * Get me the alert with a match on the `id`:\n
          `id==query_flow_run_start-599442e0-433a-4708-85fc-e226e8092096`\n
          * Get me alerts with a match on the `assetId`:\n
          `assetId==700d43d9-3b99-4d4c-8dbb-29c911c0e0df`\n
          * Get me alerts with a match on the `status`:\n
          `status==enabled`\n
          * Get me alerts with a match on the `alertType`:\n
          `alertType==success`\n 
          An example of a complex search with multiple filters:\n
          * Get me alerts that utilize multiple filters:\n
          `body: status==enabled,alertType==failure`"
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: A list of alerts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alerts_per_imsorg_and_sandbox'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
    post:
      tags:
      - Alert Subscriptions
      summary: Create an alert and subscribe users
      description: This request associates a query to a newly created alert using
        an `assetId` property, and subscribes users to alerts for that query through
        the use of `emailIds`.
      operationId: createAndSubscribeToAnAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-service-token
        in: header
        description: An optional key used to authenticate access.
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      requestBody:
        description: Create an alert for a particular query or schedule ID and subscribe
          `emailId`s to different notification channels.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscribe_user_to_alert_body'
        required: true
      responses:
        200:
          x-summary: "Success"
          description: The subscription to an alert was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_subscription_response_body'
        400:
          x-summary: "Request failed"
          description: Bad Request. The payload may be malformed, the alert might be in a disabled state, or an `emailID` provided for subscribing to the alert might not be a registered Adobe ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/post_bad_request_error_message'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not found. The request cannot be processed because the asset ID provided is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/post_not_found_error_message'
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: alert subscription
  /alert-subscriptions/{assetId}:
    get:
      tags:
      - Alert Subscriptions
      summary: List alert subscription information for a query or schedule
      description: This request lists the alerts for the query ID or schedule ID provided
        in the request path. It returns subscription information that includes a list
        of all subscribed users by providing their email IDs and their chosen notification
        channels.
      operationId: listSubscribersForAnAlertByAssetsId
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query or schedule ID that you want the subscription information
          for.
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Information on the alerts subscribed to by a particular query ID or schedule ID. A maximum of 3 alerts are available in a single response. 1 alert for each `alertType` is contained in the response body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscribers_for_alert_by_assetId'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: There is no alert associated with the provided `assetId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_error_message'
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /alert-subscriptions/{assetId}/{alertType}:
    get:
      tags:
      - Alert Subscriptions
      summary: List alert subscription information for a particular query and alert
        type
      description: This request lists the alerts and alert subscription information
        for the query ID and alert type provided in the request path.
      operationId: listSubscribersForAnAlertByAssetIdAndAlertType
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query or schedule ID that you want the subscription information
          for.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: This property describes the state of query execution that triggers
          an alert. The response will only include alert subscription information
          for alerts of this type. The alert type is one of three values (`start`,
          `success`, `failure`).
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: A successful response returns the user email IDs and notification channels for a particular query and alert type.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subscribers_for_alert_by_assetId_and_alertType'
        400:
          x-summary: "Request failed"
          description: Bad Request. An invalid `alertType` was provided in the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_and_alert_type_bad_request_error_message'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          description: No alert was found for the given `assetId`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alert_subscription_for_asset_id_and_alert_type_not_found_error_message'
        500:
          description: Internal Server Error.
          content: {}
    delete:
      tags:
      - Alert Subscriptions
      summary: Delete the alert for a particular query and alert type
      description: Delete a specific alert by providing either an alert type and a
        query ID or an alert type and a schedule ID in the request path.
      operationId: deleteAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query ID or a schedule ID that you want to delete the alert
          for.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: The state of query execution that triggers the alert to be deleted.
          The alert type is one of three values (`start`, `success`, `failure`).
        required: true
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Alert deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted'
        400:
          x-summary: "Request failed"
          description: Bad Request. An invalid `alertType` was provided in the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted_bad_request_error_message'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          description: No alert was found for the given `assetId` and `alertType`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_deleted_not_found_error_message'
        500:
          description: Internal Server Error.
          content: {}
    patch:
      tags:
      - Alert Subscriptions
      summary: Enable or disable an alert
      description: Update the status of an alert to either `enable` or `disable` by
        providing a query or schedule ID and an alert type in the request path.
      operationId: patchAlert
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: assetId
        in: path
        description: A query ID or a schedule ID for the resource that you want to update.
        required: true
        schema:
          type: string
      - name: alertType
        in: path
        description: This property determines the state of query execution that triggers
          a user to receive an alert. The alert type is one of three values (`start`,
          `success`, `failure`).
        required: true
        schema:
          type: string
      requestBody:
        description: Use JSON PATCH formatting to enable or disable an alert.
        content:
          application/json:
            schema:
              type: object
              properties:
                op:
                  type: string
                  description: The operation to be performed. The only accepted value
                    is `replace`. It replaces the current alert's status with the
                    value provided in the request.
                  enum:
                  - replace
                path:
                  type: string
                  description: The path must be `/status` to ensure the alert `status`
                    is updated.
                  enum:
                  - /status
                value:
                  type: string
                  description: The provided value will be the status of the alert
                    after the update takes effect.
                  enum:
                  - enable
                  - disable
        required: true
      responses:
        200:
          x-summary: "Success"
          description: The alert status has been updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched'
        400:
          x-summary: "Request failed"
          description: Bad Request. The payload may be malformed, or an invalid `alertType` may have been provided in URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched_bad_request_error_message'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          description: No alert found for the `assetId` and `alertType` provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert_patched_not_found_error_message'
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: operation
  /alert-subscriptions/user-subscriptions/{emailID}:
    get:
      tags:
      - Alert Subscriptions
      summary: List information on all alerts that a user is subscribed to
      description: This request lists the alerts subscribed to by the email ID provided
        in the request path. The returned information includes the alert name, IDs,
        status, alert type, and notification channels.
      operationId: listAllAlertsSubscribedToByEmailId
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform
          integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
          For more information on how to obtain this value, visit the documentation
          covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: emailID
        in: path
        description: An Adobe-registered email address whose alert subscriptions you
          want to retrieve.
        required: true
        schema:
          type: string
      - name: orderby
        in: query
        description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
        schema:
          type: string
      - name: pagesize
        in: query
        description: Control the number of records you want to fetch from the API call per page. The default limit is set to the maximum amount of 50 records per page.
        schema:
          type: integer
      - name: page
        in: query
        description: Indicate the page number of the returned results that you want to see the records for.
        schema:
          type: string
      - name: property
        in: query
        description: "Comma-separated filters. Multiple filters separated by commas can be passed. The examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n 
          The properties that allow filtering:\n 
          * `id`\n
          * `assetId`\n
          * `status`\n
          * `alertType`\n\n 
          The list of supported operators:\n\n
          ‘==` (equal to)\n\n
          Examples with filters that support the (`==`)operator:\n
          * Get me the alert with a match on the `id`:\n
          `id==query_flow_run_start-599442e0-433a-4708-85fc-e226e8092096`\n
          * Get me alerts with a match on the `assetId`:\n
          `assetId==700d43d9-3b99-4d4c-8dbb-29c911c0e0df`\n
          * Get me alerts with a match on the `status`:\n
          `status==enabled`\n
          * Get me alerts with a match on the `alertType`:\n
          `alertType==success`\n 
          An example of a complex search with multiple filters:\n
          * Get me alerts that utilize multiple filters:\n
          `body: status==enabled,alertType==failure`"
        schema:
          type: string
      responses:
        200:
          x-summary: "Success"
          description: Details of all alerts subscribed to by the `emailId` provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alerts_to_which_user_subscribed_response'
        400:
          x-summary: "Request failed"
          description: Bad Request. The emailID is not an Adobe registered ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_alerts_to_which_user_subscribed_bad_request_error_message'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
  /accelerated-queries:
    post:
      tags:
      - Accelerated Queries
      summary: Query the accelerated store
      operationId: runAcceleratedQuery
      description: Run a query on accelerated store datasets by including either an SQL statement or a template ID within the request payload.
      parameters:
      - name: Authorization
        in: header
        description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`). For more information on how to obtain this value, visit the documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-gw-ims-org-id
        in: header
        description: The Organization ID which can be copied from your Experience
          Platform integration. For more information on how to obtain this value,
          visit the documentation covering making API calls in the [authentication
          tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-api-key
        in: header
        description: The API key which can be copied from your Experience Platform
          integration. For more information on how to obtain this value, visit the
          documentation covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
        required: true
        schema:
          type: string
      - name: x-sandbox-name
        in: header
        description: The name of the sandbox in which the operation will take place.
          See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        description: The type of content being sent in the body of the request. The value should be 'application/json'.
        required: true
        schema:
          type: string
      - name: x-sandbox-id
        in: header
        description: The unique identifier of the sandbox in which the operation will
          take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
          for more information.
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that serves as a tracking ID for the request.
          If one is not provided on the request, the server generates one automatically.
        schema:
          type: string
      - name: User-Agent
        in: header
        description: The type of the client making the HTTP request.
        schema:
          type: string
      - name: Accept-Encoding
        in: header
        description: This request header indicates the type of content encoding that the client can understand when consuming compressed response bodies. It is usually a compression algorithm. Accepted values include `gzip` and `identity`.
        schema:
          type: string
      requestBody:
        description: The request body to run a query on the accelerated store. The request accepts either a query string as `sql` or the ID of a saved query as `templateId`.
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/SqlAcceleratedQueryDefinition'
                - $ref: '#/components/schemas/TemplateIdAcceleratedQueryDef'
            examples:
              SQL accelerated query:
                $ref: '#/components/examples/SqlAcceleratedQueryDefinition'
              Template ID accelerated query:
                $ref: '#/components/examples/TemplateIdAcceleratedQueryDefinition'
      responses:
        200:
          x-summary: "Success"
          description: Query Response
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/accelerated_query_response'
                  - $ref: '#/components/schemas/TemplateIdAcceleratedQueryResponse'
              examples:
                  SQL accelerated query response:
                    $ref: '#/components/examples/SqlAcceleratedQueryResponse'
                  Template ID accelerated query response:
                    $ref: '#/components/examples/TemplateIdAcceleratedQueryResponse'
                      
          # content:
          #   application/json:
          #     schema:
          #       $ref: '#/components/schemas/AudiencesList'
          #     examples:
          #       No metrics:
          #         $ref: '#/components/examples/AudiencesListNoMetrics'
          #       With metrics:
          #         $ref: '#/components/examples/AudiencesListWithMetrics'
              # schema: 
              #   $ref: '#/components/schemas/accelerated_query_response'
        401:
          x-summary: "Unauthorized"
          description: Unauthorized
          content: {}
        404:
          x-summary: "Not found"
          description: Not Found
          content: {}
        "500":
          x-summary: "Internal server error"
          description: "There was an internal server error. Try the request again in a few minutes, and contact Adobe Support if the problem persists."
          content: {}
      x-codegen-request-body-name: accelerated-query-body
components:
  schemas:
    query_def:
      type: object
      properties:
        dbName:
          type: string
          description: The name of the database you are making the query to. The value for `dbName` should take the format of `{SANDBOX}:{DATABASE}.{SCHEMA}`.
          example: acmesbox1:acmeacceldb:accmeaggschema
        sql:
          type: string
          description: The SQL query statement. You can either use standard SQL (such as `SELECT * FROM t1;`) or include parameter replacements. To use a parameter replacement in the SQL you must prepend the parameter key with a `$`. For example, `$key`,
            and provide the parameters used in the SQL as JSON key value pairs in the `queryParameters` field.
            The values passed here will be the default parameters used in the template.
            If you want to override these parameters, you must override them in the POST request.
          example: SELECT $key FROM $key1 WHERE $key > $key2;
        queryParameters:
          type: object
          properties:
            key:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value
            key1:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value1
            key2:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value2
          description: A key value pairing to replace values in the SQL statement. These are required if you are using parameter replacements. No value type checking will be done on these key value pairs.
        templateId:
          type: string
          description: The unique identifier for the query created and saved using a POST request to the `/query-templates` endpoint.
          example: "0094d000-9062-4e6a-8fdb-05606805f08f"
        name:
          type: string
          description: An optional human friendly name for the query.
          example: Sample Query Template for ACME Data
        description:
          type: string
          description: An optional comment on the intended purpose of the query.
          example: This query returns all account details.
        insertIntoParameters:
          type: object
          properties:
            datasetName:
              type: string
              description: The name of the dataset used in the query.
              example: Acme - Product Dataset
          description: If this property is defined, then this query will be converted
            into an `INSERT INTO` query. Optional.
          example: sampling_test_geometrix_sitesection_copy
        ctasParameters:
          type: object
          properties:
            datasetName:
              type: string
              description: The name of the dataset to created as part of the CTAS statement.
              example: sampling_test_geometrix_sitesection_copy
            description:
              type: string
              description: A description for the new dataset. Optional.
              example: Sampling of geometrix dataset.
            targetSchemaTitle:
              type: string
              description: The schema name for the new dataset.
              example: Schema for sampling_test_geometrix_sitesection_copy
          description: If this property is defined, this query will be converted into a CTAS query. Optional.
      description: The POST request payload sent to the `/queries` endpoint.
    SqlAcceleratedQueryDefinition:
      type: object
      required:
      - dbName
      - sql
      properties:
        dbName:
          type: string
          description: The name of the database you are making an accelerated query to. The value for `dbName` should take the format of `{SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}`. The database provided must exist within the accelerated store or the request will result in an error. You must ensure that the `x-sandbox-name` header and sandbox name in `dbName` refer to same sandbox.'
          example: acmesbox1:acmeacceldb:accmeaggschema
        sql:
          type: string
          description: An SQL statement string to be submitted to the query accelerated
            store. The maximum size allowed is 1000000 bytes. Accelerated queries
            require EITHER an SQL statement OR a template ID, but not both. Submitting
            both in a request causes an error.
          example: SELECT * FROM accounts;
        name:
          type: string
          description: An optional human-friendly, descriptive name for the accelerated query. 
          example: Second Accelerated Query Sample
        description:
          type: string
          description: An optional comment on the intent of the query to help other
            users understand its purpose. The maximum size allowed is 1000 bytes.
          example: Another sample of an accelerated query.
      description: The query definition submitted to the query accelerated store.
    TemplateIdAcceleratedQueryDef:      
      type: object
      required:
      - dbName
      - templateId
      properties:
        dbName:
          type: string
          description: The name of the database you are making an accelerated query to. The value for `dbName` should take the format of `{SANDBOX_NAME}:{ACCELERATED_STORE_DATABASE}.{ACCELERATED_STORE_SCHEMA}`. The database provided must exist within the accelerated store or the request will result in an error. You must ensure that the `x-sandbox-name` header and sandbox name in `dbName` refer to same sandbox.
          example: acmesbox1:acmeacceldb:accmeaggschema
        templateId:
          type: string
          description: The ID of a query created when a POST request is made to the
            `/templates` endpoint. The corresponding query is submitted to the query
            accelerated store. Accelerated queries require EITHER an SQL statement
            OR a template ID, but not both. Submitting both in a request causes an
            error.
          example: f7cb5155-29da-4b95-8131-8c5deadfbe7f
        name:
          type: string
          description: An optional human-friendly, descriptive name for the accelerated query.
          example: Second Accelerated Query Sample
        description:
          type: string
          description: An optional comment on the intent of the query to help other
            users understand its purpose. The maximum size allowed is 1000 bytes.
          example: Another sample of an accelerated query.
      description: The query definition submitted to the query accelerated store.
    metadata_schema_ref:
      type: object
      properties:
        _adhoc:
          type: object
          properties:
            type:
              type: string
              description: The data type of the `_adhoc` object.
            meta:xdmType:
              type: string
              description: This is a system-generated value for the XDM field type.
                For more information on the available types see the documentation
                on available [XDM types](https://experienceleague.adobe.com/docs/experience-platform/xdm/tutorials/custom-fields-api.html).
            properties:
              type: object
              properties: {}
              description: These are the column names of the queried dataset.
              example:
                Industry_name:
                  type: string
                  meta:xdmType: string
                  default: null
                Industry_code:
                  type: integer
                  meta:xdmType: int,
                  maximum: 2147483647
                  minimum: -2147483648
                Value:
                  type: number
                  meta:xdmType: number
                  maximum: null,
                  minimum: null
                Active_customer:
                  type: boolean
                  meta:xdmType: boolean
          description: The schema of the ad hoc object created. An ad-hoc Experience
            Data Model (XDM) schema with fields that are namespaced for usage only
            by a single dataset.
      description: This object contains the metadata for each column returned in the
        response. It includes the name and type of each column.
    accelerated_query_response:
      type: object
      properties:
        queryId:
          type: string
          description: The unique identifier for the query.
          example: ba7aa60c-f5ab-47de-b980-c30789108efe
        resultsMeta:
          $ref: '#/components/schemas/metadata_schema_ref'
        results:
          type: array
          description: The results of the query in JSON format.
          items:
            $ref: '#/components/schemas/results_each_row_schema_ref'
        request:
          $ref: '#/components/examples/SqlAcceleratedQueryDefinition'
      description: The response body for the accelerated query.
    TemplateIdAcceleratedQueryResponse:
      type: object
      properties:
        queryId:
          type: string
          description: The unique identifier for the query.
          example: ba7aa60c-f5ab-47de-b980-c30789108efe
        resultsMeta:
          $ref: '#/components/schemas/metadata_schema_ref'
        results:
          type: array
          description: The results of the query in JSON format.
          items:
            $ref: '#/components/schemas/results_each_row_schema_ref'
        request:
          $ref: '#/components/examples/TemplateIdAcceleratedQueryDefinition'
      description: The response body for the accelerated query.
    results_each_row_schema_ref:
      type: object
      description: An object that represents a single row of the result set.
      example:
        Industry_name: Acme
        Industry_code: 23
        Value: 93141
        column_name_boolean_type: true
    query:
      type: object
      description: A list of queries and their associated information.
      properties:
        id:
          type: string
          description: The unique identifier for the query.
          example: 0094d000-8062-4e6a-6fdb-05606704f08f
        request:
          $ref: '#/components/schemas/query_def'
        effectiveSQL:
          type: string
          description: If the query is modified from the original, as in the case of a conversion to a CTAS statement using `ctasParameters`, this property will be reflected with the actual issued SQL.
          example: "SELECT SUM(test_segment.count_of_profiles) COUNT FROM acmesbox1.profile_agg.test_segment LEFT OUTER JOIN acmesbox1.profile_agg.adwh_dim_segments ON test_segment.segment_id = adwh_dim_segments.segment_id WHERE test_segment.segment_id = 67176434 and test_segment.merge_policy_id = 1914981602 and test_segment.date_key = '2022-11-09';"
        isCTAS:
          type: boolean
          description: This confirms whether the original SQL statement matches a CTAS query pattern or whether the query included a `ctasDataset` name that effectively turned the query into a CTAS statement.
          example: false
        isInsertInto:
          type: boolean
          description: This confirms whether the original SQL statement matches an INSERT INTO query pattern or whether the query included a dataset name under `insertIntoParameters` that effectively turned the query into an INSERT INTO statement.
          example: false
        state:
          type: string
          description: The current state of this query.
          enum:
          - SUBMITTED
          - IN_PROGRESS
          - SUCCESS
          - FAILED
          - KILLED
          - TIMEOUT
          example: SUCCESS
        created:
          type: string
          description: The time in UTC when the query was `SUBMITTED`.
          example: "2022-11-09T18:45:31.256Z"
        updated:
          type: string
          description: The time in UTC when the query was updated.
          example: "2022-11-09T18:45:31.256Z"
        elapsedTime:
          type: integer
          description: The time that has passed in milliseconds since the query state changed to `IN_PROGRESS`, or total time between the `IN_PROGRESS` state and a terminal state.
          example: 0
        rowCount:
          type: integer
          description: The total number of data rows returned in a result set, or persisted in the created dataset. This is meaningful only when query is in the `SUCCESS` state.
          example: 0
        templateName:
          type: string
          description: The name of the query template if the query was created using a query template.
          example: Sample Query Template for ACME Data 
        userId:
          type: string
          description: The ID of the user who created this object.
          example: '{USER_ID}'
        client:
          type: string
          description: A string that identifies the client application that generated this query.
          example: Acme
        copyURI:
          type: string
          description: If the query is a `COPY` with a state of `SUCCESS`, this field holds the URI where the data was written.
          example: https://acme.org/acme-central/rev/48ea452803907f2575d81021e8678634e8067fc2/browser/app/profile/acme.js#575
        errors:
          type: array
          description: Information about errors.
          items:
            $ref: '#/components/schemas/error'
        _links:
          $ref: '#/components/schemas/query_links'
        version:
          type: integer
          description: The REST API version of this resource.
    query_list:
      type: object
      properties:
        queries:
          description: A list of queries for your organization.
          items:
            $ref: '#/components/schemas/query'
        _page:
          $ref: '#/components/schemas/_page'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          type: integer
          description: The REST API version of this resource.
      description: List of queries
    query_list_links:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/next'
        prev:
          $ref: '#/components/schemas/prev'
      description: Contains the URI reference that clients may use to obtain the next
        or previous page of resources.
    error:
      type: object
      properties:
        code:
          type: string
          description: A code that identifies the type of error encountered.
          example: 408
        message:
          type: string
          description: Short description of the error.
          example: The server timed out waiting for the request
        errorType:
          type: string
          description: The broad type for this error.
          enum:
          - USER_ERROR
          - SYSTEM_ERROR
          example: 'USER_ERROR'
    query_links:
      type: object
      description: A list of links that provide more information on a query.
      properties:
        soft_delete:
          type: object
          properties:
            href:
              type: string
              description: The URI to call in order to soft-delete this query.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The JSON body to send to the `href`.
              example: { \"op\": \"soft_delete\"}
          description: Soft-deleting stops the query from being returned on GET requests to the `/queries` endpoint but does not delete it from the system.
        cancel:
          type: object
          description: Cancels the query run. 
          properties:
            href:
              type: string
              description: The URI of this resource.
              example: https://platform.adobe.io/data/foundation/query/queries/219e31bc-b186-427f-d541-65dc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The JSON body to send to the `href`.
              example: { \"op\": \"cancel\"}
        referenced_datasets:
          type: array
          description: Datasets utilized by this query, if any. Note that these datasets are resolved when the query is in state `IN_PROGRESS`.
          items:
            type: object
            properties:
              id:
                type: string
                description: The ID of the referenced dataset.
                example: 5f7e5169ad81ea16bba6b222
              href:
                type: string
                description: The catalog-owned URI of this resource.
                example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
        created_dataset:
          type: object
          properties:
            id:
              type: string
              description: The ID of the created dataset.
              example: 5f7e5169ad81ea16bba6b222
            href:
              type: string
              description: Catalog-owned URI related to this dataset.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
          description: If this query is a CTAS query, the created dataset is exposed under this object.
        schedule:
          type: object
          properties:
            id:
              type: string
              description: The ID of the schedule that created this query.
              example: 5f7e5169ad81ea16bba6b222
            href:
              type: string
              description: The URI to call to get details for the schedule that triggered this query.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: If this query was triggered by a schedule, then this object will be defined.
        schedule_run:
          type: object
          properties:
            id:
              type: string
              description: The ID of the `schedule_run` instance associated with this query.
              example: 5f7e5169ad81ea16bba6b222
            href:
              type: string
              description: The URI to call to get details for the `schedule_run` instance.
                associated with this query.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: If this query was triggered by a schedule, then this object will be defined.
    PagingProperties:
      type: object
      properties:
        orderby:
          type: string
          description: The property by which this page is ordered.
          example: -created
        page:
          type: integer
          description: The page number of the result.
          example: 1
        property:
          type: string
          description: If a `property` filter was used in the request path then this value is populated and displayed in the response body.
          example: status==enabled
        count:
          type: integer
          description: The number of items on the page.
          example: 26
        pageSize:
          type: integer
          description: The number of items on the page.
          example: 26
      description: Contains properties to describe the order, size, total number of
        pages, and current page.
    version:
      type: integer
      description: The version of this resource.
      example: 1
    _page:
      type: object
      properties:
        orderby:
          type: string
          description: The property by which this page is ordered.
          example: -created
        start:
          type: string
          description: The first value, in sorted order, of the orderby property on
            this page.
          example: '2021-12-06T22:00:17.362Z'
        next:
          type: string
          description: The start value for the next page.
          example: '2022-11-22T00:52:34.839Z'
        property:
          type: string
          description: The list of properties by which the result is filtered, if any. If the `property` query parameter is set when the query is issued, then it is returned in the `_page` object.
          example: created>=2021-04-05T13:30:00Z,state==IN_PROGRESS
        count:
          type: integer
          description: The number of items on the page.
          example: 26
      description: Pagination information for this resource. It contains a `count` property for the number of resources returned.
    next:
      type: object
      properties:
        href:
          type: string
          description: A link to the next page of results.
          example: https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2
      description: Pre-constructed URI for the next page of results, if any exist.
    prev:
      type: object
      properties:
        href:
          type: string
          description: A link to the previous page of results.
          example: https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=0
      description: Pre-constructed URI for the previous page of results, if any exist.
    connection_parameters:
      type: object
      properties:
        host:
          type: string
          description: The URI of the host to connect to.
          example: acme-prod.platform-query.adobe.io
        port:
          type: integer
          description: The host port to connect to.
          example: 80
        username:
          type: string
          description: Your organization ID as it was received in the request.
          example: '{USER_NAME}'
        token:
          type: string
          description: The IMS token as it was received in the request.
          example: NCSDFBRlhQRTdJWFVLR01RRjI3WUJRND09PT09PSIsInNpZCI6IjE2NfkwNTg3ODc4MDVfMzI2YWE0NfQtODFlYy00MWI4LWFlMjctNjU3MThhYjIxOGE5X3VlMSIsIm1vaSI6ImYwYjJjYjkxIiwicGJhIjoiTWVkU2VjTm9FVixMb3dTZWMiLCJleHBpcmVzX2luIjoiODY0MDAwMDAiLCJzY29wZSI6ImFiLm1hbmFnZSxhZGRpdGlvbmFsX2luZm8sYWRkaXRpb25hbhMS5hZG9iZWxvZ2luLmNvbS9pbXMvc2Vzc2lvbi92MS9ORGt6TkRZMU5HTXRaVEUxTVMwMFl6SXdMVGd6T0RBdFlURTBNVGhsTVRkbFlqRXpMUzFHUmpsQk1FTkVNell3T1VGRk56RXdNRUUwT1RWRFJETkFRV1J2WW1WSlJBXCJ9IiwiYXMiOiJpbXMtbmExIiwiYWFfaWQiOiJGRjlBMENEMzYwOUFFNzEwMEE0OTVDRDNAQWRvYmVJRCIsImN0cCI6MCwiZmciOiJXNjF9pbmZvLmpvYl9mdW5jdGlvbixhZGRpdGlvbmFsX2luZm8ucHJvamVjdGVkUHJvZHVjdENvbnRleHQsYWRkaXRpb25hbF9pbmZvLnJvbGVzLEFkb2JlSUQsYWRvYmVpby5hcHByZWdpc3RyeS5yZWFkLGFkb2JlaW9fYXBpLGF1ZGllbmNlbWFuYWdlcl9hcGksY3JlYXRpdmVfY2xvdWQsbXBzLG9wZW5pZCxyZWFkX29yZ2FuaXphdGlvbnMscmVhZF9wYyxyZWFkX3BjLmFjcCxyZWFkX3BjLmRtYV90YXJ0YW4sc2Vzc2lvbiIsImNyZWF0ZWRfYXQiOiIxNjY5MDY2NzY2MzY0In0.ZPNyd7JHKFRfrPFtGh8SqoGK7em0AT7WN_LK_DHGzPZr5WqGCcdUE-qEifOa-DqdiAUM2OCNHCXjzN1U9TZu7xs-AZYkz8dEjMQmDfxTcdCSJDHTPYVqWCxxARvw9hS62QhJsAsJ2b08reo0Q6qoTeRlXt1xyl4pVruf2rHmC_Dz8EkujrZsdmxTLgsIkCfYOXnKISVLrqAtQbmNwcSmhBmpmYCDVvU8v1qjrSb3Qd11nw56a5CLHJZQ2y8adm6TUsqtXyGZGSDvdYPbwCEMNHs_Uk9F1PaT51NH1AKKr6a4lA1E3SOUE6ithAytqcA4wyoLqz86PCPMmmbPG7_jEQeyJhbGciOiJSUzI1NiIsIng1dSI6Imltc19uYTEta2V5LWF0LTEuY2VyIiwia2lkIjoiaW1zX25hMS1rZXktYXQtMSIsIml0dCI6ImF0In0.eyJpZCI6IjE2NjkwNjY3NjYzNjRfNGFhN2NjZDMtYTdiNi00NGJkLWFjMzAtYjIyNGFkNDk3NDk4X3VlMSIsInR5cGUiOiJhY2Nlc3NfdG9rZW4iLCJjbGllbnRfaWQiOiJleGNfYXBwIiwidXNlcl9pZCI6IkMzNUI3OEJFNjJERDVERDcwQTQ5NUU3NEBjMGZjNzc0NjYyZGQzODlkNDk1YzBjLmUiLCJzdGF0ZSI6IntcInNlc3Npb25cIjpcImh0dHBzOi8vaW1zLW5
        compressedToken:
          type: string
          description: The IMS token compressed in a special format. It is required by some interactive clients such as Tableau.
          example: Nkgt8JNlbpg32ldmZrPOK1lo1oc1kZQkgw6lingKlj_wt3DRUshQ2cS22qDaUhL9RX212pIl9sKtZh35x1o1aCacFvGsU3TJ-rSotX_Y3XqFK09qlw9qHlUrlmyhqxlK1u3txGAP90mPGTNmy4mUkmjjKbA8YMS8utyFmpNtxe161trlNJbnfhuWqWUMk9dJnbI1Szz68LrP6352vINTQaKvs0bF03u9MFz0F__cGsj79_9RxV.eNoBAAH__mTzcneyRyhUX6zxbRofEqqBiu3ptAE-1jfyyvwxxsz2a-VqhgnHVBPqhInzmvg6nYgFDNjgjRwl48zdVPU2bu8bPgGWJM_HRIzEJg38U3HQkiQx0z2FalgscQEb8PYUutkISbALCdm9PK3qNEOqqE3kZV7dccpeKVa7n9qx5gew8_BJLo62bHZsUy4LCJAn2Dl5yiElS66gLUG5jcHEpoQZqZmAg1b1PL9ao60m90HddZ8OemuQixyWUNsvGnZuk1LKrV8hmRkg73WD28AhDDR7P1JPRdT2k-dTR9QCiq-muFQNRN0jlBOorYQMranAOMMqC6s_OjwjzJpmzxu_4xE5BXzTeNqrVkrMSVeyUgoKNjI1U9JRqjAtBfIyc4vj8xINdbNTK3UTS3QN9ZJTi4CS2ZkpWCSBEpklJUCJxBKlWgC4CRff.eNplU39vmzAQ_S78DcSAY0OkSSWFdN1K2qbpj0yR0GE7qVOCEThJm6rjjSZJN6k1EvjevfM93x3vluTWwPIIiRAhlJCA4BwDUMZ44AAtiINxwR1gAXIK38fAcURxFOYb4Vm2pd9qYeKBMdG2uVYvojIoK6WodH44WryyHOraoJtWNEfsPOgPaThMiZ8k_SShKMZRP6X4jKEFoxQT4nMehJHJ1WeIucJEtxp0l-p9brUml1TV3BrMrWet63bQ68l161TgucBVIUq1lJXL1LqDeyd6b-v1xsnLfpzMvPFFpv9MUy-7Q2i2v9xdTZf76yTWs2mKsulzmU15OVul-6s772KyKodZOk6z_Wx3fT8ajffpLktTdD19SCbJOL59nGxn64dfk3hufRih0BqVJzmdCcc7j0ZRfM6TgKAoTqmHDnc29lneKb5MurLp2hog21osDf-RBMOffjx6uknp5dP974vsduTTWXyLfyxWV5L_veuH1Dyonwc-AcAEO6EnmIO9InRA-NQhfeqFUPjmFZ16t1bShC9Q4bMi6oC6AA
        version:
          type: integer
          description: The REST API version of this resource.
          example: 1
        dbName:
          type: string
          description: A combination of the sandbox name and the database name.
          example: prod:all
        websoketHost:
          type: string
          description: A combination of the sandbox name and the database name.
          example: query-service-interactive-ws-prod-va7.cloud.adobe.io
      description: An object containing the connection parameters.
    schedules_request:
      required:
      - schedule
      - startDate
      type: object
      properties:
        schedule:
          type: string
          description: 'A cron like definition for recurring jobs. For example, the 
            expression  "0 0 * * *" will run on the hour, every hour, every day, and 
            every month. For a non-recurring job, set the value to "@once" and the 
            job would run once at the timestamp specified in "startDate" parameter'
          example: '51 12 * * 1'
        startDate:
          type: string
          description: The start date for the scheduled query runs. 
          example: 2020-01-08T12:30:00.000Z
        endDate:
          type: string
          description: The end date for the scheduled query runs.
          example: 2021-01-08T12:30:00.000Z
        maxActiveRuns:
          type: integer
          description: The number of parallel schedule runs allowed. The default value is 1.
          example: 3
      description: Information on the cadence of the query schedule.
    schedules_response:
      type: object
      properties:
        schedule:
          type: string
          description: 'A cron like definition for recurring jobs. For example, the 
            expression  "0 0 * * *" will run on the hour, every hour, every day, and 
            every month. For a non-recurring job, set the value to "@once" and the 
            job would run once at the timestamp specified in "startDate" parameter'
          example: '51 12 * * 1'
        startDate:
          type: string
          description: The start date for the scheduled query runs. 
          example: 2020-01-08T12:30:00.000Z
        endDate:
          type: string
          description: The end date for the scheduled query runs.
          example: 2021-01-08T12:30:00.000Z
        maxActiveRuns:
          type: integer
          description: The number of parallel schedule runs allowed. The default value is 1.
          example: 3
      description: Information on the cadence of the query schedule.
    schedules_runs_by_id_links:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              description: The URI of this resource.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: Contains the information required to access this resource.
        soft_delete:
          type: object
          properties:
            href:
              type: string
              description: The URI to call in order to soft-delete this query.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The JSON body to send to the `href`.
              example: { \"op\": \"cancel\"}
          description: Soft-deleting stops this query from being returned on GET requests to the `/queries` endpoint but does not delete it from the system.
        cancel:
          type: object
          properties:
            href:
              type: string
              description: The URI of this resource.
              example: https://platform.adobe.io/data/foundation/query/queries/219e31bc-b186-427f-d541-65dc34f2b6ed
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The JSON body to send to the `href`.
              example: { \"op\": \"cancel\"}
          description: Contains the information required to cancel the query run.
        referenced_datasets:
          type: object
          properties:
            id:
              type: string
              description: The ID of the referenced dataset.
              example: 5f7e5169ad81ea16bba6b222
            href:
              type: string
              description: The URI of this resource.
              example: https://platform.adobe.io/data/foundation/query/queries/217e32dc-d186-427f-b541-65bc34f2b6ed
          description: The datasets utilized by this query, if any. Note that these datasets are resolved when the query is in state `IN_PROGRESS`.
    schedules_links:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              description: URI of this resource.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jcec73f0a495jc9_51c9d32c-7654-468a-69d3-2c7654786ad1_a3000599_c779_417f_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85dfee
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: Contains the information required to return the schedule information for this query.
        enable:
          type: object
          properties:
            href:
              type: string
              description: The URI to call to enable this schedule.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jcec73f0a495jc9_51c9d32c-7654-468a-69d3-2c7654786ad1_a3000599_c779_417f_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85dfee
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The payload for the request.
              example: '{ "op": "enable" }'
          description: Contains the necessary information to enable the associated query's schedule.
        disable:
          type: object
          properties:
            href:
              type: string
              description: URI to call to disable this schedule.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jcec73f0a495jc9_51c9d32c-7654-468a-69d3-2c7654786ad1_a3000599_c779_417f_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85dfee
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PATCH
            body:
              type: string
              description: The payload for the request.
              example: '{ "op": "disable" }'
          description: Contains the necessary information to disable the associated query's schedule.
        delete:
          type: object
          properties:
            href:
              type: string
              description: URI to call to delete this schedule.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jcec73f0a495jc9_51c9d32c-7654-468a-69d3-2c7654786ad1_a3000599_c779_417f_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85dfee
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: DELETE
          description: Contains the necessary information to delete the associated query's schedule.
        runs:
          type: object
          properties:
            href:
              type: string
              description: URI to call to return all runs, past and currently running,
                for a particular query schedule.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/jcbd04245jcec73j0a495jc9_51c9b32c-7654-486a-89d3-2c7654788ad1_a3000599_c779_417f_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85deee/runs
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: Contains the necessary information to return the run schedule for the associated query.
        trigger:
          type: object
          properties:
            href:
              type: string
              description: The URI to call to trigger an immediate run of this scheduled query.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245fcec73j0a495jc9_51c9d32c-7654-468a-69b3-2c7654768ad1_a3000599_c779_417j_9933_4ec1c1b8828d4bwimtwh0aag3xzxvzv7_85deee/runs
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: POST
          description: Contains the necessary information to trigger an immediate run for the associated query.
      description: Contains links to perform a variety of actions on this query schedule.
    schedules_list_links:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/next'
      description: Contains the navigation links for results pages.
    schedules:
      type: object
      properties:
        id:
          type: string
          description: The ID for the schedule.
          example: e95168d65a26abf00a495d82_28e74200-e3de-11e9-8f5d-7f27416c5f0d_sample_scheduled_query7omob151bm_birvwm
        userId:
          type: string
          description: The ID of the user that created the schedule.
          example: '{USER_ID}'
        updatedUserId:
          type: string
          description: The ID of the user who last updated the schedule.
          example: '{USER_ID}'
        state:
          type: string
          description: When a schedule has recently being created and is in the 
            process of being registered on internal systems, it enters the `REGISTERING` state.
            It will automatically transition into `ENABLED` once it is acknowledged
            by internal systems. When `ENABLED`, a schedule will run based on time 
            interval specified and can be triggered to run manually via `POST /schedules/{scheduleId}/runs`. 
            When `DISABLED`, a schedule will not run on the specified time interval and will not
            be allowed to run manually via `POST /schedules/{scheduleId}/runs`. Only
            schedules in the `DISABLED` state can be deleted via `DELETE /schedules/{scheduleId}`.
          enum:
          - REGISTERING
          - ENABLED
          - DISABLED
        query:
          $ref: '#/components/schemas/query_def'
        schedule:
          $ref: '#/components/schemas/schedules_response'
        created: 
          type: string
          description: 'UTC time when schedule was submitted. Note: We don''t return
            this parameter in response for POST /schedules'
          example: '2022-01-06T23:42:15.352Z' 
        updated:
          type: string
          description: 'UTC time when schedule was last updated. Note: We don''t return
            this parameter in response for POST /schedules'
          example: '2022-01-06T23:42:15.352Z'
        _links:
          $ref: '#/components/schemas/schedules_links'
      description: Each object contains the schedule information for your organization's queries.
    schedules_list:
      type: object
      properties:
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/schedules'
          description: Each object contains the schedule information for your organization's queries.
        _page:
          $ref: '#/components/schemas/_page'
        _links:        
          properties:            
            next:
              type: string
              description: A link to the next page of results.
              example: https://platform-va7.adobe.io/data/foundation/query/schedules?start=2022-11-01T00:11:08.389Z&limit=10&linkType=next
          description: Contains the URI reference to obtain the next page of resources.
        version:
          type: integer
          description: The REST API version of this resource.
      description: List of schedules
    self_and_cancel_links:
      properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The URI of this resource.
                  example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jeec73f0a495fc9_51c9d32c-7654-468a-89d3-2e7654768ad1_a3000599_c779_417f_9933_4ec1c1d8828d4bwimtwh0aag3xxzvzv7_85deee/runs/c2NoZWR1bGVkX18yMDIyLTAxLTMwVDE1OjQxOjAwKzAwOfAw
                method:
                  type: string
                  description: The HTTP method to use with the `href`.
                  example: GET
              description: Contains the information required to access this resource.
            cancel:
              properties:
                href: 
                  type: string
                  description: The URI to call to cancel the run of this scheduled query.
                  example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jeec73f0a495fc9_51c9d32c-7654-468a-89d3-2e7654768ad1_a3000599_c779_417f_9933_4ec1c1d8828d4bwimtwh0aag3xxzvzv7_85deee/runs/c2NoZWR1bGVkX18yMDIyLTAxLTMwVDE1OjQxOjAwKzAwOfAw
                method:
                  type: string
                  description: The HTTP method to use with the `href`.
                  example: PATCH
              description: Contains the information required to cancel this resource.
      description: Contains links to perform actions on this schedule run.
    schedules_run:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the run of this scheduled query.
          example: c2NoZFR1dGVjX18yMDIyLKAxLTIxVDE1OfQxOjAwKzAwOfAw
        created:
          type: string
          description: The UTC timestamp when the run was initiated.
          example: 2022-01-21T15:41:00Z
        state:
          type: string
          enum:
          - SUCCESS
          - IN_PROGRESS
          - FAILED
          description: The state of the query run. 
          example: SUCCESS
        externalTrigger:
          type: boolean
          description: Indicates whether the run was triggered using a POST request to the `/schedules/{scheduleId}/runs` endpoint.
          example: false
        _links:
          properties:
            self:
              type: object
              properties:
                href:
                  type: string
                  description: The URI of this resource.
                  example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jeec73f0a495fc9_51c9d32c-7654-468a-89d3-2e7654768ad1_a3000599_c779_417f_9933_4ec1c1d8828d4bwimtwh0aag3xxzvzv7_85deee/runs/c2NoZWR1bGVkX18yMDIyLTAxLTMwVDE1OjQxOjAwKzAwOfAw
                method:
                  type: string
                  description: The HTTP method to use with the `href`.
                  example: GET
              description: Contains the information required to access this resource.
            cancel:
              properties:
                href: 
                  type: string
                  description: The URI to call to cancel the run of this scheduled query.
                  example: https://platform-va7.adobe.io/data/foundation/query/schedules/fcbd04245jeec73f0a495fc9_51c9d32c-7654-468a-89d3-2e7654768ad1_a3000599_c779_417f_9933_4ec1c1d8828d4bwimtwh0aag3xxzvzv7_85deee/runs/c2NoZWR1bGVkX18yMDIyLTAxLTMwVDE1OjQxOjAwKzAwOfAw
                method:
                  type: string
                  description: The HTTP method to use with the `href`.
                  example: PATCH
              description: Contains the information required to cancel this resource.
          description: Contains links to perform actions on this schedule run.          
        version:
          type: integer
          example: 1
          description: The REST API version of this resource.
      description: A list of all the run information for a specified query schedule.
    schedules_run_list:
      type: object
      properties:
        runsSchedules:
          type: array
          items:
            $ref: '#/components/schemas/schedules_run'
          description: A list of all the run information for a specified query.
        _page:
          $ref: '#/components/schemas/_page'
        _links:        
          properties:            
            next:
              type: string
              description: A link to the next page of results.
              example: https://platform.adobe.io/data/foundation/query/queries/alert-subscriptions?orderby=-created&page=2
          description: Contains the URI reference to obtain the next page of resources.
        version:
          type: integer
          description: The REST API version of this resource.
      description: List of schedules runs
    schedules_run_details:
      type: object
      properties:
        created:
          type: string
          description: The execution date of the run provided in the request path.
          example: 2022-06-02T10:56:00Z
        state:
          type: string
          description: The state of the run provided in the request path.
          enum:
          - SUCCESS
          - IN_PROGRESS
          - FAILED
          example: FAILED
        taskStatusList:
          type: array
          description: A list of information related to run provided in the request path.
          items:
            $ref: '#/components/schemas/task_detail'          
        id:
          type: string
          description: The unique identifier for the run provided in the request path..
          example: a2NoKWR1dGVkX18yMDIyLJA2LTAyVDEwOfU2OfAwKzAwOfAw
        scheduleId:
          type: string
          description: The ID of the schedule that the run belongs to.
          example: fcbd04245fcec73j0a495fc9_51c9d32e-7654-466a-89b3-2c7654768ab1_d623a799_6jbb_4b13_aaf5_j8b4f728fc3cw6tmcbapd30tx2ktp58s_mqj4xg
        externalTrigger:
          type: boolean
          description: Identifies whether the given run was triggered through a POST request to  `/schedules/{scheduleId}/runs`.
          example: false
        _links:
          $ref: '#/components/schemas/self_and_cancel_links'
      description: The schedule run details.
    schedules_create_request:
      required:
      - query
      - schedule
      type: object
      properties:
        query:
          $ref: '#/components/schemas/query_def'
        schedule:
          $ref: '#/components/schemas/schedules_request'
    task_detail:
      type: object
      properties:
        duration:
          type: string
          description: The amount of seconds taken to complete this run.
          example: 9
        endDate:
          type: string
          description: The end date of this run.
          example: 2022-06-03T11:04:03.236972Z
        state:
          type: string
          description: The state of the task.
          enum:
          - SUCCESS
          - IN_PROGRESS
          - FAILED
          - QUEUED_FOR_RETRY
          - QUEUED
          example: FAILED
        message:
          type: string
          description: A message giving more information related to this run.
          example: Processing Failed
        startDate:
          type: string
          description: The start date of this run.
          example: 2022-06-03T11:03:54.095191Z
        taskId:
          type: string
          description: The task ID of this run.
          example: 0tx2JTP56S
    template_count:
      type: object
      properties:
        totalCount:
          type: integer
          description: The total number of templates.
          example: 52
        version:
          type: integer
          description: The REST API version of this resource.
          example: 1
      description: Total Query Template count Response.
    query_template_def:
      required:
      - name
      - sql
      type: object
      properties:
        sql:
          type: string
          description: You can either use standard SQL or a parameter replacement.
            To use a parameter replacement in the SQL you must prepend the parameter key with a `$`. For example, `$key`,
            and provide the parameters used in the SQL as JSON key value pairs in the `queryParameters` field. The values
            passed here will be the default parameters used in the template.
            If you want to override these parameters, you must override
            them in the POST request.
          example: SELECT $key FROM $key1 WHERE $key > $key2;
        queryParameters:
          type: object
          properties:
            key:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value
            key1:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value1
            key2:
              type: string
              description: A set of two linked data items. The key is a unique identifier for some item of data, and the value, is either the data that is identified or a pointer to the location of that data. 
              example: value2
          description: A key value pairing to replace values in the SQL statement. These are required if you are using parameter replacements. No value type checking will be done on these key value pairs.
        name:
          type: string
          description: A descriptive and human readable name for the template.
          example: Test Parameterized Query
      description: A description of the query template to be submitted.
    query_template:
      type: object
      properties:
        sql:
          type: string
          description: The SQL query statement. You can use either standard SQL or include parameter replacements. To use a parameter replacement in the SQL you must prepend the parameter key with a `$`. For example, `$key`,
            and provide the parameters used in the SQL as JSON key value pairs in the `queryParameters` field.
          example: SELECT $key from $key1 where $key > $key2;
        name:
          type: string
          description: The name for the template.
          example: Sample template query
        id:
          type: string
          description: The ID of the query template.
          example: f7cb5155-29da-4b95-6131-6c5beadjde7f
        queryParameters:
          type: object
          properties:
            key:
              type: string
              description: An example key value pair for a parameterized query.
              example: value
            key1:
              type: string
              description: An example key value pair for a parameterized query.
              example: value1
            key2:
              type: string
              description: An example key value pair for a parameterized query.
              example: value2
          description: A key value pairing for replacing values in the SQL. The key must be prepended with a `$`. For example, `SELECT column1 FROM table2 WHERE column1=$key;`. No value type checking will be done. This is required if using a parameter replacement. 
        updated:
          type: string
          description: The time in UTC format when query template was last updated.
          example: '2022-11-21T21:50:01.469Z'
        lastUpdatedBy:
          type: string
          description: The ID of the user who last updated the template.
          example: '{USER_ID}'
        userId:
          type: string
          description: The ID of the user who created the template.
          example: '{USER_ID}'
        _links:
          $ref: '#/components/schemas/query_template_links'          
      description: Query Template Response.
    query_template_links:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              description: The URI of this resource.
              example: https://platform-va7.adobe.io/data/foundation/query/query-templates/2f560b99-abc0-4058-92dj-9408jaddcd71
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: GET
          description: Contains the information required to access this resource.
        update:
          type: object
          properties:
            href:
              type: string
              description: The URI to update this resource.
              example: https://platform-va7.adobe.io/data/foundation/query/query-templates/2f560b99-abc0-4058-92dj-9408jaddcd71
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: PUT
            body:
              type: string
              description: The JSON payload to send to the `href`.
              example: '{\"sql\" : \"new sql\", \"name\" : \"new name\"}'
          description: Contains the information required to update this resource.
        delete:
          type: object
          properties:
            href:
              type: string
              description: The URI to delete this resource.
              example: https://platform-va7.adobe.io/data/foundation/query/query-templates/2f560b99-abc0-4058-92dj-9408jaddcd71
            method:
              type: string
              description: The HTTP method to use with the `href`.
              example: DELETE
          description: Contains the information required to delete this resource.
      description: The object contains links to perform actions on this schedule run.
    query_template_list:
      type: object
      properties:
        templates:
          type: array
          items:
            $ref: '#/components/schemas/query_template'
        _page:
          $ref: '#/components/schemas/_page'
        _links:
          $ref: '#/components/schemas/query_list_template_links'
        version:
          type: integer
          description: The REST API version of this resource.
      description: List of queries
    query_list_template_links:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/next'
        prev:
          $ref: '#/components/schemas/prev'
    query_template_delete:
      type: object
      properties:
        message:
          type: string
          description: A message to indicate the outcome of the request.
          example: Deleted
        statusCode:
          type: string
          description: The status code generated by the request.
          example: 202
    schedule_patch_operation:
      required:
      - op
      - path
      - value
      type: object
      properties:
        op:
          type: string
          description: The operation to be performed on the query schedule. 
          enum:
          - replace
          example: replace
        path:
          type: string
          description: The path to the resource that will be updated.
          enum:
          - /state
          - /schedule/schedule
          example: /state
        value:
          type: string
          enum:
          - enable
          - disable
          description: The value to update the resource with. The value can either enable or disable the scheduled query.
          example: disable
    subscribe_user_to_alert_body:
      required:
      - alertType
      - assetId
      - subscriptions
      type: object
      properties:
        assetId:
          type: string
          description: The query or schedule ID that you want the alert to track.
          example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
        alertType:
          type: string
          description: The state of query execution that you want to trigger an alert.
            The alert type is one of three values (`start`, `success`, `failure`).
          example: failure
        subscriptions:
          required:
          - emailIds
          - emailNotifications
          - inContextNotifications
          type: object
          properties:
            emailIds:
              type: array
              description: A list of email address identifiers for the users you are
                subscribing. These must be Adobe-registered email addresses. The maximum
                number of `emailID`s that can be registered at once is five.
              items:
                $ref: '#/components/schemas/emailIdForSubscribing'
            inContextNotifications:
              type: boolean
              description: A `true` value indicates that the users want to receive
                an alert through the Platform UI. A `false` value means that the users
                will not be sent alerts in the Platform UI.
              example: true
            emailNotifications:
              type: boolean
              description: A `true` value indicates that the users want to receive
                an alert via email. A `false` value means that the users will not
                be sent alerts via email. To receive email alerts you must first enable
                this setting within the UI. See the documentation for [instructions
                on how to enable email alerts](https://experienceleague.adobe.com/docs/experience-platform/observability/alerts/ui.html?lang=en#enable-email-alerts).
              example: true
          description: This object provides the details of the users that you want
            to receive the alert, including the preferred delivery method. You must
            include their email ID and preferred notification channels for the alerts.
      description: The request payload used to subscribe `emailId`s to query or schedule
        IDs for a given alert type.
    emailIdForSubscribing:
      type: string
      description: A list of Adobe registered `emailID`s that want to subscribe to
        the alert for a given `assetId` and `alertType`.
      example: rrunner@adobe.com
    alert_subscription_response_body:
      type: object
      properties:
        id:
          type: string
          description: The alert name that appears in the Alerts tab of the Adobe
            Experience Platform UI.
          example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
        assetId:
          type: string
          description: The query or schedule ID that the alert is created for and
            subscribed to.
          example: 4422fc69-eaa7-464e-945b-63cfd435d3d1
        alertType:
          type: string
          description: This property determines the state of query execution that
            triggers a user to receive an alert. The alert type is one of three values
            (`start`, `success`, `failure`).
          example: failure
        subscriptions:
          $ref: '#/components/schemas/SubscriptionsBasic'
        _links:
          $ref: '#/components/schemas/alert_links'
      description: The response when subscribing `emailID`s to an alert for an `assetId`
        and `alertType`.
    alert_links:
      type: object
      properties:
        self:
          type: object
          properties:
            href:
              type: string
              description: The URI to get subscribers information for a given `assetId`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928
            method:
              type: string
              description: The HTTP method to use.
              example: GET
          description: An object that contains the method and URI required to return subscriber information for a given `assetId`.
        subscribe:
          type: object
          properties:
            href:
              type: string
              description: The URI to subscribe new users to an alert.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions
            method:
              type: string
              description: The HTTP method to use.
              example: POST
            body:
              type: string
              description: The JSON body to send.
              example: '{\"assetId\": \"queryId/scheduleId\", \"alertType\": \"start/success/failure\",
                \"subscriptions\": {\n\"emailIds\": [\"xyz@example.com\", \"abc@example.com\"],
                \"email\": true, \"inContext\": false}}'
          description: An object that contains the method and URI required to subscribe
            new users to an alert.
        patch_status:
          type: object
          properties:
            href:
              type: string
              description: The URI to update the status of an alert for a given `assetId`
                and `alertType` between `enable` and `disable`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: PATCH
            body:
              type: string
              description: The JSON body to send.
              example: '{ \"op\": \"replace\", \"path\": \"/status\", \"value\": \"enable/disable\"
                }'
          description: An object that contains the method and URI required to update
            the status of an alert for a given `assetId` and `alertType` between `enable`
            and `disable`.
        get_list_of_subscribers_by_alert_type:
          type: object
          properties:
            href:
              type: string
              description: Return a list of all subscribers for given `assetId` and
                `alertType`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: GET
          description: An object that contains the method and URI required to return
            a list of all subscribers for given `assetId` and `alertType`.
        delete:
          type: object
          properties:
            href:
              type: string
              description: The URI to delete an alert for particular `assetId` and
                `alertType`.
              example: https://platform.adobe.io/data/foundation/query/alert-subscriptions/c4f67291-1161-4943-bc29-8736469bb928/failure
            method:
              type: string
              description: The HTTP method to use.
              example: DELETE
          description: An object that contains the method and URI required to delete
            an alert for particular `assetId` and `alertType`.
      description: An object that contains information such as the URIs and methods
        for common alert subscriptions use cases.
    alerts_per_imsorg_and_sandbox:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/Id'
              alertType:
                $ref: '#/components/schemas/AlertType'
              status:
                $ref: '#/components/schemas/Status'
              assetId:
                $ref: '#/components/schemas/AssetId'
              _links:
                $ref: '#/components/schemas/alert_links'
        _page:
          $ref: '#/components/schemas/PagingProperties'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          $ref: '#/components/schemas/version'
    alerts_per_imsorg_and_sandbox_response:
      type: object
      properties:
        alerts:
          $ref: '#/components/schemas/CoreAlertProperties'
        _page:
          $ref: '#/components/schemas/PagingProperties'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          $ref: '#/components/schemas/version'
      description: All alerts per organization and sandbox.
    CoreAlertProperties:
      type: object
      properties:
        id:
          type: string
          description: A unique system-generated ID for the alert.
          example: query_service_flow_run_success-4422fc69-eaa7-464e-945b-63cfd435d3d1
        assetId:
          type: string
          description: The query or schedule ID that the alert is created for and
            subscribed to.
          example: 4422fc69-eaa7-464e-945b-63cfd435d3d1
        alertType:
          type: string
          description: This property determines the state of query execution that
            triggers a user to receive an alert. The alert type is one of three values
            (`start`, `success`, `failure`).
          example: start
        status:
          type: string
          description: This represents the status of the alert. It is one of four
            values (enabled, enabling, disabled, disabling).
          example: enabled
      description: Contains properties to describe the query ID, alert ID, type, and
        status of alert.
    subscribers_for_alert_by_assetId:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/Id'
              alertType:
                $ref: '#/components/schemas/AlertType'
              status:
                $ref: '#/components/schemas/Status'
              assetId:
                $ref: '#/components/schemas/AssetId'
              subscriptions:
                $ref: '#/components/schemas/Subscriptions'
              _links:
                $ref: '#/components/schemas/alert_links'
      description: Alert information and Email IDs for all users subscribed for alerts
        on a particular query.
    Subscriptions:
      $ref: '#/components/schemas/SubscriptionEmailIdsByChannel'
    SubscriptionsBasic:
      type: object
      properties:
        emailNotifications:
          type: array
          description: A list of the email IDs subscribed to notifications by email.
          items:
            type: object
            example: rrunner@adobe.com
        inContextNotifications:
          type: array
          description: A list of the email IDs subscribed to notifications within
            the Platform UI.
          items:
            type: object
            example: rrunner@adobe.com
      description: An object that contains two arrays of subscriber email IDs divided
        by their selected notification channel.
    _links:
      $ref: '#/components/schemas/query_list_links'
    subscribers_for_alert_by_assetId_and_alertType:
      type: object
      properties:
        alerts:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/AlertId'
              assetId:
                $ref: '#/components/schemas/AssetId'
              alertType:
                $ref: '#/components/schemas/AlertTypeSuccess'
              status:
                $ref: '#/components/schemas/Status'
              subscriptions:
                $ref: '#/components/schemas/Subscriptions'
              _links:
                $ref: '#/components/schemas/alert_links'
      description: A list of alerts for an `assetId` and `alertType`.
    alert_patched:
      $ref: '#/components/schemas/CoreAlertProperties'
    alert_patched_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'An invalid alertType was provided. Valid values are: start, success
            and failure.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status to patch an alert.
    alert_patched_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'No alert exists for assetId: 24a218c7-1738-4f56-95fb-df62928751a680
            and alertType: start. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status to patch an alert.
    alert_deleted:
      type: object
      properties:
        message:
          type: string
          description: A message string that contains the `assetId` and the `alertType`,
            confirms the alert has been deleted.
          example: 'Alert deleted successfully for assetId: 6df22232-f427-4250-a4e1-43cd30990641
            and alertType: success'
        statusCode:
          type: string
          description: The status code.
          example: "200"
      description: An alert has been deleted for the `assetId` and `alertType` provided
        in the URI.
    alert_deleted_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'An invalid alertType was provided. Valid values are: start, success
            and failure'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status to delete an alert.
    alert_deleted_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'No alert exists for assetId: c4f67291-1161-4943-bc29-8736469bb92w8
            and alertType: success. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status to delete an alert.
    get_alerts_to_which_user_subscribed_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The emailId: unregistered@adobe.com is not an Adobe registered
            ID. Please use another emailId'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status for a request to return all
        the alerts a user is subscribed to.
    alerts_to_which_user_subscribed_response:
      type: object
      properties:
        items:
          type: array
          description: A list of alerts that match the parameters of the listing call.
          items:
            type: object
            properties:
              name:
                $ref: '#/components/schemas/AlertName'
              assetId:
                $ref: '#/components/schemas/AssetId'
              status:
                $ref: '#/components/schemas/Status'
              alertType:
                $ref: '#/components/schemas/AlertType'
              subscriptions:
                $ref: '#/components/schemas/notification_channels'
              _links:
                $ref: '#/components/schemas/alert_links'
        page:
          $ref: '#/components/schemas/PagingProperties'
        _links:
          $ref: '#/components/schemas/query_list_links'
        version:
          $ref: '#/components/schemas/version'
      description: Information about a particular alert.
    notification_channels:
      type: object
      properties:
        inContextNotifications:
          type: boolean
          description: A true value indicates that the user, identified by their email
            ID, wants to receive an alert through the Experience Platform UI. A false
            value would not provide an alert in the Adobe Experience Platform UI.
          example: true
        emailNotifications:
          type: boolean
          description: A true value indicates that the user, identified by their email
            ID, wants to receive an alert by email. A false value would not provide
            an alert via email.
          example: false
      description: A boolean value to confirm the channel of alert notification subscribed
        to by the user.
    SubscriptionEmailIdsByChannel:
      type: object
      properties:
        emailNotifications:
          $ref: '#/components/schemas/Email_ID_emailNotifications'
        inContextNotifications:
          $ref: '#/components/schemas/Email_ID_inContextNotifications'
      description: An object that contains two arrays of subscriber email IDs divided
        by their selected notification channel.
    Email_ID_emailNotifications:
      type: array
      description: A list of the email IDs subscribed to notifications by email.
      items:
        type: object
        example: rrunner@adobe.com, jsnow@adobe.com, keverdeen@adobe.com
    Email_ID_inContextNotifications:
      type: array
      description: A list of the email IDs subscribed to notifications within the
        Platform UI.
      items:
        type: object
        example: jsnow@adobe.com, keverdeen@adobe.com
    get_alert_subscription_for_asset_id_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct
            how to resolve the issue.
          example: 'No alert exists for assetId: e5fb-62928751a680. Please resubmit
            with different assetId.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status when requesting alert information
        for an asset ID.
    get_alert_subscription_for_asset_id_and_alert_type_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct
            how to resolve the issue.
          example: 'No alert exists for assetId: c4f67291-1161-4943-bc29-8736469bb928sa
            and alertType: failure. Please resubmit with different assetId and alertType.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status when requesting subscriber
        information for an asset ID and alert type.
    get_alert_subscription_for_asset_id_and_alert_type_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error to explain the problem and instruct
            how to resolve the issue.
          example: 'An invalid alertType was provided. Valid values are: start, success
            and failure.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status when requesting subscriber
        information for an asset ID and alert type.
    post_bad_request_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The provided emailId: scoobydoo@adobe.com is not an Adobe registered
            ID. Please use another emailId.'
        statusCode:
          $ref: '#/components/schemas/BadRequestError'
      description: The error response for a 400 status for a request to create and
        subscribe to a new alert.
    post_not_found_error_message:
      type: object
      properties:
        message:
          type: string
          description: A description of the error.
          example: 'The provided assetId: 24a218c7-1738-4f56-95fb-asda62928751a680
            is invalid. Retry with another assetId.'
        statusCode:
          $ref: '#/components/schemas/NotFoundError'
      description: The error response for a 404 status for a request to create and
        subscribe to a new alert.
    Id:
      type: string
      description: The alert name that appears in the Alerts tab of the Adobe Experience
        Platform UI.
      example: query_service_flow_run_failure-5cdc3bbe-750a-4d80-9c43-96e5e09f1a96
    AlertId:
      type: string
      description: The alert name that appears in the Alerts tab of the Adobe Experience
        Platform UI.
      example: a679dd0e-bcb2-4e69-a610-22d17ba98cac
    AlertType:
      type: string
      description: This property determines the state of query execution that triggers
        a user to receive an alert. The alert type is one of three values (`start`,
        `success`, `failure`).
      example: failure
    AlertTypeSuccess:
      type: string
      description: This property determines the state of query execution that triggers
        a user to receive an alert. The alert type is one of three values (`start`,
        `success`, `failure`).
      example: success
    Status:
      type: string
      description: This represents the status of the alert. It is one of four values
        (`enabled`, `enabling`, `disabled`, `disabling`).
      example: enabled
    AssetId:
      type: string
      description: The query or schedule ID that the alert is created for and subscribed
        to.
      example: 6df22232-f427-4250-a4e1-43cd30990641
    AlertName:
      type: string
      description: The name of the alert. This name is generated automatically by
        Adobe Experience Platform.
      example: query_service_flow_run_success-8f057161-b312-4274-b629-f346c7d15c1f
    NotFoundError:
      type: object
      description: An HTTP status code that indicates the page, or resource you are
        looking for cannot be found.
      example: 404
    BadRequestError:
      type: object
      description: An HTTP status code that indicates the server cannot or will not
        process the request due to something that is perceived to be a client error.
      example: 400
    UnauthorizedError:
      type: object
      description: An HTTP status code that indicates the request has not been applied
        because it lacks valid authentication credentials for the target resource.
      example: 401
    InternalServerError:
      type: object
      description: An HTTP status code that indicates the server has encountered an
        unexpected condition that prevented it from fulfilling the request.
      example: 500
  parameters:
    authorization:
      name: Authorization
      in: header
      description: The access token which can be copied from your Experience Platform
        integration, prefixed with "Bearer " (for example, `Bearer {ACCESS_TOKEN}`).
        For more information on how to obtain this value, visit the documentation
        covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-gw-ims-org-id:
      name: x-gw-ims-org-id
      in: header
      description: The Organization ID which can be copied from your Experience Platform
        integration. For more information on how to obtain this value, visit the documentation
        covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-api-key:
      name: x-api-key
      in: header
      description: The API key which can be copied from your Experience Platform integration.
        For more information on how to obtain this value, visit the documentation
        covering making API calls in the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    x-sandbox-name:
      name: x-sandbox-name
      in: header
      description: The name of the sandbox in which the operation will take place.
        See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
        for more information.
      required: true
      schema:
        type: string
    x-sandbox-name-not-required:
      name: x-sandbox-name
      in: header
      description: The name of the sandbox in which the operation will take place.
        See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
        for more information.
      schema:
        type: string
    x-sandbox-id:
      name: x-sandbox-id
      in: header
      description: The unique identifier of the sandbox in which the operation will
        take place. See the [sandboxes overview documentation](https://adobe.com/go/sandbox-overview-en)
        for more information.
      schema:
        type: string
    x-service-token:
      name: x-service-token
      in: header
      description: An optional key used to authenticate access.
      schema:
        type: string
    json-header:
      name: Content-Type
      in: header
      description: The type of content being sent in the body of the request. The value should be 'application/json'.
      required: true
      schema:
        type: string
    accept-encoding:
      name: Accept-Encoding
      in: header
      description: This request header indicates the type of content encoding that
        the client can understand when consuming compressed response bodies. It is
        usually a compression algorithm. Accepted values include `gzip` and `identity`.
      schema:
        type: string
    template_count_property:
      name: property
      in: query
      description: "Comma-separated filters. Multiple filters separated by commas can be passed. Examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n  Currently only userId is allowed in filtering count.\nExample: property=userId=={USER_ID}\n "
      schema:
        type: string
    template_property:
      name: property
      in: query
      description: "Comma-separated filters. Multiple filters separated by commas can be passed.\n\n 
        List of properties that allow filtering:\n\
        `name`, `userId`, `lastUpdatedBy`.\n\n
        Supported operators:\n\n
        `~` (contains). This operator can only be used on the `name` property.\n\n
        `==` (equal to). This operator can be used on both the `userId` and the `lastUpdatedBy` properties.\n\n
        Example: `property=name~Sample query`\n\n
        Example: `property=userId=={USER_ID}`"
      schema:
        type: string
    isPrevLink:
      name: isPrevLink
      in: query
      description: >- 
        `isPrevLink` is used in pagination. Results are sorted using the `created` timestamp and the `orderby` property. 
          When navigating pages of results, `isPrevLink` is set to true when paging backwards. It reverses the order of the query. See "next" and "prev" links as examples.
      schema:
        type: boolean
    queries_orderby:
      name: orderby
      in: query
      description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
      schema:
        type: string
    schedules_orderby:
      name: orderby
      in: query
      description: "The field that specifies the order of results. The supported fields 
          are `created` and `updated`. Prepend the property name with `+` for ascending and 
          `-` for descending order. The default is `-created`. Note that the plus sign (`+`) 
          has to be escaped with `%2B`. For example `%2Bcreated` is the value for an ascending 
          created order."
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Control the number of records to fetch per page.
      schema:
        type: integer
    start:
      name: start
      in: query
      description: The timestamp used with `orderby` to order the returned results.
      schema:
        type: string
    queries_property:
      name: property
      in: query
      description: "Comma-separated filters. Multiple filters separated by commas can be passed. Examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.\n\n List of properties that allow filtering with all operators:\n created\n updated\n state\n id\n\n List of supported operators:\n '>'  (greater than)\n '<'  (less than)\n '>=' (greater than or equal to)\n '<=' (less than or equal to)\n '==' (equal to)\n '!=' (not equal to)\n '~' (contains)\n\n Examples with filters that support all operators:\n * Get query with match on id:\n id==6ebd9c2d-494d-425a-aa91-24033f3abeec\n * Get me queries created after a timestamp, and with a specific state:\n created>=2017-04-05T13:30:00Z,state==IN_PROGRESS\n\
        \nFiltering is also allowed with limited operators on the following properties:\n * the referenced_datasets and userId property. This filter only allows the '==' equal to operator, and up to 10 dataset ids can be included by using the '||' logical OR operator. \n Example: referenced_datasets==aabbcc||ddeeff\n * the SQL property. This filter only allows the '~' contains operator, and only one SQL string WITHOUT COMMA (,) can be included.\n Example: sql~SELECT c1\n * the templateId property: This filter only allows the '==' equal to operator, and only one template ID can be included. \n Example: templateId=3e61c592-05de-422e-99be-24712c07fc29\n * the templateName property: This filter only allows the '~' contains operator, and only one templateName can be included. \n Example: templateName~sample-template-name \n * the client property. This filter only allows the '==' equal to operator, and only one SQL string WITHOUT COMMA (,) can be included.\n Example: client==API\n * the scheduleId and scheduleRunId properties. These filters only allow the '==' equal to operator.\n Example: scheduleId==bWFudWFsX18yMDE4LTEwLTEyVDA0OjM2OjE5LjkzNzI2Nw==,scheduleRunId==manual__2018-10-12T05:11:40.816520\n\
        \n Example of a complex search with multiple filters:\n * Get me queries that utilize two specific datasets,submitted by a particular user, and that include the string 'SELECT c1' in the SQL body: referenced_datasets==aabbcc||ddeeff,userId=1234@AdobeId,sql~SELECT c1"
      schema:
        type: string
    schedules_property:
      name: property
      in: query
      description: "Comma-separated filters. Multiple filters separated by commas can be passed.\n\n List of properties that allow filtering with all operators:\n created\n List of supported operators:\n '>'  (greater than)\n '<'  (less than)\n Examples with filters that support all operators:\n * Get me schedules created after a timestamp:\n created>2017-04-05T13:30:00Z\n\
        \nFiltering is also allowed with limited operators on the following properties:\n * the templateId property. This filter only allows the '==' equal to operator. \n Example: templateId==123412354\n * the userId property. This filter only allows the '==' equal to operator. \n Example: userId==123412354\n"
      schema:
        type: string
    schedules_runs_property:
      name: property
      in: query
      description: |-
        Comma-separated filters. Multiple filters separated by commas can be passed. Examples below are given with unsafe HTML characters for clarity, but all content MUST be HTML escaped.

         Properties that allow filtering :
         created
         Supported operators:
         '>'  (greater than)
         '<'  (less than)
         state
         Supported operators:
         '==' (equal to)
         '!=' (not equal to)
         externalTrigger
         List of supported operators:
         '==' (equal to)

         Examples with filters that support all operators:
         * Get me  runs created after a timestamp:
         created>2017-04-05T13:30:00Z
         * Get me  runs that have failed: state==FAILED * Get me runs that were manually triggered, and that succeeded: externalTrigger==true,state==SUCCESS
      schema:
        type: string
    excludeSoftDeleted:
      name: excludeSoftDeleted
      in: query
      description: Whether to include any queries that have been soft deleted. Defaults
        to true. Soft-deleting stops the query from being returned on GET requests to 
        the `/queries` endpoint but does not delete it from the system.
      schema:
        type: boolean
    excludeHidden:
      name: excludeHidden
      in: query
      description: Whether to include any low-level queries issued as part of the Postgres protocol that were not user driven. Examples include CURSOR definitions,
        FETCH, and Metadata queries. `true` is the default value.
      schema:
        type: boolean
    x-request-id:
      name: x-request-id
      in: header
      description: An optional header that serves as a tracking ID for the request.
        If one is not provided on the request, the server generates one automatically.
      schema:
        type: string
    User-Agent:
      name: User-Agent
      in: header
      description: The type of the client making the HTTP request.
      schema:
        type: string
  examples:
    SqlAcceleratedQueryDefinition:
      description: A payload for an accelerated query request that includes SQL in the payload.
      value:
        dbName: acmesbox1:acmeacceldb:accmeaggschema
        sql: SELECT * FROM accounts;                    
        name: Accelerated Query Sample
        description: A sample of an accelerated query.
    TemplateIdAcceleratedQueryDefinition:
      description: A payload for an accelerated query request that includes a template ID in the payload.
      value:
        dbName: acmesbox1:acmeacceldb:accmeaggschema 
        templateId: f7cb5155-29da-4b95-8131-8c5deadfbe7f
        name: A Templated Accelerated Query Sample
        description: A sample of an accelerated query request that uses a template ID. 
    SqlAcceleratedQueryResponse:
      description: A sample response for an accelerated query request that used SQL directly in the payload.
      value:
        queryId: ba7aa60c-f5ab-47de-b980-c30789108efe
        resultsMeta:
          _adhoc:
            type: string
            meta:xdmType: string
            properties:
              Industry_name:
                type: string
                meta:xdmType: string
                default:
              Industry_code:
                type: integer
                meta:xdmType: int,
                maximum: 2147483647
                minimum: -2147483648
              Value:
                type: number
                meta:xdmType: number
                maximum: null,
                minimum:
              Active_customer:
                type: boolean
                meta:xdmType: boolean
        results:
          Industry_name: Acme
          Industry_code: 23
          Value: 93141
          column_name_boolean_type: true
        request:
          dbName: acmesbox1:acmeacceldb:accmeaggschema
          sql: SELECT * FROM accounts;                    
          name: Accelerated Query Sample
          description: A sample of an accelerated query.
    TemplateIdAcceleratedQueryResponse:
      description: A sample response for an accelerated query request that used a template ID in the payload.
      value:
        queryId: ba7aa60c-f5ab-47de-b980-c30789108efe
        resultsMeta:
          _adhoc:
            type: string
            meta:xdmType: string
            properties:
              Industry_name:
                type: string
                meta:xdmType: string
                default:
              Industry_code:
                type: integer
                meta:xdmType: int,
                maximum: 2147483647
                minimum: -2147483648
              Value:
                type: number
                meta:xdmType: number
                maximum: null,
                minimum:
              Active_customer:
                type: boolean
                meta:xdmType: boolean
        results:
          Industry_name: Acme
          Industry_code: 23
          Value: 93141
          column_name_boolean_type: true
        request:
          dbName: acmesbox1:acmeacceldb:accmeaggschema
          templateId: f7cb5155-29da-4b95-8131-8c5deadfbe7f
          name: Second Accelerated Query Sample
          description: Another sample of an accelerated query.