Workday Studio Service Directory API

Operations for discovering available web services, their versions, and WSDL definitions.

OpenAPI Specification

workday-studio-service-directory-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Studio Integration Absence Management Service Directory 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: Service Directory
  description: Operations for discovering available web services, their versions, and WSDL definitions.
paths:
  /Human_Resources:
    get:
      operationId: getHumanResourcesService
      summary: Workday Studio Retrieve Human Resources Service Metadata
      description: Returns metadata about the Human Resources web service including available operations, supported versions, and WSDL location.
      tags:
      - Service Directory
      responses:
        '200':
          description: Service metadata for Human Resources
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceMetadata'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: A high-level error message
        errors:
          type: array
          items:
            type: object
            properties:
              error:
                type: string
              field:
                type: string
              message:
                type: string
    ServiceMetadata:
      type: object
      description: Metadata about a Workday web service including its operations and supported versions.
      properties:
        serviceName:
          type: string
          description: The name of the web service
        version:
          type: string
          description: The current version of the web service
        wsdlUrl:
          type: string
          format: uri
          description: The URL to the WSDL definition for the service
        operations:
          type: array
          description: The list of operations available in the service
          items:
            type: object
            properties:
              operationName:
                type: string
                description: The name of the operation
              description:
                type: string
                description: A description of the operation
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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