Workday (Beta) Component
Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.
Component key: workday · · Changelog ↓Description
BETA component connections and actions may not always work as expected. Please report any feedback through the support channel.
Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.
The Workday component allows managing Organizations, People, Workers, and more.
API Documentation
This component was built using the Workday REST Services API reference.
Connections
OAuth 2.0
key: workdayOAuth2ConnectionPrerequisites
Before configuring the connection, the following are required:
- A Workday tenant ID.
- Administrator access to the Workday tenant to register an API client.
- The Workday domain used by the tenant (for building the API base URL).
Setup Steps
The API client is registered in the Workday portal based on the category. This process also surfaces the information required to set up the Workday REST Access Token account.
-
Log into the Workday Portal
- Use valid Workday Org admin credentials.
- Format:
https://impl.workday.com/wday/authgwy/<tenant_name>/login.htmld
-
Search and Register
- From the Search menu for the Workday categories, select Register API Client and click Register.
-
Provide Mandatory Details
- Client Name: Specify a name for the API Client.
- Client Grant Type: Select
Authorization Code Grant. - Enforce 60 Minutes Access Token Expiry: Ensure this is selected so the auto-refresh token works correctly in the Workday REST OAuth2 Account.
- Access Token Type: Select
Bearer. - Redirect URL: Enter the redirect URL:
https://oauth2.prismatic.io/callback - Scope: Select the required services from the dropdown list.
-
Complete Registration
- Click Done.
After the API client is registered in the Workday portal, note the Client ID, Client Secret, and Endpoints to be used in the integration workflow.
Configure the Connection
Create a connection of type OAuth 2.0 and provide the following inputs:
- Authorize URL (required) — The OAuth 2.0 Authorization URL for Workday. Replace
<tenant_id>with the Workday tenant ID. - Token URL (required) — The OAuth 2.0 Token URL for Workday. Replace
<tenant_id>with the Workday tenant ID. - Scopes (optional) — Space-separated list of OAuth 2.0 scopes, if any are required.
- Client ID (required) — The OAuth 2.0 client ID issued by Workday for the registered API client.
- Client secret (required) — The OAuth 2.0 client secret paired with the Workday client ID.
- API URL (required) — The base URL for the Workday API. Replace
<domain>with the Workday domain.
| Input | Notes | Example |
|---|---|---|
| API URL | The base URL for the Workday API. Replace <domain> with the Workday domain. | https://<domain>/ccx |
| Authorize URL | The OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with the tenant ID. | https://impl.workday.com/<tenant_id>/authorize |
| Client ID | The OAuth 2.0 client ID issued by Workday for the registered API client. | |
| Client secret | The OAuth 2.0 client secret paired with the Workday client ID. | |
| Scopes | Space-separated list of OAuth 2.0 scopes, if any are required. | |
| Token URL | The OAuth 2.0 Token URL for Workday. Replace <tenant_id> with the tenant ID. | https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant_id>/token |
Data Sources
Select Data Change
A picklist of data changes in your Workday Prism Analytics tenant. | key: selectDataChange | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tenant | The Workday tenant name used in API paths. |
{
"result": [
{
"label": "Employee Data Upload",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Event
A picklist of business process events in your Workday tenant. | key: selectEvent | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "Hire: John Smith",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Invoice
A picklist of customer invoices in your Workday tenant. | key: selectInvoice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "INV-001234",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Message Template
A picklist of message templates in your Workday tenant. | key: selectMessageTemplate | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "Welcome Email Template",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Organization
A picklist of organizations in your Workday tenant. | key: selectOrganization | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "Engineering Department",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Person
A picklist of people in your Workday tenant. | key: selectPerson | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "3aa5550b7fe348b98d7b5741afc65534",
"key": "3aa5550b7fe348b98d7b5741afc65534"
}
]
}
Select Supplier Invoice Request
A picklist of supplier invoice requests in your Workday tenant. | key: selectSupplierInvoiceRequest | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "Invoice Request #1001",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Table
A picklist of tables in your Workday Prism Analytics tenant. | key: selectTable | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tenant | The Workday tenant name used in API paths. |
{
"result": [
{
"label": "Employee Demographics",
"key": "5d115c9c-44e3-ea11-bb43-000d3a2feca1"
}
]
}
Select Worker
A picklist of workers in your Workday tenant. | key: selectWorker | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection |
{
"result": [
{
"label": "John Smith",
"key": "3aa5550b7fe348b98d7b5741afc65534"
}
]
}
Actions
Create File Container
Creates a new file container. | key: postFileContainers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"id": "string"
}
}
Create Job Change
Creates a job change instance with the specified data. | key: postJobChanges
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Effective Date | The date this business process takes effect. | 2022-01-01 |
| Instance Descriptor | Human-readable preview label for the referenced instance. | |
| Instance Href | Direct API link pointing to the referenced instance. | |
| Instance ID | Identifies the Workday instance being referenced. | |
| Job Change Reason ID | Identifies the reason used in a Change Job business process. | 123$456 |
| Move Managers Team | When true, also moves subordinate teams to the new manager. | false |
| Proposed Organizations | Organizations with staffing behavior assigned to the position as a result of this event. | |
| Supervisory Organization ID | Supervisory organization assigned to the worker as of the effective date. | 123$456 |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"supervisoryOrganization": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobChangeReason": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"moveManagersTeam": true,
"effective": "2024-06-01T07:00:00.000Z",
"proposedOrganizations": [
{
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Create Message Template
Creates a new message template. | key: postMessageTemplates
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Connection | ||
| Created By ID | Identifies the user who created the record. | |
| Email Detail | Details for the email. | |
| Message Template Name | Display name given to the message template. | |
| Push Detail | Details for the push notification. | |
| Reference ID | Reference ID used for lookups within Workday Web Services. | |
| Template Descriptor | Human-readable descriptor for the template. | |
| Template ID | Identifies the message template record. | |
| Template Inactive | When true, marks the template as inactive. | true |
{
"data": {
"createdBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"emailDetail": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"body": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"subject": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"replyTo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"lastUpdated": "2024-06-08T07:00:00.000Z",
"pushDetail": {
"redirectURL": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"message": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"usageCount": "2001658030",
"createdOn": "2024-06-08T07:00:00.000Z",
"notificationType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"lastUpdatedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inactive": true,
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Create Payment
Creates a single customer invoice payment header instance with the specified data. | key: postPayment
| Input | Notes | Example |
|---|---|---|
| Amount | Monetary amount for the payment. | |
| Company ID | Identifies the Workday company. | |
| Connection | ||
| Payment Date | Date the payment was made. | |
| Memo | Free-text memo attached to the transaction. | |
| Payment Descriptor | Human-readable descriptor for the payment. | |
| Payment ID | Optional identifier to assign to the payment on creation. | |
| Ready to Auto Apply | When true, flags the payment as ready for automatic application. | true |
| Reference | External reference string associated with the payment. | |
| Remit From Customer ID | Identifies the customer remitting the payment. | |
| Transaction Number | Bank transaction number associated with the payment. | |
| Type ID | Identifies the payment type. |
{
"data": {
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"remitFromCustomer": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"readyToAutoApply": true,
"transactionNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"reference": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"amount": "1475402065",
"type": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"date": "2024-06-08T07:00:00.000Z",
"company": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Create Supplier Invoice Request
Creates a supplier invoice request with the specified data. | key: postSupplierInvoiceRequests
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Company ID | Identifies the Workday company. | |
| Connection | ||
| Control Total Amount | Expected total amount used to validate invoice line totals. | |
| Currency ID | Identifies the currency used for the invoice. | |
| Memo | Free-text memo attached to the transaction. | |
| Payment Terms ID | Identifies the payment terms that apply to the invoice. | |
| Reference Type ID | Identifies the reference type for the invoice. | |
| Requester ID | Identifies the worker who requested the invoice. | |
| Supplier Invoice ID | Identifies the supplier invoice. | |
| Supplier Invoice Descriptor | Human-readable descriptor for the supplier invoice. | |
| Tax Amount | Total tax amount applied to the invoice. |
{
"data": {
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"company": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"taxAmount": "559571748",
"requester": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"controlTotalAmount": "1402330559",
"paymentTerms": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"lines": [
{
"unitCost": "482931938",
"internalMemo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"worktags": [
{
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"itemDescription": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"splits": [
{
"percent": "640",
"billable": true,
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"quantity": "1219127822",
"amount": "1629252870",
"worktags": [
{
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"order": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"billable": true,
"splitBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"quantity": "884590584",
"extendedAmount": "594603050",
"spendCategory": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"unitOfMeasure": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"serviceLine": true,
"item": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"statutoryInvoiceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"suppliersInvoiceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"referenceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"invoiceReceivedDate": "2024-06-08T07:00:00.000Z",
"freightAmount": "972111269",
"supplier": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"handlingCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"shipToAddress": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"invoiceDate": "2024-06-08T07:00:00.000Z",
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"remitToConnection": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Create Supplier Invoice Request Attachment
Creates attachments for the specified supplier invoice. | key: postSupplierInvoiceRequestsAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Content Type ID | Identifies the MIME content type of the attachment. | |
| File Length | Size of the attached file in bytes. | 1307948067 |
| File Name | Display name of the attached file. | |
| Supplier Invoice Request Attachment Descriptor | Human-readable descriptor for the attachment. | |
| Supplier Invoice Request Attachment ID | Identifies the attachment on the supplier invoice request. | |
| Supplier Invoice Request ID | Identifies the supplier invoice request. |
{
"data": {
"fileLength": "1307948067",
"contentType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fileName": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Create Table
Creates a new table with the specified name. | key: postTable
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Description | Short description shown alongside the table. | |
| Display Name | User-facing display name shown in Prism Analytics. | |
| Documentation | Long-form documentation describing how the table is used. | |
| Enable For Analysis | When true, enables the table for Prism Analytics. | false |
| Fields | The fields of the table. An array of objects. See Workday API documentation for more information. | |
| Name | Internal name used to reference the table via API. | |
| Tags | The tags of the table. An array of objects with id and name. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"displayName": "string",
"description": "string",
"documentation": "string",
"enableForAnalysis": false,
"name": "string",
"tags": [
{
"id": "string",
"name": "string"
}
],
"fields": [
{
"id": "string",
"name": "string",
"ordinal": 0,
"description": "string",
"parseFormat": "string",
"type": {
"name": "Boolean",
"id": "Schema_Field_Type=Boolean"
},
"precision": 0,
"scale": 0,
"businessObject": {
"id": "string",
"descriptor": "string"
},
"context": {
"id": "string",
"descriptor": "string"
},
"displayName": "string",
"defaultValue": "string",
"fieldId": "string",
"required": false,
"externalId": false
}
],
"id": "string",
"empty": false,
"published": false,
"stats": {
"rows": "string",
"size": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"updatedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"updatedMoment": "string",
"dateRefreshed": "string",
"tablePermissions": {
"canView": false,
"canEdit": false,
"canDelete": false,
"canShare": false,
"canPublish": false,
"canAppendTableData": false,
"canReplaceTableData": false,
"canTruncateTableData": false,
"canDeleteTableData": false,
"canEditDataSourceSecurity": false,
"selectTableData": false
}
}
}
Create Worker Business Title Change
Creates a new business title change for the specified worker. | key: postWorkerBusinessTitleChange
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Instance Descriptor | Human-readable preview label for the referenced instance. | |
| Instance Href | Direct API link pointing to the referenced instance. | |
| Instance ID | Identifies the Workday instance being referenced. | |
| Proposed Business Title | 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. | |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"proposedBusinessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Create Worker Time Block
Creates a worker time block for the specified worker. | key: postWorkerTimeBlock
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Comment | Free-text comment attached to the reported time block. | |
| Connection | ||
| Do Not Bill | When true, marks the time block as non-billable. | false |
| Instance Descriptor | Human-readable preview label for the referenced instance. | |
| Instance ID | Identifies the Workday instance being referenced. | |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"customWorktag07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag13": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag15": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag14": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag11": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag12": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculatedTimeDetails": [
{
"overrideRate": "3.3",
"shiftDate": "2019-11-11T08:00:00.000Z",
"calculatedQuantity": "20",
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculatedDate": "2019-11-05T08:00:00.000Z",
"calculatedInTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculationTags": [
{
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"calendarDate": "2019-11-12T17:00:00.000Z",
"calculatedOutTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string"
}
],
"customOrganization10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"appropriation": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"allocationPool": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"program": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobProfile": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"costCenter": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"grant": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"businessUnit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"region": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fund": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"reportedQuantity": "8",
"gift": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "This is a comment.",
"unit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calendarDate": "2024-06-01T07:00:00.000Z",
"timeEntryCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"projectRole": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overrideRate": "3",
"projectPlanPhase": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"inTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"outTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"inTime": "2024-06-01T07:00:00.000Z",
"outReason": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"outTime": "2024-06-01T07:00:00.000Z",
"project": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"doNotBill": true,
"projectPlanTask": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Delete Time Clock Event by ID
Deletes a time clock event with the specified ID. | key: deleteTimeClockEventsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Time Clock Event ID | Identifies the time clock event record. |
{
"data": {}
}
Delete Worker Time Block
Deletes a worker time block with the specified ID for the specified worker. | key: deleteWorkerTimeBlock
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Worker ID | Unique identifier for the Workday worker record. | |
| Worker Time Block ID | Identifies the worker's reported time block. |
{
"data": {}
}
Get Customer by ID
Retrieves customer by ID. | key: getCustomerById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer ID | Identifies the customer account. |
{
"data": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Get Data Change by ID
Data change is a Prism artifact that gives users the ability to easily load data into a Prism table so that they can use the table for analysis in downstream applications (Discovery Board, Reports, apps like Accounting Center/People Analytics) Data from multiple sources. | key: getDataChangesById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data Change ID | Identifies the Prism Analytics data change transaction. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"id": "string",
"name": "string",
"displayName": "string",
"source": {
"sourceType": "UPLOAD",
"id": "string",
"name": "string",
"parms": [
{
"fileNamePattern": "string",
"prompts": {
"descriptor": "string",
"doNotPromptAtRuntime": false,
"operator": {
"id": "string",
"descriptor": "string"
},
"externalField": {
"id": "string",
"descriptor": "string"
},
"promptQualifier": {
"id": "string",
"descriptor": "string"
},
"externalParameter": {
"id": "string",
"descriptor": "string"
},
"displayOptions": [
{
"id": "string",
"descriptor": "string"
}
],
"xmlAlias": "string",
"order": "string",
"wqlAlias": "string",
"label": "string",
"dynamicValue": {
"id": "string",
"descriptor": "string"
},
"xmlSchemaType": "string",
"promptValue": {
"attributeValue": "string",
"workdataType": {
"id": "string",
"type": "string",
"descriptor": "string"
},
"instanceValue": [
{
"id": "string",
"descriptor": "string"
}
]
}
}
}
],
"schema": {
"fields": [
{
"id": "string",
"name": "string",
"ordinal": 0,
"description": "string",
"parseFormat": "string",
"type": {
"name": "Boolean",
"id": "Schema_Field_Type=Boolean"
},
"precision": 0,
"scale": 0,
"businessObject": {
"id": "string",
"descriptor": "string"
},
"context": {
"id": "string",
"descriptor": "string"
}
}
],
"parseOptions": {
"type": "string",
"charset": "string",
"fieldsDelimitedBy": "string",
"headerLinesToIgnore": 0,
"fieldsEnclosedBy": "string",
"ignoreTrailingExtraFields": false,
"ignoreTrailingMissingFields": false,
"recordsDelimitedBy": "string",
"ignoreTrailingWhitespaces": false,
"ignoreLeadingWhitespaces": false,
"fieldsEnclosingCharacterEscapedBy": "string",
"ignoreTrailingWhitespacesInQuotes": "string",
"ignoreLeadingWhitespacesInQuotes": "string",
"commentCharacter": "string"
}
}
},
"target": {
"id": "string",
"name": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"modifiedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"modifiedMoment": "string",
"operation": {
"operationType": "APPEND",
"operationKeys": [
"string"
]
},
"mappings": [
{
"sourceFieldName": "string",
"targetFieldName": "string"
}
],
"errorMessage": "string",
"updatedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"updatedMoment": "string"
}
}
Get Event Attachments
Retrieves attachments on the specified business process event that the processing user has permission to view. | key: getEventAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event ID | Identifies the business process event. | |
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
{
"data": {
"data": [
{
"uploadedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"description": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"category": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"contentType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fileLength": "495160246",
"fileName": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"uploadDate": "2024-06-08T07:00:00.000Z",
"id": "string"
}
],
"total": 0
}
}
Get Event by ID
Retrieves the business process event with the specified ID. | key: getEventById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Event ID | Identifies the business process event. |
{
"data": {
"data": [
{
"subBusinessProcesses": [
{
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"initiator": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"for": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overallBusinessProcess": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"completedDate": "2024-06-08T07:00:00.000Z",
"creationDate": "2024-06-08T07:00:00.000Z",
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"effectiveDate": "2024-06-08T07:00:00.000Z",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
Get Files by Container ID
Retrieves all files for a file container. Returns file metadata such as file name, size, checksum, and state (Timed Out, Uploading, Failed, Success). Only files with state 'Success' are ready for upload. | key: getFilesByContainerId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| File Container ID | Identifies the file container whose files will be retrieved. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"total": 0,
"data": [
{
"id": "string",
"descriptor": "string",
"name": "string",
"checksum": "string",
"length": "string",
"state": {
"id": "string"
},
"allowedFileSize": "string"
}
]
}
}
Get Invoice by ID
Retrieves a customer invoice or adjustment with the specified ID. | key: getInvoiceById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Invoice ID | Identifies the customer invoice to retrieve. |
{
"data": {
"invoiceDate": "2024-06-08T07:00:00.000Z",
"transactionType": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"withholdingAmount": "1627849682",
"company": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"billToCustomer": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"inCollection": true,
"netAmount": "1059542329",
"disputeAmount": "1295724502",
"dueAmount": "878946597",
"invoiceType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"poNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"relatedAdjustments": [
{
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"taxAmount": "312820395",
"adjustmentReason": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"disputeDate": "2024-06-08T07:00:00.000Z",
"paymentStatus": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"relatedInvoice": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inDispute": true,
"billToCustomerAddress": {
"regionSubdivision1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"countryRegion": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"addressLine3": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"citySubdivision1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"addressLine1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"addressLine4": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"city": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"citySubdivision2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"addressLine2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"regionSubdivision2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"postalCode": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"disputeReasons": [
{
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"invoiceStatus": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"retentionAmount": "825010139",
"totalAmount": "1264090431",
"invoiceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string",
"href": "string"
}
}
Get Invoice PDF
Retrieves printed customer invoice PDF documents. | key: getInvoicePdf
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Invoice PDF ID | Identifies the invoice PDF resource to retrieve. |
{
"data": "PDF DATA"
}
Get Message Template by ID
Retrieves a message template by ID. | key: getMessageTemplateById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Message Template ID | Identifies the Connect message template. |
{
"data": {
"createdBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"emailDetail": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"body": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"subject": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"replyTo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"lastUpdated": "2024-06-08T07:00:00.000Z",
"pushDetail": {
"redirectURL": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"message": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"usageCount": "2001658030",
"createdOn": "2024-06-08T07:00:00.000Z",
"notificationType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"lastUpdatedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inactive": true,
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Get Organization by ID
Retrieves an Organization by ID. | key: getOrganizationById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Organization ID | Identifies the Workday organization. |
{
"data": {
"descriptor": "Lorem ipsum dolor sit ame",
"href": "string",
"id": "string"
}
}
Get Payment by ID
Retrieves a customer invoice payment with the specified ID. | key: getPaymentById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Payment ID | Identifies the customer payment record. |
{
"data": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Get Person by ID
Retrieves a person with the specified ID. IDs returned from 'List People' or 'List Workers' can be used to retrieve further information about a specific person. | key: getPersonById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Person ID | Unique identifier for a person in the Workday tenant. |
{
"data": {
"photos": "http://example.com",
"homeEmails": "http://example.com",
"personalInformation": "http://example.com",
"homeWebAddresses": "http://example.com",
"universal_ID": {
"id": "string"
},
"workInstantMessengers": "http://example.com",
"homePhones": "http://example.com",
"preferredName": "http://example.com",
"workEmails": "http://example.com",
"workAddresses": "http://example.com",
"workWebAddresses": "http://example.com",
"homeAddresses": "http://example.com",
"audioNamePronunciation": "http://example.com",
"legalName": "http://example.com",
"socialNetworks": "http://example.com",
"workPhones": "http://example.com",
"additionalNames": "http://example.com",
"homeInstantMessengers": "http://example.com",
"id": "string",
"href": "string"
}
}
Get Staffing Worker By ID
Retrieves a worker with the specified ID and current staffing information from the Staffing service. | key: getStaffingWorkerById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"workerType": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"additionalJobs": [
{
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobProfile": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"primaryJob": {
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobProfile": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"person": {
"phone": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"email": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"workerId": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Get Staffing Workers
Retrieves a collection of workers and current staffing information from the Staffing service. | key: getStaffingWorkers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v7/get-/workers | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"workerType": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"additionalJobs": [
{
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobProfile": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"primaryJob": {
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobProfile": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"person": {
"phone": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"email": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"workerId": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
Get Supplier Invoice Request Attachments
Retrieves all attachments associated with supplier invoices. | key: getSupplierInvoiceRequestAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Supplier Invoice Request ID | Identifies the supplier invoice request. |
{
"data": {
"data": [
{
"fileExtension": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"fileLength": "373396837",
"fileName": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"total": 0
}
}
Get Supplier Invoice Request by ID
Retrieves the supplier invoice with the specified ID. | key: getSupplierInvoiceRequestsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Supplier Invoice Request ID | Identifies the supplier invoice request. |
{
"data": {
"invoiceDate": "2024-06-08T07:00:00.000Z",
"statutoryInvoiceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"taxAmount": "508668943",
"handlingCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"remitToConnection": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"paymentTerms": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"controlTotalAmount": "1517172198",
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"currency": {
"currencyID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame"
},
"suppliersInvoiceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"freightAmount": "28734511",
"shipToAddress": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"requestNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"invoiceReceivedDate": "2024-06-08T07:00:00.000Z",
"requester": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"supplier": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"company": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Get Table by ID
Retrieves the description of a table or dataset the current user has permission to access. | key: getTableById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables/-id- | Key: worker, Value: 123 |
| Table ID | Identifies the Prism Analytics table. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"displayName": "string",
"description": "string",
"documentation": "string",
"enableForAnalysis": false,
"name": "string",
"tags": [
{
"id": "string",
"name": "string"
}
],
"fields": [
{
"id": "string",
"name": "string",
"ordinal": 0,
"description": "string",
"parseFormat": "string",
"type": {
"name": "Boolean",
"id": "Schema_Field_Type=Boolean"
},
"precision": 0,
"scale": 0,
"businessObject": {
"id": "string",
"descriptor": "string"
},
"context": {
"id": "string",
"descriptor": "string"
},
"displayName": "string",
"defaultValue": "string",
"fieldId": "string",
"required": false,
"externalId": false
}
],
"id": "string",
"empty": false,
"published": false,
"stats": {
"rows": "string",
"size": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"updatedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"updatedMoment": "string",
"dateRefreshed": "string",
"tablePermissions": {
"canView": false,
"canEdit": false,
"canDelete": false,
"canShare": false,
"canPublish": false,
"canAppendTableData": false,
"canReplaceTableData": false,
"canTruncateTableData": false,
"canDeleteTableData": false,
"canEditDataSourceSecurity": false,
"selectTableData": false
}
}
}
Get Time Clock Event by ID
Retrieves a time clock event with the specified ID. | key: getTimeClockEventsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Time Clock Event ID | Identifies the time clock event record. |
{
"data": {
"dateTime": "2024-06-08T07:00:00.000Z",
"timeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fund": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overrideRate": "5712",
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"reference_ID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"timeEntryCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"projectPlanTask": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"project": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"eventType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"region": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobProfile": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"grant": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"gift": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"program": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"businessUnit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"costCenter": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag14": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag12": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag13": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag15": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag11": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"allocationPool": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"appropriation": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Get Time Clock Events
Retrieves a collection of time clock events. You can filter by the time clock events by worker and date range. | key: getTimeClockEvents
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"dateTime": "2024-06-08T07:00:00.000Z",
"timeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fund": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overrideRate": "5712",
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"reference_ID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"timeEntryCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"projectPlanTask": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"project": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"eventType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"region": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobProfile": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"grant": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"gift": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"program": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"businessUnit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"costCenter": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag14": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag12": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag13": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag15": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag11": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"allocationPool": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"appropriation": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"total": 0
}
}
Get Time Off Balance by ID
Retrieves the specified balance of all absence plan and leave of absence types for the specified balance ID. | key: getTimeOffBalanceById
| Input | Notes | Example |
|---|---|---|
| Balance ID | Identifies the time-off balance to retrieve. | |
| Connection |
{
"data": {
"unit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"position": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"quantity": "1542937255",
"absencePlan": {
"timeoffs": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"absenceTable": [
{
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"id": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"dateOfFirstAbsence": "2024-06-08T07:00:00.000Z",
"effectiveDate": "2024-06-08T07:00:00.000Z",
"category": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
}
}
}
Get Time Off Details
Retrieves Time Off Entries for the specified worker ID. Supports filtering by date range, status, and type; returns all entries when no query parameters are specified. | key: getTimeOffDetails
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation. | Key: worker, Value: 123 |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"data": [
{
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"timeOffType": {
"descriptor": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"reason": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"quantity": "36624060",
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"date": "2024-06-08T07:00:00.000Z",
"unit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
}
}
],
"total": 0
}
}
Get Worker Business Title Changes
Retrieves a collection of business title changes for the specified worker. | key: getWorkerBusinessTitleChanges
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"data": [
{
"currentBusinessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"proposedBusinessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"effective": "2024-06-01T07:00:00.000Z",
"due": "2024-06-01T07:00:00.000Z",
"initiated": "2024-06-01T07:00:00.000Z",
"initiator": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"subject": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"total": 0
}
}
Get Worker by ID
Retrieves a worker and current staffing information by ID. | key: getWorkerById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"primaryJob": {
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"jobProfile": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"person": {
"phone": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"email": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"workerId": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"workerType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"additionalJobs": [
{
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"jobProfile": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Get Worker Explicit Skills
Retrieves explicit skills for the specified worker ID. Supports optional filtering by skill name or skill source. | key: getWorkerExplicitSkills
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v7/get-/workers/-ID-/explicitSkills | Key: worker, Value: 123 |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"data": [
{
"skillSources": [
{
"dateCreated": "2026-04-11T07:00:00.000Z",
"sourceTypeID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"sourceType": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"skillItem": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"remoteID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
Get Worker Service Dates
Retrieves a collection of service dates (hire date, continuous service date, etc.) for the specified worker ID. | key: getWorkerServiceDates
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"data": [
{
"hireDate": "2020-01-20T16:00:00.000Z",
"continuousServiceDate": "2020-01-20T16:00:00.000Z"
}
],
"total": 0
}
}
Initiate Job Change
Initiates a job change request for the specified worker. Returns a new job change ID that can be submitted with POST /jobChanges/{ID}/submit. | key: initiateJobChange
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Connection | ||
| Effective Date | The effective date of the job change. | 2024-06-01T07:00:00.000Z |
| Job ID | Workday ID of the target job or position. Retrieve using GET /values/jobChangesGroup/jobs with the worker query parameter. | |
| Reason ID | Workday ID of the change job reason. Retrieve using GET /values/jobChangesGroup/reason. | |
| Change Job Worker ID | Workday ID of the worker whose job is being changed. Retrieve using GET /values/jobChangesGroup/workers. | |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"job": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"date": "2020-01-18T01:00:00.000Z",
"supervisoryOrganization": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"reason": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"template": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Initiate Organization Assignment Change
Initiates an organization assignment change for the specified worker. Returns a new change ID that can be submitted with POST /organizationAssignmentChanges/{ID}/submit. | key: initiateOrganizationAssignmentChange
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Connection | ||
| Effective Date | The effective date of the organization assignment change. | 2024-06-01T07:00:00.000Z |
| Job ID | Workday ID of the worker's current position. Retrieve using GET /values/organizationAssignmentChangesGroup/jobs with the worker query parameter. | |
| Change Org Worker ID | Workday ID of the worker whose organization assignment is being changed. Retrieve using GET /values/organizationAssignmentChangesGroup/workers. | |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"date": "2026-04-11T07:00:00.000Z",
"position": {
"id": "00000000000000000000000000000000",
"descriptor": "string",
"href": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
List Data Changes
Returns the collection of data changes accessible to the authenticated user. Supports offset and limit query parameters. Response type is determined by the 'type' query parameter. The default response includes id, name, and displayName. | key: listDataChanges
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/dataChanges | Key: worker, Value: 123 |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"total": 0,
"data": [
{
"id": "string",
"name": "string",
"displayName": "string",
"source": {
"sourceType": "UPLOAD",
"id": "string",
"name": "string"
},
"target": {
"id": "string",
"name": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"modifiedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"modifiedMoment": "string",
"operation": {
"operationType": "APPEND",
"operationKeys": [
"string"
]
}
}
]
}
}
List Events
Retrieves a collection of business process events based on the specified parameters. Exactly one worker parameter must be specified; otherwise, a blank response is returned. | key: listEvents
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"subBusinessProcesses": [
{
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"initiator": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"for": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overallBusinessProcess": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"completedDate": "2024-06-08T07:00:00.000Z",
"creationDate": "2024-06-08T07:00:00.000Z",
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"effectiveDate": "2024-06-08T07:00:00.000Z",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
List Invoices
Retrieves all customer invoices and adjustments. | key: listInvoices
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"invoiceDate": "2024-06-08T07:00:00.000Z",
"transactionType": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"withholdingAmount": "1627849682",
"company": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"billToCustomer": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"inCollection": true,
"netAmount": "1059542329",
"disputeAmount": "1295724502",
"dueAmount": "878946597",
"invoiceType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"poNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"relatedAdjustments": [
{
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"taxAmount": "312820395",
"adjustmentReason": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"disputeDate": "2024-06-08T07:00:00.000Z",
"paymentStatus": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"relatedInvoice": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inDispute": true,
"billToCustomerAddress": {
"regionSubdivision1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"countryRegion": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"addressLine3": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"citySubdivision1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"addressLine1": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"addressLine4": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"city": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"citySubdivision2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"addressLine2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"regionSubdivision2": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"postalCode": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"disputeReasons": [
{
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"invoiceStatus": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"retentionAmount": "825010139",
"totalAmount": "1264090431",
"invoiceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string",
"href": "string"
}
],
"total": 0
}
}
List Message Templates
Retrieves message templates. | key: listMessageTemplates
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"createdBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"emailDetail": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"body": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"subject": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"replyTo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"lastUpdated": "2024-06-08T07:00:00.000Z",
"pushDetail": {
"redirectURL": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"message": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"usageCount": "2001658030",
"createdOn": "2024-06-08T07:00:00.000Z",
"notificationType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"lastUpdatedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inactive": true,
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
List Organizations
Retrieves list of Organizations. | key: listOrganizations
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"descriptor": "Lorem ipsum dolor sit ame",
"href": "string",
"id": "string"
}
],
"total": 0
}
}
List People
Retrieves all people in the Workday tenant. | key: listPeople
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"photos": "http://example.com",
"homeEmails": "http://example.com",
"personalInformation": "http://example.com",
"homeWebAddresses": "http://example.com",
"universal_ID": {
"id": "string"
},
"workInstantMessengers": "http://example.com",
"homePhones": "http://example.com",
"preferredName": "http://example.com",
"workEmails": "http://example.com",
"workAddresses": "http://example.com",
"workWebAddresses": "http://example.com",
"homeAddresses": "http://example.com",
"audioNamePronunciation": "http://example.com",
"legalName": "http://example.com",
"socialNetworks": "http://example.com",
"workPhones": "http://example.com",
"additionalNames": "http://example.com",
"homeInstantMessengers": "http://example.com",
"id": "string",
"href": "string"
}
],
"total": 0
}
}
List Supplier Invoice Requests
Retrieves all supplier invoices. | key: listSupplierInvoiceRequests
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) in the Workday API documentation. | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"invoiceDate": "2024-06-08T07:00:00.000Z",
"statutoryInvoiceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"taxAmount": "508668943",
"handlingCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"dueDate": "2024-06-08T07:00:00.000Z",
"remitToConnection": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"paymentTerms": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"controlTotalAmount": "1517172198",
"memo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"currency": {
"currencyID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"descriptor": "Lorem ipsum dolor sit ame"
},
"suppliersInvoiceNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"freightAmount": "28734511",
"shipToAddress": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"requestNumber": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"invoiceReceivedDate": "2024-06-08T07:00:00.000Z",
"requester": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"supplier": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"company": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"total": 0
}
}
List Tables
Retrieves a collection of tables created by the Workday REST API. Only tables or datasets permitted by the current user's security profile are returned. | key: listTables
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables | Key: worker, Value: 123 |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"total": 0,
"data": [
{
"displayName": "string",
"description": "string",
"documentation": "string",
"enableForAnalysis": false,
"name": "string",
"tags": [
{
"id": "string",
"name": "string"
}
],
"fields": [
{
"id": "string",
"name": "string",
"ordinal": 0,
"description": "string",
"parseFormat": "string",
"type": {
"name": "Boolean",
"id": "Schema_Field_Type=Boolean"
},
"precision": 0,
"scale": 0,
"businessObject": {
"id": "string",
"descriptor": "string"
},
"context": {
"id": "string",
"descriptor": "string"
},
"displayName": "string",
"defaultValue": "string",
"fieldId": "string",
"required": false,
"externalId": false
}
],
"id": "string",
"empty": false,
"published": false,
"stats": {
"rows": "string",
"size": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"updatedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"updatedMoment": "string",
"dateRefreshed": "string",
"tablePermissions": {
"canView": false,
"canEdit": false,
"canDelete": false,
"canShare": false,
"canPublish": false,
"canAppendTableData": false,
"canReplaceTableData": false,
"canTruncateTableData": false,
"canDeleteTableData": false,
"canEditDataSourceSecurity": false,
"selectTableData": false
}
}
]
}
}
List Workers
Retrieves a collection of workers and current staffing information. | key: getWorkers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 |
| Offset | The zero-based index of the first object in a response collection. The default is 0. Use Offset with the Limit input 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. | 5 |
| Query Params | Query parameters to be used in the request. This should be a list of key-value pairs. Ex. Key: worker, Value: 123 See optional (QUERY-STRING PARAMETERS) at https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v5/get-/workers | Key: worker, Value: 123 |
{
"data": {
"data": [
{
"primaryJob": {
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"jobProfile": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"person": {
"phone": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"email": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"workerId": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"workerType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"additionalJobs": [
{
"businessTitle": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"supervisoryOrganization": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"jobType": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"jobProfile": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"location": {
"country": {
"descriptor": "Lorem ipsum dolor sit ame"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"workSpace": {
"locationChain": "Sample Location Chain",
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
},
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
],
"total": 0
}
}
Post Time Off Request
Creates a time off request for the specified worker ID and initiates the Request Time Off business process. | key: postTimeOffRequest
| Input | Notes | Example |
|---|---|---|
| Action ID | Identifies the action to take on the business process. | |
| Connection | ||
| Days | The days for which the time off request is being made. An array of objects. See Workday API documentation for more information. | |
| Overall Business Process ID | Identifies the parent business process instance. | |
| Time Off Attachments | The attachments for the time off request. | |
| Time Off Comment | Free-text comment attached to the time-off entry. | |
| Time Off For ID | Target instance the time-off entry applies to; may be another business process ID when used as a sub-process. | |
| Transaction Status ID | Identifies the current status of the transaction. | |
| Worker ID | Unique identifier for the Workday worker record. |
{
"data": {
"businessProcessParameters": {
"action": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overallBusinessProcess": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"comments": [
{
"commentDate": "2024-06-08T07:00:00.000Z",
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"person": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
}
}
],
"transactionStatus": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"warningValidations": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"attachments": [
{
"description": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"contentType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fileLength": "208232717",
"uploadDate": "2024-06-08T07:00:00.000Z",
"fileName": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"uploadedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"category": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string"
}
],
"overallStatus": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"criticalValidations": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"for": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
}
},
"days": [
{
"date": "2024-06-08T07:00:00.000Z",
"start": "2024-06-08T07:00:00.000Z",
"position": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"end": "2024-06-08T07:00:00.000Z",
"reason": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"dailyQuantity": "30",
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"timeOffType": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
]
}
}
Raw Request
Sends a raw HTTP request to Workday. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/accountsPayable/v1/supplierInvoiceRequests), The base URL is already included (https://<domain>/ccx). For example, to connect to https://<domain>/ccx/accountsPayable/v1/supplierInvoiceRequests, only /accountsPayable/v1/supplierInvoiceRequests is entered in this field. | /accountsPayable/v1/supplierInvoiceRequests |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Send Message
Sends a message. | key: sendMessage
| Input | Notes | Example |
|---|---|---|
| Communication ID | Identifier of the Workday communication group. | |
| Connection | ||
| Contacts | Contacts to send the message to. This should be an array of contacts. | |
| Email Detail | Details for the email. | |
| Message Template ID | Identifies the Connect message template. | |
| Notification Type ID | Identifies the notification type used for delivery. | |
| Push Detail | Details for the push notification. | |
| Sender Override ID | Overrides the icon displayed for the sender. |
{
"data": {
"senderOverride": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"commID": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"emailDetail": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"body": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"subject": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"replyTo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"recipients": {
"contacts": [
{
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
]
},
"messageTemplate": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"notificationType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"pushDetail": {
"redirectURL": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"message": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
}
}
}
Submit Supplier Invoice Request
Submits a supplier invoice instance with the specified ID for approval. | key: submitSupplierInvoiceRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Supplier Invoice Instance Descriptor | Human-readable descriptor for the supplier invoice instance being submitted. | |
| Supplier Invoice Instance ID | Identifies the supplier invoice instance to submit for approval. | |
| Supplier Invoice Request ID | Identifies the supplier invoice request. |
{
"data": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Update Message Template by ID
Updates a message template by ID. | key: updateMessageTemplateById
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Connection | ||
| Created By ID | Identifies the user who created the record. | |
| Email Detail | Details for the email. | |
| Message Template ID | Identifies the Connect message template. | |
| Message Template Name | Display name given to the message template. | |
| Push Detail | Details for the push notification. | |
| Reference ID | Reference ID used for lookups within Workday Web Services. | |
| Template Descriptor | Human-readable descriptor for the template. | |
| Template ID | Identifies the message template record. | |
| Template Inactive | When true, marks the template as inactive. |
{
"data": {
"createdBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"emailDetail": {
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"body": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"subject": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"replyTo": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu."
},
"lastUpdated": "2024-06-08T07:00:00.000Z",
"pushDetail": {
"redirectURL": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"message": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"id": "string"
},
"usageCount": "2001658030",
"createdOn": "2024-06-08T07:00:00.000Z",
"notificationType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"name": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"lastUpdatedBy": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"referenceID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"inactive": true,
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Update Table by ID
Updates an existing table with the specified name. | key: updateTableById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Description | Short description shown alongside the table. | |
| Display Name | User-facing display name shown in Prism Analytics. | |
| Documentation | Long-form documentation describing how the table is used. | |
| Enable For Analysis | When true, enables the table for Prism Analytics. | |
| Fields | The fields of the table. An array of objects. See Workday API documentation for more information. | |
| Name | Internal name used to reference the table via API. | |
| Table ID | Identifies the Prism Analytics table. | |
| Tags | The tags of the table. An array of objects with id and name. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"displayName": "string",
"description": "string",
"documentation": "string",
"enableForAnalysis": false,
"name": "string",
"tags": [
{
"id": "string",
"name": "string"
}
],
"fields": [
{
"id": "string",
"name": "string",
"ordinal": 0,
"description": "string",
"parseFormat": "string",
"type": {
"name": "Boolean",
"id": "Schema_Field_Type=Boolean"
},
"precision": 0,
"scale": 0,
"businessObject": {
"id": "string",
"descriptor": "string"
},
"context": {
"id": "string",
"descriptor": "string"
},
"displayName": "string",
"defaultValue": "string",
"fieldId": "string",
"required": false,
"externalId": false
}
],
"id": "string",
"empty": false,
"published": false,
"stats": {
"rows": "string",
"size": "string"
},
"createdBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"createdMoment": "string",
"updatedBy": {
"id": "string",
"fullName": "string",
"descriptor": "string"
},
"updatedMoment": "string",
"dateRefreshed": "string",
"tablePermissions": {
"canView": false,
"canEdit": false,
"canDelete": false,
"canShare": false,
"canPublish": false,
"canAppendTableData": false,
"canReplaceTableData": false,
"canTruncateTableData": false,
"canDeleteTableData": false,
"canEditDataSourceSecurity": false,
"selectTableData": false
}
}
}
Update Time Clock Event by ID
Updates the time clock event for the specified ID, replacing the existing time clock event with the specified data. | key: updateTimeClockEventsById
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. | |
| Clock Event Comment | Free-text comment attached to the time clock event. | |
| Clock Event Date Time | Timestamp when the time clock event occurred. | 2024-06-01T07:00:00.000Z |
| Clock Event Override Rate | Optional rate that overrides the default pay rate for this event. | |
| Clock Event Project ID | Identifies the project associated with the clock event. | |
| Clock Event Project Plan Task ID | Identifies the project plan task associated with the clock event. | |
| Clock Event Time Entry Code ID | Identifies the time entry code applied to the clock event. | |
| Clock Event Time Zone ID | Identifies the time zone applied to the clock event. | |
| Connection | ||
| Instance Descriptor | Human-readable preview label for the referenced instance. | |
| Instance Href | Direct API link pointing to the referenced instance. | |
| Instance ID | Identifies the Workday instance being referenced. | |
| Reference ID | Reference ID used for lookups within Workday Web Services. | |
| Time Clock Event ID | Identifies the time clock event record. |
{
"data": {
"dateTime": "2024-06-08T07:00:00.000Z",
"timeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fund": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overrideRate": "5712",
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"reference_ID": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"timeEntryCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"projectPlanTask": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"project": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"eventType": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"region": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobProfile": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"grant": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"gift": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"program": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "Lorem ipsum dolor sit amet, cum choro singulis consectetuer ut, ubique iisque contentiones ex duo. Quo lorem etiam eu.",
"businessUnit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"costCenter": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag14": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag12": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag13": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag15": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag11": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"allocationPool": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"appropriation": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"href": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Update Worker Time Block
Updates the worker time block for the specified worker with the specified data in the request body. | key: updateWorkerTimeBlock
| Input | Notes | Example |
|---|---|---|
| Additional Fields | Additional fields that might not be covered by the standard inputs. See Workday API documentation for more information. See Workday API documentation for more information. | |
| Comment | Free-text comment attached to the reported time block. | |
| Connection | ||
| Do Not Bill | When true, marks the time block as non-billable. | |
| Instance Descriptor | Human-readable preview label for the referenced instance. | |
| Instance ID | Identifies the Workday instance being referenced. | |
| Worker ID | Unique identifier for the Workday worker record. | |
| Worker Time Block ID | Identifies the worker's reported time block. |
{
"data": {
"customWorktag07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag13": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag15": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag14": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag11": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customWorktag12": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculatedTimeDetails": [
{
"overrideRate": "3.3",
"shiftDate": "2019-11-11T08:00:00.000Z",
"calculatedQuantity": "20",
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculatedDate": "2019-11-05T08:00:00.000Z",
"calculatedInTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calculationTags": [
{
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
],
"calendarDate": "2019-11-12T17:00:00.000Z",
"calculatedOutTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string"
}
],
"customOrganization10": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization06": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"appropriation": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization02": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"allocationPool": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization03": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization04": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization05": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization01": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization07": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization08": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"customOrganization09": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"program": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"jobProfile": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"costCenter": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"location": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"grant": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"businessUnit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"region": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"position": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"fund": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"reportedQuantity": "8",
"gift": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"status": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"comment": "This is a comment.",
"unit": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"worker": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"calendarDate": "2024-06-01T07:00:00.000Z",
"timeEntryCode": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"projectRole": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"overrideRate": "3",
"projectPlanPhase": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"inTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"outTimeZone": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"inTime": "2024-06-01T07:00:00.000Z",
"outReason": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"outTime": "2024-06-01T07:00:00.000Z",
"project": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"doNotBill": true,
"projectPlanTask": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"currency": {
"id": "^(?:(?:[0-9a-f]{32})|(?:[0-9]+\\$[0-9]+)|(\\S+=\\S+))$",
"descriptor": "string",
"href": "string"
},
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Upload Files by Container ID
This resource loads the file into a file container. Creates temporary location to store file, and saves file metadata like size, checksum. | key: postFilesByContainerId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| File | The contents to write to a file. Binary data generated from a previous step. | ZXhhbXBsZQ== |
| File Container ID | Identifies the file container whose files will be retrieved. | |
| Tenant | The Workday tenant name used in API paths. |
{
"data": {
"id": "string",
"descriptor": "string",
"name": "string",
"checksum": "string",
"length": "string",
"state": {
"id": "string"
},
"allowedFileSize": "string"
}
}
Changelog
2026-04-22
Added Staffing (v7) service integration with six new actions:
- Get Staffing Workers - Retrieve a list of workers
- Get Staffing Worker By ID - Retrieve a specific worker by ID
- Get Worker Service Dates - Retrieve service dates for a worker
- Get Worker Explicit Skills - Retrieve explicit skills for a worker
- Initiate Job Change - Start a job change business process for a worker
- Initiate Organization Assignment Change - Start an organization assignment change for a worker
Upgraded Time Tracking endpoints from v3 to v5, Absence Management endpoints from v1 to v5, and Person endpoints from v3 to v4
2026-03-16
Improved input field documentation with formatted URL links for better readability
2026-02-26
Added inline data source for workers to enable dynamic dropdown selection