Workday Studio Integration Systems API

openapi: 3.1.0
info:
  title: Workday Studio Integration Absence Management Integration Systems API
  description: API for building and deploying custom integrations using Workday Studio, an Eclipse-based IDE that provides a graphical development environment with drag-and-drop reusable components for creating sophisticated integrations with flow control, data transformation, error handling, and scripting. Enables programmatic management of integration systems, events, assemblies, and launch parameters within the Workday platform.
  version: v1
  contact:
    name: Workday API Support
    email: api-support@workday.com
    url: https://community.workday.com
  license:
    name: Proprietary
    url: https://www.workday.com/en-us/legal/site-terms.html
  termsOfService: https://www.workday.com/en-us/legal.html
servers:
- url: https://{baseUrl}/ccx/service/{tenant}
  description: Workday Integration Services Server
  variables:
    baseUrl:
      default: wd2-impl-services1.workday.com
      description: The Workday data center hostname
    tenant:
      default: tenant
      description: The Workday tenant name
security:
- OAuth2:
  - r:integrations
  - w:integrations
tags:
- name: Integration Systems
  description: Manage integration systems configured in the Workday tenant, including Studio-built integrations and core connector configurations.
paths:
  /integrationSystems:
    get:
      operationId: listIntegrationSystems
      summary: Workday Studio List Integration Systems
      description: Returns a collection of integration systems configured in the tenant, including Studio-built integrations, core connectors, and document transformation integrations. Supports filtering by system name, type, and active status.
      tags:
      - Integration Systems
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Successful response with integration systems
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationSystemsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /integrationSystems/{ID}:
    get:
      operationId: getIntegrationSystem
      summary: Workday Studio Retrieve a Specific Integration System
      description: Returns the specified integration system with its full configuration details including template reference, launch parameters, schedule settings, and notification configuration.
      tags:
      - Integration Systems
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the integration system
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationSystem'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /integrationSystems/{ID}/launch:
    post:
      operationId: launchIntegration
      summary: Workday Studio Launch an Integration System
      description: Triggers execution of the specified integration system. Accepts optional launch parameters to control runtime behavior. Returns the newly created integration event representing the running integration instance.
      tags:
      - Integration Systems
      parameters:
      - $ref: '#/components/parameters/ID'
      requestBody:
        description: Optional launch parameters for the integration execution
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IntegrationLaunchRequest'
      responses:
        '201':
          description: Integration launched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationEvent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Invalid request parameters
      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'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  parameters:
    ID:
      name: ID
      in: path
      required: true
      description: The Workday ID of the resource
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    search:
      name: search
      in: query
      description: Search string used to filter results by name or descriptor
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: The maximum number of objects in a single response. Default is 20, maximum is 100.
      schema:
        type: integer
        default: 20
        maximum: 100
  schemas:
    ResourceReference:
      type: object
      description: A reference to a Workday resource with its identifier and display name
      properties:
        id:
          type: string
          description: The Workday ID of the referenced resource
        descriptor:
          type: string
          description: The display name of the referenced resource
        href:
          type: string
          format: uri
          description: The API URL to retrieve the full resource
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: A high-level error message
        errors:
          type: array
          description: Detailed list of validation or processing errors
          items:
            type: object
            properties:
              error:
                type: string
                description: Error code or type
              field:
                type: string
                description: The field that caused the error
              message:
                type: string
                description: Human-readable error message
    IntegrationEvent:
      type: object
      description: A record of an integration execution, tracking the run status, timing, and processing statistics of an integration system run.
      properties:
        id:
          type: string
          description: The unique Workday identifier for the integration event
        descriptor:
          type: string
          description: The display name of the integration event
        integrationSystem:
          $ref: '#/components/schemas/ResourceReference'
        status:
          type: string
          enum:
          - Completed
          - Failed
          - In_Progress
          - Cancelled
          description: The execution status of the integration
        startDateTime:
          type: string
          format: date-time
          description: The date and time the integration started
        endDateTime:
          type:
          - string
          - 'null'
          format: date-time
          description: The date and time the integration completed
        recordsProcessed:
          type: integer
          description: The number of records successfully processed
        recordsFailed:
          type: integer
          description: The number of records that failed processing
        initiatedBy:
          $ref: '#/components/schemas/ResourceReference'
        errorMessage:
          type: string
          description: Summary error message if the integration failed
    IntegrationLaunchRequest:
      type: object
      description: Request body for launching an integration system
      properties:
        launchParameters:
          type: array
          description: Key-value pairs of launch parameters for the integration run
          items:
            type: object
            properties:
              name:
                type: string
                description: The name of the launch parameter
              value:
                type: string
                description: The value to set for the launch parameter
    IntegrationSystemsResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of integration systems matching the query
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationSystem'
    IntegrationSystem:
      type: object
      description: An integration system configured in the Workday tenant, representing a deployed Studio integration or core connector configuration.
      properties:
        id:
          type: string
          description: The unique Workday identifier for the integration system
        descriptor:
          type: string
          description: The display name of the integration system
        integrationSystemName:
          type: string
          description: The configured name of the integration system
        template:
          $ref: '#/components/schemas/ResourceReference'
        integrationServiceProvider:
          $ref: '#/components/schemas/ResourceReference'
        isActive:
          type: boolean
          description: Whether the integration system is currently active
        lastRunDateTime:
          type: string
          format: date-time
          description: The date and time of the last successful execution
        scheduleFrequency:
          type: string
          description: The configured schedule frequency for automatic execution
        notificationRecipients:
          type: array
          description: Users or groups who receive notifications about integration events
          items:
            $ref: '#/components/schemas/ResourceReference'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          refreshUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            r:integrations: Read integration data
            w:integrations: Write integration data
externalDocs:
  description: Workday Studio Integration Documentation
  url: https://doc.workday.com/reader/wsiU0cnNjCc_k7shLNxLEA/HdIduH8HQGat1qdv1nXNVQ