Workday Extend App Configurations API

openapi: 3.1.0
info:
  title: Workday Extend Workday Custom Objects App Configurations API
  description: APIs for defining and managing custom objects that extend Workday's data model to meet specific business needs. When new custom objects and business processes are built, a public REST API is automatically created for other developers and processes to use. Supports both single-instance and multi-instance custom objects attached to standard Workday business objects such as workers and organizations.
  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/customObjects/v1/{tenant}
  description: Workday Custom Objects API Server
  variables:
    baseUrl:
      default: api.workday.com
    tenant:
      default: tenant
security:
- OAuth2:
  - customObjects:manage
tags:
- name: App Configurations
  description: Operations for managing application configuration settings and environment-specific parameters.
paths:
  /apps/{appId}/configurations:
    get:
      operationId: listAppConfigurations
      summary: Workday Extend List application configurations
      description: Returns the configuration settings for the specified Extend application, including environment-specific parameters and feature flags.
      tags:
      - App Configurations
      parameters:
      - $ref: '#/components/parameters/appId'
      responses:
        '200':
          description: Successful response with configuration settings
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AppConfiguration'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
    put:
      operationId: updateAppConfigurations
      summary: Workday Extend Update application configurations
      description: Updates the configuration settings for the specified Extend application. Replaces all configuration values with the provided settings.
      tags:
      - App Configurations
      parameters:
      - $ref: '#/components/parameters/appId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppConfigurationUpdate'
      responses:
        '200':
          description: Configuration successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppConfiguration'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  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'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    AppConfigurationUpdate:
      type: object
      properties:
        configurations:
          type: array
          items:
            type: object
            required:
            - key
            - value
            properties:
              key:
                type: string
              value:
                type: string
              description:
                type: string
              dataType:
                type: string
                enum:
                - string
                - number
                - boolean
                - json
    AppConfiguration:
      type: object
      properties:
        id:
          type: string
          description: Configuration identifier
        key:
          type: string
          description: Configuration setting key
        value:
          type: string
          description: Configuration setting value
        description:
          type: string
          description: Description of the configuration setting
        dataType:
          type: string
          enum:
          - string
          - number
          - boolean
          - json
          description: Data type of the configuration value
        isSecret:
          type: boolean
          description: Whether the value is stored as a secret
    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
  parameters:
    appId:
      name: appId
      in: path
      required: true
      description: The unique identifier of the Extend application
      schema:
        type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://{baseUrl}/authorize
          tokenUrl: https://{baseUrl}/oauth2/{tenant}/token
          scopes:
            customObjects:manage: Manage custom object definitions and instances
            customObjects:read: Read custom object data
externalDocs:
  description: Workday Custom Objects Documentation
  url: https://doc.workday.com/extend/custom-objects/