Workday Extend Orchestration Steps API

openapi: 3.2.0
info:
  title: Workday Extend Workday Orchestration Orchestration Steps API
  description: APIs for creating and managing orchestrations that automate business processes and integrate with external systems. Developers visually build orchestrations using the Orchestration Builder to define flows, map data, and perform transformations. Orchestrations can be triggered from Extend apps, business processes, integration systems, or external systems via API triggers.
  version: v1
  contact:
    name: Workday Developer Support
    url: https://support.developer.workday.com/s/
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{baseUrl}/api/orchestrate/v1/{tenant}
  description: Workday Orchestrate API Server
  variables:
    baseUrl:
      default: api.workday.com
    tenant:
      default: tenant
security:
- OAuth2:
  - orchestrate:orchestrations
tags:
- name: Orchestration Steps
  description: Operations for managing individual steps within an orchestration flow, including connectors, transformations, and conditions.
paths:
  /orchestrations/{orchestrationId}/steps:
    get:
      operationId: listOrchestrationSteps
      summary: Workday Extend List orchestration steps
      description: Returns the collection of steps defined within the specified orchestration, including their order, type, and configuration.
      tags:
      - Orchestration Steps
      parameters:
      - $ref: '#/components/parameters/orchestrationId'
      responses:
        '200':
          description: Successful response with orchestration steps
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrchestrationStep'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
    OrchestrationStep:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the step
        name:
          type: string
          description: Name of the orchestration step
        type:
          type: string
          enum:
          - connector
          - transformation
          - condition
          - loop
          - subOrchestration
          - notification
          - workdayApi
          - restApi
          - soapApi
          description: The type of step
        order:
          type: integer
          description: Position of the step in the orchestration flow
        description:
          type: string
          description: Description of what this step does
        configuration:
          type: object
          additionalProperties: true
          description: Step-specific configuration parameters
  parameters:
    orchestrationId:
      name: orchestrationId
      in: path
      required: true
      description: The unique identifier of the orchestration
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            orchestrate:orchestrations: Manage orchestrations
            orchestrate:orchestrations:read: Read orchestration data
            orchestrate:executions: Execute orchestrations
externalDocs:
  description: Workday Orchestrations Documentation
  url: https://doc.workday.com/extend/orchestrations/