Workday Extend Apps API

openapi: 3.2.0
info:
  title: Workday Extend REST Apps API
  description: RESTful APIs for building and managing Workday Extend applications, including app registration, deployment, configuration, and lifecycle management. Enables developers to create custom applications that integrate seamlessly with the Workday platform and extend its core functionality.
  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/extend/v1/{tenant}
  description: Workday Extend API Server
  variables:
    baseUrl:
      default: api.workday.com
    tenant:
      default: tenant
security:
- OAuth2:
  - extend:apps
tags:
- name: Apps
  description: Operations for managing Extend applications including registration, deployment, and configuration.
paths:
  /apps:
    get:
      operationId: listApps
      summary: Workday Extend List Extend applications
      description: Returns a collection of Workday Extend applications registered within the tenant. Supports filtering by status, name, and other attributes.
      tags:
      - Apps
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Successful response with a collection of applications
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    description: Total number of applications matching the query
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/App'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
    post:
      operationId: createApp
      summary: Workday Extend Register a new Extend application
      description: Registers a new Workday Extend application within the tenant. The app definition includes metadata, permissions, and configuration schema.
      tags:
      - Apps
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppCreate'
      responses:
        '201':
          description: Application successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
  /apps/{appId}:
    get:
      operationId: getApp
      summary: Workday Extend Retrieve an Extend application
      description: Returns the details of a specific Workday Extend application including its metadata, configuration, deployment status, and version history.
      tags:
      - Apps
      parameters:
      - $ref: '#/components/parameters/appId'
      responses:
        '200':
          description: Successful response with the application details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateApp
      summary: Workday Extend Update an Extend application
      description: Updates the metadata or configuration of an existing Workday Extend application. Only the fields provided in the request body are updated.
      tags:
      - Apps
      parameters:
      - $ref: '#/components/parameters/appId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppUpdate'
      responses:
        '200':
          description: Application successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/App'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteApp
      summary: Workday Extend Delete an Extend application
      description: Removes a Workday Extend application registration from the tenant. The application must be undeployed before deletion.
      tags:
      - Apps
      parameters:
      - $ref: '#/components/parameters/appId'
      responses:
        '204':
          description: Application successfully deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 20
        maximum: 100
    appId:
      name: appId
      in: path
      required: true
      description: The unique identifier of the Extend application
      schema:
        type: string
    search:
      name: search
      in: query
      description: Search term to filter results
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
  schemas:
    App:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the Extend application
        descriptor:
          type: string
          description: Display name of the application
        name:
          type: string
          description: The registered name of the application
        description:
          type: string
          description: Detailed description of the application purpose and functionality
        status:
          type: string
          enum:
          - draft
          - published
          - deployed
          - deprecated
          description: Current lifecycle status of the application
        category:
          type: string
          description: The application category within Workday
        owner:
          $ref: '#/components/schemas/ResourceReference'
        currentVersion:
          $ref: '#/components/schemas/ResourceReference'
        createdOn:
          type: string
          format: date-time
          description: Timestamp when the application was created
        lastModified:
          type: string
          format: date-time
          description: Timestamp when the application was last modified
        href:
          type: string
          format: uri
          description: The API resource URL for this application
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error code identifying the type of error
        message:
          type: string
          description: Human-readable error message
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
    ResourceReference:
      type: object
      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 resource URL
    AppUpdate:
      type: object
      properties:
        name:
          type: string
          description: Updated application name
          maxLength: 255
        description:
          type: string
          description: Updated application description
        category:
          type: string
          description: Updated application category
    AppCreate:
      type: object
      required:
      - name
      - description
      properties:
        name:
          type: string
          description: The name of the Extend application
          maxLength: 255
        description:
          type: string
          description: Description of the application
        category:
          type: string
          description: The application category
  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'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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
          scopes:
            extend:apps: Manage Extend applications
            extend:apps:read: Read Extend application data
externalDocs:
  description: Workday Extend Documentation
  url: https://doc.workday.com/extend/