openapi: 3.2.0
info:
  title: Adobe Suite Schedules API
  version: '1.0'
  description: 'Operations tagged Schedules across 2 of this provider''s published API definitions: adobe-suite-aep-query-service-openapi.yaml, adobe-suite-aep-segmentation-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: //{environment}.adobe.io/data/foundation/query
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
- url: //{environment}.adobe.io/data/core/ups
  variables:
    environment:
      default: platform
      enum:
      - platform
      - platform-stage
tags:
- 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.
paths:
  /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
    servers:
    - url: //{environment}.adobe.io/data/foundation/query
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /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
    servers:
    - url: //{environment}.adobe.io/data/foundation/query
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /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.\n\n Properties that allow filtering :\n created\n Supported operators:\n '>'  (greater than)\n '<'  (less than)\n state\n Supported operators:\n '==' (equal to)\n '!=' (not equal to)\n externalTrigger\n List of supported operators:\n '==' (equal to)\n\n Examples with filters that support all operators:\n * Get me  runs created after a timestamp:\n created>2017-04-05T13:30:00Z\n * 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: {}
    servers:
    - url: //{environment}.adobe.io/data/foundation/query
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /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
    servers:
    - url: //{environment}.adobe.io/data/foundation/query
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /config/schedules:
    get:
      tags:
      - Schedules
      summary: List schedules
      operationId: listSchedules
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: x-request-id
        in: header
        description: An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
        schema:
          type: string
      - name: start
        in: query
        description: Return results from a specific page offset. For example, `start=3`.
        schema:
          type: integer
      - name: limit
        in: query
        description: Limit response to a specific number of objects. Must be a positive number. For example, `limit=10`
        schema:
          type: integer
      responses:
        200:
          x-summary: Success
          description: A list of schedules is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchedulesResponse'
        403:
          x-summary: Missing access permissions
          description: Access is forbidden.
          content: {}
        500:
          x-summary: Internal service error
          description: There was an issue reading the schedules.
          content: {}
        503:
          x-summary: Service unavailable
          description: The service is unavailable.
          content: {}
    post:
      tags:
      - Schedules
      summary: Create a schedule
      description: This endpoint is used to create a schedule, including specifying the time when the schedule should be triggered. Note that the scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
      operationId: createSchedule
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: x-request-id
        in: header
        description: An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
        schema:
          type: string
      requestBody:
        description: "- **name**: **(Required)** The name of schedule. Must be a string. - **type**: **(Required)** The job type in string format.\n  - Supported types: `batch_segmentation` and `export`.\n- **properties**: **(Required)** An object containing additional properties related to the schedule. - **properties.segments**: **(Required when `type` equals `batch_segmentation`)** Using `[\\\"*\\\"]` ensures all segment definitions are included. - **schedule**: **(Required)** A string containing the job schedule. Jobs can only be scheduled to run once a day, meaning you cannot schedule a job to run more than once during a 24 hour period. The example shown (`0 30 13 * * ?`) means the job is triggered every day at 13:30:00 UTC. For more information, please review the [cron expression format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) documentation. - **state**: *(Optional)* String containing the schedule state. Available values: `active` and `inactive`. Default value is `inactive`.\""
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleCreate'
        required: true
      responses:
        200:
          x-summary: Success
          description: The schedule was successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        400:
          x-summary: Error
          description: The schedule posted is invalid.
          content: {}
        403:
          x-summary: Missing access permissions
          description: Access is forbidden.
          content: {}
        500:
          x-summary: Internal service error
          description: There was an issue reading schedules.
          content: {}
        503:
          x-summary: Service unavailable
          description: The service is unavailable.
          content: {}
      x-codegen-request-body-name: body
    servers:
    - url: //{environment}.adobe.io/data/core/ups
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
  /config/schedules/{SCHEDULE_ID}:
    get:
      tags:
      - Schedules
      summary: Retrieve a schedule
      description: The scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
      operationId: retrieveSchedule
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: SCHEDULE_ID
        in: path
        description: The ID of the schedule against which the operation is being performed.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
        schema:
          type: string
      responses:
        200:
          x-summary: Success
          description: The schedule was successfully returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        403:
          x-summary: Missing access permissions
          description: Access is forbidden.
          content: {}
        404:
          x-summary: Not found
          description: The schedule was not found.
          content: {}
        503:
          x-summary: Service unavailable
          description: The service is unavailable.
          content: {}
    delete:
      tags:
      - Schedules
      summary: Delete a schedule
      operationId: deleteSchedule
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: SCHEDULE_ID
        in: path
        description: The ID of the schedule against which the operation is being performed.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
        schema:
          type: string
      responses:
        204:
          x-summary: Success
          description: (No content) The schedule was deleted successfully deleted.
          content: {}
        403:
          x-summary: Missing access permissions
          description: Access is forbidden.
          content: {}
        404:
          x-summary: Not found
          description: The schedule was not found.
          content: {}
        503:
          x-summary: Service unavailable
          description: The service is unavailable.
          content: {}
    patch:
      tags:
      - Schedules
      summary: Update a schedule
      description: This endpoint is ued to update a schedule, including changing the trigger time or enabling/disabling the schedule. Note that the scheduler is updated periodically (approximately every 30 minutes), so changes to a schedule may not go into effect immediately.
      operationId: updateSchedule
      parameters:
      - $ref: '#/components/parameters/authorization'
      - $ref: '#/components/parameters/content-type'
      - $ref: '#/components/parameters/x-api-key'
      - $ref: '#/components/parameters/x-gw-ims-org-id'
      - $ref: '#/components/parameters/x-sandbox-name'
      - name: SCHEDULE_ID
        in: path
        description: The ID of the schedule against which the operation is being performed.
        required: true
        schema:
          type: string
      - name: x-request-id
        in: header
        description: An optional header that may be used for debugging purposes when investigating issues with a workflow. The same ID can be used to identify a single request to the service from a flow. A new ID should be created for each request.
        schema:
          type: string
      requestBody:
        description: 'Use JSON Patch formatting to update the schedule. Note: You must use an "add" operation to add or update the given "path" with the given "value".'
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/schedulePatchOperation'
            examples:
              Update schedule state:
                value:
                - op: add
                  path: /state
                  value: active
              Update cron schedule:
                value:
                - op: add
                  path: /schedule
                  value: 0 0 2 * * ?
        required: true
      responses:
        204:
          x-summary: Success
          description: (No content) The schedule was successfully updated.
          content: {}
        400:
          x-summary: Error
          description: The schedule is invalid.
          content: {}
        403:
          x-summary: Missing access permissions
          description: Access is forbidden.
          content: {}
        429:
          x-summary: Rate limit
          description: There are too many schedule update requests processing at the moment. Try again at a later time.
          content: {}
        500:
          x-summary: Internal service error
          description: There was an issue reading the schedule.
          content: {}
        503:
          x-summary: Service unavailable
          description: The service is unavailable.
          content: {}
      x-codegen-request-body-name: body
    servers:
    - url: //{environment}.adobe.io/data/core/ups
      variables:
        environment:
          default: platform
          enum:
          - platform
          - platform-stage
components:
  schemas:
    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.
    _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.
    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
    schedules_run_details:
      type: object
      properties:
        created:
          type: string
          description: The execution date of the run provided in the request path.
          example: 2022-06-02 10:56:00+00:00
        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_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-21 15:41:00+00:00
        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.
    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.
    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.
    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
    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.
    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-03 11:04:03.236972+00:00
        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-03 11:03:54.095191+00:00
        taskId:
          type: string
          description: The task ID of this run.
          example: 0tx2JTP56S
    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-08 12:30:00+00:00
        endDate:
          type: string
          description: The end date for the scheduled query runs.
          example: 2021-01-08 12:30:00+00:00
        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_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_create_request:
      required:
      - query
      - schedule
      type: object
      properties:
        query:
          $ref: '#/components/schemas/query_def'
        schedule:
          $ref: '#/components/schemas/schedules_request'
    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-08 12:30:00+00:00
        endDate:
          type: string
          description: The end date for the scheduled query runs.
          example: 2021-01-08 12:30:00+00:00
        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.
    schedulePatchOperation:
      required:
      - op
      - path
      - value
      type: object
      properties:
        op:
          type: string
          description: The patch operation you are performing.
          example: add
          enum:
          - add
        path:
          type: string
          description: The path of the attribute that needs to be updated. This value can either be `/state` or `/schedule`, depending what you want to update.
          example: /state
        value:
          type: string
          description: The updated value for the field you want to update. If using the `/state` path, this value can either be active or inactive. If using the `/schedule` path, this will be the updated cron schedule.
          example: active
      description: Patch operation
    SchedulesResponse:
      required:
      - _page
      - children
      type: object
      properties:
        _page:
          $ref: '#/components/schemas/SchedulesPage'
        children:
          type: array
          items:
            $ref: '#/components/schemas/Schedule'
    Schedule:
      required:
      - name
      - properties
      - schedule
      - type
      type: object
      properties:
        id:
          type: string
          description: A unique, read-only, system-generated schedule ID.
          example: 5e61e66e-e8b4-4a7b-8d41-70c74b0b981a
        name:
          type: string
          description: The name of the schedule.
          example: profile-default
        type:
          type: string
          description: The job type for the schedule.
          example: batch_segmentation
          enum:
          - batch_segmentation
        schedule:
          type: string
          description: A cron expression stating when the schedule should be triggered. Jobs can only be scheduled to run once a day, meaning you cannot schedule a job to run more than once during a 24 hour period. For more information, please review the [cron expression format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) documentation.
          example: 0 0 1 * * ?
        state:
          type: string
          description: The state of the schedule. If the schedule is inactive, it must be activated before it will be triggered.
          example: inactive
          enum:
          - active
          - inactive
        properties:
          required:
          - segments
          type: object
          properties:
            segments:
              type: array
              description: This field is required if the job type is batch_segmentation. It holds a list of segment definitions which need to be evaluated at the scheduled time. Use `*` to evaluate all segment definitions.
              items:
                type: string
                example: '*'
          description: schedule properties
        createEpoch:
          type: integer
          description: The timestamp, as unix time in seconds, for when the schedule was created.
          example: 1234567890
        updateEpoch:
          type: integer
          description: The timestamp, as unix time in seconds, for when the schedule was last updated.
          example: 1234567890
      description: The schedule entity.
    ScheduleCreate:
      required:
      - name
      - properties
      - schedule
      - type
      type: object
      properties:
        name:
          type: string
          description: The name of the schedule being created.
          example: profile-default
        type:
          type: string
          description: The job type.
          example: batch_segmentation
          enum:
          - batch_segmentation
        properties:
          required:
          - segments
          type: object
          properties:
            segments:
              type: array
              description: This field is required if the job type is batch_segmentation. It holds a list of segment definitions which need to be evaluated at the scheduled time. Use `*` to evaluate all segment definitions.
              items:
                type: string
                example: '*'
          description: schedule properties
        schedule:
          type: string
          description: A cron expression stating when the schedule should be triggered. Jobs can only be scheduled to run once a day, meaning you cannot schedule a job to run more than once during a 24 hour period. For more information, please review the [cron expression format](http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html) documentation.
          example: 0 0 1 * * ?
        state:
          type: string
          description: The state of the schedule. If the schedule is inactive, it must be activated before it will be triggered.
          example: inactive
          enum:
          - active
          - inactive
      description: The request body for creating a schedule.
    SchedulesPage:
      required:
      - pageSize
      - totalCount
      type: object
      properties:
        totalCount:
          type: number
          description: The total number of schedules.
          example: 100.0
        pageSize:
          type: number
          description: The number of schedules per page.
          example: 100.0
        next:
          type: string
          description: The offset to start pagination for the schedules.
          example: '1'
  parameters:
    authorization:
      name: Authorization
      in: header
      description: The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the [authentication tutorial](http://www.adobe.com/go/platform-api-authentication-en).
      required: true
      schema:
        type: string
    content-type:
      name: Content-Type
      in: header
      description: The type of content being sent in the body of the request. Should be 'application/json'.
      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 [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 [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: All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the [sandboxes overview](https://adobe.com/go/sandbox-overview-en) for more information.
      required: true
      schema:
        type: string
x-refined-from:
- adobe-suite-aep-query-service-openapi.yaml
- adobe-suite-aep-segmentation-openapi.yaml
x-original-swagger-version: '2.0'