Workday (Beta) Component
![Workday (Beta)](/docs/img/components/icons/60/d29ya2RheQ==.png)
Workday HCM is a single, cloud-based solution for workforce planning, talent management, and payroll processes.
Component key: workdayDescription
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.
Actions
Delete Time Clock Events By ID
Deletes a time clock event with the specified ID. | key: deleteTimeClockEventsById
Output Example Payload
{
"data": {}
}
Delete Worker Time Block
Deletes a worker time block with the specified ID for the specified worker. | key: deleteWorkerTimeBlock
Output Example Payload
{
"data": {}
}
Get Customer by ID
Retrieves customer by ID. | key: getCustomerById
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"data": "PDF DATA"
}
Get Message Template By ID
Get a Message Template by ID | key: getMessageTemplateById
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Send Message
Send a message. | key: sendMessage
Output Example Payload
{
"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
Output Example Payload
{
"data": {
"id": "string",
"descriptor": "Lorem ipsum dolor sit ame"
}
}
Update Message Template By ID
Update a Message Template by ID. | key: updateMessageTemplateById
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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
Output Example Payload
{
"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"
}
}