Workday Common v1 — full pinned service

This reference is readable without JavaScript. Download the OpenAPI document.

Runtime

/api/purple-suite/{instanceId}/contracts/hris/workday

[
  {
    "method": "post",
    "path": "/common/v1/validateWorktags",
    "operationId": "workdayCommonPostValidateWorktags"
  },
  {
    "method": "get",
    "path": "/common/v1/organizations",
    "operationId": "workdayCommonGetOrganizations"
  },
  {
    "method": "get",
    "path": "/common/v1/organizations/:ID",
    "operationId": "workdayCommonGetOrganizationsByID"
  },
  {
    "method": "get",
    "path": "/common/v1/supervisoryOrganizations",
    "operationId": "workdayCommonGetSupervisoryOrganizations"
  },
  {
    "method": "get",
    "path": "/common/v1/supervisoryOrganizations/:ID/workers/:subresourceID",
    "operationId": "workdayCommonGetSupervisoryOrganizationsByIDWorkersBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/supervisoryOrganizations/:ID/workers",
    "operationId": "workdayCommonGetSupervisoryOrganizationsByIDWorkers"
  },
  {
    "method": "get",
    "path": "/common/v1/supervisoryOrganizations/:ID",
    "operationId": "workdayCommonGetSupervisoryOrganizationsByID"
  },
  {
    "method": "get",
    "path": "/common/v1/jobChangeReasons",
    "operationId": "workdayCommonGetJobChangeReasons"
  },
  {
    "method": "get",
    "path": "/common/v1/jobChangeReasons/:ID",
    "operationId": "workdayCommonGetJobChangeReasonsByID"
  },
  {
    "method": "get",
    "path": "/common/v1/businessTitleChanges/:ID",
    "operationId": "workdayCommonGetBusinessTitleChangesByID"
  },
  {
    "method": "get",
    "path": "/common/v1/organizationTypes",
    "operationId": "workdayCommonGetOrganizationTypes"
  },
  {
    "method": "get",
    "path": "/common/v1/organizationTypes/:ID",
    "operationId": "workdayCommonGetOrganizationTypesByID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers",
    "operationId": "workdayCommonGetWorkers"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/directReports",
    "operationId": "workdayCommonGetWorkersByIDDirectReports"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/directReports/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDDirectReportsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/organizations",
    "operationId": "workdayCommonGetWorkersByIDOrganizations"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/organizations/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDOrganizationsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/inboxTasks/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDInboxTasksBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/timeOffEntries",
    "operationId": "workdayCommonGetWorkersByIDTimeOffEntries"
  },
  {
    "method": "post",
    "path": "/common/v1/workers/:ID/businessTitleChanges",
    "operationId": "workdayCommonPostWorkersByIDBusinessTitleChangesTypeMe",
    "discriminator": {
      "kind": "query",
      "operation": "workdayCommonPostWorkersByIDBusinessTitleChangesTypeMe",
      "parameter": "type",
      "value": "me"
    }
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/history/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDHistoryBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/timeOffEntries/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDTimeOffEntriesBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/timeOffPlans/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDTimeOffPlansBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/businessTitleChanges",
    "operationId": "workdayCommonGetWorkersByIDBusinessTitleChanges"
  },
  {
    "method": "post",
    "path": "/common/v1/workers/:ID/businessTitleChanges",
    "operationId": "workdayCommonPostWorkersByIDBusinessTitleChanges"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/supervisoryOrganizationsManaged",
    "operationId": "workdayCommonGetWorkersByIDSupervisoryOrganizationsManaged"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/timeOffPlans",
    "operationId": "workdayCommonGetWorkersByIDTimeOffPlans"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/paySlips/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDPaySlipsBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/history",
    "operationId": "workdayCommonGetWorkersByIDHistory"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID",
    "operationId": "workdayCommonGetWorkersByID"
  },
  {
    "method": "post",
    "path": "/common/v1/workers/:ID/jobChanges",
    "operationId": "workdayCommonPostWorkersByIDJobChanges"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/inboxTasks",
    "operationId": "workdayCommonGetWorkersByIDInboxTasks"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/supervisoryOrganizationsManaged/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDSupervisoryOrganizationsManagedBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/paySlips",
    "operationId": "workdayCommonGetWorkersByIDPaySlips"
  },
  {
    "method": "get",
    "path": "/common/v1/workers/:ID/businessTitleChanges/:subresourceID",
    "operationId": "workdayCommonGetWorkersByIDBusinessTitleChangesBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/currencies",
    "operationId": "workdayCommonGetCurrencies"
  },
  {
    "method": "get",
    "path": "/common/v1/currencies/:ID",
    "operationId": "workdayCommonGetCurrenciesByID"
  },
  {
    "method": "get",
    "path": "/common/v1/customers/:ID/activities",
    "operationId": "workdayCommonGetCustomersByIDActivities"
  },
  {
    "method": "get",
    "path": "/common/v1/customers/:ID/activities/:subresourceID",
    "operationId": "workdayCommonGetCustomersByIDActivitiesBySubresourceID"
  },
  {
    "method": "get",
    "path": "/common/v1/customers/:ID",
    "operationId": "workdayCommonGetCustomersByID"
  }
]

Credentials

OAuth 2.0 bearer token: Authorization: Bearer <TOKEN>
The painted runtime validates a PurpleSuite instance key in the Workday bearer-token transport.
Credential model: instance-key

Coverage and limitations

{
  "documentScope": "full",
  "runtimeFidelity": "modeled",
  "counts": {
    "operations": 40
  },
  "notes": [
    "All 40 operations in the pinned 2026-07-27 Workday Common v1 artifact are mounted: 0 captured handlers and 40 per-instance repository-backed operations.",
    "Modeled reads return stored resources, relationship-scoped collections, or native 404s; modeled writes provide read-after-write lifecycle behavior and never return request-seeded schema witnesses.",
    "Two artifact paths contain ?type=archive; runtime routing canonicalizes only those exact single-value query discriminators while retaining both official operation identities.",
    "Full means the complete pinned service artifact, not the whole Workday platform.",
    "Explicitly excluded: Workday Web Services (SOAP/WWS); Workday Graph API; Workday Query Language (WQL), a separate Platform API family; Reports-as-a-Service (RaaS) and tenant custom reports; Finance, Payroll, Student, and non-HR Platform REST services; Experimental alpha, beta, and labs services; Tenant-configured actions absent from the pinned public artifacts."
  ]
}

The public Workday API.

Servers

[
  {
    "url": "/api/purple-suite/{instanceId}/contracts/hris/workday",
    "description": "PurpleSuite Workday-painted instance boundary",
    "variables": {
      "instanceId": {
        "default": "INSTANCE_ID",
        "description": "PurpleSuite instance identifier"
      }
    }
  }
]

Authentication schemes

{
  "OAuth2": {
    "type": "oauth2",
    "flows": {
      "implicit": {
        "authorizationUrl": "https://<tenantAuthorizationHostname>",
        "scopes": {}
      }
    }
  }
}

Each operation lists its security requirements. An empty security array permits an unauthenticated request. Use the scheme and headers declared for the selected contract.

Operations

POST /common/v1/validateWorktags
GET /common/v1/organizations
GET /common/v1/organizations/{ID}
GET /common/v1/supervisoryOrganizations
GET /common/v1/supervisoryOrganizations/{ID}/workers/{subresourceID}
GET /common/v1/supervisoryOrganizations/{ID}/workers
GET /common/v1/supervisoryOrganizations/{ID}
GET /common/v1/jobChangeReasons
GET /common/v1/jobChangeReasons/{ID}
GET /common/v1/businessTitleChanges/{ID}
GET /common/v1/organizationTypes
GET /common/v1/organizationTypes/{ID}
GET /common/v1/workers
GET /common/v1/workers/{ID}/directReports
GET /common/v1/workers/{ID}/directReports/{subresourceID}
GET /common/v1/workers/{ID}/organizations
GET /common/v1/workers/{ID}/organizations/{subresourceID}
GET /common/v1/workers/{ID}/inboxTasks/{subresourceID}
GET /common/v1/workers/{ID}/timeOffEntries
POST /common/v1/workers/{ID}/businessTitleChanges?type=me
GET /common/v1/workers/{ID}/history/{subresourceID}
GET /common/v1/workers/{ID}/timeOffEntries/{subresourceID}
GET /common/v1/workers/{ID}/timeOffPlans/{subresourceID}
GET /common/v1/workers/{ID}/businessTitleChanges
POST /common/v1/workers/{ID}/businessTitleChanges
GET /common/v1/workers/{ID}/supervisoryOrganizationsManaged
GET /common/v1/workers/{ID}/timeOffPlans
GET /common/v1/workers/{ID}/paySlips/{subresourceID}
GET /common/v1/workers/{ID}/history
GET /common/v1/workers/{ID}
POST /common/v1/workers/{ID}/jobChanges
GET /common/v1/workers/{ID}/inboxTasks
GET /common/v1/workers/{ID}/supervisoryOrganizationsManaged/{subresourceID}
GET /common/v1/workers/{ID}/paySlips
GET /common/v1/workers/{ID}/businessTitleChanges/{subresourceID}
GET /common/v1/currencies
GET /common/v1/currencies/{ID}
GET /common/v1/customers/{ID}/activities
GET /common/v1/customers/{ID}/activities/{subresourceID}
GET /common/v1/customers/{ID}

POST /common/v1/validateWorktags

(End of Life Date: 2025-08-03 ) Validates allowed and required worktag types and worktag combinations so that you can correct errors before you submit transactions.

Validate the allowed and required worktag types and worktag combinations based on the configuration in the 'Maintain Related Worktag Usage' and 'Maintain Worktag Usage' tasks and related worktags so that you can correct errors before you submit transactions using web services. This method is a read-only POST that doesn't add data to Workday. Secured By Domain: Manage: Related Worktags, Worktag REST API Scope: Common Financial Management, Worktags

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "validateWorktags"
  ],
  "summary": "(End of Life Date: 2025-08-03 ) Validates allowed and required worktag types and worktag combinations so that you can correct errors before you submit transactions.",
  "description": "Validate the allowed and required worktag types and worktag combinations based on the configuration in the 'Maintain Related Worktag Usage' and 'Maintain Worktag Usage' tasks and related worktags so that you can correct errors before you submit transactions using web services. This method is a read-only POST that doesn't add data to Workday.\n\n<b>Secured By Domain:</b> Manage: Related Worktags, Worktag REST API\n\n<b>Scope:</b> Common Financial Management, Worktags",
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/validateWorktagInput_aa8aaaaeca3910002fd14d954eea0371"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/validateWorktagInput_aa8aaaaeca3910002fd14d954eea0371"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nAllow Built-in Worktags must be either true or false.\n\nDuplicate worktag types are not allowed.\n\nTaggable Configuration is required.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "deprecated": true,
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "aa8aaaaeca3910002f9fbcab1262036e",
  "x-workday-secured-by-domains": [
    "Manage: Related Worktags",
    "Worktag REST API"
  ]
}

GET /common/v1/organizations

Retrieves a collection of organizations.

Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "organizations"
  ],
  "summary": "Retrieves a collection of organizations.",
  "description": "\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "organizationType",
      "in": "query",
      "description": "Reference to an Organization Type. Example: Organization Type WID. Requests must provide an Organization Type.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/organizationSummary_a03132f19b911000119b05cfd7cf0032"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "a03132f19b91100011bb405bfeb70034",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/organizations/{ID}

Retrieves an organization instance.

Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "organizations"
  ],
  "summary": "Retrieves an organization instance.",
  "description": "\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/organizationSummary_a03132f19b911000119b05cfd7cf0032"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "a03132f19b91100011bb405bfeb70034",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/supervisoryOrganizations

Retrieves a collection of supervisory organizations.

Retrieves all supervisory organizations. Secured By Domain: FLW Service, Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "supervisoryOrganizations"
  ],
  "summary": "Retrieves a collection of supervisory organizations.",
  "description": "Retrieves all supervisory organizations.\n\n<b>Secured By Domain:</b> FLW Service, Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/supervisoryOrganizationSummary_3a94b57f042a4ebb95027e09d6192992"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "22c69260c8784717a6a7bdec9efbca32",
  "x-workday-secured-by-domains": [
    "FLW Service",
    "Reports: Organization"
  ]
}

GET /common/v1/supervisoryOrganizations/{ID}/workers/{subresourceID}

Retrieves a worker instance for a specific supervisory organization.

Retrieves a supervisory organization for a worker with the specified ID. Secured By Domain: Worker Data: Public Worker Reports Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "supervisoryOrganizations"
  ],
  "summary": "Retrieves a worker instance for a specific supervisory organization.",
  "description": "Retrieves a supervisory organization for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Worker Data: Public Worker Reports\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/workerSummary_a489aef739484c13a59e6d502a9e7b68"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "5c954a75094a4f6183f8602897afd7ff",
  "x-workday-secured-by-domains": [
    "Worker Data: Public Worker Reports"
  ]
}

GET /common/v1/supervisoryOrganizations/{ID}/workers

Retrieves a collection of workers for a specific supervisory organization.

Retrieves all supervisory organizations for a worker with the specified ID. Secured By Domain: Worker Data: Public Worker Reports Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "supervisoryOrganizations"
  ],
  "summary": "Retrieves a collection of workers for a specific supervisory organization.",
  "description": "Retrieves all supervisory organizations for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Worker Data: Public Worker Reports\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/workerSummary_a489aef739484c13a59e6d502a9e7b68"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "5c954a75094a4f6183f8602897afd7ff",
  "x-workday-secured-by-domains": [
    "Worker Data: Public Worker Reports"
  ]
}

GET /common/v1/supervisoryOrganizations/{ID}

Retrieves a supervisory organization instance.

Retrieves a supervisory organization instance. Secured By Domain: FLW Service, Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "supervisoryOrganizations"
  ],
  "summary": "Retrieves a supervisory organization instance.",
  "description": "Retrieves a supervisory organization instance.\n\n<b>Secured By Domain:</b> FLW Service, Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/supervisoryOrganizationSummary_3a94b57f042a4ebb95027e09d6192992"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "22c69260c8784717a6a7bdec9efbca32",
  "x-workday-secured-by-domains": [
    "FLW Service",
    "Reports: Organization"
  ]
}

GET /common/v1/jobChangeReasons

Retrieves a collection of job change reasons.

Retrieves all job change reasons. Secured By Domain: Staffing Actions: Change Job Date and Reason Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobChangeReasons"
  ],
  "summary": "Retrieves a collection of job change reasons.",
  "description": "Retrieves all job change reasons.\n\n<b>Secured By Domain:</b> Staffing Actions: Change Job Date and Reason\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/jobChangeReasonSummary_69b1f5fbb40c4cd6b9c55b226ca2424c"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "0edf6078b26046bb988499f0b7f92dee",
  "x-workday-secured-by-domains": [
    "Staffing Actions: Change Job Date and Reason"
  ]
}

GET /common/v1/jobChangeReasons/{ID}

Retrieves a job change reason instance.

Retrieves a job change reason with the specified ID. Secured By Domain: Staffing Actions: Change Job Date and Reason Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "jobChangeReasons"
  ],
  "summary": "Retrieves a job change reason instance.",
  "description": "Retrieves a job change reason with the specified ID.\n\n<b>Secured By Domain:</b> Staffing Actions: Change Job Date and Reason\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/jobChangeReasonSummary_69b1f5fbb40c4cd6b9c55b226ca2424c"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "0edf6078b26046bb988499f0b7f92dee",
  "x-workday-secured-by-domains": [
    "Staffing Actions: Change Job Date and Reason"
  ]
}

GET /common/v1/businessTitleChanges/{ID}

Retrieves a business title change instance.

Secured By Domain: Staffing Actions: Business Title Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "businessTitleChanges"
  ],
  "summary": "Retrieves a business title change instance.",
  "description": "\n\n<b>Secured By Domain:</b> Staffing Actions: Business Title\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/businessTitleChangeDetail_f3169dd3470046378f404ac21e864ab4"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "45a9c799b3fd4e70a0b53d07c20c867f",
  "x-workday-secured-by-domains": [
    "Staffing Actions: Business Title"
  ]
}

GET /common/v1/organizationTypes

Retrieves a collection of organization types.

Retrieves all organization types. Secured By Domain: Set Up: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "organizationTypes"
  ],
  "summary": "Retrieves a collection of organization types.",
  "description": "Retrieves all organization types.\n\n<b>Secured By Domain:</b> Set Up: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/organizationTypeSummary_e91ac1399cd410000481d84f988f0ec7"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "e91ac1399cd410000486288a174f0ec9",
  "x-workday-secured-by-domains": [
    "Set Up: Organization"
  ]
}

GET /common/v1/organizationTypes/{ID}

Retrieves an organization type instance.

Retrieves an organization type with the specified ID. Secured By Domain: Set Up: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "organizationTypes"
  ],
  "summary": "Retrieves an organization type instance.",
  "description": "Retrieves an organization type with the specified ID.\n\n<b>Secured By Domain:</b> Set Up: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/organizationTypeSummary_e91ac1399cd410000481d84f988f0ec7"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "e91ac1399cd410000486288a174f0ec9",
  "x-workday-secured-by-domains": [
    "Set Up: Organization"
  ]
}

GET /common/v1/workers

Retrieves a collection of workers.

Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive. Secured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of workers.",
  "description": "Retrieves all workers. Use the search parameter to search for workers by name. The search is case-insensitive.\n\n<b>Secured By Domain:</b> FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "includeTerminatedWorkers",
      "in": "query",
      "description": "Include terminated workers in the output",
      "schema": {
        "type": "boolean"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "search",
      "in": "query",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/workerSummary_a489aef739484c13a59e6d502a9e7b68"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "94a39e71541b468fa895955508287acd",
  "x-workday-secured-by-domains": [
    "FLW Service",
    "Self-Service: Current Staffing Information",
    "Worker Data: Public Worker Reports"
  ]
}

GET /common/v1/workers/{ID}/directReports

Retrieves a collection of direct reports for a specific worker.

Retrieves all direct reports. Secured By Domain: Reports: Manager, Reports: Matrix Manager, Self-Service: My Team Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of direct reports for a specific worker.",
  "description": "Retrieves all direct reports.\n\n<b>Secured By Domain:</b> Reports: Manager, Reports: Matrix Manager, Self-Service: My Team\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/workerSummary_a489aef739484c13a59e6d502a9e7b68"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "3dad5f33d6974b2691f53037644f40be",
  "x-workday-secured-by-domains": [
    "Reports: Manager",
    "Reports: Matrix Manager",
    "Self-Service: My Team"
  ]
}

GET /common/v1/workers/{ID}/directReports/{subresourceID}

Retrieves a direct report instance for a specific worker.

Retrieves a direct report with the specified ID Secured By Domain: Reports: Manager, Reports: Matrix Manager, Self-Service: My Team Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a direct report instance for a specific worker.",
  "description": "Retrieves a direct report with the specified ID\n\n<b>Secured By Domain:</b> Reports: Manager, Reports: Matrix Manager, Self-Service: My Team\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/workerSummary_a489aef739484c13a59e6d502a9e7b68"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "3dad5f33d6974b2691f53037644f40be",
  "x-workday-secured-by-domains": [
    "Reports: Manager",
    "Reports: Matrix Manager",
    "Self-Service: My Team"
  ]
}

GET /common/v1/workers/{ID}/organizations

Retrieves a collection of organizations for a specific worker.

Retrieves all organizations for a specific worker. Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of organizations for a specific worker.",
  "description": "Retrieves all organizations for a specific worker.\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/workerOrganizationSummary_b09201ecbe6f10000c600196a3f70012"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "b09201ecbe6f10000c612f777e670015",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/workers/{ID}/organizations/{subresourceID}

Retrieves an organization instance for a specific worker.

Retrieves an organization with the specified ID for a specific worker. Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves an organization instance for a specific worker.",
  "description": "Retrieves an organization with the specified ID for a specific worker.\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/workerOrganizationSummary_b09201ecbe6f10000c600196a3f70012"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "b09201ecbe6f10000c612f777e670015",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/workers/{ID}/inboxTasks/{subresourceID}

Retrieves an inbox task instance for a specific worker.

Secured By Domain: Core Navigation Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves an inbox task instance for a specific worker.",
  "description": "\n\n<b>Secured By Domain:</b> Core Navigation\n\n<b>Scope:</b> Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/inboxTaskSummary_1bbb07a8ab4349dd934ca72301974204"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d02ccd56f7894dabb8e0dd66e42e94b9",
  "x-workday-secured-by-domains": [
    "Core Navigation"
  ]
}

GET /common/v1/workers/{ID}/timeOffEntries

Retrieves a collection of time off entries for a specific worker.

Secured By Domain: Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances) Scope: Time Off and Leave

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of time off entries for a specific worker.",
  "description": "\n\n<b>Secured By Domain:</b> Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances)\n\n<b>Scope:</b> Time Off and Leave",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/timeOffEntries_436f2afb755f100012528fa3260e000f"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "436f2afb755f1000125443cdc76e0017",
  "x-workday-secured-by-domains": [
    "Self-Service: Time Off Balances",
    "Worker Data: Time Off (Time Off Balances Manager View)",
    "Worker Data: Time Off (Time Off Balances)"
  ]
}

POST /common/v1/workers/{ID}/businessTitleChanges?type=me

Secured By Business Process Type: Title Change Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "description": "\n\n<b>Secured By Business Process Type:</b> Title Change\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/businessTitleChangeInput_0123d0c7e84e4263a53f5d74968690af"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/businessTitleChangeInput_0123d0c7e84e4263a53f5d74968690af"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nProposed Business Title is required.\n\nThe last filled date for the position is after the current date.\n\nThe position has been vacated by this worker.\n\nThere are other staffing or business title business processes that affect this business title that are effective after this date.\n\nWorker has additional jobs. This task is not supported for workers with multiple jobs.\n\nWorker is terminated and does not have a future hire.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "9c0a3c288a2c1000017eb88849a30002",
  "x-workday-secured-by-business-process-types": [
    "Title Change"
  ]
}

GET /common/v1/workers/{ID}/history/{subresourceID}

Retrieves a history instance for a specific worker.

Retrieves a collection of history items for a specific worker with the specified ID. Secured By Domain: Worker Data: Historical Staffing Information Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a history instance for a specific worker.",
  "description": "Retrieves a collection of history items for a specific worker with the specified ID.\n\n<b>Secured By Domain:</b> Worker Data: Historical Staffing Information\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/businessProcessSummary_5a3be01347ed4c30b2ab02b28d97b655"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "0d02120b4f9f4494adf71d47d6621668",
  "x-workday-secured-by-domains": [
    "Worker Data: Historical Staffing Information"
  ]
}

GET /common/v1/workers/{ID}/timeOffEntries/{subresourceID}

Retrieves a time off entry for a specific worker.

Secured By Domain: Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances) Scope: Time Off and Leave

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a time off entry for a specific worker.",
  "description": "\n\n<b>Secured By Domain:</b> Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances)\n\n<b>Scope:</b> Time Off and Leave",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/timeOffEntries_436f2afb755f100012528fa3260e000f"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "436f2afb755f1000125443cdc76e0017",
  "x-workday-secured-by-domains": [
    "Self-Service: Time Off Balances",
    "Worker Data: Time Off (Time Off Balances Manager View)",
    "Worker Data: Time Off (Time Off Balances)"
  ]
}

GET /common/v1/workers/{ID}/timeOffPlans/{subresourceID}

Retrieves a particular time off plan for a specific worker.

Retrieves a time off plan for a worker with the specified ID. Secured By Domain: Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances) Scope: Time Off and Leave

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a particular time off plan for a specific worker.",
  "description": "Retrieves a time off plan for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances)\n\n<b>Scope:</b> Time Off and Leave",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/timeOffPlans_581c389cce1410000feacaebd2e40002"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "581c389cce1410000ff399298ba10006",
  "x-workday-secured-by-domains": [
    "Self-Service: Time Off Balances",
    "Worker Data: Time Off (Time Off Balances Manager View)",
    "Worker Data: Time Off (Time Off Balances)"
  ]
}

GET /common/v1/workers/{ID}/businessTitleChanges

Retrieves a collection of business title changes for a specific worker.

Retrieves all business title change events. Secured By Domain: Staffing Actions: Business Title Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of business title changes for a specific worker.",
  "description": "Retrieves all business title change events.\n\n<b>Secured By Domain:</b> Staffing Actions: Business Title\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/businessTitleChangeDetail_f3169dd3470046378f404ac21e864ab4"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "a865e2c38bd74c80a6f289390d3e619f",
  "x-workday-secured-by-domains": [
    "Staffing Actions: Business Title"
  ]
}

POST /common/v1/workers/{ID}/businessTitleChanges

Creates a business title change instance with the specified data.

Create a new business title change for the specified worker Secured By Business Process Type: Title Change Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Creates a business title change instance with the specified data.",
  "description": "Create a new business title change for the specified worker\n\n<b>Secured By Business Process Type:</b> Title Change\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/businessTitleChangeInput_0123d0c7e84e4263a53f5d74968690af"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/businessTitleChangeInput_0123d0c7e84e4263a53f5d74968690af"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nProposed Business Title is required.\n\nThe last filled date for the position is after the current date.\n\nThe position has been vacated by this worker.\n\nThere are other staffing or business title business processes that affect this business title that are effective after this date.\n\nWorker has additional jobs. This task is not supported for workers with multiple jobs.\n\nWorker is terminated and does not have a future hire.\n\nWorker submitted is the processing user.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "c2ffb30053964fbfa7a46dcfa577adb1",
  "x-workday-secured-by-business-process-types": [
    "Title Change"
  ]
}

GET /common/v1/workers/{ID}/supervisoryOrganizationsManaged

Retrieves a collection of supervisory organizations managed by a specific worker.

Retrieves all managed supervisory organizations for a worker with the specified ID. Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of supervisory organizations managed by a specific worker.",
  "description": "Retrieves all managed supervisory organizations for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/supervisoryOrganizationSummary_3a94b57f042a4ebb95027e09d6192992"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "b6044838fb1f100001fe0872896b0002",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/workers/{ID}/timeOffPlans

Retrieves a collection of time off plans for a specific worker.

Retrieves all time off plans for a worker with the specified ID. Secured By Domain: Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances) Scope: Time Off and Leave

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of time off plans for a specific worker.",
  "description": "Retrieves all time off plans for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Self-Service: Time Off Balances, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances)\n\n<b>Scope:</b> Time Off and Leave",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/timeOffPlans_581c389cce1410000feacaebd2e40002"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "581c389cce1410000ff399298ba10006",
  "x-workday-secured-by-domains": [
    "Self-Service: Time Off Balances",
    "Worker Data: Time Off (Time Off Balances Manager View)",
    "Worker Data: Time Off (Time Off Balances)"
  ]
}

GET /common/v1/workers/{ID}/paySlips/{subresourceID}

Retrieves a pay slip instance for a specific worker.

Retrieves a pay slip for a worker with the specified ID. Secured By Domain: Self-Service: Payroll (My Payslips), Worker Data: Payroll (Payslips) Scope: Core Payroll

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a pay slip instance for a specific worker.",
  "description": "Retrieves a pay slip for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Self-Service: Payroll (My Payslips), Worker Data: Payroll (Payslips)\n\n<b>Scope:</b> Core Payroll",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/paySlipSummary_056982a2aa04100005cc479e6e5a0022"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "056982a2aa04100005cd56c3da4a0028",
  "x-workday-secured-by-domains": [
    "Self-Service: Payroll (My Payslips)",
    "Worker Data: Payroll (Payslips)"
  ]
}

GET /common/v1/workers/{ID}/history

Retrieves a collection of history items for a specific worker.

Retrieves all history items for the worker. Secured By Domain: Worker Data: Historical Staffing Information Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of history items for a specific worker.",
  "description": "Retrieves all history items for the worker.\n\n<b>Secured By Domain:</b> Worker Data: Historical Staffing Information\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/businessProcessSummary_5a3be01347ed4c30b2ab02b28d97b655"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "0d02120b4f9f4494adf71d47d6621668",
  "x-workday-secured-by-domains": [
    "Worker Data: Historical Staffing Information"
  ]
}

GET /common/v1/workers/{ID}

Retrieves a worker instance.

Retrieves a worker instance with the specific ID. Secured By Domain: FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a worker instance.",
  "description": "Retrieves a worker instance with the specific ID.\n\n<b>Secured By Domain:</b> FLW Service, Self-Service: Current Staffing Information, Worker Data: Public Worker Reports\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/workerProfile_c0a0dce56eb142d39dbffeb505becf7a"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "94a39e71541b468fa895955508287acd",
  "x-workday-secured-by-domains": [
    "FLW Service",
    "Self-Service: Current Staffing Information",
    "Worker Data: Public Worker Reports"
  ]
}

POST /common/v1/workers/{ID}/jobChanges

Creates a job change instance with the specified data.

Creates a job change instance with the specified data. Secured By Business Process Type: Change Job Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Creates a job change instance with the specified data.",
  "description": "Creates a job change instance with the specified data.\n\n<b>Secured By Business Process Type:</b> Change Job\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/changeJobInput_cadd132f15994dc3bcda042ae1c90629"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Resource created.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/changeJobInput_cadd132f15994dc3bcda042ae1c90629"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)\n\nChange Organization is not part of the Change Job workflow definition for the proposed Supervisory Organization\n\nHiring restrictions are missing for the organization selected.\n\nOrganization is not accessible by the user.\n\nOrganizations with the following Organization Types are required: [req_org_types]\n\nProposed Organizations contains inactive Organizations.\n\nProposed Organizations contains multiple Organizations with Organization Types that are restricted to single assignments.\n\nProposed Organizations contains those with Organization Types that cannot be part of Change Organization Assignments.\n\nProposed Supervisory Organization is required.\n\nProposed supervisory organization is not valid. It will be made inactive after the event effective date. This will result in this position not having a supervisory organization.\n\nReason is not valid for the Job Change Event or the processing user is a \\~Manager\\~ and the Reason is not valid for \\~managers\\~.\n\nReason is not valid for the worker type (Employee or Contingent Worker).\n\nReason is required.\n\nSupervisory Organization must be active.\n\nThe Proposed Organization assignments do not meet the restrictions defined for the Proposed Supervisory Organization.\n\nThe current position has a pending organization change or a completed \\~Supervisory Organization\\~ change effective after this date. Therefore, this position cannot have changes as of the effective date.\n\nThe date entered cannot be earlier than the earliest hire date.\n\nThe effective date must be after the date of the last completed Assign Pay Group change.\n\nThe effective date must be after the date of the last completed Change Organization assignment.\n\nThe effective date must be after the date of the last completed Matrix Organization change.\n\nThe effective date must be equal to or greater than the date the position was last updated.\n\nThe hiring restrictions for the proposed \\~supervisory organization\\~ do not allow this type of \\~worker\\~.\n\nThe proposed \\~supervisory organization\\~ is in a Hiring Freeze. It cannot be selected.\n\nThis position is in a pending Merit Event. The effective date must be after the pending Merit Event's effective date.\n\nWorker has additional jobs. This task is not supported for workers with multiple jobs.\n\nWorker is terminated and does not have a future hire.\n\nWorker submitted is the processing user.\n\nYou cannot initiate this action because there are other pending actions for the worker that conflict with this one. Close any pending Staffing, Matrix Organization, Pay Group or Organization events before initiating this action.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b4f1492ac4c741378c8d71305f9553f5",
  "x-workday-secured-by-business-process-types": [
    "Change Job"
  ]
}

GET /common/v1/workers/{ID}/inboxTasks

Retrieves a collection of inbox tasks for a specific worker.

Secured By Domain: Core Navigation Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of inbox tasks for a specific worker.",
  "description": "\n\n<b>Secured By Domain:</b> Core Navigation\n\n<b>Scope:</b> Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/inboxTaskSummary_1bbb07a8ab4349dd934ca72301974204"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "d02ccd56f7894dabb8e0dd66e42e94b9",
  "x-workday-secured-by-domains": [
    "Core Navigation"
  ]
}

GET /common/v1/workers/{ID}/supervisoryOrganizationsManaged/{subresourceID}

Retrieves a supervisory organization managed by a specific worker.

Retrieves a managed supervisory organization for a worker with the specified ID. Secured By Domain: Reports: Organization Scope: Organizations and Roles

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a supervisory organization managed by a specific worker.",
  "description": "Retrieves a managed supervisory organization for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Reports: Organization\n\n<b>Scope:</b> Organizations and Roles",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/supervisoryOrganizationSummary_3a94b57f042a4ebb95027e09d6192992"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "b6044838fb1f100001fe0872896b0002",
  "x-workday-secured-by-domains": [
    "Reports: Organization"
  ]
}

GET /common/v1/workers/{ID}/paySlips

Retrieves a collection of pay slips for a specific worker.

Retrieves all pay slips for a worker with the specified ID. Secured By Domain: Self-Service: Payroll (My Payslips), Worker Data: Payroll (Payslips) Scope: Core Payroll

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a collection of pay slips for a specific worker.",
  "description": "Retrieves all pay slips for a worker with the specified ID.\n\n<b>Secured By Domain:</b> Self-Service: Payroll (My Payslips), Worker Data: Payroll (Payslips)\n\n<b>Scope:</b> Core Payroll",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/paySlipSummary_056982a2aa04100005cc479e6e5a0022"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "056982a2aa04100005cd56c3da4a0028",
  "x-workday-secured-by-domains": [
    "Self-Service: Payroll (My Payslips)",
    "Worker Data: Payroll (Payslips)"
  ]
}

GET /common/v1/workers/{ID}/businessTitleChanges/{subresourceID}

Retrieves a business title change instance for a specific worker.

Retrieves a business title change event with the specified ID. Secured By Domain: Staffing Actions: Business Title Scope: Staffing

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "workers"
  ],
  "summary": "Retrieves a business title change instance for a specific worker.",
  "description": "Retrieves a business title change event with the specified ID.\n\n<b>Secured By Domain:</b> Staffing Actions: Business Title\n\n<b>Scope:</b> Staffing",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.\n\n- **ID:** Replace with your actual Workday ID\n- **me**",
      "required": true,
      "schema": {
        "type": "string",
        "enum": [
          "ID",
          "me"
        ]
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/businessTitleChangeDetail_f3169dd3470046378f404ac21e864ab4"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "a865e2c38bd74c80a6f289390d3e619f",
  "x-workday-secured-by-domains": [
    "Staffing Actions: Business Title"
  ]
}

GET /common/v1/currencies

Retrieves a collection of currencies.

Retrieves all currencies. Secured By Domain: Core Navigation Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "currencies"
  ],
  "summary": "Retrieves a collection of currencies.",
  "description": "Retrieves all currencies.\n\n<b>Secured By Domain:</b> Core Navigation\n\n<b>Scope:</b> Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable",
  "parameters": [
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/currencySummary_7ceb0e9ce857100019c6099ce1ad00fa"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "4b1c5da0cff34a3c88438ffebbfbd970",
  "x-workday-secured-by-domains": [
    "Core Navigation"
  ]
}

GET /common/v1/currencies/{ID}

Retrieves a currency instance.

Retrieves a currency with the specified ID Secured By Domain: Core Navigation Scope: Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "currencies"
  ],
  "summary": "Retrieves a currency instance.",
  "description": "Retrieves a currency with the specified ID\n\n<b>Secured By Domain:</b> Core Navigation\n\n<b>Scope:</b> Adaptive Planning for Financial Plans, Adaptive Planning for the Workforce, Benefits, Tenant Non-Configurable",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/currencySummary_7ceb0e9ce857100019c6099ce1ad00fa"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "true",
  "x-workday-operation-id": "4b1c5da0cff34a3c88438ffebbfbd970",
  "x-workday-secured-by-domains": [
    "Core Navigation"
  ]
}

GET /common/v1/customers/{ID}/activities

Retrieves a collection of activities for a specific customer.

Secured By Domain: Reports: Customer Accounts Scope: Customer Accounts

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "customers"
  ],
  "summary": "Retrieves a collection of activities for a specific customer.",
  "description": "\n\n<b>Secured By Domain:</b> Reports: Customer Accounts\n\n<b>Scope:</b> Customer Accounts",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "fromDate",
      "in": "query",
      "schema": {
        "type": "string",
        "format": "date"
      }
    },
    {
      "name": "limit",
      "in": "query",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "offset",
      "in": "query",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.",
      "schema": {
        "type": "integer",
        "format": "int64"
      }
    },
    {
      "name": "toDate",
      "in": "query",
      "schema": {
        "type": "string",
        "format": "date"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "total": {
                "type": "integer",
                "format": "int32"
              },
              "data": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/activity_bb1fcf6de05b100009ce64e02ac43c08"
                }
              }
            }
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "c29dedec19201000115c769e98610014",
  "x-workday-secured-by-domains": [
    "Reports: Customer Accounts"
  ]
}

GET /common/v1/customers/{ID}/activities/{subresourceID}

Retrieves an activity instance for a specific customer.

Secured By Domain: Reports: Customer Accounts Scope: Customer Accounts

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "customers"
  ],
  "summary": "Retrieves an activity instance for a specific customer.",
  "description": "\n\n<b>Secured By Domain:</b> Reports: Customer Accounts\n\n<b>Scope:</b> Customer Accounts",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "subresourceID",
      "in": "path",
      "description": "The Workday ID of the subresource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/activity_bb1fcf6de05b100009ce64e02ac43c08"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "c29dedec19201000115c769e98610014",
  "x-workday-secured-by-domains": [
    "Reports: Customer Accounts"
  ]
}

GET /common/v1/customers/{ID}

Retrieves a customer instance.

Secured By Domain: View: Customer Scope: Customers

Authentication

[
  {
    "OAuth2": []
  }
]

Request, responses and operation details

{
  "tags": [
    "customers"
  ],
  "summary": "Retrieves a customer instance.",
  "description": "\n\n<b>Secured By Domain:</b> View: Customer\n\n<b>Scope:</b> Customers",
  "parameters": [
    {
      "name": "ID",
      "in": "path",
      "description": "The Workday ID of the resource.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Successful response. A successful response can return no matched data.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/customer_b7ecfe5ec60c10000aa161405fa5002c"
          }
        }
      }
    },
    "400": {
      "description": "Invalid request. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized: Missing or invalid credentials. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "403": {
      "description": "User has insufficient permissions. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "404": {
      "description": "Resource not found. (https://community.workday.com/rest/error-messages)",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/VALIDATION_ERROR_MODEL_REFERENCE"
          }
        }
      }
    },
    "default": {
      "description": "An error occurred.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  },
  "x-workday-internal-try-enabled": "false",
  "x-workday-operation-id": "b7ecfe5ec60c10000ac57590b2650034",
  "x-workday-secured-by-domains": [
    "View: Customer"
  ]
}

Schemas and reusable components

schemas

INSTANCE_MODEL_REFERENCE

{
  "required": [
    "id"
  ],
  "type": "object",
  "properties": {
    "id": {
      "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance",
      "readOnly": true
    },
    "href": {
      "type": "string",
      "description": "A link to the instance",
      "readOnly": true
    }
  }
}

ERROR_MODEL_REFERENCE

{
  "required": [
    "error"
  ],
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "A description of the error"
    },
    "code": {
      "type": "string",
      "description": "The code that corresponds to the error message. Use the error code to drive programmatic error-handling behavior. Don't use error message strings for this purpose because they are subject to change"
    },
    "field": {
      "type": "string",
      "description": "The field related to the error"
    },
    "path": {
      "type": "string",
      "description": "The path of the field related to the error"
    },
    "severity": {
      "type": "string",
      "description": "Severity of the validation (e.g. Critical, Warning)."
    },
    "internalMessage": {
      "type": "string",
      "description": "Internal message providing additional context for the validation (e.g. representation content validation details)."
    }
  }
}

VALIDATION_ERROR_MODEL_REFERENCE

{
  "allOf": [
    {
      "required": [
        "error"
      ],
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "description": "A description of the error"
        },
        "errors": {
          "type": "array",
          "description": "An array of validation errors",
          "items": {
            "$ref": "#/components/schemas/ERROR_MODEL_REFERENCE"
          }
        }
      }
    }
  ]
}

FACETS_MODEL_REFERENCE

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "descriptor": {
        "type": "string",
        "description": "A description of the facet"
      },
      "facetParameter": {
        "type": "string",
        "description": "The alias used to select the facet"
      },
      "values": {
        "type": "array",
        "description": "the facet values",
        "items": {
          "required": [
            "id"
          ],
          "type": "object",
          "properties": {
            "count": {
              "type": "integer",
              "description": "The number of instances returned by this facet",
              "format": "int32"
            },
            "id": {
              "pattern": "^(([0-9a-f]{32})|(\\S+=\\S+))$",
              "type": "string",
              "description": "Workday Id or Reference Id of the instance."
            },
            "descriptor": {
              "type": "string",
              "description": "A description of the facet"
            },
            "href": {
              "type": "string",
              "description": "A link to the instance",
              "readOnly": true
            }
          }
        }
      }
    },
    "description": "This object represents the possible facets for this resource",
    "readOnly": true
  }
}

MULTIPLE_INSTANCE_MODEL_REFERENCE

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32"
    },
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
      }
    }
  }
}

validationTypes_7ccdf8f26ee910000b6aff359b1c00c4

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagValidationTypeInput_7ccdf8f26ee910000b6a70bc5fd600c2"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktags REST Validation Type Representation (Derived)"
        }
      }
    }
  ]
}

restrictions_f08fabab3cae10001d09c7148c9101ef

{
  "allOf": [
    {
      "$ref": "#/components/schemas/restrictionInput_4b3cd975feb010000567e14324830071"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Restriction Representation (Derived)"
        }
      }
    }
  ]
}

invalidRestrictionsForWorktags_f08fabab3cae10001a21f30e937501b3

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagAndRestrictionInput_f08fabab3cae10001a2f1a982daa01b5"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Constraint Values Representation (Derived)"
        }
      }
    }
  ]
}

missingRequiredWorktagTypesForWorktags_3f71b007c34610001ff29543f94900ca

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagAndTypeInput_854b3abfd54d10000e8038b032223278"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Anchor Worktag and Target Worktag Types Representation (Derived)"
        }
      }
    }
  ]
}

nonAllowedWorktagTypesForTaggableConfig_3f71b007c34610001c4ca37e7c3f00a0

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagTypeInput_3f71b007c34610000e0bb926bf370056"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Type Representation (Derived)"
        }
      }
    }
  ]
}

missingRequiredWorktagTypesForTaggableConfig_3f71b007c34610000e0c8b4c86f00058

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagTypeInput_3f71b007c34610000e0bb926bf370056"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Type Representation (Derived)"
        }
      }
    }
  ]
}

nonAllowedInactiveWorktagValues_aa8aaaaeca39100035e3236199f00406

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagInput_aa8aaaaeca39100034443e493aef03ce"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Representation (Derived)"
        }
      }
    }
  ]
}

worktags_aa8aaaaeca391000349a30b2a58203dc

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagInput_aa8aaaaeca39100034443e493aef03ce"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Representation (Derived)"
        }
      }
    }
  ]
}

invalidWorktagCombinations_aa8aaaaeca391000344569c0b5dd03d0

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagsComboInput_f08fabab3cae10000b041ae3234b009d"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Anchor Target Representation (Derived)"
        }
      }
    }
  ]
}

taggableConfiguration_aa8aaaaeca391000321b455e3c150390

{
  "description": "For REST API requests only. Usually the Taggable Type in the 'Maintain Worktag Usage' task that is used for the transaction. Examples: Customer Invoice, Accounting Journal, Expense Report. Exceptions are when the taggable type is Budgets or Time Tracking, the value needs to be either a budget plan structure or time entry template.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

missingRequiredWorktagTypesAfterDefaulting_5ee0ae813753100008c735574add423b

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagTypeInput_3f71b007c34610000e0bb926bf370056"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Type Representation (Derived)"
        }
      }
    }
  ]
}

validateWorktagInput_aa8aaaaeca3910002fd14d954eea0371

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "validationTypes": {
          "type": "array",
          "description": "For REST API requests only. The validation types to include in the response. If this request parameter is missing or empty, all validation types are included in the response.",
          "items": {
            "$ref": "#/components/schemas/validationTypes_7ccdf8f26ee910000b6aff359b1c00c4"
          },
          "x-workday-type": "Multi-instance"
        },
        "restrictions": {
          "type": "array",
          "description": "For REST API requests only. Values that are validated for worktag types configured with 'Restricted To' values. Example: Company for a cost center configured with Restricted To Companies.",
          "items": {
            "$ref": "#/components/schemas/restrictions_f08fabab3cae10001d09c7148c9101ef"
          },
          "x-workday-type": "Multi-instance"
        },
        "invalidRestrictionsForWorktags": {
          "type": "array",
          "description": "When returned in a REST API response, indicates invalid restrictions for a worktag configured with Restricted To values. Use the Worktag With Restricted To Values and Invalid Restricted To Values report fields to view the values.",
          "items": {
            "$ref": "#/components/schemas/invalidRestrictionsForWorktags_f08fabab3cae10001a21f30e937501b3"
          },
          "x-workday-type": "Multi-instance"
        },
        "onlyOneProjectOrPhaseOrTaskAllowed": {
          "type": "string",
          "description": "When returned in a REST API response, indicates that there is more than one worktag for a \\~Project\\~ in the request. Only one worktag type of \\~Project\\~, \\~Project Phase\\~ or \\~Project Task\\~ is allowed.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "allowBuiltInWorktags": {
          "type": "string",
          "description": "When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. Example: Supplier in Supplier Invoice.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "missingRequiredWorktagTypesForWorktags": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one worktag type configured as required in related worktags is missing. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.",
          "items": {
            "$ref": "#/components/schemas/missingRequiredWorktagTypesForWorktags_3f71b007c34610001ff29543f94900ca"
          },
          "x-workday-type": "Multi-instance"
        },
        "nonAllowedWorktagTypesForTaggableConfig": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one worktag type sent in the request isn't allowed by the Taggable Configuration.",
          "items": {
            "$ref": "#/components/schemas/nonAllowedWorktagTypesForTaggableConfig_3f71b007c34610001c4ca37e7c3f00a0"
          },
          "x-workday-type": "Multi-instance"
        },
        "missingRequiredWorktagTypesForTaggableConfig": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request.",
          "items": {
            "$ref": "#/components/schemas/missingRequiredWorktagTypesForTaggableConfig_3f71b007c34610000e0c8b4c86f00058"
          },
          "x-workday-type": "Multi-instance"
        },
        "status": {
          "type": "string",
          "description": "The status in the REST API response that indicates whether the worktags sent in the request have validation errors or not.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "nonAllowedInactiveWorktagValues": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one inactive worktag was sent in the request that wasn't allowed by the Taggable Configuration.",
          "items": {
            "$ref": "#/components/schemas/nonAllowedInactiveWorktagValues_aa8aaaaeca39100035e3236199f00406"
          },
          "x-workday-type": "Multi-instance"
        },
        "worktags": {
          "type": "array",
          "description": "The worktags sent in a REST API request to be validated based on the configuration in the 'Maintain Worktag Usage' and 'Maintain Related Worktag Usage' tasks. Validations consider required and allowed worktag types, allowed values, and whether inactive values are allowed.",
          "items": {
            "$ref": "#/components/schemas/worktags_aa8aaaaeca391000349a30b2a58203dc"
          },
          "x-workday-type": "Multi-instance"
        },
        "invalidWorktagCombinations": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one combination of worktag values aren't allowed with one another. Use the Worktag with Allowed Values and Invalid Worktag Values report fields to view the values.",
          "items": {
            "$ref": "#/components/schemas/invalidWorktagCombinations_aa8aaaaeca391000344569c0b5dd03d0"
          },
          "x-workday-type": "Multi-instance"
        },
        "taggableConfiguration": {
          "$ref": "#/components/schemas/taggableConfiguration_aa8aaaaeca391000321b455e3c150390"
        },
        "missingRequiredWorktagTypesAfterDefaulting": {
          "type": "array",
          "description": "When returned in a REST API response, indicates that at least one worktag type configured as ‘Required’ for the Taggable Configuration is missing in the request and not added by default from related worktags. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values.",
          "items": {
            "$ref": "#/components/schemas/missingRequiredWorktagTypesAfterDefaulting_5ee0ae813753100008c735574add423b"
          },
          "x-workday-type": "Multi-instance"
        }
      }
    }
  ]
}

organizationSummary_a03132f19b911000119b05cfd7cf0032

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

manager_0c28a4eb372c41ab9a109e9703487457

{
  "description": "The \\~manager\\~ for the \\~supervisory organization\\~. If there is more than 1 \\~manager\\~ assigned, this is the Single Assignment manager.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

supervisoryOrganizationSummary_3a94b57f042a4ebb95027e09d6192992

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "workers": {
          "type": "string",
          "description": "Contains the \\~workers\\~ in the organization.",
          "format": "url",
          "readOnly": true,
          "x-workday-type": "Multi-instance"
        },
        "manager": {
          "$ref": "#/components/schemas/manager_0c28a4eb372c41ab9a109e9703487457"
        },
        "code": {
          "type": "string",
          "description": "The organization id for the organization.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "name": {
          "type": "string",
          "description": "The organization name for the organization.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

primarySupervisoryOrganization_642d7497e69c48da946fc503f66d7da1

{
  "description": "The \\~supervisory organization\\~ for the \\~worker's\\~ primary position, if the \\~supervisory organization\\~ is viewable by everyone.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

workerSummary_a489aef739484c13a59e6d502a9e7b68

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "isManager": {
          "type": "boolean",
          "description": "Identifies if the \\~worker\\~ has a \\~manager\\~ role.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "primaryWorkPhone": {
          "type": "string",
          "description": "The primary work phone number for the \\~worker\\~ including the area code and \\~country\\~ code.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "primaryWorkEmail": {
          "type": "string",
          "description": "The primary work email address for the \\~worker\\~.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "primarySupervisoryOrganization": {
          "$ref": "#/components/schemas/primarySupervisoryOrganization_642d7497e69c48da946fc503f66d7da1"
        },
        "businessTitle": {
          "type": "string",
          "description": "The business title for the \\~worker's\\~ primary position. If no business title is defined for a position, the position title is returned back.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

jobChangeReasonSummary_69b1f5fbb40c4cd6b9c55b226ca2424c

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "isForContingentWorker": {
          "type": "boolean",
          "description": "Identifies whether the reason is allowed to be entered for \\~contingent workers\\~.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "managerReason": {
          "type": "boolean",
          "description": "Identifies whether the reason is allowed to be entered by \\~managers\\~.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "isForEmployee": {
          "type": "boolean",
          "description": "Identifies whether the reason is allowed to be entered for \\~employees\\~.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

subject_11c61172ead64041a04fc92c28a3b34e

{
  "description": "The subject of this business process.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

initiator_f48f5f155a4448758b8be033ecd99f87

{
  "description": "The \\~worker\\~ that initiated the business process.  Does not return \\~workers\\~ who are hired in the future. Please do not use this field in a condition rule for the initiation step of a process, as it will not return results. This is because there is no initiator designated until the process has started. The Initiator field only gets a value after the event is initiated (after the process is submitted). Use the Current \\~Worker\\~ field instead",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

businessTitleChangeDetail_f3169dd3470046378f404ac21e864ab4

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "subject": {
          "$ref": "#/components/schemas/subject_11c61172ead64041a04fc92c28a3b34e"
        },
        "currentBusinessTitle": {
          "type": "string",
          "description": "The business title for the \\~worker\\~ prior to this business process.  If there is no business title override, this field defaults to the job title or job profile name.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "proposedBusinessTitle": {
          "type": "string",
          "description": "The new business title for the \\~worker\\~ as of the effective date.  If there is no business title override, this field defaults to the job title or job profile name.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "due": {
          "type": "string",
          "description": "The date the business process needs to be completed.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "effective": {
          "type": "string",
          "description": "The date this business process takes effect.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "initiator": {
          "$ref": "#/components/schemas/initiator_f48f5f155a4448758b8be033ecd99f87"
        },
        "initiated": {
          "type": "string",
          "description": "The date and time this business process was initiated.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

organizationTypeSummary_e91ac1399cd410000481d84f988f0ec7

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

location_d6235be431f940598806053af7ba94ef

{
  "description": "Contains the location for the \\~worker\\~.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

primarySupervisoryOrganization_851e1342d4c2489c9680fb2a899227ca

{
  "description": "The \\~supervisory organization\\~ for the \\~worker's\\~ primary position, if the \\~supervisory organization\\~ is viewable by everyone.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

workerProfile_c0a0dce56eb142d39dbffeb505becf7a

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "supervisoryOrganizationsManaged": {
          "type": "string",
          "description": "All \\~supervisory organizations\\~, excluding inherited organizations, in which the \\~worker\\~ has a leadership role.",
          "format": "url",
          "readOnly": true,
          "x-workday-type": "Multi-instance"
        },
        "dateOfBirth": {
          "type": "string",
          "description": "The birth date of the \\~worker\\~.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "businessTitle": {
          "type": "string",
          "description": "The business title for the \\~worker's\\~ primary position. If no business title is defined for a position, the position title is returned back.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "isManager": {
          "type": "boolean",
          "description": "Identifies if the \\~worker\\~ has a \\~manager\\~ role.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "primaryWorkEmail": {
          "type": "string",
          "description": "The primary work email address for the \\~worker\\~.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "location": {
          "$ref": "#/components/schemas/location_d6235be431f940598806053af7ba94ef"
        },
        "primaryWorkPhone": {
          "type": "string",
          "description": "The primary work phone number for the \\~worker\\~ including the area code and \\~country\\~ code.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "primaryWorkAddressText": {
          "type": "string",
          "description": "Returns the primary work address for the \\~worker\\~, or from their default primary work location, full format on a single line.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "primarySupervisoryOrganization": {
          "$ref": "#/components/schemas/primarySupervisoryOrganization_851e1342d4c2489c9680fb2a899227ca"
        },
        "yearsOfService": {
          "type": "number",
          "description": "The years of service for the \\~worker\\~.",
          "format": "double",
          "example": 99999999999.99,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

subject_0cb6354752a84103b396a3d00b503568

{
  "description": "The subject of this business process.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

initiator_f3b51f13346543ba83122960f6c8a9c2

{
  "description": "The \\~worker\\~ that initiated the business process.  Does not return \\~workers\\~ who are hired in the future. Please do not use this field in a condition rule for the initiation step of a process, as it will not return results. This is because there is no initiator designated until the process has started. The Initiator field only gets a value after the event is initiated (after the process is submitted). Use the Current \\~Worker\\~ field instead",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

businessProcessSummary_5a3be01347ed4c30b2ab02b28d97b655

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "initiated": {
          "type": "string",
          "description": "The date and time this business process was initiated.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "subject": {
          "$ref": "#/components/schemas/subject_0cb6354752a84103b396a3d00b503568"
        },
        "initiator": {
          "$ref": "#/components/schemas/initiator_f3b51f13346543ba83122960f6c8a9c2"
        },
        "due": {
          "type": "string",
          "description": "The date the business process needs to be completed.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "effective": {
          "type": "string",
          "description": "The date this business process takes effect.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

organizationType_7f3b2f7a5a8910001a137fb9ae22001f

{
  "description": "Organization Type",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

workerOrganizationSummary_b09201ecbe6f10000c600196a3f70012

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "organizationType": {
          "$ref": "#/components/schemas/organizationType_7f3b2f7a5a8910001a137fb9ae22001f"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

jobChangeReason_3679c9f487c4403b90fff56091c0e360

{
  "description": "Returns the reason used in a Change Job business process.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

proposedOrganizations_8c583abbeaf010000c765bd6c36d000c

{
  "allOf": [
    {
      "$ref": "#/components/schemas/proposedStaffsInput_caa87cab145210000473a5695c1c0011"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Proposed Staff Representation"
        }
      }
    }
  ]
}

supervisoryOrganization_e868185fab874bb994e045d84ad1a658

{
  "description": "The \\~supervisory organization\\~ for the \\~worker\\~ as of the effective date.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

changeJobInput_cadd132f15994dc3bcda042ae1c90629

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "moveManagersTeam": {
          "type": "boolean",
          "description": "Returns a boolean that indicates whether teams reporting to the \\~Manager\\~ moved with them during the Change Job Event.",
          "example": true,
          "x-workday-type": "Boolean"
        },
        "jobChangeReason": {
          "$ref": "#/components/schemas/jobChangeReason_3679c9f487c4403b90fff56091c0e360"
        },
        "proposedOrganizations": {
          "type": "array",
          "description": "Contains the organizations with staffing behavior that are assigned to the position as a result of this event.\nAll staffing behavior organization types are included (company, cost center, region, custom organizations, fund, grant, program, gift, business unit).",
          "items": {
            "$ref": "#/components/schemas/proposedOrganizations_8c583abbeaf010000c765bd6c36d000c"
          },
          "x-workday-type": "Multi-instance"
        },
        "effective": {
          "type": "string",
          "description": "The date this business process takes effect.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "supervisoryOrganization": {
          "$ref": "#/components/schemas/supervisoryOrganization_e868185fab874bb994e045d84ad1a658"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

businessTitleChangeInput_0123d0c7e84e4263a53f5d74968690af

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "proposedBusinessTitle": {
          "type": "string",
          "description": "The new business title for the \\~worker\\~ as of the effective date.  If there is no business title override, this field defaults to the job title or job profile name.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

employee_436f2afb755f100012528fe3effe0015

{
  "description": "The \\~worker\\~ requesting the paid time off.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

timeOffRequest_436f2afb755f100012528fd1e2e60013

{
  "description": "Returns the Time Off Event which includes this Time Off Entry.",
  "allOf": [
    {
      "$ref": "#/components/schemas/timeOffEntryStatus_436f2afb755f1000125176952ea6000c"
    },
    {
      "type": "object"
    }
  ]
}

unitOfTime_436f2afb755f100012528fdc5a960014

{
  "description": "This is the unit of time (hours or days) associated with the time off for this time off entry.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

timeOff_436f2afb755f100012528fbfc62e0011

{
  "description": "The Time Off for this time off entry requested (Example: Vacation Time Off for Salaried \\~Employees\\~).",
  "allOf": [
    {
      "$ref": "#/components/schemas/timeOff_436f2afb755f10001245239d27960009"
    },
    {
      "type": "object"
    }
  ]
}

timeOffEntries_436f2afb755f100012528fa3260e000f

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "employee": {
          "$ref": "#/components/schemas/employee_436f2afb755f100012528fe3effe0015"
        },
        "timeOffRequest": {
          "$ref": "#/components/schemas/timeOffRequest_436f2afb755f100012528fd1e2e60013"
        },
        "unitOfTime": {
          "$ref": "#/components/schemas/unitOfTime_436f2afb755f100012528fdc5a960014"
        },
        "timeOff": {
          "$ref": "#/components/schemas/timeOff_436f2afb755f100012528fbfc62e0011"
        },
        "date": {
          "type": "string",
          "description": "The date requested to be taken for a paid time off request line item.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "units": {
          "type": "number",
          "description": "The units entered for a time off request line item for all status'.  Excludes adjustments.",
          "format": "double",
          "example": 100000000000,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

unitOfTime_581c389cce1410000feacb26b51c0003

{
  "description": "Identifies the unit of time for which time off and accruals are tracked for the Time Off plan.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

timeOffPlans_581c389cce1410000feacaebd2e40002

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "timeOffBalance": {
          "type": "number",
          "description": "Returns the time off balance including pending events for the \\~worker\\~ and time off plan.  This report field should be used within Calculated Fields.",
          "format": "double",
          "example": 100000000000,
          "x-workday-type": "Numeric"
        },
        "unitOfTime": {
          "$ref": "#/components/schemas/unitOfTime_581c389cce1410000feacb26b51c0003"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

initiator_7f6d98c3e99344df800de3b5defa4549

{
  "description": "The person that initiated the event for this event record.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

status_e00f98895a7b48e7a681a308f8b8ad71

{
  "description": "The status of this business process step.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

stepType_e351106ef7c14ce19def3e2a50eeb806

{
  "description": "Returns the type of step being performed by the event record.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

subject_9d3d194b5fe340cba946593757de5d10

{
  "description": "Returns the subject of the business process this event record is part of.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

overallProcess_f06a97ddf4794a5c8ff063bd51bfc2e4

{
  "description": "Returns the overall process for this event record. The overall process is the outermost process in a business process.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

inboxTaskSummary_1bbb07a8ab4349dd934ca72301974204

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "assigned": {
          "type": "string",
          "description": "Returns the date when the event record was last updated on.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "due": {
          "type": "string",
          "description": "Returns the due date for this step.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "initiator": {
          "$ref": "#/components/schemas/initiator_7f6d98c3e99344df800de3b5defa4549"
        },
        "status": {
          "$ref": "#/components/schemas/status_e00f98895a7b48e7a681a308f8b8ad71"
        },
        "stepType": {
          "$ref": "#/components/schemas/stepType_e351106ef7c14ce19def3e2a50eeb806"
        },
        "subject": {
          "$ref": "#/components/schemas/subject_9d3d194b5fe340cba946593757de5d10"
        },
        "overallProcess": {
          "$ref": "#/components/schemas/overallProcess_f06a97ddf4794a5c8ff063bd51bfc2e4"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

status_056982a2aa04100005cc4858775a0026

{
  "description": "Status",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

paySlipSummary_056982a2aa04100005cc479e6e5a0022

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "gross": {
          "type": "number",
          "description": "Gross Pay for a Payslip",
          "format": "double",
          "example": 100000000000,
          "x-workday-type": "Numeric"
        },
        "status": {
          "$ref": "#/components/schemas/status_056982a2aa04100005cc4858775a0026"
        },
        "date": {
          "type": "string",
          "description": "Payment Date",
          "format": "date",
          "x-workday-type": "Date"
        },
        "net": {
          "type": "number",
          "description": "Net Pay for a Payslip",
          "format": "double",
          "example": 100000000000,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

currencySummary_7ceb0e9ce857100019c6099ce1ad00fa

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "Currency ID - 3 character currency code identified by ISO 4217",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "precision": {
          "type": "integer",
          "description": "Decimal precision for currency amounts",
          "format": "int32",
          "example": 9,
          "x-workday-type": "Numeric"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

customer_b7ecfe5ec60c10000aa161405fa5002c

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the customer.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

invoiceOpportunity_671e9196f9971000115942211aba00a8

{
  "description": "The opportunity for the invoice.",
  "allOf": [
    {
      "$ref": "#/components/schemas/opportunityDisplay_c29dedec19201000119fd1d13ca40019"
    },
    {
      "type": "object"
    }
  ]
}

activity_bb1fcf6de05b100009ce64e02ac43c08

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "transactionNumber": {
          "type": "string",
          "description": "The transaction number for the reporting transaction. This is for internal use only on a REST API.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "transactionStatus": {
          "type": "string",
          "description": "The current status of the transaction. Applicable for all transaction types. This is for internal use only on a REST API.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "transactionType": {
          "type": "string",
          "description": "The transaction type of this customer transaction. This is for internal use only on a REST API.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "applicationStatus": {
          "type": "string",
          "description": "The payment or application status of the customer invoice, customer invoice adjustment or customer invoice payment. For customer invoice payments, the application status can be Unapplied, Applied with On Account, or Fully Applied. For invoices, the payment status can be Paid, Partially Paid, or Unpaid.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "maxLength": 36,
          "type": "string",
          "description": "Returns the Workday ID for a given object.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "invoiceDueDate": {
          "type": "string",
          "description": "The due date of the customer invoice or invoice adjustment as of the defined reporting date.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "invoiceOpportunity": {
          "$ref": "#/components/schemas/invoiceOpportunity_671e9196f9971000115942211aba00a8"
        },
        "paymentReference": {
          "type": "string",
          "description": "The check number for a customer payment. This is a reference number that's available only when processed through a settlement run and not a check number.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "transactionDate": {
          "type": "string",
          "description": "The date of the customer transaction. This field is for internal use only on a REST API.",
          "format": "date",
          "x-workday-type": "Date"
        },
        "transactionAmountSigned": {
          "type": "object",
          "description": "The positive or negative sign of the transaction amount for this customer transaction. This is for internal use only on a REST API.",
          "example": "99999999999.999999",
          "x-workday-type": "Currency"
        }
      }
    }
  ]
}

worktagWithAllowedValues_f08fabab3cae10000bd8f5a584f100c1

{
  "description": "For REST API responses only. Worktags that are configured with allowed values.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

invalidWorktagValues_f08fabab3cae10000bed7987306400c3

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagInput_aa8aaaaeca39100034443e493aef03ce"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Representation (Derived)"
        }
      }
    }
  ]
}

worktagsComboInput_f08fabab3cae10000b041ae3234b009d

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "worktagWithAllowedValues": {
          "$ref": "#/components/schemas/worktagWithAllowedValues_f08fabab3cae10000bd8f5a584f100c1"
        },
        "invalidWorktagValues": {
          "type": "array",
          "description": "For REST API responses only. Worktags from the REST request that are invalid for the worktag with allowed values.",
          "items": {
            "$ref": "#/components/schemas/invalidWorktagValues_f08fabab3cae10000bed7987306400c3"
          },
          "x-workday-type": "Multi-instance"
        }
      }
    }
  ]
}

proposedStaffsInput_caa87cab145210000473a5695c1c0011

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

restrictionInput_4b3cd975feb010000567e14324830071

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

plan_436f2afb755f1000124523c2d036000a

{
  "description": "The time off plan that the accrual or time off belongs to.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

timeOff_436f2afb755f10001245239d27960009

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "plan": {
          "$ref": "#/components/schemas/plan_436f2afb755f1000124523c2d036000a"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "The id for Time Off"
        }
      }
    }
  ]
}

worktagInput_aa8aaaaeca39100034443e493aef03ce

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

worktagValidationTypeInput_7ccdf8f26ee910000b6a70bc5fd600c2

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

missingWorktagTypes_854b3abfd54d10000e80396c4dd1327a

{
  "allOf": [
    {
      "$ref": "#/components/schemas/worktagTypeInput_3f71b007c34610000e0bb926bf370056"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Worktag Type Representation (Derived)"
        }
      }
    }
  ]
}

worktagWithRequiredWorktags_854b3abfd54d10000e8038f3ed3f3279

{
  "description": "For REST API responses only. Worktags configured with required worktag types in their related worktags.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

worktagAndTypeInput_854b3abfd54d10000e8038b032223278

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "missingWorktagTypes": {
          "type": "array",
          "description": "For REST API responses only. The worktag types that are configured as required in related worktags but are missing in the request.",
          "items": {
            "$ref": "#/components/schemas/missingWorktagTypes_854b3abfd54d10000e80396c4dd1327a"
          },
          "x-workday-type": "Multi-instance"
        },
        "worktagWithRequiredWorktags": {
          "$ref": "#/components/schemas/worktagWithRequiredWorktags_854b3abfd54d10000e8038f3ed3f3279"
        }
      }
    }
  ]
}

invalidRestrictedToValues_f08fabab3cae10002bec470e736c0279

{
  "allOf": [
    {
      "$ref": "#/components/schemas/restrictionInput_4b3cd975feb010000567e14324830071"
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The id for Restriction Representation (Derived)"
        }
      }
    }
  ]
}

worktagWithRestrictedToValues_f08fabab3cae10002bec472cf4f9027a

{
  "description": "For REST API responses only. Worktags that are configured with Restricted To values.",
  "allOf": [
    {
      "$ref": "#/components/schemas/INSTANCE_MODEL_REFERENCE"
    },
    {
      "type": "object"
    }
  ]
}

worktagAndRestrictionInput_f08fabab3cae10001a2f1a982daa01b5

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "invalidRestrictedToValues": {
          "type": "array",
          "description": "For REST API responses only. The invalid Restricted To values for worktags.",
          "items": {
            "$ref": "#/components/schemas/invalidRestrictedToValues_f08fabab3cae10002bec470e736c0279"
          },
          "x-workday-type": "Multi-instance"
        },
        "worktagWithRestrictedToValues": {
          "$ref": "#/components/schemas/worktagWithRestrictedToValues_f08fabab3cae10002bec472cf4f9027a"
        }
      }
    }
  ]
}

opportunityDisplay_c29dedec19201000119fd1d13ca40019

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "The non-unique name of the Opportunity. This is for internal use only.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "opportunityReferenceID": {
          "type": "string",
          "description": "The Reference ID to use for lookups within our Workday Web Services. For \\~supervisory organizations\\~, this is also the 'Organization ID'",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "id": {
          "maxLength": 36,
          "type": "string",
          "description": "The id for Opportunity",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        }
      }
    }
  ]
}

worktagTypeInput_3f71b007c34610000e0bb926bf370056

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

timeOffEntryStatus_436f2afb755f1000125176952ea6000c

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "status": {
          "type": "string",
          "description": "The current status of the business process.  For example: Successfully Completed, Denied, Terminated.",
          "example": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
          "x-workday-type": "Text"
        },
        "descriptor": {
          "type": "string",
          "description": "The display name of the instance",
          "example": "Lorem ipsum dolor sit ame"
        },
        "href": {
          "type": "string",
          "description": "A link to the instance"
        },
        "id": {
          "type": "string",
          "description": "Workday Id or Reference Id of the instance."
        }
      }
    }
  ]
}

securitySchemes

OAuth2

{
  "type": "oauth2",
  "flows": {
    "implicit": {
      "authorizationUrl": "https://<tenantAuthorizationHostname>",
      "scopes": {}
    }
  }
}

Document metadata and extensions

{
  "openapi": "3.0.1",
  "info": {
    "title": "common",
    "description": "The public Workday API.",
    "version": "v1",
    "x-workday-internal-source": "xo",
    "x-workday-internal-routing": "Public",
    "x-workday-internal-protected-usage-enabled": false,
    "x-workday-internal-service-container-id": "27d54c0f796e10000b3b7fd383f2002b"
  },
  "tags": [
    {
      "name": "businessTitleChanges"
    },
    {
      "name": "currencies"
    },
    {
      "name": "customers"
    },
    {
      "name": "jobChangeReasons"
    },
    {
      "name": "organizationTypes"
    },
    {
      "name": "organizations",
      "description": "Retrieves organizations for the specified organization type. If you don't specify the organizationType query parameter, this endpoint returns no results."
    },
    {
      "name": "supervisoryOrganizations"
    },
    {
      "name": "validateWorktags",
      "description": "DEPRECATED as of 02/03/2024. Workday recommends that you use the Worktag v1 REST service instead."
    },
    {
      "name": "workers",
      "description": "A collection of workers in Workday"
    }
  ],
  "security": [
    {
      "OAuth2": []
    }
  ],
  "x-purple-suite-contract": "full-service-repository-modeled-runtime",
  "x-purple-suite-upstream-servers": [
    {
      "url": "https://<tenantHostname>/api/common/v1"
    }
  ],
  "x-purple-suite-runtime-fidelity": {
    "capturedOperationIds": [],
    "modeledOperationIds": [
      "workdayCommonPostValidateWorktags",
      "workdayCommonGetOrganizations",
      "workdayCommonGetOrganizationsByID",
      "workdayCommonGetSupervisoryOrganizations",
      "workdayCommonGetSupervisoryOrganizationsByIDWorkersBySubresourceID",
      "workdayCommonGetSupervisoryOrganizationsByIDWorkers",
      "workdayCommonGetSupervisoryOrganizationsByID",
      "workdayCommonGetJobChangeReasons",
      "workdayCommonGetJobChangeReasonsByID",
      "workdayCommonGetBusinessTitleChangesByID",
      "workdayCommonGetOrganizationTypes",
      "workdayCommonGetOrganizationTypesByID",
      "workdayCommonGetWorkers",
      "workdayCommonGetWorkersByIDDirectReports",
      "workdayCommonGetWorkersByIDDirectReportsBySubresourceID",
      "workdayCommonGetWorkersByIDOrganizations",
      "workdayCommonGetWorkersByIDOrganizationsBySubresourceID",
      "workdayCommonGetWorkersByIDInboxTasksBySubresourceID",
      "workdayCommonGetWorkersByIDTimeOffEntries",
      "workdayCommonPostWorkersByIDBusinessTitleChangesTypeMe",
      "workdayCommonGetWorkersByIDHistoryBySubresourceID",
      "workdayCommonGetWorkersByIDTimeOffEntriesBySubresourceID",
      "workdayCommonGetWorkersByIDTimeOffPlansBySubresourceID",
      "workdayCommonGetWorkersByIDBusinessTitleChanges",
      "workdayCommonPostWorkersByIDBusinessTitleChanges",
      "workdayCommonGetWorkersByIDSupervisoryOrganizationsManaged",
      "workdayCommonGetWorkersByIDTimeOffPlans",
      "workdayCommonGetWorkersByIDPaySlipsBySubresourceID",
      "workdayCommonGetWorkersByIDHistory",
      "workdayCommonGetWorkersByID",
      "workdayCommonPostWorkersByIDJobChanges",
      "workdayCommonGetWorkersByIDInboxTasks",
      "workdayCommonGetWorkersByIDSupervisoryOrganizationsManagedBySubresourceID",
      "workdayCommonGetWorkersByIDPaySlips",
      "workdayCommonGetWorkersByIDBusinessTitleChangesBySubresourceID",
      "workdayCommonGetCurrencies",
      "workdayCommonGetCurrenciesByID",
      "workdayCommonGetCustomersByIDActivities",
      "workdayCommonGetCustomersByIDActivitiesBySubresourceID",
      "workdayCommonGetCustomersByID"
    ],
    "operations": [
      {
        "operationId": "workdayCommonPostValidateWorktags",
        "method": "post",
        "path": "/common/v1/validateWorktags",
        "upstreamPath": "/validateWorktags",
        "fidelity": "modeled",
        "xWorkdayOperationId": "aa8aaaaeca3910002f9fbcab1262036e"
      },
      {
        "operationId": "workdayCommonGetOrganizations",
        "method": "get",
        "path": "/common/v1/organizations",
        "upstreamPath": "/organizations",
        "fidelity": "modeled",
        "xWorkdayOperationId": "a03132f19b91100011bb405bfeb70034"
      },
      {
        "operationId": "workdayCommonGetOrganizationsByID",
        "method": "get",
        "path": "/common/v1/organizations/{ID}",
        "upstreamPath": "/organizations/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "a03132f19b91100011bb405bfeb70034"
      },
      {
        "operationId": "workdayCommonGetSupervisoryOrganizations",
        "method": "get",
        "path": "/common/v1/supervisoryOrganizations",
        "upstreamPath": "/supervisoryOrganizations",
        "fidelity": "modeled",
        "xWorkdayOperationId": "22c69260c8784717a6a7bdec9efbca32"
      },
      {
        "operationId": "workdayCommonGetSupervisoryOrganizationsByIDWorkersBySubresourceID",
        "method": "get",
        "path": "/common/v1/supervisoryOrganizations/{ID}/workers/{subresourceID}",
        "upstreamPath": "/supervisoryOrganizations/{ID}/workers/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "5c954a75094a4f6183f8602897afd7ff"
      },
      {
        "operationId": "workdayCommonGetSupervisoryOrganizationsByIDWorkers",
        "method": "get",
        "path": "/common/v1/supervisoryOrganizations/{ID}/workers",
        "upstreamPath": "/supervisoryOrganizations/{ID}/workers",
        "fidelity": "modeled",
        "xWorkdayOperationId": "5c954a75094a4f6183f8602897afd7ff"
      },
      {
        "operationId": "workdayCommonGetSupervisoryOrganizationsByID",
        "method": "get",
        "path": "/common/v1/supervisoryOrganizations/{ID}",
        "upstreamPath": "/supervisoryOrganizations/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "22c69260c8784717a6a7bdec9efbca32"
      },
      {
        "operationId": "workdayCommonGetJobChangeReasons",
        "method": "get",
        "path": "/common/v1/jobChangeReasons",
        "upstreamPath": "/jobChangeReasons",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0edf6078b26046bb988499f0b7f92dee"
      },
      {
        "operationId": "workdayCommonGetJobChangeReasonsByID",
        "method": "get",
        "path": "/common/v1/jobChangeReasons/{ID}",
        "upstreamPath": "/jobChangeReasons/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0edf6078b26046bb988499f0b7f92dee"
      },
      {
        "operationId": "workdayCommonGetBusinessTitleChangesByID",
        "method": "get",
        "path": "/common/v1/businessTitleChanges/{ID}",
        "upstreamPath": "/businessTitleChanges/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "45a9c799b3fd4e70a0b53d07c20c867f"
      },
      {
        "operationId": "workdayCommonGetOrganizationTypes",
        "method": "get",
        "path": "/common/v1/organizationTypes",
        "upstreamPath": "/organizationTypes",
        "fidelity": "modeled",
        "xWorkdayOperationId": "e91ac1399cd410000486288a174f0ec9"
      },
      {
        "operationId": "workdayCommonGetOrganizationTypesByID",
        "method": "get",
        "path": "/common/v1/organizationTypes/{ID}",
        "upstreamPath": "/organizationTypes/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "e91ac1399cd410000486288a174f0ec9"
      },
      {
        "operationId": "workdayCommonGetWorkers",
        "method": "get",
        "path": "/common/v1/workers",
        "upstreamPath": "/workers",
        "fidelity": "modeled",
        "xWorkdayOperationId": "94a39e71541b468fa895955508287acd"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDDirectReports",
        "method": "get",
        "path": "/common/v1/workers/{ID}/directReports",
        "upstreamPath": "/workers/{ID}/directReports",
        "fidelity": "modeled",
        "xWorkdayOperationId": "3dad5f33d6974b2691f53037644f40be"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDDirectReportsBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/directReports/{subresourceID}",
        "upstreamPath": "/workers/{ID}/directReports/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "3dad5f33d6974b2691f53037644f40be"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDOrganizations",
        "method": "get",
        "path": "/common/v1/workers/{ID}/organizations",
        "upstreamPath": "/workers/{ID}/organizations",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b09201ecbe6f10000c612f777e670015"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDOrganizationsBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/organizations/{subresourceID}",
        "upstreamPath": "/workers/{ID}/organizations/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b09201ecbe6f10000c612f777e670015"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDInboxTasksBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/inboxTasks/{subresourceID}",
        "upstreamPath": "/workers/{ID}/inboxTasks/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d02ccd56f7894dabb8e0dd66e42e94b9"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDTimeOffEntries",
        "method": "get",
        "path": "/common/v1/workers/{ID}/timeOffEntries",
        "upstreamPath": "/workers/{ID}/timeOffEntries",
        "fidelity": "modeled",
        "xWorkdayOperationId": "436f2afb755f1000125443cdc76e0017"
      },
      {
        "operationId": "workdayCommonPostWorkersByIDBusinessTitleChangesTypeMe",
        "method": "post",
        "path": "/common/v1/workers/{ID}/businessTitleChanges?type=me",
        "upstreamPath": "/workers/{ID}/businessTitleChanges?type=me",
        "fidelity": "modeled",
        "queryDiscriminator": {
          "parameter": "type",
          "value": "me"
        },
        "xWorkdayOperationId": "9c0a3c288a2c1000017eb88849a30002"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDHistoryBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/history/{subresourceID}",
        "upstreamPath": "/workers/{ID}/history/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0d02120b4f9f4494adf71d47d6621668"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDTimeOffEntriesBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/timeOffEntries/{subresourceID}",
        "upstreamPath": "/workers/{ID}/timeOffEntries/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "436f2afb755f1000125443cdc76e0017"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDTimeOffPlansBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/timeOffPlans/{subresourceID}",
        "upstreamPath": "/workers/{ID}/timeOffPlans/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "581c389cce1410000ff399298ba10006"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDBusinessTitleChanges",
        "method": "get",
        "path": "/common/v1/workers/{ID}/businessTitleChanges",
        "upstreamPath": "/workers/{ID}/businessTitleChanges",
        "fidelity": "modeled",
        "xWorkdayOperationId": "a865e2c38bd74c80a6f289390d3e619f"
      },
      {
        "operationId": "workdayCommonPostWorkersByIDBusinessTitleChanges",
        "method": "post",
        "path": "/common/v1/workers/{ID}/businessTitleChanges",
        "upstreamPath": "/workers/{ID}/businessTitleChanges",
        "fidelity": "modeled",
        "xWorkdayOperationId": "c2ffb30053964fbfa7a46dcfa577adb1"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDSupervisoryOrganizationsManaged",
        "method": "get",
        "path": "/common/v1/workers/{ID}/supervisoryOrganizationsManaged",
        "upstreamPath": "/workers/{ID}/supervisoryOrganizationsManaged",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b6044838fb1f100001fe0872896b0002"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDTimeOffPlans",
        "method": "get",
        "path": "/common/v1/workers/{ID}/timeOffPlans",
        "upstreamPath": "/workers/{ID}/timeOffPlans",
        "fidelity": "modeled",
        "xWorkdayOperationId": "581c389cce1410000ff399298ba10006"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDPaySlipsBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/paySlips/{subresourceID}",
        "upstreamPath": "/workers/{ID}/paySlips/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "056982a2aa04100005cd56c3da4a0028"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDHistory",
        "method": "get",
        "path": "/common/v1/workers/{ID}/history",
        "upstreamPath": "/workers/{ID}/history",
        "fidelity": "modeled",
        "xWorkdayOperationId": "0d02120b4f9f4494adf71d47d6621668"
      },
      {
        "operationId": "workdayCommonGetWorkersByID",
        "method": "get",
        "path": "/common/v1/workers/{ID}",
        "upstreamPath": "/workers/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "94a39e71541b468fa895955508287acd"
      },
      {
        "operationId": "workdayCommonPostWorkersByIDJobChanges",
        "method": "post",
        "path": "/common/v1/workers/{ID}/jobChanges",
        "upstreamPath": "/workers/{ID}/jobChanges",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b4f1492ac4c741378c8d71305f9553f5"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDInboxTasks",
        "method": "get",
        "path": "/common/v1/workers/{ID}/inboxTasks",
        "upstreamPath": "/workers/{ID}/inboxTasks",
        "fidelity": "modeled",
        "xWorkdayOperationId": "d02ccd56f7894dabb8e0dd66e42e94b9"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDSupervisoryOrganizationsManagedBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/supervisoryOrganizationsManaged/{subresourceID}",
        "upstreamPath": "/workers/{ID}/supervisoryOrganizationsManaged/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b6044838fb1f100001fe0872896b0002"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDPaySlips",
        "method": "get",
        "path": "/common/v1/workers/{ID}/paySlips",
        "upstreamPath": "/workers/{ID}/paySlips",
        "fidelity": "modeled",
        "xWorkdayOperationId": "056982a2aa04100005cd56c3da4a0028"
      },
      {
        "operationId": "workdayCommonGetWorkersByIDBusinessTitleChangesBySubresourceID",
        "method": "get",
        "path": "/common/v1/workers/{ID}/businessTitleChanges/{subresourceID}",
        "upstreamPath": "/workers/{ID}/businessTitleChanges/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "a865e2c38bd74c80a6f289390d3e619f"
      },
      {
        "operationId": "workdayCommonGetCurrencies",
        "method": "get",
        "path": "/common/v1/currencies",
        "upstreamPath": "/currencies",
        "fidelity": "modeled",
        "xWorkdayOperationId": "4b1c5da0cff34a3c88438ffebbfbd970"
      },
      {
        "operationId": "workdayCommonGetCurrenciesByID",
        "method": "get",
        "path": "/common/v1/currencies/{ID}",
        "upstreamPath": "/currencies/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "4b1c5da0cff34a3c88438ffebbfbd970"
      },
      {
        "operationId": "workdayCommonGetCustomersByIDActivities",
        "method": "get",
        "path": "/common/v1/customers/{ID}/activities",
        "upstreamPath": "/customers/{ID}/activities",
        "fidelity": "modeled",
        "xWorkdayOperationId": "c29dedec19201000115c769e98610014"
      },
      {
        "operationId": "workdayCommonGetCustomersByIDActivitiesBySubresourceID",
        "method": "get",
        "path": "/common/v1/customers/{ID}/activities/{subresourceID}",
        "upstreamPath": "/customers/{ID}/activities/{subresourceID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "c29dedec19201000115c769e98610014"
      },
      {
        "operationId": "workdayCommonGetCustomersByID",
        "method": "get",
        "path": "/common/v1/customers/{ID}",
        "upstreamPath": "/customers/{ID}",
        "fidelity": "modeled",
        "xWorkdayOperationId": "b7ecfe5ec60c10000ac57590b2650034"
      }
    ]
  },
  "x-purple-suite-runtime-path-canonicalization": [
    {
      "documentedPath": "/common/v1/workers/{ID}/businessTitleChanges?type=me",
      "runtimePath": "/common/v1/workers/:ID/businessTitleChanges",
      "queryDiscriminator": {
        "parameter": "type",
        "value": "me"
      },
      "reason": "The pinned Workday artifact encodes a query string in an OpenAPI path key; HTTP routing canonicalizes only this exact single-value discriminator."
    }
  ],
  "x-purple-suite-exclusions": [
    "Workday Web Services (SOAP/WWS)",
    "Workday Graph API",
    "Workday Query Language (WQL), a separate Platform API family",
    "Reports-as-a-Service (RaaS) and tenant custom reports",
    "Finance, Payroll, Student, and non-HR Platform REST services",
    "Experimental alpha, beta, and labs services",
    "Tenant-configured actions absent from the pinned public artifacts"
  ]
}