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 Prismatic’s 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 Prismatic representative.
API Documentation
This component is built to the Workday REST Services API reference
Connections
Workday OAuth 2.0 Connection
Register 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 in the following format:
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 Prismatic Integration.
| Input | Default | Notes |
|---|---|---|
API URL string / Required apiUrl | https://<domain>/ccx | The base URL for the Workday API. Replace <domain> with your domain. |
Authorize URL string / Required authorizeUrl | https://impl.workday.com/<tenant_id>/authorize | The OAuth 2.0 Authorization URL for Workday. Replace <tenant_id> with your tenant ID. |
Client ID string / Required clientId | ||
Client secret password / Required clientSecret | ||
Scopes string scopes | Space separated list of scopes if needed | |
Token URL string / Required tokenUrl | https://wd2-impl-services1.workday.com/ccx/oauth2/<tenant_id>/token | The OAuth 2.0 Token URL for Workday. Replace <tenant_id> with your tenant ID. |
Actions
Delete Time Clock Events By ID
Deletes a time clock event with the specified ID. | key: deleteTimeClockEventsById
| Input | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Time Clock Event Id string / Required timeClockEventId | Id of the time clock event |
Example Payload for Delete Time Clock Events By ID
Example Payload for Delete Time Clock Events By ID
{
"data": {}
}
Delete Worker Time Block
Deletes a worker time block with the specified ID for the specified worker. | key: deleteWorkerTimeBlock
| Input | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Worker Id string / Required workerId | Id of the worker | |
Worker Time Block Id string / Required workerTimeBlockId | Id of the worker time block |
Example Payload for Delete Worker Time Block
Example Payload for Delete Worker Time Block
{
"data": {}
}
Get Customer by ID
Retrieves customer by ID. | key: getCustomerById
| Input | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Customer ID string / Required customerId | The ID of the customer to retrieve | |
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Get Customer by ID
Example Payload for Get Customer by ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Data Change ID string / Required dataChangeId | The ID of the data change to retrieve | |
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Tenant string / Required tenant | The tenant. |
Example Payload for Get Data Changes By ID
Example Payload for Get Data Changes By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Event ID string / Required eventId | The ID of the event. | ||
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 |
Example Payload for Get Event Attachments
Example Payload for Get Event Attachments
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Event ID string / Required eventId | The ID of the event. |
Example Payload for Get Event By ID
Example Payload for Get Event By ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
File Container ID string / Required fileContainerId | The ID of the file container to retrieve files for | |
Tenant string / Required tenant | The tenant. |
Example Payload for Get Files By Container ID
Example Payload for Get Files By Container ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Invoice ID string / Required invoiceId | The ID of the invoice. |
Example Payload for Get Invoice By ID
Example Payload for Get Invoice By ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Invoice PDF ID string / Required invoicePdfId | The ID of the invoice PDF to retrieve. |
Example Payload for Get Invoice PDF
Example Payload for Get Invoice PDF
{
"data": "PDF DATA"
}
Get Message Template By ID
Get a Message Template by ID | key: getMessageTemplateById
| Input | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Message Template ID string / Required messageTemplateId | The ID of the message template |
Example Payload for Get Message Template By ID
Example Payload for Get Message Template By ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Organization ID string / Required organizationId | The ID of the organization. |
Example Payload for Get Organization by ID
Example Payload for Get Organization by ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Payment ID string / Required paymentId | The ID of the payment. |
Example Payload for Get Payment By ID
Example Payload for Get Payment By ID
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Person Id string / Required personId | Id of the person |
Example Payload for Get Person By ID
Example Payload for Get Person By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string / Required supplierInvoiceRequestId | The ID of the supplier invoice request. |
Example Payload for Get Supplier Invoice Request Attachments
Example Payload for Get Supplier Invoice Request Attachments
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Supplier Invoice Request ID string / Required supplierInvoiceRequestId | The ID of the supplier invoice request. |
Example Payload for Get Supplier Invoice Requests by ID
Example Payload for Get Supplier Invoice Requests by ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query Params string Key Value List 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 string / Required tableId | The ID of the table. | ||
Tenant string / Required tenant | The tenant. |
Example Payload for Get Table By ID
Example Payload for Get Table By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query Params string Key Value List 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 |
Example Payload for Get Time Clock Events
Example Payload for Get Time Clock Events
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Time Clock Event Id string / Required timeClockEventId | Id of the time clock event |
Example Payload for Get Time Clock Events By ID
Example Payload for Get Time Clock Events By ID
{
"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 | Default | Notes |
|---|---|---|
Balance ID string / Required balanceId | The ID of the balance. | |
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Example Payload for Get Time Off Balance By ID
Example Payload for Get Time Off Balance By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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#absenceManagement/v1/get-/workers/-ID-/timeOffDetails | Key: worker, Value: 123 | |
Worker Id string / Required workerId | Id of the worker |
Example Payload for Get Time Off Details
Example Payload for Get Time Off Details
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string / Required workerId | Id of the worker |
Example Payload for Get Worker Business Title Changes
Example Payload for Get Worker Business Title Changes
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Worker Id string / Required workerId | Id of the worker |
Example Payload for Get Worker By ID
Example Payload for Get Worker By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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 |
Example Payload for Get Workers
Example Payload for Get Workers
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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 string / Required tenant | The tenant. |
Example Payload for List Data Changes
Example Payload for List Data Changes
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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 |
Example Payload for List Events
Example Payload for List Events
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query Params string Key Value List 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 |
Example Payload for List Invoices
Example Payload for List Invoices
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query Params string Key Value List 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 |
Example Payload for List Message Templates
Example Payload for List Message Templates
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Query Params string Key Value List 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 |
Example Payload for List Organizations
Example Payload for List Organizations
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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 |
Example Payload for List People
Example Payload for List People
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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#accountsPayable/v1/get-/supplierInvoiceRequests | Key: worker, Value: 123 |
Example Payload for List Supplier Invoice Requests
Example Payload for List Supplier Invoice Requests
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Limit string limit | The maximum number of objects in a single response. The default is 20. The maximum is 100. | 5 | |
Offset string 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 string Key Value List 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 string / Required tenant | The tenant. |
Example Payload for List Tables
Example Payload for List Tables
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Tenant string / Required tenant | The tenant. |
Example Payload for Post File Containers
Example Payload for Post File Containers
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
File data / Required file | The contents to write to a file. Binary data generated from a previous step. | ZXhhbXBsZQ== | |
File Container ID string / Required fileContainerId | The ID of a Prism Analytics File Container | ||
Tenant string / Required tenant | The tenant. |
Example Payload for Post Files By Container ID
Example Payload for Post Files By Container ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Effective Date string / Required effective | The date this business process takes effect. | 2022-01-01 | |
Instance Descriptor string / Required instanceDescriptor | A preview of the instance | ||
Instance Href string / Required instanceHref | A link to the instance | ||
Instance Id string / Required instanceId | Id of the instance | ||
Job Change Reason Id string / Required jobChangeReasonId | Id of the reason used in a Change Job business process. | 123$456 | |
Move Managers Team boolean / Required moveManagersTeam | false | Indicates whether teams reporting to the Manager moved with them during the Change Job Event. | |
Proposed Organizations code / Required proposedOrganizations | Organizations with staffing behavior assigned to the position as a result of this event. | ||
Supervisory Organization Id string / Required supervisoryOrganizationId | The supervisory organization for the worker as of the effective date. | 123$456 | |
Worker Id string / Required workerId | Id of the worker |
Example Payload for Post Job Changes
Example Payload for Post Job Changes
{
"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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/post-/messageTemplates | ||
Connection connection / Required connection | |||
Created By ID string createdById | Creator ID | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Email Detail code emailDetail | Details for the email. | ||
Message Template Name string / Required messageTemplateName | Name of the message template. | ||
Push Detail code pushDetail | Details for the push notification. | ||
Reference Id string referenceId | The Reference ID to use for lookups within our Workday Web Services | ||
Template Descriptor string temaplateDescriptor | Descriptor for the template. | ||
Template Id string templateId | Id for the template. | ||
Template Inactive boolean templateInactive | true | Whether the template is inactive. |
Example Payload for Post Message Templates
Example Payload for Post Message Templates
{
"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 | Default | Notes |
|---|---|---|
Amount string amount | The amount of the payment. | |
Company ID string companyId | The ID of the company. | |
Connection connection / Required connection | ||
Payment Date string date | The date of the payment. | |
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Memo string memo | The memo. | |
Payment Descriptor string paymentDescriptor | A descriptor for the payment. | |
Payment ID string paymentId | The ID of the payment. | |
Ready to Auto Apply boolean readyToAutoApply | true | Indicates whether the payment is ready to be automatically applied. |
Reference string reference | A reference for the payment. | |
Remit From Customer ID string remitFromCustomerId | The ID of the customer from which the payment is being remitted. | |
Transaction Number string transactionNumber | The transaction number for the payment. | |
Type ID string typeId | The ID of the payment type. |
Example Payload for Post Payment
Example Payload for Post Payment
{
"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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/post-/supplierInvoiceRequests for more information. | ||
Company ID string companyId | The ID of the company. | ||
Connection connection / Required connection | |||
Control Total Amount string controlTotalAmount | The control total amount. | ||
Currency ID string currencyId | The ID of the currency. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Memo string memo | The memo. | ||
Payment Terms ID string paymentTermsId | The ID of the payment terms. | ||
Reference Type ID string referenceTypeId | The ID of the reference type. | ||
Requester ID string requesterId | The ID of the requester. | ||
Supplier Invoice ID string supplierInvoceId | The ID of the supplier invoice. | ||
Supplier Invoice Descriptor string supplierInvoiceDescriptor | The descriptor of the supplier invoice. | ||
Tax Amount string taxAmount | The tax amount. |
Example Payload for Post Supplier Invoice Requests
Example Payload for Post Supplier Invoice Requests
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Content Type ID string contentTypeId | ID of the content type. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
File Length string fileLength | File length of the attachment. | 1307948067 | |
File Name string fileName | Name of the file. | ||
Supplier Invoice Request Attachment Descriptor string supplierInvoiceRequestAttachmentDescriptor | Descriptor of the attachment. | ||
Supplier Invoice Request Attachment ID string supplierInvoiceRequestAttachmentId | ID of the attachment. | ||
Supplier Invoice Request ID string / Required supplierInvoiceRequestId | The ID of the supplier invoice request. |
Example Payload for Post Supplier Invoice Requests Attachments
Example Payload for Post Supplier Invoice Requests Attachments
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | The description of the table. | ||
Display Name string / Required displayName | The display name of the table. | ||
Documentation string documentation | The documentation of the table. | ||
Enable For Analysis boolean enableForAnalysis | false | Whether the table is enabled for analysis. | |
Fields code / Required fields | The fields of the table. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/tables for more information. | ||
Name string / Required name | The name of the table. | ||
Tags code tags | The tags of the table. An array of objects with id and name. | ||
Tenant string / Required tenant | The tenant. |
Example Payload for Post Table
Example Payload for Post Table
{
"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 | Default | Notes | Example |
|---|---|---|---|
Action ID string actionId | The ID of the action. | ||
Connection connection / Required connection | |||
Days code / Required days | The days for which the time off request is being made. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/post-/workers/-ID-/requestTimeOff for more information. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Overall Business Process ID string overallBusinessProcessId | The ID of the overall business process. | ||
Time Off Attachments code timeOffAttachments | The attachments for the time off request. | ||
Time Off Comment string timeOffComment | The comment on the time off entry. | ||
Time Off For Id string timeOffForId | The Id of the time off for. It could be another business process Id if this is a sub-process | ||
Transaction Status Id string transactionStatusId | The id of the transaction status. | ||
Worker Id string / Required workerId | Id of the worker |
Example Payload for Post Time Off Request
Example Payload for Post Time Off Request
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Instance Descriptor string / Required instanceDescriptor | A preview of the instance | |
Instance Href string / Required instanceHref | A link to the instance | |
Instance Id string / Required instanceId | Id of the instance | |
Proposed Business Title string / Required proposedBusinessTitle | 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 string / Required workerId | Id of the worker |
Example Payload for Post Worker Business Title Change
Example Payload for Post Worker Business Title Change
{
"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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/post-/workers/-ID-/workerTimeBlock | ||
Comment string comment | The comment associated with the reported time block. | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Do Not Bill boolean doNotBill | false | The non-billable flag for a reported time block. | |
Instance Descriptor string instanceDescriptor | A preview of the instance | ||
Instance Id string instanceId | Id of the instance | ||
Worker Id string / Required workerId | Id of the worker |
Example Payload for Post Worker Time Block
Example Payload for Post 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"
}
}
Raw Request
Send raw HTTP request to Workday | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. Specify 0 for no retries. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | 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 string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | 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. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required 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 boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. |
Send Message
Send a message. | key: sendMessage
| Input | Default | Notes | Example |
|---|---|---|---|
Communication ID string commId | Group communication ID | ||
Connection connection / Required connection | |||
Contacts code contacts | Contacts to send the message to. This should be an array of contacts. | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Email Detail code emailDetail | Details for the email. | ||
Message Template ID string messageTemplateId | The ID of the message template | ||
Notification Type ID string notificationTypeId | The ID of the notification type. | ||
Push Detail code pushDetail | Details for the push notification. | ||
Sender Override ID string senderOverrideId | An ID to override the sender displayed Icon. |
Example Payload for Send Message
Example Payload for Send Message
{
"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 | Default | Notes |
|---|---|---|
Connection connection / Required connection | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. |
Supplier Invoice Instance Descriptor string / Required supplierInvoiceInstanceDescriptor | The descriptor of the supplier invoice instance to submit for approval. | |
Supplier Invoice Instance ID string / Required supplierInvoiceInstanceId | The ID of the supplier invoice instance to submit for approval. | |
Supplier Invoice Request ID string / Required supplierInvoiceRequestId | The ID of the supplier invoice request. |
Example Payload for Submit Supplier Invoice Request
Example Payload for Submit 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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/post-/messageTemplates | ||
Connection connection / Required connection | |||
Created By ID string createdById | Creator ID | ||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Email Detail code emailDetail | Details for the email. | ||
Message Template ID string / Required messageTemplateId | The ID of the message template | ||
Message Template Name string messageTemplateName | Name of the message template. | ||
Push Detail code pushDetail | Details for the push notification. | ||
Reference Id string referenceId | The Reference ID to use for lookups within our Workday Web Services | ||
Template Descriptor string temaplateDescriptor | Descriptor for the template. | ||
Template Id string templateId | Id for the template. | ||
Template Inactive string templateInactive | Whether the template is inactive. |
Example Payload for Update Message Template By ID
Example Payload for Update Message Template By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Description string description | The description of the table. | ||
Display Name string displayName | The display name of the table. | ||
Documentation string documentation | The documentation of the table. | ||
Enable For Analysis string enableForAnalysis | Whether the table is enabled for analysis. | ||
Fields code fields | The fields of the table. An array of objects. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/put-/tables/-id- for more information. | ||
Name string name | The name of the table. | ||
Table ID string / Required tableId | The ID of the table. | ||
Tags code tags | The tags of the table. An array of objects with id and name. | ||
Tenant string / Required tenant | The tenant. |
Example Payload for Update Table By ID
Example Payload for Update Table By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/put-/timeClockEvents/-ID- | ||
Clock Event Comment string clockEventComment | The comment associated with the time clock event | ||
Clock Event Date Time string clockEventDateTime | The date time for a time clock event | 2024-06-01T07:00:00.000Z | |
Clock Event Override Rate string clockEventOverrideRate | The override rate for a time clock event | ||
Clock Event Project Id string clockEventProjectId | The project id for a time clock event | ||
Clock Event Project Plan Task Id string clockEventProjectPlanTaskId | The project plan task id for a time clock event | ||
Clock Event Time Entry Code Id string clockEventTimeEntryCodeId | The time entry code id for a time clock event | ||
Clock Event Time Zone Id string clockEventTimeZoneId | The time zone id for a time clock event | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance Descriptor string / Required instanceDescriptor | A preview of the instance | ||
Instance Href string / Required instanceHref | A link to the instance | ||
Instance Id string / Required instanceId | Id of the instance | ||
Reference Id string referenceId | The Reference ID to use for lookups within our Workday Web Services | ||
Time Clock Event Id string / Required timeClockEventId | Id of the time clock event |
Example Payload for Update Time Clock Events By ID
Example Payload for Update Time Clock Events By ID
{
"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 | Default | Notes | Example |
|---|---|---|---|
Additional Fields code additionalFields | Additional fields that might not be covered by the standard inputs. See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/post-/workers/-ID-/workerTimeBlock See https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/patch-/workers/-ID-/workerTimeBlock/-subresourceID- | ||
Comment string comment | The comment associated with the reported time block. | ||
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Do Not Bill string doNotBill | The non-billable flag for a reported time block. | ||
Instance Descriptor string instanceDescriptor | A preview of the instance | ||
Instance Id string instanceId | Id of the instance | ||
Worker Id string / Required workerId | Id of the worker | ||
Worker Time Block Id string / Required workerTimeBlockId | Id of the worker time block |
Example Payload for Update Worker Time Block
Example Payload for Update 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"
}
}