Workday (Beta) Component
Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.
Component key: workday
Description
This component connector is currently in BETA.
BETA component connections and actions may not always work as expected. Please provide any feedback to the our support team.
Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.
Use the Workday component to manage Organizations, People, Workers, and more.
This component is currently in Beta and its features are still in the testing phase. This component has been made available to users for the purpose of testing and evaluating the current features. Functionality is subject to change while in Beta. Please report any feedback to your account manager.
API Documentation
This component is built to the Workday REST Services API reference
Connections
Workday OAuth 2.0 Connection
key: workdayOAuth2ConnectionRegister an API Client
You can register the API client in the Workday portal based on the category and locate all the necessary information for setting up the Workday REST Access Token account.
Steps to Register
-
Log into the Workday Portal
- Use valid Workday Org admin credentials.
- Format:
https://impl.workday.com/wday/authgwy/<your_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 for the Auto-refresh token to work 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 all the services you need to access from the dropdown list.
-
Complete Registration
- Click on Done.
After the API client is registered in the Workday portal, note down the Client ID, Client Secret, and Endpoints to be used in your workflow.
| Input | Notes | Example |
|---|---|---|
| API URL | The base URL for the Workday API. Replace <domain> with your domain. | https://<domain>/ccx |
| Authorize URL | The OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with your tenant ID. | https://impl.workday.com/<tenant_id>/authorize |
| Client ID | ||
| Client secret | ||
| Scopes | Space separated list of scopes if needed | |
| Token URL | The OAuth 2.0 Token URL for Workday. Replace <tenant_id> with your 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 tenant. |
{
"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 tenant. |
{
"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
Delete Time Clock Events By ID
Deletes a time clock event with the specified ID. | key: deleteTimeClockEventsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Time Clock Event Id | Id of the time clock event |
{
"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 | Id of the worker | |
| Worker Time Block Id | Id of the worker time block |
{
"data": {}
}
Get Customer by ID
Retrieves customer by ID. | key: getCustomerById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Customer ID | The ID of the customer to retrieve |
{
"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 Changes 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 | The ID of the data change to retrieve | |
| Tenant | The tenant. |
{
"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 | The ID of the 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 | The ID of the 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
This resource returns all files for a file container. Returns file metadata about each file such as file name, size, checksum, and state. Possible file states are Timed Out, Uploading, Failed and Success. Files with a state of "Success" are ready for upload. | key: getFilesByContainerId
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| File Container ID | The ID of the file container to retrieve files for | |
| Tenant | The tenant. |
{
"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 | The ID of the invoice. |
{
"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 | The ID of the invoice PDF to retrieve. |
{
"data": "PDF DATA"
}
Get Message Template By ID
Get a Message Template by ID | key: getMessageTemplateById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Message Template ID | The ID of the 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 | The ID of the 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 | The ID of the payment. |
{
"data": {
"descriptor": "Lorem ipsum dolor sit ame",
"id": "string"
}
}
Get Person By ID
Retrieves a person with the specified ID. You can use a returned ID from 'List People' or 'Get Workers' to get more information about a specific person. | key: getPersonById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Person Id | Id of the person |
{
"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 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 | The ID of 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 Requests by ID
Retrieves the supplier invoice with the specified ID. | key: getSupplierInvoiceRequestsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Supplier Invoice Request ID | The ID of 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
This resource exposes the description of a table or dataset that the current user has permission on. | 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 | The ID of the table. | |
| Tenant | The tenant. |
{
"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 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 Clock Events By ID
Retrieves a time clock event with the specified ID. | key: getTimeClockEventsById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Time Clock Event Id | Id of the time clock event |
{
"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 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 | The ID of the balance. | |
| 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 the Time Off Entries for the specified worker ID. You can filter by date range, status, and type. If you don't specify query parameters, this method returns all Time Off Entries. | 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 | Id of the worker |
{
"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 workers and current staffing information. | 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 | Id of the worker |
{
"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 collection of workers and current staffing information. | key: getWorkerById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Worker Id | Id of the worker |
{
"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 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/v3/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
}
}
List Data Changes
Returns collection of data changes accessible by a user. User can pass offset and limit query params to get the list of data changes. The type of responses is based on "type" query parameter. The user gets a default response containing: id, name, 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 tenant. |
{
"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. You must specify exactly one worker parameter. If a worker parameter is not specified, returns a blank response. | 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
Get 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
List all people in the Workday tenant. This action returns a list of 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/v3/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
The Tables resource represents a collection of tables created by the Workday REST API. You can only view the tables or datasets permitted by the security profile of the current user. | 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 tenant. |
{
"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
}
}
]
}
}
Post File Containers
Use this method to create a new fileContainer. | key: postFileContainers
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Tenant | The tenant. |
{
"data": {
"id": "string"
}
}
Post 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 | The ID of a Prism Analytics File Container | |
| Tenant | The tenant. |
{
"data": {
"id": "string",
"descriptor": "string",
"name": "string",
"checksum": "string",
"length": "string",
"state": {
"id": "string"
},
"allowedFileSize": "string"
}
}
Post Job Changes
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 | A preview of the instance | |
| Instance Href | A link to the instance | |
| Instance Id | Id of the instance | |
| Job Change Reason Id | Id of the reason used in a Change Job business process. | 123$456 |
| Move Managers Team | Indicates whether teams reporting to the Manager moved with them during the Change Job Event. | false |
| Proposed Organizations | Organizations with staffing behavior assigned to the position as a result of this event. | |
| Supervisory Organization Id | The supervisory organization for the worker as of the effective date. | 123$456 |
| Worker Id | Id of the worker |
{
"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"
}
}
Post Message Templates
Create 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 | Creator ID | |
| Email Detail | Details for the email. | |
| Message Template Name | Name of the message template. | |
| Push Detail | Details for the push notification. | |
| Reference Id | The Reference ID to use for lookups within our Workday Web Services | |
| Template Descriptor | Descriptor for the template. | |
| Template Id | Id for the template. | |
| Template Inactive | Whether the template is 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"
}
}
Post Payment
Creates a single customer invoice payment header instance with the specified data. | key: postPayment
| Input | Notes | Example |
|---|---|---|
| Amount | The amount of the payment. | |
| Company ID | The ID of the company. | |
| Connection | ||
| Payment Date | The date of the payment. | |
| Memo | The memo. | |
| Payment Descriptor | A descriptor for the payment. | |
| Payment ID | The ID of the payment. | |
| Ready to Auto Apply | Indicates whether the payment is ready to be automatically applied. | true |
| Reference | A reference for the payment. | |
| Remit From Customer ID | The ID of the customer from which the payment is being remitted. | |
| Transaction Number | The transaction number for the payment. | |
| Type ID | The ID of 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"
}
}
Post Supplier Invoice Requests
Request Supplier Invoice Requests. | 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 | The ID of the company. | |
| Connection | ||
| Control Total Amount | The control total amount. | |
| Currency ID | The ID of the currency. | |
| Memo | The memo. | |
| Payment Terms ID | The ID of the payment terms. | |
| Reference Type ID | The ID of the reference type. | |
| Requester ID | The ID of the requester. | |
| Supplier Invoice ID | The ID of the supplier invoice. | |
| Supplier Invoice Descriptor | The descriptor of the supplier invoice. | |
| Tax Amount | The tax amount. |
{
"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"
}
}
Post Supplier Invoice Requests Attachments
Creates attachments for the specified supplier invoice. | key: postSupplierInvoiceRequestsAttachments
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Content Type ID | ID of the content type. | |
| File Length | File length of the attachment. | 1307948067 |
| File Name | Name of the file. | |
| Supplier Invoice Request Attachment Descriptor | Descriptor of the attachment. | |
| Supplier Invoice Request Attachment ID | ID of the attachment. | |
| Supplier Invoice Request ID | The ID of 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"
}
}
Post Table
Use this method to create a new table with the specified name. | key: postTable
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Description | The description of the table. | |
| Display Name | The display name of the table. | |
| Documentation | The documentation of the table. | |
| Enable For Analysis | Whether the table is enabled for analysis. | false |
| Fields | The fields of the table. An array of objects. See Workday API documentation for more information. | |
| Name | The name of the table. | |
| Tags | The tags of the table. An array of objects with id and name. | |
| Tenant | The tenant. |
{
"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
}
}
}
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 | The ID of the action. | |
| 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 | The ID of the overall business process. | |
| Time Off Attachments | The attachments for the time off request. | |
| Time Off Comment | The comment on the time off entry. | |
| Time Off For Id | The Id of the time off for. It could be another business process Id if this is a sub-process | |
| Transaction Status Id | The id of the transaction status. | |
| Worker Id | Id of the worker |
{
"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"
}
]
}
}
Post Worker Business Title Change
Create a new business title change for the specified worker. | key: postWorkerBusinessTitleChange
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Instance Descriptor | A preview of the instance | |
| Instance Href | A link to the instance | |
| Instance Id | Id of the instance | |
| Proposed Business Title | The new business title for the ~worker~ as of the effective date. If there is no business title override, this field defaults to the job title or job profile name. | |
| Worker Id | Id of the worker |
{
"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"
}
}
Post 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 | The comment associated with the reported time block. | |
| Connection | ||
| Do Not Bill | The non-billable flag for a reported time block. | false |
| Instance Descriptor | A preview of the instance | |
| Instance Id | Id of the instance | |
| Worker Id | Id of the worker |
{
"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"
}
}
Raw Request
Send raw HTTP request to Workday | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | Enabling this flag will log out the current request. | false |
| 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
Send a message. | key: sendMessage
| Input | Notes | Example |
|---|---|---|
| Communication ID | Group communication ID | |
| Connection | ||
| Contacts | Contacts to send the message to. This should be an array of contacts. | |
| Email Detail | Details for the email. | |
| Message Template ID | The ID of the message template | |
| Notification Type ID | The ID of the notification type. | |
| Push Detail | Details for the push notification. | |
| Sender Override ID | An ID to override the sender displayed Icon. |
{
"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 | The descriptor of the supplier invoice instance to submit for approval. | |
| Supplier Invoice Instance ID | The ID of the supplier invoice instance to submit for approval. | |
| Supplier Invoice Request ID | The ID of the supplier invoice request. |
{
"data": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Update Message Template By ID
Update 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 | Creator ID | |
| Email Detail | Details for the email. | |
| Message Template ID | The ID of the message template | |
| Message Template Name | Name of the message template. | |
| Push Detail | Details for the push notification. | |
| Reference Id | The Reference ID to use for lookups within our Workday Web Services | |
| Template Descriptor | Descriptor for the template. | |
| Template Id | Id for the template. | |
| Template Inactive | Whether the template is 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
Use this method to edit an existing table with the specified name. | key: updateTableById
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Description | The description of the table. | |
| Display Name | The display name of the table. | |
| Documentation | The documentation of the table. | |
| Enable For Analysis | Whether the table is enabled for analysis. | |
| Fields | The fields of the table. An array of objects. See Workday API documentation for more information. | |
| Name | The name of the table. | |
| Table ID | The ID of the table. | |
| Tags | The tags of the table. An array of objects with id and name. | |
| Tenant | The tenant. |
{
"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 Events By ID
Updates the time clock event for the specified ID. Replaces the existing time clock event with the specified data (proceed with caution). | 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 | The comment associated with the time clock event | |
| Clock Event Date Time | The date time for a time clock event | 2024-06-01T07:00:00.000Z |
| Clock Event Override Rate | The override rate for a time clock event | |
| Clock Event Project Id | The project id for a time clock event | |
| Clock Event Project Plan Task Id | The project plan task id for a time clock event | |
| Clock Event Time Entry Code Id | The time entry code id for a time clock event | |
| Clock Event Time Zone Id | The time zone id for a time clock event | |
| Connection | ||
| Instance Descriptor | A preview of the instance | |
| Instance Href | A link to the instance | |
| Instance Id | Id of the instance | |
| Reference Id | The Reference ID to use for lookups within our Workday Web Services | |
| Time Clock Event Id | Id of the time clock event |
{
"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 | The comment associated with the reported time block. | |
| Connection | ||
| Do Not Bill | The non-billable flag for a reported time block. | |
| Instance Descriptor | A preview of the instance | |
| Instance Id | Id of the instance | |
| Worker Id | Id of the worker | |
| Worker Time Block Id | Id of the worker 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"
}
}
Changelog
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