Workday Studio Integration Events API

openapi: 3.1.0
info:
  title: Workday Studio Integration Absence Management Integration Events 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 Events
  description: Monitor and retrieve integration execution events including run status, processing statistics, and error details.
paths:
  /integrationEvents:
    get:
      operationId: listIntegrationEvents
      summary: Workday Studio List Integration Events
      description: Returns a collection of integration event records showing the status and details of integration runs. Includes information about start time, end time, records processed, and any errors encountered during execution.
      tags:
      - Integration Events
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter events by execution status
        schema:
          type: string
          enum:
          - Completed
          - Failed
          - In_Progress
          - Cancelled
      - name: fromDate
        in: query
        description: Filter events starting from this date
        schema:
          type: string
          format: date-time
      - name: toDate
        in: query
        description: Filter events up to this date
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: Successful response with integration events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationEventsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /integrationEvents/{ID}:
    get:
      operationId: getIntegrationEvent
      summary: Workday Studio Retrieve a Specific Integration Event
      description: Returns the specified integration event including run status, start time, end time, records processed, records failed, and any error messages generated during integration execution.
      tags:
      - Integration Events
      parameters:
      - $ref: '#/components/parameters/ID'
      responses:
        '200':
          description: Successful response with the integration event
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationEvent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
  /integrationEvents/{ID}/logs:
    get:
      operationId: getIntegrationEventLogs
      summary: Workday Studio Retrieve Logs for an Integration Event
      description: Returns the execution logs for the specified integration event, including step-by-step processing details, warning messages, and error traces useful for debugging Studio integration assemblies.
      tags:
      - Integration Events
      parameters:
      - $ref: '#/components/parameters/ID'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response with integration event logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationLogsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    IntegrationLogsResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of log entries for the integration event
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationLogEntry'
    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
    IntegrationLogEntry:
      type: object
      description: A single log entry from an integration execution
      properties:
        timestamp:
          type: string
          format: date-time
          description: The time the log entry was created
        severity:
          type: string
          enum:
          - INFO
          - WARNING
          - ERROR
          description: The severity level of the log entry
        message:
          type: string
          description: The log message text
        componentName:
          type: string
          description: The name of the assembly component that generated the log entry
    IntegrationEventsResponse:
      type: object
      properties:
        total:
          type: integer
          description: Total number of integration events matching the query
        data:
          type: array
          items:
            $ref: '#/components/schemas/IntegrationEvent'
  responses:
    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:
    offset:
      name: offset
      in: query
      description: The zero-based index of the first object in a response collection
      schema:
        type: integer
        default: 0
    ID:
      name: ID
      in: path
      required: true
      description: The Workday ID of the resource
      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
  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