Overview
Configuration is provided for establishing connections with Workday service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we will show you step-by-step how to create a connection to Workday REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From the drop-down menu Configuration select Workday. Set [workday-tenant] to the desired tenant in the Server host parameter. Then click New in the Token File parameter to create a new token file.
Step 3: In the next wizard, provide values for the parameters client_id,client_secret,scope, and recirect_uri for your workday app. Then press the Next button.
Step 3: Provide Email and Password. Then press the Login button. Continue with the follow-up steps until the access and refresh token has been retrieved. Save the generated access token to the file. Specify the token protection password. Click OK.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Workday instance using OAuth 2.0.
In this guide, we will show you how to create a connection to Workday REST API using COZYROC's REST Connection Manager using Client Credentials flow.
Step 1. Run "Visual Studio" under "Administrator account." Right-click on the "Connection Managers" Tab and Select "New Connection." In the "Add SSIS Connection Manager" section, scroll down and select "Connection Managers for REST Connection" and click "Add."
Step 2. In the Configuration drop-down menu, select Workday and enter the Workday tenant in the server host field.
Step 3. Select Client Credentials as the authentication type, then enter values for client_id and client_secret in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Workday instance.
This guide will show how to read data from the Workday service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop the COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select Workday connection from the combo. Select from available Workday resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the Workday resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the Workday service.
This guide will show how to write data to the Workday service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop the COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select Workday connection from the combo. Also, select the resource action and Workday resource you want to work on.
Navigate to the Mapping tab and map the input columns for the process you are configuring.
To provide input for additional resource composite objects, adjust the input above and map the relevant columns.
That’s it! You’ve now successfully learned how to write data into the Workday resource.
Configuration
Base URL address: https://[workday-tenant].workday.com/ccx/api.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id: Required. Specify the Workday application client identifier.
- client_secret: Required. Specify the Workday application client secret.
- scope: Required. Specify scope.
- redirect_uri: Required. Specify redirect_uri.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://community.workday.com/rest/oauth.
- Client Credentials
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://community.workday.com/rest/oauth.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/balances.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/balances.
- [Read Single] action
-
Endpoint URL address:
/balances/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/balances/-ID-.
- unit
Template: SharedAttributes.
- position
Template: CommonAttributes.
- quantity
Data type: DT_UI8
- absencePlan
Template: CommonAttributes. Field components:
-
Uses template:
LongText. - Contains the following components: timeoffs, absenceTable.
-
Uses template:
- dateOfFirstAbsence
Template: DateTime. A read-only field.
- effectiveDate
Template: DateTime. A read-only field.
- category
Template: SharedAttributes.
- worker
Template: SharedAttributes.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-.
The resource includes the fields from the CommonAttributes template.
- workerId
A key field. Template: ShortText.
- primaryJob
Template: PrimaryJob.
- person
Template: Person.
- workerType
Template: SharedAttributes.
- additionalJobs
Field components:
- An array.
-
Uses template:
AdditionalJob.
- TimeOffDetails
The gathered value is processed with
{{=connection.resourceManager['Worker | TimeOff Detail'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
TimeOffDetails.
- ValidTimeOffDates
The gathered value is processed with
{{=connection.resourceManager['Worker | Valid TimeOff Date'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
ValidTimeOffDates.
- EligibleAbsenceType
The gathered value is processed with
{{=connection.resourceManager['Worker | Eligible Absence Type'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
EligibleAbsenceType.
- LeaveOfAbsence
The gathered value is processed with
{{=connection.resourceManager['Worker | Leave of Absence'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
LeaveOfAbsence.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: requestTimeOff.
-
Uses template:
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/eligibleAbsenceTypes.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-/eligibleAbsenceTypes.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/eligibleAbsenceTypes/{{=parameters.eligibleAbsenceId}}.The action has the following user-defined parameters:
- eligibleAbsenceId: Required. Specify the eligible absence identifier.
The resource includes the fields from the EligibleAbsenceType template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/leavesOfAbsence.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-/leavesOfAbsence.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/eligibleAbsenceTypes/{{=parameters.leaveOfAbsenceId}}.The action has the following user-defined parameters:
- leaveOfAbsenceId: Required. Specify the leave of absence identifier.
The resource includes the fields from the LeaveOfAbsence template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/timeOffDetails.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-/timeOffDetails.
The resource includes the fields from the TimeOffDetails template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/validTimeOffDates.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/workers/-ID-/validTimeOffDates.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/validTimeOffDates/{{=parameters.validTimeOffDateId}}.The action has the following user-defined parameters:
- validTimeOffDateId: Required. Specify the valid timeoff date identifier.
The resource includes the fields from the ValidTimeOffDates template.
Based on resource template VersionOnePagination.
- [Read leave status] action
-
Endpoint URL address:
/values/leave/status/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/values/leave/status/.
- [Read timeOff status] action
-
Endpoint URL address:
/values/timeOff/status/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#absenceManagement/v1/get-/values/timeOff/status/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supplierInvoiceRequests.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/get-/supplierInvoiceRequests.
- [Read Single] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/get-/supplierInvoiceRequests/-ID-.
- [Create] action
-
Endpoint URL address:
/supplierInvoiceRequests.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/post-/supplierInvoiceRequests.
The resource includes the fields from the CommonAttributes template.
- invoiceDate
Template: DateTime.
- statutoryInvoiceType
Template: SharedAttributes.
- referenceNumber
Template: ShortText.
- taxAmount
Data type: DT_R8
- handlingCode
Template: SharedAttributes.
- dueDate
Template: DateTime.
- status
Template: SharedAttributes.
- remitToConnection
Template: SharedAttributes.
- paymentTerms
Template: SharedAttributes.
- controlTotalAmount
Data type: DT_R8
- memo
Template: LongText.
- suppliersInvoiceNumber
Template: ShortText.
- currency
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: currencyID.
-
Uses template:
- freightAmount
Data type: DT_R8
- shipToAddress
Template: SharedAttributes.
- referenceType
Template: SharedAttributes.
- requestNumber
Template: ShortText.
- invoiceReceivedDate
Template: DateTime.
- requester
Template: SharedAttributes.
- supplier
Template: SharedAttributes.
- company
Template: SharedAttributes.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Supplier Invoice Request | Attachment'].getData({ batchSize: 100, parameters: ['supplierInvoiceRequestId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Attachment.
- lines
The gathered value is processed with
{{=connection.resourceManager['Supplier Invoice Request | Line'].getData({ batchSize: 100, parameters: ['supplierInvoiceRequestId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Line.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: submit.
-
Uses template:
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=parameters.supplierInvoiceRequestId}}/attachments.The action has the following user-defined parameters:
- supplierInvoiceRequestId: Required. Specify the supplier invoice request identifier.
- [Read Single] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=parameters.id}}/attachments/{{=parameters.attachmentId}}.The action has the following user-defined parameters:
- attachmentId: Required. Specify the attachment identifier.
- [Create] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=item.supplierInvoiceRequestId}}/attachments.
The resource includes the fields from the Attachment template.
- supplierInvoiceRequestId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=parameters.supplierInvoiceRequestId}}/lines.The action has the following user-defined parameters:
- supplierInvoiceRequestId: Required. Specify the supplier invoice request identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#accountsPayable/v1/get-/supplierInvoiceRequests/-ID-/lines.
- [Read Single] action
-
Endpoint URL address:
/supplierInvoiceRequests/{{=parameters.id}}/lines/{{=parameters.lineId}}.The action has the following user-defined parameters:
- lineId: Required. Specify the line identifier.
The resource includes the fields from the Line template.
Based on resource template VersionTwoNoPagination.
- [Read Single] action
-
Endpoint URL address:
/attribute/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/get-/attribute/-ID-.
The resource includes the fields from the Attribute template.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/attribute/{{=parameters.attributeId}}/attributeValues.The action has the following user-defined parameters:
- attributeId: Required. Specify the attribute identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/get-/attribute/-ID-/attributeValues.
- [Read Single] action
-
Endpoint URL address:
/attribute/{{=parameters.id}}/attributeValues/{{=parameters.attributeValueId}}.The action has the following user-defined parameters:
- attributeValueId: Required. Specify the attribute value identifier.
- [Create] action
-
Endpoint URL address:
/attribute/{{=item.attributeId}}/attributeValues.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/post-/attribute/-ID-/attributeValues.
- [Update] action
-
Endpoint URL address:
/attribute/{{=item.attributeId}}/attributeValues/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/attribute/{{=item.attributeId}}/attributeValues/{{=item.id}}.
The resource includes the fields from the Value template.
- attributeId
A key field. Template: ShortText.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/configurations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/get-/configurations.
- [Read Single] action
-
Endpoint URL address:
/configurations/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/get-/configurations/-ID-.
- [Create] action
-
Endpoint URL address:
/configurations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/post-/configurations.
- [Update] action
-
Endpoint URL address:
/configurations/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/put-/configurations/-ID-.
- [Delete] action
-
Endpoint URL address:
/configurations/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/delete-/configurations/-ID-.
The resource includes the fields from the CommonAttributes template.
- name
Template: ShortText.
- attributes
Field components:
- An array.
-
Uses template:
Attribute.
- referenceIdValue
Template: ShortText.
- application
Template: SharedAttributes.
- description
Template: ShortText.
- version
Template: ShortText.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/configurations/{{=parameters.configurationId}}/attributes.The action has the following user-defined parameters:
- configurationId: Required. Specify the configuration identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#applicationAttributes/v2/get-/configurations/-ID-/attributes.
- [Read Single] action
-
Endpoint URL address:
/configurations/{{=parameters.id}}/attributes/{{=parameters.attributeId}}.The action has the following user-defined parameters:
- attributesId: Required. Specify the attribute identifier.
- [Create] action
-
Endpoint URL address:
/configurations/{{=item.configurationId}}/attributes.
- [Update] action
-
Endpoint URL address:
/configurations/{{=item.configurationId}}/attributes/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/configurations/{{=item.configurationId}}/attributes/{{=item.id}}.
The resource includes the fields from the Attribute template.
- configurationId
Template: ShortText.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/configurations/{{=parameters.configurationId}}/attributeValues.The action has the following user-defined parameters:
- configurationId: Required. Specify the configuration identifier.
- [Read Single] action
-
Endpoint URL address:
/configurations/{{=parameters.id}}/attributeValues/{{=parameters.attributeValueId}}.The action has the following user-defined parameters:
- attributeValueId: Required. Specify the attribute value identifier.
The resource includes the fields from the Attribute template.
Based on resource template VersionTwoPagination.
- [Read typeDetails] action
-
Endpoint URL address:
/values/attributeType/typeDetails/.
- [Read environmentDetails] action
-
Endpoint URL address:
/values/environments/environmentDetails/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events.
- [Read Single] action
-
Endpoint URL address:
/events/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-.
The resource includes the fields from the CommonAttributes template.
- subBusinessProcesses
Field components:
- An array.
-
Uses template:
CommonAttributes.
- dueDate
Template: DateTime. A read-only field.
- initiator
Template: SharedAttributes.
- for
Template: SharedAttributes.
- overallBusinessProcess
Template: SharedAttributes.
- completedDate
Template: DateTime.
- creationDate
Template: DateTime.
- status
Template: SharedAttributes.
- effectiveDate
Template: DateTime. A read-only field.
- attachments
The gathered value is processed with
{{=connection.resourceManager['Event | Attachment'].getData({ batchSize: 100, parameters: ['eventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Attachment.
- comments
The gathered value is processed with
{{=connection.resourceManager['Event | Comment'].getData({ batchSize: 100, parameters: ['eventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Comment.
- completedSteps
The gathered value is processed with
{{=connection.resourceManager['Event | Completed Steps'].getData({ batchSize: 100, parameters: ['eventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CompletedSteps.
- inProgressSteps
The gathered value is processed with
{{=connection.resourceManager['Event | InProgress Steps'].getData({ batchSize: 100, parameters: ['eventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
InProgressSteps.
- remainingSteps
The gathered value is processed with
{{=connection.resourceManager['Event | Remaining Steps'].getData({ batchSize: 100, parameters: ['eventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
RemainingSteps.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.eventId}}/attachments.The action has the following user-defined parameters:
- eventId: Required. Specify the event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-/attachments.
The resource includes the fields from the Attachment template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.eventId}}/comments.The action has the following user-defined parameters:
- eventId: Required. Specify the event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-/comments.
The resource includes the fields from the Comment template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.eventId}}/completedSteps.The action has the following user-defined parameters:
- eventId: Required. Specify the event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-/completedSteps.
The resource includes the fields from the CompletedSteps template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.eventId}}/inProgressSteps.The action has the following user-defined parameters:
- eventId: Required. Specify the event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-/inProgressSteps.
The resource includes the fields from the InProgressSteps template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/events/{{=parameters.eventId}}//remainingSteps.The action has the following user-defined parameters:
- eventId: Required. Specify the event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/events/-ID-/remainingSteps.
The resource includes the fields from the RemainingSteps template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/eventSteps.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/eventSteps.
- [Read Single] action
-
Endpoint URL address:
/eventSteps/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/eventSteps/-ID-.
The resource includes the fields from the CommonAttributes template.
- delayedDate
Template: DateTime. A read-only field.
- stepEvent
Template: SharedAttributes.
- businessProcessStep
Template: SharedAttributes.
- status
Template: SharedAttributes.
- parallelStepInboxOrder
Template: ShortText.
- dueDate
Template: DateTime. A read-only field.
- stepType
Template: SharedAttributes.
- stepHelpText
Template: ShortText.
- order
Template: ShortText.
- businessProcess
Template: SharedAttributes.
- task
Template: SharedAttributes.
- completedDate
Template: DateTime. A read-only field.
- awaitingPersons
Template: CompositeCommonAttribute.
- overallProcess
Template: SharedAttributes.
- comments
Field components:
- An array.
-
Uses template:
Comment.
- event
Template: SharedAttributes.
- completedByPerson
Template: SharedAttributes.
- questionnaire
Template: SharedAttributes.
- creationDate
Template: DateTime. A read-only field.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/types.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/types.
- [Read Single] action
-
Endpoint URL address:
/types/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/types/-ID-.
- [Read attachment category] action
-
Endpoint URL address:
/types/{{=parameters.typeId}}/attachmentCategories.The action has the following user-defined parameters:
- typeId: Required. Specify the type identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/types/-ID-/attachmentCategories.
The resource includes the fields from the CommonAttributes template.
- referenceID
Template: ShortText.
- helpText
Template: LongText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/values/sendBack/to/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#businessProcess/v1/get-/values/sendBack/to/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOneNoPagination.
- [Read Single] action
-
Endpoint URL address:
/businessTitleChanges/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/businessTitleChanges/-ID-.
The resource includes the fields from the BusinessTitleChange template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/currencies.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/currencies.
- [Read Single] action
-
Endpoint URL address:
/currencies/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/currencies/-ID-.
The resource includes the fields from the SharedAttributes template.
- precision
Template: ShortText.
- code
Template: ShortText.
Based on resource template VersionOneNoPagination.
- [Read Single] action
-
Endpoint URL address:
/customers/{{=parameters.customerId}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/customers/-ID-.
The resource includes the fields from the CommonAttributes template.
- name
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/customers/{{=parameters.customerId}}/activities.The action has the following user-defined parameters:
- customerId: Required. Specify the customer identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/customers/-ID-/activities.
- [Read Single] action
-
Endpoint URL address:
/customers/{{=parameters.id}}/activities{{=parameters.activityId}}.The action has the following user-defined parameters:
- activityId: Required. Specify the activity identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/customers/-ID-/activities/-subresourceID-.
The resource includes the fields from the CustomerActivity template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/jobChangeReasons.The action has the following user-defined parameters:
- customerId: Required. Specify the customer identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/jobChangeReasons.
- [Read Single] action
-
Endpoint URL address:
/jobChangeReasons/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/jobChangeReasons/-ID-.
The resource includes the fields from the SharedAttributes template.
- isForContingentWorker
Data type: DT_BOOL
- isForEmployee
Data type: DT_BOOL
- managerReason
Data type: DT_BOOL
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/organizationTypes.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/organizationTypes.
- [Read Single] action
-
Endpoint URL address:
/organizationTypes/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/organizationTypes/-ID-.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/organizations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/organizations.
- [Read Single] action
-
Endpoint URL address:
/organizations/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/organizations/-ID-.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supervisoryOrganizations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/supervisoryOrganizations.
- [Read Single] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/supervisoryOrganizations/-ID-.
The resource includes the fields from the SupervisoryManagedOrganization template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.supervisoryOrganizationId}}/workers.The action has the following user-defined parameters:
- supervisoryOrganizationId: Required. Specify the organization identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/supervisoryOrganizations/-ID-/workers.
- [Read Single] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.id}}/workers/{{=parameters.workerId}}.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
The resource includes the fields from the SharedAttributes template.
- primaryWorkPhone
Template: ShortText.
- isManager
Data type: DT_BOOL
- primaryWorkEmail
Template: ShortText.
- businessTitle
Template: ShortText.
- primarySupervisoryOrganization
Template: SharedAttributes.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-.
The resource includes the fields from the Worker template.
- TimeOffDetails
The gathered value is processed with
{{=connection.resourceManager['Worker | TimeOff Detail'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
TimeOffDetails.
- TimeOffPlan
The gathered value is processed with
{{=connection.resourceManager['Worker | TimeOff Plan'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
TimeOffPlan.
- BusinessTitleChange
The gathered value is processed with
{{=connection.resourceManager['Worker | Business Title Change'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
BusinessTitleChange.
- DirectReport
The gathered value is processed with
{{=connection.resourceManager['Worker | Direct Report'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
DirectReport.
- History
The gathered value is processed with
{{=connection.resourceManager['Worker | History'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
History.
- InboxTask
The gathered value is processed with
{{=connection.resourceManager['Worker | InboxTask'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
InboxTask.
- Organization
The gathered value is processed with
{{=connection.resourceManager['Worker | Organization'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
Organization.
- PaySlip
The gathered value is processed with
{{=connection.resourceManager['Worker | PaySlip'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
PaySlip.
- SupervisoryOrganizationManaged
The gathered value is processed with
{{=connection.resourceManager['Supervisory Organization Managed'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
SupervisoryManagedOrganization.
- TimeOffEntry
The gathered value is processed with
{{=connection.resourceManager['Worker | TimeOff Entries'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
TimeOffEntry.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/businessTitleChanges.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/businessTitleChanges.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/businessTitleChanges/{{=parameters.businessTitleChange}}.The action has the following user-defined parameters:
- businessTitleChangId: Required. Specify the business title change identifier.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/businessTitleChanges.
The resource includes the fields from the BusinessTitleChange template.
- workerId
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/directReports.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/directReports.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/directReports/{{=parameters.directReportId}}.The action has the following user-defined parameters:
- directReportId: Required. Specify the report identifier.
The resource includes the fields from the DirectReport template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/history.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/history.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/history/{{=parameters.historyId}}.The action has the following user-defined parameters:
- historyId: Required. Specify the history identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/history/-subresourceID-.
The resource includes the fields from the History template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/inboxTasks.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/inboxTasks.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/inboxTasks/{{=parameters.inboxTaskId}}.The action has the following user-defined parameters:
- inboxTaskId: Required. Specify the inbox task identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/inboxTasks/-subresourceID-.
The resource includes the fields from the InboxTask template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/organizations.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/organizations.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/organizations/{{=parameters.organizationId}}.The action has the following user-defined parameters:
- organizationId: Required. Specify the organization identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/organizations/-subresourceID-.
The resource includes the fields from the Organization template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/paySlips.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/paySlips.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/paySlips/{{=parameters.paySlipId}}.The action has the following user-defined parameters:
- paySlipId: Required. Specify the paySlip identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/paySlips/-subresourceID-.
The resource includes the fields from the PaySlip template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/supervisoryOrganizationsManaged.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/supervisoryOrganizationsManaged.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/supervisoryOrganizationsManaged/{{=parameters.supervisoryOrganizationsManagedId}}.The action has the following user-defined parameters:
- supervisoryOrganizationsManagedId: Required. Specify the spervisory organization manage identifier.
The resource includes the fields from the SupervisoryManagedOrganization template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/timeOffEntries.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/timeOffEntries.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/timeOffEntries/{{=parameters.timeOffEntryId}}.The action has the following user-defined parameters:
- timeOffEntryId: Required. Specify the timeoff entry identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/timeOffEntries/-subresourceID-.
The resource includes the fields from the TimeOffEntry template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/timeOffPlans.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/timeOffEntries.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/timeOffPlans/{{=parameters.timeOffPlanId}}.The action has the following user-defined parameters:
- timeOffEntryId: Required. Specify the timeoff plan identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#common/v1/get-/workers/-ID-/timeOffPlans/-subresourceID-.
The resource includes the fields from the TimeOffPlan template.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/scorecardResults.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/scorecardResults.
- [Read Single] action
-
Endpoint URL address:
/scorecardResults/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/scorecardResults/-ID-.
- [Create] action
-
Endpoint URL address:
/scorecardResults.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/post-/scorecardResults.
- [Delete] action
-
Endpoint URL address:
/scorecardResults/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/delete-/scorecardResults/-ID-.
The resource includes the fields from the CommonAttributes template.
- scorecardDescription
Template: LongText.
- scorecardName
Template: ShortText.
- scorecardID
Template: Identifier.
- profileScorecardGoalsResult
Field components:
- An array.
-
Uses template:
ScoreCardGoalResult.
- defaultScorecardGoalsResult
Template: ScoreCardGoalResult.
- evaluationDate
Template: DateTime.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/scorecards.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/scorecards.
- [Read Single] action
-
Endpoint URL address:
/scorecards{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/scorecards/-ID-.
- [Create] action
-
Endpoint URL address:
/scorecards.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/post-/scorecards.
- [Update] action
-
Endpoint URL address:
/scorecards/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/put-/scorecards/-ID-.
- [Delete] action
-
Endpoint URL address:
/scorecards/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/delete-/scorecards/-ID-.
- id
A key field. Template: ShortText.
- inactive
Data type: DT_BOOL
- defaultScorecardGoals
Field components:
- An array.
-
Uses template:
ScoreCardGoal.
- scorecardDescription
Template: LongText.
- scorecardProfiles
Field components:
- An array.
- Contains the following components: eligibilityRule, profileScorecardGoals, id.
- scorecardName
Template: ShortText.
- effectiveDate
Template: DateTime.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#compensation/v2/get-/workers/-ID-.
The resource includes the fields from the Worker template.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/messageTemplates.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/get-/messageTemplates.
- [Read Single] action
-
Endpoint URL address:
/messageTemplates/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/get-/messageTemplates/-ID-.
- [Create] action
-
Endpoint URL address:
/messageTemplates.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/post-/messageTemplates.
- [Update] action
-
Endpoint URL address:
/messageTemplates/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/put-/messageTemplates/-ID-.
The resource includes the fields from the CommonAttributes template.
- createdBy
Template: SharedAttributes.
- emailDetail
Field components:
-
Uses template:
ShortText. - Contains the following components: name, body, subject, replyTo.
-
Uses template:
- lastUpdated
Template: DateTime. A read-only field.
- pushDetail
Field components:
-
Uses template:
LongText. - Contains the following components: redirectURL, message, id.
-
Uses template:
- usageCount
Template: ShortText.
- createdOn
Template: DateTime. A read-only field.
- notificationType
Template: SharedAttributes.
- name
Template: ShortText.
- lastUpdatedBy
Template: SharedAttributes.
- referenceID
Template: ShortText.
- inactive
Data type: DT_BOOL
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/notificationTypes.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/get-/notificationTypes.
- [Read Single] action
-
Endpoint URL address:
/notificationTypes/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#connect/v2/get-/notificationTypes/-ID-.
The resource includes the fields from the CommonAttributes template.
- parentCategory
Template: SharedAttributes.
- name
Template: ShortText.
- referenceID
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/supplierContracts.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#contractCompliance/v1/get-/supplierContracts.
- [Read Single] action
-
Endpoint URL address:
/supplierContracts/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#contractCompliance/v1/get-/supplierContracts/-ID-.
The resource includes the fields from the CommonAttributes template.
- overridePaymentType
Template: SharedAttributes.
- billToAddress
Template: SharedAttributes.
- catalogDiscountPercent
Template: ShortText.
- supplierInvoiceReferenceNumber
Template: ShortText.
- purchaseOrderDefaultCompany
Template: CommonAttributes.
- overview
Template: ShortText.
- buyer
Template: SharedAttributes.
- defaultOrderFromConnection
Template: SharedAttributes.
- supplierInvoiceDefaultCompany
Template: CommonAttributes.
- signedDate
Template: DateTime. A read-only field.
- externalReferenceID
Template: ShortText.
- catalogs
Template: CompositeCommonAttribute.
- companyOrHierarchy
Template: CommonAttributes.
- invoicedPOAmount
Data type: DT_R8
- receiptAmount
Data type: DT_R8
- billToContactDetail
Template: ShortText.
- serviceLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: lineNumber, lineIsCanceled, companyForInvoice, extendedAmount, taxCode, spendCategory, item, taxRecoverabilities, doNotAutoRenew, lineOnHold, lineDescription, retention, worktags, memo, shipToContact, taxApplicability, renewalAmount, lineEndDate, location, chargeControls, lineStartDate, shipToAddress.
- fromSupplierList
Data type: DT_BOOL
- noticePeriod
Template: ShortText.
- allowAllSuppliers
Data type: DT_BOOL
- automaticallyRenew
Data type: DT_BOOL
- totalAmount
Data type: DT_R8
- paymentType
Template: SharedAttributes.
- originalTotalAmount
Template: ShortText.
- documentLink
Template: ShortText.
- gpoReference
Template: ShortText.
- renewalTerm
Template: ShortText.
- noticePeriodFrequency
Template: SharedAttributes.
- multiParticipants
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: company, inactive.
- chargeControls
Template: ChargeControl.
- nonPOInvoiceAmount
Data type: DT_R8
- endDate
Template: Date.
- shipToAddress
Template: SharedAttributes.
- purchaseOrderAmount
Template: ShortText.
- supplierForSupplierInvoice
Template: SharedAttributes.
- startDate
Template: DateTime. A read-only field.
- number
Template: ShortText.
- contractSpecialist
Template: SharedAttributes.
- onHold
Data type: DT_BOOL
- currency
Template: SharedAttributes.
- shipToContactDetail
Template: ShortText.
- supplier
Template: SharedAttributes.
- purchaseOrderIssueOption
Template: SharedAttributes.
- externalSystemReference
Template: SharedAttributes.
- renewalTermFrequency
Template: SharedAttributes.
- name
Template: ShortText.
- sendExpiryNotification
Data type: DT_BOOL
- status
Template: SharedAttributes.
- multiSuppliers
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: supplier, inactive, markupPercent.
- contractReferenceNumber
Template: ShortText.
- paymentTerms
Template: SharedAttributes.
- contractType
Template: CommonAttributes.
- markupPercent
Data type: DT_R8
Based on resource template VersionOnePagination.
- [Read companiesOrHierarchies] action
-
Endpoint URL address:
/values/contractComplianceGroup/companiesOrHierarchies/.
- [Read contractTypes] action
-
Endpoint URL address:
/values/contractComplianceGroup/contractTypes/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOneNoPagination.
- [Read] action
-
Endpoint URL address:
/currencies.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#coreAccounting/v1/get-/currencies.
- [Read Single] action
-
Endpoint URL address:
/currencies/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#coreAccounting/v1/get-/currencies/-ID-.
The resource includes the fields from the CommonAttributes template.
- code
Template: ShortText.
- precision
Data type: DT_I4
Based on resource template VersionOneNoPagination.
- [Read] action
-
Endpoint URL address:
/evaluateAccountPostingRules.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#coreAccounting/v1/get-/evaluateAccountPostingRules.
The resource includes the fields from the CommonAttributes template.
- ledgerAccountName
Template: ShortText.
- resultingWorktags
Template: WorkTag.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/customers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/customers.
- [Read Single] action
-
Endpoint URL address:
/customers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/customers/-ID-.
- id
A key field. Template: ShortText.
- creditLimit
Data type: DT_R8
- name
Template: ShortText.
- paymentTerms
Template: SharedAttributes.
- satisfactionScore
Data type: DT_R8
- compositeRiskScore
Data type: DT_R8
- groups
Template: CompositeCommonAttribute.
- commercialCreditScore
Data type: DT_R8
- primaryPhone
Template: ShortText.
- totalBalance
Data type: DT_R8
- category
Template: SharedAttributes.
- activities
The gathered value is processed with
{{=connection.resourceManager['Customer | Activity'].getData({ batchSize: 100, parameters: ['customerId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CustomerActivity.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/invoices.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/invoices.
- [Read Single] action
-
Endpoint URL address:
/invoices/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/invoices/-ID-.
The resource includes the fields from the SharedAttributes template.
- invoiceDate
Template: DateTime. A read-only field.
- transactionType
Template: ShortText.
- withholdingAmount
Data type: DT_R8
- company
Template: CommonAttributes.
- billToCustomer
Template: CommonAttributes.
- inCollection
Data type: DT_BOOL
- netAmount
Data type: DT_R8
- disputeAmount
Data type: DT_R8
- dueAmount
Data type: DT_R8
- invoiceType
Template: Descriptor.
- poNumber
Template: ShortText.
- relatedAdjustments
Field components:
- An array.
-
Uses template:
SharedAttributes.
- adjustmentReason
Template: Descriptor.
- taxAmount
Data type: DT_R8
- disputeDate
Template: Date.
- relatedInvoice
Template: SharedAttributes.
- paymentStatus
Template: CommonAttributes.
- currency
Template: Descriptor.
- dueDate
Template: Date.
- memo
Template: ShortText.
- inDispute
Data type: DT_BOOL
- billToCustomerAddress
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: regionSubdivision1, countryRegion, addressLine3, citySubdivision1, addressLine1, addressLine4, city, citySubdivision2, country, addressLine2, regionSubdivision2, postalCode.
-
Uses template:
- disputeReasons
Field components:
- An array.
-
Uses template:
Descriptor.
- invoiceStatus
Template: CommonAttributes.
- retentionAmount
Data type: DT_R8
- totalAmount
Data type: DT_R8
- invoiceNumber
Template: ShortText.
- activities
The gathered value is processed with
{{=connection.resourceManager['Invoice | Print Run'].getData({ batchSize: 100, parameters: ['invoiceId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PrintRun.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/invoices/{{=parameters.invoiceId}}/printRuns.The action has the following user-defined parameters:
- invoiceId: Required. Specify the invoice identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/invoices/-ID-/printRuns.
- [Read Single] action
-
Endpoint URL address:
/invoices/{{=parameters.id}}/printRuns/{{=parameters.printRunId}}.The action has the following user-defined parameters:
- printRunId: Required. Specify the print run identifier.
The resource includes the fields from the PrintRun template.
Based on resource template VersionOneNoPagination.
- [Read Single] action
-
Endpoint URL address:
/payments/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/get-/payments/-ID-.
- [Create] action
-
Endpoint URL address:
/payments.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#customerAccounts/v1/post-/payments.
The resource includes the fields from the CommonAttributes template.
- memo
Template: LongText.
- remitFromCustomer
Template: Identifier.
- readyToAutoApply
Data type: DT_BOOL
- transactionNumber
Template: ShortText.
- reference
Template: ShortText.
- amount
Data type: DT_R8
- type
Template: Identifier.
- date
Template: DateTime.
- company
Template: Identifier.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/entries.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/entries.
- [Read Single] action
-
Endpoint URL address:
/entries/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/entries.
- [Create] action
-
Endpoint URL address:
/entries.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/post-/entries.
- [Update] action
-
Endpoint URL address:
/entries/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/put-/entries/-ID-.
- [Delete] action
-
Endpoint URL address:
/entries/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/delete-/entries/-ID-.
The resource includes the fields from the SharedAttributes template.
- expenseEntryStatus
Template: SharedAttributes.
- amount
Data type: DT_R8
- memo
Template: LongText.
- entryType
Template: SharedAttributes.
- date
Template: Date.
- scanStatus
Template: SharedAttributes.
- attachments
Template: Attachment. Field components:
- An array.
-
Uses template:
SharedAttributes.
- merchant
Template: ShortText.
- expenseItem
Template: SharedAttributes.
- hasOCRReceipt
Data type: DT_BOOL
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: postAttachment.
-
Uses template:
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/expenseItems.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/expenseItems.
- [Read Single] action
-
Endpoint URL address:
/expenseItems/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/expenseItems/-ID-.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/reports.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/reports.
- [Read Single] action
-
Endpoint URL address:
/reports/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/get-/reports/-ID-.
- [Create] action
-
Endpoint URL address:
/reports.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#expense/v1/post-/reports.
The resource includes the fields from the SharedAttributes template.
- totalAmount
Data type: DT_R8
- expenseReportStatus
Template: SharedAttributes.
- creationDate
Template: DateTime. A read-only field.
- expenseReportMemo
Template: ShortText.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: createLine, submitReport.
-
Uses template:
Based on resource template VersionOnePagination.
- [Create] action
-
Endpoint URL address:
/electronicReportingRuns.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#finTaxPublic/v1/post-/electronicReportingRuns.
- id
A key field. Template: ShortText.
- fileName
Template: ShortText.
- invoiceDocuments
Field components:
- An array.
-
Uses template:
Identifier.
- integrationEventEndDate
Template: DateTime.
- integrationEventStartDate
Template: DateTime.
- integrationEvent
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/payGroups.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#globalPayroll/v1/get-/payGroups.
- [Read Single] action
-
Endpoint URL address:
/payGroups/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#globalPayroll/v1/get-/payGroups/-ID-.
The resource includes the fields from the CommonAttributes template.
- country
Template: CommonAttributes.
- periods
The gathered value is processed with
{{=connection.resourceManager['Pay Group | Period'].getData({ batchSize: 100, parameters: ['payGroupId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Period.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/payGroups/{{=parameters.payGroupId}}/periods.The action has the following user-defined parameters:
- payGroupId: Required. Specify the pay group identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#globalPayroll/v1/get-/payGroups/-ID-/periods.
- [Read Single] action
-
Endpoint URL address:
/payGroups/{{=parameters.id}}/periods/{{=parameters.periodId}}.The action has the following user-defined parameters:
- periodId: Required. Specify the period identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#globalPayroll/v1/get-/payGroups/-ID-.
The resource includes the fields from the Period template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/articleStatuses.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpArticle/v1/get-/articleStatuses.
- [Read Single] action
-
Endpoint URL address:
/articleStatuses/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpArticle/v1/get-/articleStatuses/-ID-.
The resource includes the fields from the CommonAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/articleVersions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpArticle/v1/get-/articleVersions.
- [Read Single] action
-
Endpoint URL address:
/articleVersions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpArticle/v1/get-/articleVersions/-ID-.
- id
A key field. Template: ShortText.
- location
Template: SharedAttributes.
- createdByWorker
Template: CompositeCommonAttribute.
- language
Template: SharedAttributes.
- title
Template: ShortText.
- tags
Template: CompositeCommonAttribute.
- version
Template: ShortText.
- parentArticle
Template: SharedAttributes.
- createdDate
Template: DateTime. A read-only field.
- lastUpdatedDate
Template: DateTime. A read-only field.
- viewLink
Template: ShortText.
- audience
Template: CompositeCommonAttribute.
- lastUpdatedByWorker
Template: CompositeCommonAttribute.
- status
Template: SharedAttributes.
- category
Template: SharedAttributes.
- content
Template: LongText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/values/common/audiences/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpArticle/v1/get-/values/common/audiences/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/cases.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/cases.
- [Read Single] action
-
Endpoint URL address:
/cases/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/cases/-ID-.
- [Create] action
-
Endpoint URL address:
/cases.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/post-/cases.
- id
A key field. Template: ShortText.
- caseID
A key field. Template: ShortText.
- detailedMessage
Template: LongText.
- title
Template: ShortText.
- creationDate
Template: DateTime. A read-only field.
- caseLink
Template: ShortText.
- status
Template: CommonAttributes.
- serviceTeam
Template: SharedAttributes.
- assignee
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: person.
-
Uses template:
- about
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: person.
-
Uses template:
- type
Field components:
-
Uses template:
ShortText. - Contains the following components: confidential, name, serviceCategory, inactive, description, id.
-
Uses template:
- confidential
Data type: DT_BOOL
- formattedCreationDate
Template: ShortText.
- by
Template: Who.
- for
Template: Who.
- aboutWorker
Template: SharedAttributes.
- attachments
The value is sent to
/v3/attachmentsaddress. Field components:- An array.
-
Uses template:
Attachment.
- source
Template: Identifier.
- questionnaireResponses
Template: Identifier. Field components:
-
Uses template:
ShortText. - Contains the following components: questionnaireTargetContext, questionnaireTarget, questionnaireAnswers, id, descriptor.
-
Uses template:
- forWorker
Template: Identifier.
- forExternalCreator
Template: Identifier.
- questionnaireHolder
Template: Identifier.
- caseType
Template: Identifier.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/cases/{{=parameters.caseId}}/timeline.The action has the following user-defined parameters:
- caseId: Required. Specify the case identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/cases/-ID-/timeline.
- [Read Single] action
-
Endpoint URL address:
/cases/{{=parameters.id}}/timeline/{{=parameters.timelineId}}.The action has the following user-defined parameters:
- timelineId: Required. Specify the timeline identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/cases/-ID-/timeline/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/cases/{{=item.caseId}}/timeline.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/post-/cases/-ID-/timeline.
- id
A key field. Template: ShortText.
- actions
Field components:
- An array.
- Contains the following components: text, id.
- description
Template: LongText.
- creationDate
Template: DateTime. A read-only field.
- submittedBy
Template: Who.
- guidance
Field components:
-
Uses template:
CommonAttributes. - Contains the following components: uiTask, kbArticle.
-
Uses template:
- formattedCreationDate
Template: ShortText.
- attachments
Field components:
- An array.
-
Uses template:
CaseTimelineAttachment.
- questionnaireResponse
Field components:
-
Uses template:
SharedAttributes. - Contains the following components: questionAnswerPair, questionnaire.
-
Uses template:
- type
Template: CommonAttributes.
- comment
Field components:
-
Uses template:
LongText. - Contains the following components: content, textBody.
-
Uses template:
- caseId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/caseTypes.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/caseTypes.
- [Read Single] action
-
Endpoint URL address:
/caseTypes/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/caseTypes/-ID-.
The resource includes the fields from the CaseType template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/caseSuggestions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/caseSuggestions.
- [Read Single] action
-
Endpoint URL address:
/caseSuggestions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/caseSuggestions/-ID-.
- caseSuggestionContentId
A key field. Template: ShortText.
- description
Template: LongText.
- name
Template: ShortText.
- order
Template: ShortText.
- url
Template: ShortText.
- type
Template: SharedAttributes.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/configuration.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/configuration.
- [Read Single] action
-
Endpoint URL address:
/configuration/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/configuration/-ID-.
- maxAttachments
Data type: DT_I4
- displayServiceCategories
Data type: DT_BOOL
- fileConfigurations
Field components:
- Contains the following components: supportedFileTypes, allFileTypesSupported, maxFileSizeInMB.
- confidentialCasesMessage
Template: LongText.
Based on resource template VersionThreePagination.
- [Create] action
-
Endpoint URL address:
/externalRecords.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/post-/externalRecords.
- [Update] action
-
Endpoint URL address:
/externalRecords/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/put-/externalRecords/-ID-.
- id
A key field. Template: ShortText.
- href
Template: ShortText.
- name
Template: ShortText.
- source
Field components:
-
Uses template:
ShortText. - Contains the following components: id.
-
Uses template:
- case
Field components:
-
Uses template:
ShortText. - Contains the following components: id.
-
Uses template:
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/externalCreators.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/externalCreators.
- [Read Single] action
-
Endpoint URL address:
/externalCreators/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/externalCreators/-ID-.
- [Create] action
-
Endpoint URL address:
/externalCreators.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/post-/externalCreators.
The resource includes the fields from the ExternalCreator template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/serviceCategories.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/serviceCategories.
- [Read Single] action
-
Endpoint URL address:
/serviceCategories/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/serviceCategories/-ID-.
- id
A key field. Template: ShortText.
- categories
Template: LongText. A composite field.
- description
Template: LongText.
- caseTypes
Field components:
- An array.
-
Uses template:
CaseType.
- name
Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/values/externalRecords/source/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#helpCase/v3/get-/values/externalRecords/source/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/values/externalRecords/source/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#holiday/v1/get-/holidayEvents.
- holidayCalendar
Template: SharedAttributes.
- date
Template: DateTime. A read-only field.
- worker
Template: CommonAttributes.
- holidayName
Template: ShortText.
- workerDetails
Template: Worker. The value is gathered from
/v1/workers/{{=item.worker.id}}address.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/clientDetails.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#oAuthClient/v1/get-/clientDetails.
- [Read Single] action
-
Endpoint URL address:
/clientDetails/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#oAuthClient/v1/get-/clientDetails/-ID-.
- clientId
A key field. Template: ShortText.
- grantType
Template: ShortText.
- tokenEndpoint
Template: ShortText.
- workdayAPIEndpoint
Template: ShortText.
- authorizationEndpoint
Template: ShortText.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/jobs.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/jobs.
- [Read Single] action
-
Endpoint URL address:
/jobs/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/jobs/-ID-.
The resource includes the fields from the CommonAttributes template.
- location
Template: CommonAttributes. Field components:
-
Uses template:
Descriptor. - Contains the following components: country.
-
Uses template:
- businessTitle
Template: ShortText.
- worker
Template: CommonAttributes.
- supervisoryOrganization
Template: CommonAttributes.
- nextPayPeriodStartDate
Template: DateTime. A read-only field.
- jobType
Template: Descriptor.
- jobProfile
Template: CommonAttributes.
- workerDetails
Template: Worker. A read-only field. The value is gathered from
/v1/workers/{{=item.worker.id}}address.- supervisoryOrganizationDetails
Template: SupervisoryManagedOrganization. A read-only field. The value is gathered from
/v1/supervisoryOrganizations/{{=item.supervisoryOrganization.id}}address.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/payGroups.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payGroups.
- [Read Single] action
-
Endpoint URL address:
/payGroups/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payGroups/-ID-.
The resource includes the fields from the CommonAttributes template.
- country
Template: SharedAttributes.
- payGroupDetails
Template: CompositeCommonAttribute. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: runCategory.
-
Uses template:
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/payGroupDetails.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payGroupDetails.
- [Read Single] action
-
Endpoint URL address:
/payGroupDetails/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payGroupDetails/-ID-.
The resource includes the fields from the CommonAttributes template.
- runCategory
Template: SharedAttributes.
- currentPeriodInProgress
Template: SharedAttributes.
- nextPeriodToProcess
Template: SharedAttributes.
- firstProcessingPeriod
Template: SharedAttributes.
- lastPeriodCompleted
Template: SharedAttributes.
- periodSchedule
Template: SharedAttributes.
- payRunGroup
Template: CompositeCommonAttribute.
- payGroup
Template: CommonAttributes.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/payrollInputs.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payGroupDetails.
- [Read Single] action
-
Endpoint URL address:
/payrollInputs/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/payrollInputs/-ID-.
- [Create] action
-
Endpoint URL address:
/payrollInputs.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/post-/payrollInputs.
- [Update] action
-
Endpoint URL address:
/payrollInputs/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/patch-/payrollInputs/-ID-.
- [Delete] action
-
Endpoint URL address:
/payrollInputs/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/delete-/payrollInputs/-ID-.
The resource includes the fields from the CommonAttributes template.
- runCategories
Template: CompositeCommonAttribute.
- payComponent
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: code.
-
Uses template:
- comment
Template: LongText.
- startDate
Template: DateTime.
- currency
Template: SharedAttributes.
- worktags
Template: WorkTag.
- inputDetails
Field components:
- An array.
- Contains the following components: type, value, id.
- ongoing
Data type: DT_BOOL
- position
Template: SharedAttributes.
- fieldEditability
Template: ShortText.
- endDate
Template: DateTime.
- worker
Template: CommonAttributes.
- adjustment
Data type: DT_BOOL
- workerDetails
Template: Worker. A read-only field. The value is gathered from
/v1/workers/{{=item.worker.id}}address.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/taxRates.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/taxRates.
- [Create] action
-
Endpoint URL address:
/taxRates/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/post-/taxRates.
- id
A key field. Template: ShortText.
- startDate
Template: Date.
- ein
Template: ShortText.
- endDate
Template: Date.
- exempt
Data type: DT_BOOL
- einType
Template: ShortText.
- rateType
Template: ShortText.
- taxCode
Template: ShortText.
- applicableRate
Data type: DT_R8
- stateInstance
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: payrollStateAuthorityTaxCode.
-
Uses template:
- companyInstance
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: company, fein.
-
Uses template:
Based on resource template VersionTwoPagination.
- [Read payComponents] action
-
Endpoint URL address:
/values/payrollInputsGroup/payComponents/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/payrollInputsGroup/payComponents/.
- [Read positions] action
-
Endpoint URL address:
/values/payrollInputsGroup/positions/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/payrollInputsGroup/positions/.
- [Read runCategories] action
-
Endpoint URL address:
/values/payrollInputsGroup/runCategories/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/payrollInputsGroup/runCategories/.
- [Read worktags] action
-
Endpoint URL address:
/values/payrollInputsGroup/worktags/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/payrollInputsGroup/worktags/.
- [Read companyInstances] action
-
Endpoint URL address:
/values/taxRatesGroup/companyInstances/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/taxRatesGroup/companyInstances/.
- [Read stateInstances] action
-
Endpoint URL address:
/values/taxRatesGroup/stateInstances/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#payroll/v2/get-/values/taxRatesGroup/stateInstances/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/feedbackBadges.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/feedbackBadges.
- [Read Single] action
-
Endpoint URL address:
/feedbackBadges/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/feedbackBadges/-ID-.
- feedbackBadgeIcon
Template: SharedAttributes.
- workdayID
Template: ShortText.
- feedbackBadgeID
Template: ShortText.
- name
Template: ShortText.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/giveRequestedFeedbackEvents.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/giveRequestedFeedbackEvents.
- [Read Single] action
-
Endpoint URL address:
/giveRequestedFeedbackEvents/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/giveRequestedFeedbackEvents/-ID-.
- [Update] action
-
Endpoint URL address:
/giveRequestedFeedbackEvents/{{=item.id}}.
The action uses PATCH method.
The resource includes the fields from the CommonAttributes template.
- dueDate
Template: DateTime.
- feedbackGivenDate
Template: DateTime.
- requestedBy
Template: SharedAttributes.
- feedbackCreationDate
Template: DateTime. A read-only field.
- expirationDate
Template: DateTime. A read-only field.
- aboutWorker
Template: SharedAttributes.
- feedbackComments
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: feedbackDeclined, possibleMultipleChoiceAnswers, feedbackDeclineReason, questionType, multipleChoiceAnswers, numericAnswer, dateAnswer, response, relatesTo, feedbackQuestion.
- displayNameofResponder
Data type: DT_BOOL
- businessProcessParameters
Template: BusinessProcessParameter.
- feedbackPrivate
Data type: DT_BOOL
- feedbackConfidential
Data type: DT_BOOL
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/workers/-ID-.
The resource includes the fields from the CommonAttributes template.
- primaryJob
Template: PrimaryJob.
- person
Template: Person.
- workerId
Template: ShortText.
- workerType
Template: SharedAttributes.
- additionalJobs
Field components:
- An array.
-
Uses template:
AdditionalJob.
- goals
The gathered value is processed with
{{=connection.resourceManager['Worker | Goal'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
Goal.
- requestedFeedbackOnSelfEvents
The gathered value is processed with
{{=connection.resourceManager['Worker | Req Feedback SelfEvent'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
FeedbackEvent.
- requestedFeedbackOnWorkerEvents
The gathered value is processed with
{{=connection.resourceManager['Worker | Req Feedback WorkerEvent'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
FeedbackEvent.
- anytimeFeedbackEvents
The gathered value is processed with
{{=connection.resourceManager['Worker | AnytimeFeedback Event'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
FeedbackEvent.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/anytimeFeedbackEvents.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/anytimeFeedbackEvents/{{=parameters.anytimeFeedbackEventId}}.The action has the following user-defined parameters:
- anytimeFeedbackEventId: Required. Specify the anytime feedback event identifier.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/anytimeFeedbackEvents.
The resource includes the fields from the SharedAttributes template.
- toWorker
Template: SharedAttributes.
- workersToNotify
Template: CompositeCommonAttribute.
- relatesTo
Template: CommonAttributes.
- businessProcessParameters
Template: BusinessProcessParameter.
- feedbackAlsoAbout
Template: CompositeCommonAttribute.
- hiddenFromWorker
Data type: DT_BOOL
- hiddenFromManager
Data type: DT_BOOL
- comment
Template: ShortText.
- fromWorker
Template: SharedAttributes.
- badge
Template: SharedAttributes.
- relatedFeedbackEvents
Field components:
- An array.
-
Uses template:
CommonAttributes.
- feedbackGivenDate
Template: DateTime. A read-only field.
- showFeedbackProviderName
Data type: DT_BOOL
- workerId
A key field. Template: ShortText.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/goals.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/workers/-ID-/goals.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/goals/{{=parameters.goalId}}.The action has the following user-defined parameters:
- goalId: Required. Specify the goal identifier.
The resource includes the fields from the Goal template.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/requestedFeedbackOnSelfEvents.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/requestedFeedbackOnSelfEvents/{{=parameters.requestedFeedbackOnSelfEventId}}.The action has the following user-defined parameters:
- requestedFeedbackOnSelfEventId: Required. Specify the requested Feedback On SelfEvent identifier.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/requestedFeedbackOnSelfEvents.
The resource includes the fields from the FeedbackEvent template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionFive.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/requestedFeedbackOnWorkerEvents.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/requestedFeedbackOnWorkerEvents/{{=parameters.requestedFeedbackOnWorkerEventId}}.The action has the following user-defined parameters:
- requestedFeedbackOnWorkerEventId: Required. Specify the requested Feedback On WorkerEvent identifier.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/requestedFeedbackOnWorkerEvents.
The resource includes the fields from the FeedbackEvent template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionFive.
- [Read feedbackOnWorker] action
-
Endpoint URL address:
/values/feedbackOnWorker/feedbackOnWorker/.
- [Read feedbackResponder] action
-
Endpoint URL address:
/values/feedbackResponder/feedbackResponder/.
- [Read feedbackTemplate] action
-
Endpoint URL address:
/values/feedbackTemplate/feedbackTemplate/.
- [Read relatesTo] action
-
Endpoint URL address:
/values/relatesTo/relatesTo/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#performanceEnablement/v5/get-/values/relatesTo/relatesTo/.
- [Read workersToNotify] action
-
Endpoint URL address:
/values/workersToNotify/workersToNotify/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/countries.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/countries.
- [Read Single] action
-
Endpoint URL address:
/countries/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/countries/-ID-.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionFour.
- [Read address] action
-
Endpoint URL address:
/countries/{{=parameters.countryId}}/addressComponents.The action has the following user-defined parameters:
- countryId: Required. Specify the country identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/countries/-ID-/addressComponents.
- [Read name] action
-
Endpoint URL address:
/countries/{{=parameters.countryId}}/nameComponents.The action has the following user-defined parameters:
- countryId: Required. Specify the country identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/countries/-ID-/nameComponents.
- type
Template: ShortText.
- order
Template: ShortText.
- label
Template: ShortText.
- componentType
Template: SharedAttributes.
- webServiceAlias
Template: ShortText.
- required
Data type: DT_BOOL
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-.
- id
A key field. Template: ShortText.
- photos
Template: ShortText.
- homeEmails
Template: ShortText.
- personalInformation
Template: ShortText.
- homeWebAddresses
Template: ShortText.
- universal_ID
Template: Identifier.
- workInstantMessengers
Template: ShortText.
- homePhones
Template: ShortText.
- preferredName
Template: ShortText.
- workEmails
Template: ShortText.
- workAddresses
Template: ShortText.
- workWebAddresses
Template: ShortText.
- homeAddresses
Template: ShortText.
- audioNamePronunciation
Template: ShortText.
- legalName
Template: ShortText.
- socialNetworks
Template: ShortText.
- workPhones
Template: ShortText.
- additionalNames
Template: ShortText.
- homeInstantMessengers
Template: ShortText.
- href
Template: ShortText.
- additionalName
The gathered value is processed with
{{=connection.resourceManager['People | Additional Name'].getData({ batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
AdditionalName.
- legalNames
The gathered value is processed with
{{=connection.resourceManager['People | Legal Name'].getData({ batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
LegalName.
- photo
The gathered value is processed with
{{=connection.resourceManager['People | Photo'].getData({ batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Photo.
- preferredNames
The gathered value is processed with
{{=connection.resourceManager['People | Preferred Name'].getData({ batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PreferredName.
- workAddress
The gathered value is processed with
{{=connection.resourceManager['People | Address'].getData({ endpoint: 'listWorkAdresses', batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PeopleAddress.
- homeAddress
The gathered value is processed with
{{=connection.resourceManager['People | Address'].getData({ endpoint: 'listHomeAdresses', batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PeopleAddress.
- homeEmail
The gathered value is processed with
{{=connection.resourceManager['People | Email'].getData({ endpoint: 'listHomeEmails', batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PeopleAddress.
- workEmail
The gathered value is processed with
{{=connection.resourceManager['People | Email'].getData({ endpoint: 'listWorkEmails', batchSize: 100, parameters: ['peopleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
PeopleAddress.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/additionalNames.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/additionalNames.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/additionalNames/{{=Workday.UI.AdditNameEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- additionalNameId: Required. Specify the additional name identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/additionalNames/-subresourceID-.
The resource includes the fields from the AdditionalName template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/audioNamePronunciation.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/audioNamePronunciation.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/audioNamePronunciation/{{=parameters.audioNamePronunciationId}}.The action has the following user-defined parameters:
- audioNamePronunciationId: Required. Specify the audio name pronounciation identifier.
- filename
Template: ShortText.
- person_id
Template: ShortText.
- media_id
Template: ShortText.
- download_audio
Template: ShortText.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/legalName.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/legalName.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/legalName/{{=Workday.UI.LegalNameEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- legalNameId: Required. Specify the home legal name identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/legalName/-subresourceID-.
The resource includes the fields from the LegalName template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/personalInformation.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/personalInformation.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/personalInformation/{{=parameters.personalInformationId}}.The action has the following user-defined parameters:
- personalInformationId: Required. Specify the personal information identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/personalInformation/-subresourceID-.
- militaryServices
Field components:
- An array.
- Contains the following components: militaryDischargeTypeReference, notes, discharge, rank, militaryServiceReference, status, begin, type, descriptor.
- additionalNationalities
Template: CompositeCommonAttribute.
- maritalStatus
Field components:
-
Uses template:
Date. - Contains the following components: date, status.
-
Uses template:
- medicalExam
Field components:
-
Uses template:
DateTime. - Contains the following components: lastExamDate, notes, expirationDate.
-
Uses template:
- relativeNames
Field components:
- An array.
- Contains the following components: middleName, royalSuffix, religiousSuffix, localPersonName, lastName, firstName, honorarySuffix, country, secondaryLastName, salutationSuffix, relativeType, socialSuffix, professionalSuffix, fullName, academicSuffix, title, hereditarySuffix, descriptor.
- uniformServiceReserveStatus
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: uniformServiceReserveStatusDescription, uniformServiceReserveStatusName, uniformServiceReserveStatusCode, inactive.
-
Uses template:
- activeMilitaryUniformedService
Template: CommonAttributes.
- disabledVeteranLeaveDate
Template: Date.
- hispanicOrLatino
Data type: DT_BOOL
- politicalAffiliation
Template: Descriptor.
- dateOfDeath
Template: Date.
- disabilityStatuses
Field components:
- An array.
- Contains the following components: disability, certificationBasis, certificationID, grade, rehabilitationProvided, workRestrictions, accommodationRequested, certifiedBy, statusDate, degreePercent, knownDate, accommodationProvided, endDate, certifiedAt, severityRecognitionDate, workerDocuments, remainingCapacity, note, statusID, fteTowardQuota, rehabilitationRequested, descriptor.
- religion
Field components:
- An array.
-
Uses template:
Descriptor.
- aboriginalIndigenousIdentification
Template: Descriptor.
- aboriginalIndigenousIdentificationDetails
Field components:
- An array.
-
Uses template:
Descriptor.
- socialBenefitsLocality
Field components:
-
Uses template:
Descriptor. - Contains the following components: location, name, code, description, inactive, descriptor.
-
Uses template:
- primaryNationality
Template: CommonAttributes.
- veteransPreferenceForRIF
Template: CommonAttributes.
- gender
Template: Descriptor.
- selectiveServiceRegistration
Template: CommonAttributes.
- dateOfBirth
Template: Date.
- veteransPreference
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: militaryServicePreferenceName, militaryServicePreferenceCode, inactive, militaryServicePreferenceDescription.
- ethnicities
Field components:
- An array.
- Contains the following components: location, descriptor.
- placeOfBirth
Field components:
-
Uses template:
ShortText. - Contains the following components: city, country, region.
-
Uses template:
- sexualOrientationAndGenderIdentity
Field components:
- An array.
-
Uses template:
Descriptor.
- ethnicitiesForVisualSurvey
Field components:
- Contains the following components: hispanicOrLatinoForVisualSurvey, ethnicities.
- citizenshipStatuses
Field components:
- An array.
- Contains the following components: citizen, description, inactive, country, name, descriptor.
- bloodType
Template: Descriptor.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/photos.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/photos.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/photos/{{=Workday.UI.PhotoEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- photoId: Required. Specify the photo identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/photos/-subresourceID-.
The resource includes the fields from the Photo template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/preferredName.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/preferredName.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/preferredName/{{=Workday.UI.PreferredNameEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- preferredNameId: Required. Specify the preferred name identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/preferredName/-subresourceID-.
The resource includes the fields from the PreferredName template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/publicContactInformation.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/publicContactInformation.
- [Read Single] action
-
Endpoint URL address:
/people/{{=parameters.id}}/publicContactInformation/{{=Workday.UI.PublicContactEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- publicContactInformationId: Required. Specify the public contact info identifier.
- instantMessengers
Field components:
- An array.
-
Uses template:
PeopleInstantMessenger.
- phoneNumbers
Field components:
- An array.
-
Uses template:
PeoplePhone.
- addresses
Field components:
- An array.
-
Uses template:
PeopleAddress.
- webAddresses
Field components:
- An array.
-
Uses template:
WebAddress.
- emails
Field components:
- An array.
-
Uses template:
PeopleEmail.
Based on resource template VersionFour.
- [Read work] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workAddresses.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workAddresses.
- [Read home] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeAddresses.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeAddresses.
- [Read singleHome] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeAddresses/{{=parameters.Workday.UI.HomeAddressEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- homeAddressId: Required. Specify the home address identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeAddresses/-subresourceID-.
- [Read singleWork] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workAddresses/{{=parameters.Workday.UI.WorkAddressEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- workAddressId: Required. Specify the work address identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workAddresses/-subresourceID-.
The resource includes the fields from the PeopleAddress template.
Based on resource template VersionFour.
- [Read work] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workEmails.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workEmails.
- [Read home] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeEmails.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeEmails.
- [Read singleWork] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workEmails/{{=Workday.UI.WorkEmailEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- workEmailId: Required. Specify the work email identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workEmails/-subresourceID-.
- [Read singleHome] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeEmails/{{=Workday.UI.HomeEmailEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- homeEmailId: Required. Specify the home email identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeEmails/-subresourceID-.
The resource includes the fields from the PeopleEmail template.
Based on resource template VersionFour.
- [Read home] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeWebAddresses.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeWebAddresses.
- [Read work] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workWebAddresses.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workWebAddresses.
- [Read singleHome] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeWebAddresses/{{=orkday.UI.HomeWebAddressEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- homeWebAddresseId: Required. Specify the home web address identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeWebAddresses/-subresourceID-.
- [Read singleWork] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workWebAddresses/{{=Workday.UI.WorkWebAddressEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- workWebAddressId: Required. Specify the work web address identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workWebAddresses/-subresourceID-.
The resource includes the fields from the WebAddress template.
Based on resource template VersionFour.
- [Read home] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homePhones.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homePhones.
- [Read work] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workPhones.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workPhones.
- [Read singleHome] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homePhones/{{=Workday.UI.HomePhoneEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- homePhoneId: Required. Specify the home phone identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homePhones/-subresourceID-.
- [Read singleWork] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workPhones/{{=Workday.UI.WorkPhoneEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- workPhoneId: Required. Specify the work phone identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workPhones/-subresourceID-.
The resource includes the fields from the PeoplePhone template.
Based on resource template VersionFour.
- [Read home] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeInstantMessengers.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/homeInstantMessengers.
- [Read work] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workInstantMessengers.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/people/-ID-/workInstantMessengers.
- [Read singleHome] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/homeInstantMessengers/{{=Workday.UI.HomeIMessengerEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- homeInstantMessengerId: Required. Specify the home instant messenger identifier.
- [Read singleWork] action
-
Endpoint URL address:
/people/{{=Workday.UI.PeopleEditor.getValue(parameters)}}/workInstantMessengers/{{=Workday.UI.WorkIMessengerEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- peopleId: Required. Specify the people identifier.
- workInstantMessengerId: Required. Specify the work instant messenger identifier.
The resource includes the fields from the PeopleInstantMessenger template.
Based on resource template VersionFour.
- [Read countryPhoneCodes] action
-
Endpoint URL address:
/values/commonPhone/countryPhoneCodes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/commonPhone/countryPhoneCodes/.
- [Read phoneDeviceTypes] action
-
Endpoint URL address:
/values/commonPhone/phoneDeviceTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/commonPhone/phoneDeviceTypes/.
- [Read country] action
-
Endpoint URL address:
/values/countryComponents/country/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/countryComponents/country/.
- [Read countryCity] action
-
Endpoint URL address:
/values/countryComponents/countryCity/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/countryComponents/countryCity/.
- [Read countryRegion] action
-
Endpoint URL address:
/values/workersToNotify/countryRegion/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/countryComponents/countryRegion/.
- [Read academic] action
-
Endpoint URL address:
/values/countryComponents/academic/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/academic/.
- [Read hereditary] action
-
Endpoint URL address:
/values/countryComponents/hereditary/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/hereditary/.
- [Read honorary] action
-
Endpoint URL address:
/values/workersToNotify/honorary/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/honorary/.
- [Read professional] action
-
Endpoint URL address:
/values/workersToNotify/professional/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/professional/.
- [Read religious] action
-
Endpoint URL address:
/values/countryComponents/religious/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/religious/.
- [Read royal] action
-
Endpoint URL address:
/values/countryComponents/royal/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/royal/.
- [Read salutation] action
-
Endpoint URL address:
/values/workersToNotify/salutation/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/salutation/.
- [Read social] action
-
Endpoint URL address:
/values/countryComponents/social/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/social/.
- [Read title] action
-
Endpoint URL address:
/values/workersToNotify/title/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#person/v4/get-/values/nameComponents/title/.
- [Read allowedCountry] action
-
Endpoint URL address:
/values/personalInformationCountry/allowedCountry/.
- [Read populatedCountry] action
-
Endpoint URL address:
/values/personalInformationCountry/populatedCountry/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/tables.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables.
- [Read Single] action
-
Endpoint URL address:
/tables/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/tables/-id-.
- [Create] action
-
Endpoint URL address:
/tables.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/tables.
- [Update] action
-
Endpoint URL address:
/tables/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/put-/tables/-id-.
- id
A key field. Template: ShortText.
- displayName
Template: ShortText.
- description
Template: ShortText.
- documentation
Template: ShortText.
- enableForAnalysis
Data type: DT_BOOL
- name
Template: ShortText.
- tags
Field components:
- An array.
-
Uses template:
TableType.
- fields
Field components:
- An array.
-
Uses template:
TBField.
- empty
Data type: DT_BOOL
- published
Data type: DT_BOOL
- stats
Field components:
-
Uses template:
ShortText. - Contains the following components: rows, size.
-
Uses template:
- createdBy
Template: TableCreatdBY.
- createdMoment
Template: DateTime. A read-only field.
- updatedBy
Template: TableCreatdBY.
- updatedMoment
Template: DateTime.
- dateRefreshed
Template: DateTime.
- tablePermissions
Field components:
- Contains the following components: canView, canEdit, canDelete, canShare, canPublish, canAppendTableData, canReplaceTableData, canTruncateTableData, canDeleteTableData, canEditDataSourceSecurity, selectTableData.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/buckets.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/buckets.
- [Read Single] action
-
Endpoint URL address:
/buckets/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/buckets/-id-.
- [Create] action
-
Endpoint URL address:
/buckets.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/buckets.
- [Update] action
-
Endpoint URL address:
/buckets/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/put-/buckets/-id-.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- displayName
Template: ShortText.
- description
Template: ShortText.
- documentation
Template: ShortText.
- state
Template: CommonAttributes.
- operation
Template: CommonAttributes.
- schema
Template: Schema.
- targetDataset
Template: CommonAttributes.
- message
Template: ShortText.
- stats
Template: Stats.
- files
Template: CompositeCommonAttribute.
- createdBy
Template: TableCreatdBY.
- createdMoment
Template: DateTime. A read-only field.
- updatedBy
Template: TableCreatdBY.
- updatedMoment
Template: ShortText.
- errorFile
Data type: DT_IMAGE The value is gathered from
/v3/buckets/{{=item.id}}/errorFileaddress.- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: complete.
-
Uses template:
Based on resource template VersionThreePagination.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.id}}/files.The following request parameters will be automatically processed:
-
uploadFile:
{{=item.content}}
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/buckets.
-
uploadFile:
- id
A key field. Template: ShortText.
- fileName
Template: ShortText.
- content
Data type: DT_IMAGE
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/dataChanges.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/dataChanges.
- [Read Single] action
-
Endpoint URL address:
/dataChanges/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/dataChanges/-dataChangeID-.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- displayName
Template: ShortText.
- source
Field components:
-
Uses template:
ShortText. - Contains the following components: sourceType, id, name, parms, schema.
-
Uses template:
- target
Template: TableType.
- createdBy
Template: TableCreatdBY.
- createdMoment
Template: DateTime. A read-only field.
- modifiedBy
Template: TableCreatdBY.
- modifiedMoment
Template: DateTime. A read-only field.
- operation
Field components:
-
Uses template:
ShortText. - Contains the following components: operationType, operationKeys.
-
Uses template:
- mappings
Field components:
- An array.
- Contains the following components: sourceFieldName, targetFieldName.
- errorMessage
Template: LongText.
- updatedBy
Template: TableCreatdBY.
- updatedMoment
Template: DateTime. A read-only field.
- validate
Template: CommonAttributes. A read-only field. The value is gathered from
/v3/dataChanges/{{=item.id}}/validateaddress.
Based on resource template VersionThreeNoPagination.
- [Read Single] action
-
Endpoint URL address:
/dataChanges/{{=parameters.id}}/activities/{{=parameters.activityId}}.The action has the following user-defined parameters:
- activityId: Required. Specify the activity identifier.
- [Create] action
-
Endpoint URL address:
/dataChanges/{{=item.dataChangeID}}/activities.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/dataChanges/-dataChangeID-/activities.
The resource includes the fields from the CommonAttributes template.
- dataChangeID
Template: ShortText.
- dataChangeName
Template: ShortText.
- dataChangeDisplayName
Template: ShortText.
- state
Template: CommonAttributes.
- operation
Template: CommonAttributes.
- stats
Template: Stats.
- message
Template: ShortText.
- errorCode
Template: ShortText.
- createdBy
Template: TableCreatdBY.
- startTime
Template: DateTime.
- endTime
Template: DateTime.
- target
Template: CommonAttributes.
- source
Template: CommonAttributes.
- fileContainer
Template: CommonAttributes.
- fileContainerWid
Template: ShortText.
- exceptions
Field components:
- An array.
- Contains the following components: exceptionTarget, exceptionType, invalidRowCount.
Based on resource template VersionThreeNoPagination.
- [Read] action
-
Endpoint URL address:
/fileContainers/{{=parameters.fileContainerId}}/files.The action has the following user-defined parameters:
- fileContainerId: Required. Specify the file container identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/get-/fileContainers/-fileContainerID-/files.
- [Create] action
-
Endpoint URL address:
/buckets/{{=item.fileContainerId}}/files.The following request parameters will be automatically processed:
-
File:
{{=item.content}}
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#prismAnalytics/v3/post-/buckets.
-
File:
The resource includes the fields from the CommonAttributes template.
- name
Template: ShortText.
- checksum
Template: ShortText.
- length
Template: ShortText.
- state
Template: Identifier.
- allowedFileSize
Template: ShortText.
- content
Data type: DT_IMAGE
- fileContainerId
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/activityLogging.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#privacy/v1/get-/activityLogging.
- systemAccount
Template: ShortText.
- activityAction
Template: ShortText.
- requestTime
Template: ShortText.
- userAgent
Template: ShortText.
- taskId
Template: ShortText.
- deviceType
Template: ShortText.
- ipAddress
Template: ShortText.
- userActivityEntryCount
Template: ShortText.
- sessionId
Template: ShortText.
- target
Template: SharedAttributes.
- taskDisplayName
Template: ShortText.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/purchaseOrders.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/purchaseOrders.
- [Read Single] action
-
Endpoint URL address:
/purchaseOrders/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/purchaseOrders/-ID-.
The resource includes the fields from the CommonAttributes template.
- shippingTerms
Template: SharedAttributes.
- billToContact
Template: SharedAttributes.
- dueDate
Template: Date.
- goodsLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: prepaid, location, quantityInvoiced, deliveryType, spendCategory, leadTime, supplierItemIdentifier, taxApplicability, dueDate, taxRecoverability, shipToContact, memo, taxCode, deliverTo, quantityReceived, itemName, itemDescription, unitCost, extendedAmount, requestedAsNoCharge, splits, unitOfMeasure, worktags, quantityShipped, shipToAddress, quantityOrdered, retention.
- memo
Template: ShortText.
- paymentType
Template: SharedAttributes.
- submittedBy
Template: SharedAttributes.
- projectBasedServiceLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: extendedAmount, subtasks, prepaid, retention, amountReceived, memo, worktags, project, amountInvoiced, splits, spendCategory.
- shippingMethod
Template: SharedAttributes.
- taxCodes
Template: CompositeCommonAttribute.
- supplierContract
Template: SharedAttributes.
- taxAmount
Data type: DT_R8
- currency
Template: SharedAttributes.
- orderFromConnection
Template: SharedAttributes.
- otherCharges
Template: ShortText.
- supplier
Template: SharedAttributes.
- shipToAddress
Template: SharedAttributes.
- billToContactDetail
Template: ShortText.
- internalMemo
Template: LongText.
- buyer
Template: SharedAttributes.
- shippingInstructions
Template: ShortText.
- paymentTerms
Template: SharedAttributes.
- documentDate
Template: DateTime.
- company
Template: SharedAttributes.
- lineTotalAmount
Data type: DT_R8
- freightAmount
Data type: DT_R8
- excludeFromMassClose
Data type: DT_BOOL
- serviceLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: location, extendedAmount, deliverTo, spendCategory, amountReceived, shipToContact, startDate, amountInvoiced, endDate, retention, prepaid, itemDescription, worktags, splits, dueDate, memo, amountOrdered, taxApplicability, taxRecoverability, taxCode, itemName, shipToAddress.
- status
Template: SharedAttributes.
- shipToContactDetail
Template: ShortText.
- shipToContact
Template: SharedAttributes.
- billToAddress
Template: CompositeCommonAttribute.
- creditCard
Template: SharedAttributes.
- taxOption
Template: SharedAttributes.
- issueOption
Template: SharedAttributes.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/requisitionTemplates.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitionTemplates.
- [Read Single] action
-
Endpoint URL address:
/requisitionTemplates/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitionTemplates/-ID-.
The resource includes the fields from the CommonAttributes template.
- createdOnDate
Template: ShortText.
- serviceLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: spendCategory, worktags, itemDescription, extendedAmount, supplier, memo, itemName, shipToAddress, startDate, orderFromConnection, deliverTo, shipToContact, splits, fulfillmentSource, endDate.
- name
Template: ShortText.
- currency
Template: SharedAttributes.
- goodsLines
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: splits, shipToAddress, fulfillmentSource, supplierItemIdentifier, orderFromConnection, unitOfMeasure, shipToContact, memo, itemIdentifiers, itemName, itemDescription, worktags, supplier, deliverTo, itemTags, unitCost, spendCategory, quantity, extendedAmount.
- company
Template: SharedAttributes.
- owner
Template: SharedAttributes.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/requisitions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions.
- [Read Single] action
-
Endpoint URL address:
/requisitions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions/-ID-.
- [Create] action
-
Endpoint URL address:
/requisitions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/post-/requisitions.
- [Update] action
-
Endpoint URL address:
/requisitions/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/patch-/requisitions/-ID-.
The resource includes the fields from the SharedAttributes template.
- requisitionDate
Template: DateTime.
- procedureDate
Template: DateTime.
- company
Template: CommonAttributes.
- requester
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: image.
-
Uses template:
- supplierRepresentative
Template: ShortText.
- currency
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: currencySymbol.
-
Uses template:
- additionalInformation
Template: ShortText.
- amount
Data type: DT_R8
- verifiedBy
Template: ShortText.
- deliverToLocation
Template: CommonAttributes.
- reasonCode
Template: SharedAttributes.
- comments
Template: ShortText.
- medicalRecordNumber
Template: ShortText.
- parLocation
Template: SharedAttributes.
- formattedOtherCharges
Data type: R8
- inventorySite
Template: SharedAttributes.
- formattedFreight
Template: ShortText.
- formattedSubtotal
Template: ShortText.
- physicianId
Template: ShortText.
- procedureNumber
Template: ShortText.
- patientId
Template: ShortText.
- formattedAmount
Data type: DT_R8
- requisitionType
Template: CommonAttributes. Field components:
- Contains the following components: requisitionTypeDetails.
- warningCustomValidations
Template: ShortText.
- procedure
Template: ShortText.
- highPriority
Data type: DT_BOOL
- purchaseOrders
Template: PurchaseOrder.
- criticalCustomValidations
Template: ShortText.
- requestingEntity
Template: SharedAttributes.
- internalMemo
Template: ShortText.
- freightAmount
Data type: DT_R8
- requisitionLines
Field components:
- An array.
-
Uses template:
RequisitionLine.
- sourcingBuyer
Template: SharedAttributes.
- memo
Template: ShortText.
- formattedShippingAddress
Template: ShortText.
- otherCharges
Data type: R8
- deliverToLocationChain
Template: ShortText.
- worktags
Template: WorkTag.
- status
Template: SharedAttributes.
- shippingAddress
Template: SharedAttributes.
- externalSystemId
Template: SharedAttributes.
- submitter
Template: SharedAttributes.
- externalSourceableId
Template: ShortText.
- action
Field components:
-
Uses template:
ReuisitionCancelClose. - Contains the following components: cancel, close, submitRequisitionEvent.
-
Uses template:
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=parameters.requisitionId}}/attachments.The action has the following user-defined parameters:
- requisitionId: Required. Specify the requisition identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions/-ID-/attachments.
- [Read Single] action
-
Endpoint URL address:
/requisitions/{{=parameters.id}}/attachments/{{=parameters.attachmentId}}.The action has the following user-defined parameters:
- attachmentId: Required. Specify the attachment identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions/-ID-/attachments.
- [Create] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/attachments.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/post-/requisitions/-ID-/attachments.
- [Update] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/attachments/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/attachments/{{=item.id}}.
The resource includes the fields from the CommonAttributes template.
- external
Data type: DT_BOOL
- contentType
Template: SharedAttributes.
- attachmentCategory
Template: CommonAttributes.
- fileName
Template: ShortText.
- comment
Template: ShortText.
- fileLength
Data type: DT_I4
- requisitionId
A key field. Template: ShortText.
- content
Data type: DT_IMAGE The value is gathered from
/v4/requisitions/{{=parameters.requisitionId}}/attachments/{{=item.id}}address.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=parameters.requisitionId}}/relatedPurchaseOrders.The action has the following user-defined parameters:
- requisitionId: Required. Specify the requisition identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions/-ID-/relatedPurchaseOrders.
- [Read Single] action
-
Endpoint URL address:
/requisitions/{{=parameters.id}}/relatedPurchaseOrders/{{=parameters.relatedPurchaseOrderId}}.The action has the following user-defined parameters:
- relatedPurchaseOrderId: Required. Specify the related purchase order identifier.
The resource includes the fields from the PurchaseOrder template.
Based on resource template VersionFour.
- [Read] action
-
Endpoint URL address:
/requisitions/{{=parameters.requisitionId}}/requisitionLines.The action has the following user-defined parameters:
- requisitionId: Required. Specify the requisition identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/requisitions/-ID-/requisitionLines.
- [Read Single] action
-
Endpoint URL address:
/requisitions/{{=parameters.id}}/requisitionLines/{{=parameters.requisitionLineId}}.The action has the following user-defined parameters:
- requisitionLineId: Required. Specify the requisition line identifier.
- [Create] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/requisitionLines.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/post-/requisitions/-ID-/requisitionLines.
- [Update] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/requisitionLines/{{=item.id}}.
The action uses PATCH method.
- [Delete] action
-
Endpoint URL address:
/requisitions/{{=item.requisitionId}}/requisitionLines/{{=item.id}}.
The action uses PATCH method.
The resource includes the fields from the RequisitionLine template.
- requisitionId
A key field. Template: ShortText.
Based on resource template VersionFive.
- [Read commodityCodes] action
-
Endpoint URL address:
/values/requisitionsGroup/commodityCodes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/commodityCodes/.
- [Read companies] action
-
Endpoint URL address:
/values/requisitionsGroup/companies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/companies/.
- [Read deliverToLocation] action
-
Endpoint URL address:
/values/requisitionsGroup/deliverToLocation/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/currencies/.
- [Read inventorySite] action
-
Endpoint URL address:
/values/requisitionsGroup/inventorySite/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/inventorySite/.
- [Read lineCompany] action
-
Endpoint URL address:
/values/requisitionsGroup/lineCompany/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/lineCompany/.
- [Read orderFromConnection] action
-
Endpoint URL address:
/values/requisitionsGroup/orderFromConnection/.
- [Read parLocation] action
-
Endpoint URL address:
/values/requisitionsGroup/parLocation/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/parLocation/.
- [Read requesters] action
-
Endpoint URL address:
/values/requisitionsGroup/requesters/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/requesters/.
- [Read requestingEntity] action
-
Endpoint URL address:
/values/requisitionsGroup/requestingEntity/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/requestingEntity/.
- [Read requisitionTypes] action
-
Endpoint URL address:
/values/requisitionsGroup/requisitionTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/requisitionTypes/.
- [Read resolvedWorktags] action
-
Endpoint URL address:
/values/requisitionsGroup/resolvedWorktags/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/resolvedWorktags/.
- [Read resourceProvider] action
-
Endpoint URL address:
/values/requisitionsGroup/resourceProvider/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/resourceProvider/.
- [Read shipToAddress] action
-
Endpoint URL address:
/values/requisitionsGroup/shipToAddress/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/shipToAddress/.
- [Read sourcingBuyer] action
-
Endpoint URL address:
/values/requisitionsGroup/sourcingBuyer/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/sourcingBuyer/.
- [Read spendCategory] action
-
Endpoint URL address:
/values/requisitionsGroup/spendCategory/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/spendCategory/.
- [Read supplierContract] action
-
Endpoint URL address:
/values/requisitionsGroup/supplierContract/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/supplierContract/.
- [Read unitOfMeasure] action
-
Endpoint URL address:
/values/requisitionsGroup/unitOfMeasure/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/unitOfMeasure/.
- [Read worktags] action
-
Endpoint URL address:
/values/requisitionsGroup/worktags/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#procurement/v4/get-/values/requisitionsGroup/worktags/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/adHocProjectTimeTransactions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/adHocProjectTimeTransactions.
- [Read Single] action
-
Endpoint URL address:
/adHocProjectTimeTransactions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/adHocProjectTimeTransactions/-ID-.
- [Create] action
-
Endpoint URL address:
/adHocProjectTimeTransactions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/adHocProjectTimeTransactions.
The resource includes the fields from the SharedAttributes template.
- projectRole
Template: SharedAttributes.
- billingStatus
Template: SharedAttributes.
- includeCost
Data type: DT_BOOL
- project
Template: SharedAttributes.
- worker
Template: SharedAttributes.
- worktags
Template: WorkTag.
- memo
Template: LongText.
- standardCostRate
Data type: DT_R8
- rateToBill
Data type: DT_R8
- hours
Data type: DT_I4
- transactionDate
Template: DateTime.
- task
Template: SharedAttributes.
- projectDetails
Template: Project. A read-only field. The value is gathered from
/v1/projects/{{=item.project.id}}address.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/planPhases.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/planPhases.
- [Read Single] action
-
Endpoint URL address:
/planPhases/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/planPhases/-ID-.
- [Create] action
-
Endpoint URL address:
/planPhases.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/planPhases.
- [Update] action
-
Endpoint URL address:
/planPhases/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/patch-/planPhases/-ID-.
- [Delete] action
-
Endpoint URL address:
/planPhases/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/delete-/planPhases/-ID-.
The resource includes the fields from the CommonAttributes template.
- description
Template: ShortText.
- order
Template: ShortText.
- levelNumber
Data type: DT_I4
- phase
Template: SharedAttributes.
- hasChildren
Data type: DT_BOOL
- project
Template: SharedAttributes.
- childrenCount
Data type: DT_I4
- sequenceNumber
Template: ShortText.
- parentPhase
Template: SharedAttributes.
- deletable
Data type: DT_BOOL
- editable
Data type: DT_BOOL
- projectDetails
Template: Project. A read-only field. The value is gathered from
/v1/projects/{{=item.project.id}}address.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/planTasks.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/planTasks.
- [Read Single] action
-
Endpoint URL address:
/planTasks/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/planTasks/-ID-.
- [Create] action
-
Endpoint URL address:
/planTasks.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/planTasks.
- [Update] action
-
Endpoint URL address:
/planTasks/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/patch-/planTasks/-ID-.
- [Delete] action
-
Endpoint URL address:
/planTasks/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/delete-/planTasks/-ID-.
The resource includes the fields from the ProjectPlanTask template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/projects.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/projects.
- [Read Single] action
-
Endpoint URL address:
/projects/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/projects/-ID-.
- [Create] action
-
Endpoint URL address:
/projects.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/projects.
The resource includes the fields from the Project template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/resourceForecastLines.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/resourceForecastLines.
- [Read Single] action
-
Endpoint URL address:
/resourceForecastLines/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/resourceForecastLines/-ID-.
The resource includes the fields from the CommonAttributes template.
- projectResource
Template: SharedAttributes.
- resourcePlanLine
Template: SharedAttributes.
- projectRole
Template: SharedAttributes.
- projectPlanTask
Template: SharedAttributes.
- allocations
The gathered value is processed with
{{=connection.resourceManager['Resource Forecast Line | Allocation'].getData({ batchSize: 100, parameters: ['resourceForecastLineId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ForecastLineAllocation.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/resourceForecastLines/{{=parameters.resourceForecastLineId}}/allocations.The action has the following user-defined parameters:
- resourceForecastLineId: Required. Specify the resource forecast line identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/resourceForecastLines/-ID-/allocations.
- [Read Single] action
-
Endpoint URL address:
/resourceForecastLines/{{=parameters.id}}/allocations/{{=parameters.allocationId}}.
- [Create] action
-
Endpoint URL address:
/resourceForecastLines/{{=item.resourceForecastLineId}}/allocations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/resourceForecastLines/-ID-/allocations.
- [Update] action
-
Endpoint URL address:
/resourceForecastLines/{{=item.resourceForecastLineId}}/allocations/{{=item.allocationId}}.
The action uses PATCH method.
The resource includes the fields from the ForecastLineAllocation template.
- resourceForecastLineId
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/resourcePlanLines.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/resourcePlanLines.
- [Read Single] action
-
Endpoint URL address:
/resourcePlanLines/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/resourcePlanLines/-ID-.
- [Create] action
-
Endpoint URL address:
/resourcePlanLines.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/resourcePlanLines.
The resource includes the fields from the ProjectPlanLine template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/taskResources.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/taskResources.
- [Read Single] action
-
Endpoint URL address:
/taskResources/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/taskResources/-ID-.
- [Create] action
-
Endpoint URL address:
/taskResources.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/post-/taskResources.
- [Update] action
-
Endpoint URL address:
/taskResources/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/patch-/taskResources/-ID-.
- [Delete] action
-
Endpoint URL address:
/taskResources/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/delete-/taskResources/-ID-.
The resource includes the fields from the CommonAttributes template.
- projectPlanTask
Template: SharedAttributes.
- warningCustomValidations
Template: ShortText.
- allocation
Data type: DT_I4
- memo
Template: ShortText.
- projectPlanLine
Template: CommonAttributes. Field components:
- Contains the following components: associationResourcePlanDetail.
- estimatedHours
Data type: DT_I4
- projectResources
Template: ProjectResource.
- startDate
Template: DateTime.
- endDate
Template: DateTime.
- planTaskDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Plan Task'].getData({ batchSize: 100, parameters: ['planTaskId=' + item.projectPlanTask.id] })}}expression. Field components:- An array.
-
Uses template:
ProjectPlanTask.
- planLineDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Plan Task'].getData({ batchSize: 100, parameters: ['resourcePlanLineId=' + item.projectPlanLine.id] })}}expression. Field components:- An array.
-
Uses template:
ProjectPlanLine.
Based on resource template VersionOnePagination.
- [Read companies] action
-
Endpoint URL address:
/values/common/companies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/companies/.
- [Read currencies] action
-
Endpoint URL address:
/values/common/currencies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/currencies/.
- [Read customers] action
-
Endpoint URL address:
/values/common/customers/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/customers/.
- [Read groups] action
-
Endpoint URL address:
/values/common/groups/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/groups/.
- [Read hierarchies] action
-
Endpoint URL address:
/values/common/hierarchies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/hierarchies/.
- [Read importanceRatings] action
-
Endpoint URL address:
/values/common/importanceRatings/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/importanceRatings/.
- [Read optionalHierarchies] action
-
Endpoint URL address:
/values/common/optionalHierarchies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/optionalHierarchies/.
- [Read owners] action
-
Endpoint URL address:
/values/common/owners/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/owners/.
- [Read priorities] action
-
Endpoint URL address:
/values/common/priorities/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/priorities/.
- [Read projectDependencies] action
-
Endpoint URL address:
/values/common/projectDependencies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/projectDependencies/.
- [Read projects] action
-
Endpoint URL address:
/values/common/projects/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/projects/.
- [Read projectStates] action
-
Endpoint URL address:
/values/common/projectStates/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/projectStates/.
- [Read riskLevels] action
-
Endpoint URL address:
/values/common/riskLevels/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/riskLevels/.
- [Read statuses] action
-
Endpoint URL address:
/values/common/statuses/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/statuses/.
- [Read successRatings] action
-
Endpoint URL address:
/values/common/successRatings/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/successRatings/.
- [Read worktags] action
-
Endpoint URL address:
/values/common/worktags/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/worktags/.
- [Read worktagTypes] action
-
Endpoint URL address:
/values/common/worktagTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/common/worktagTypes/.
- [Read projectPhases] action
-
Endpoint URL address:
/values/projectPlan/projectPhases/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/projectPlan/projectPhases/.
- [Read projectPlanPhases] action
-
Endpoint URL address:
/values/projectPlan/projectPhases/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/projectPlan/projectPlanPhases/.
- [Read projectPlanProjectPhases] action
-
Endpoint URL address:
/values/projectPlan/projectPlanPhases/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/projectPlan/projectPhases/.
- [Read projectPlanTasks] action
-
Endpoint URL address:
/values/projectPlan/projectPlanTasks/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/projectPlan/projectPlanTasks/.
- [Read projectTasks] action
-
Endpoint URL address:
/values/projectPlan/projectTasks/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/projectPlan/projectTasks/.
- [Read bookingStatus] action
-
Endpoint URL address:
/values/resourcePlan/bookingStatus/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/bookingStatus/.
- [Read costRateCurrencies] action
-
Endpoint URL address:
/values/resourcePlan/costRateCurrencies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/costRateCurrencies/.
- [Read requirementCategories] action
-
Endpoint URL address:
/values/resourcePlan/requirementCategories/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/requirementCategories/.
- [Read requirements] action
-
Endpoint URL address:
/values/resourcePlan/requirements/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/requirements/.
- [Read resourceTypes] action
-
Endpoint URL address:
/values/resourcePlan/resourceTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/resourceTypes/.
- [Read roleCategories] action
-
Endpoint URL address:
/values/resourcePlan/roleCategories/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/roleCategories/.
- [Read roles] action
-
Endpoint URL address:
/values/resourcePlan/roles/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/roles/.
- [Read unnamedResources] action
-
Endpoint URL address:
/values/resourcePlan/unnamedResources/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/unnamedResources/.
- [Read workerGroups] action
-
Endpoint URL address:
/values/resourcePlan/workerGroups/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/workerGroups/.
- [Read workers] action
-
Endpoint URL address:
/values/resourcePlan/workers/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/values/resourcePlan/workers/.
- [Read workerToReplaceUnnamedResources] action
-
Endpoint URL address:
/values/resourcePlan/workerToReplaceUnnamedResources/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/interviews.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/interviews.
- [Read Single] action
-
Endpoint URL address:
/interviews/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#projects/v1/get-/taskResources/-ID-.
The resource includes the fields from the CommonAttributes template.
- interviewStatuses
Field components:
- An array.
-
Uses template:
SharedAttributes.
- hasCompetenciesQuestionnaires
Data type: DT_BOOL
- giveInterviewFeedbackLink
Template: ShortText.
- jobRequisition
Template: CommonAttributes. Field components:
-
Uses template:
CompositeCommonAttribute. - Contains the following components: primaryRecruiters, recruiters, hiringManager.
-
Uses template:
- workersPendingFeedback
Template: CompositeCommonAttribute.
- jobApplication
Template: CommonAttributes. Field components:
- Contains the following components: yearsInCurrentJob, totalYearsExperience, numberOfJobs.
- overallRating
Template: ShortText.
- overallComment
Template: LongText.
- interviewers
Template: CompositeCommonAttribute.
- feedback
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Interview | Feedback'].getData({ batchSize: 100, parameters: ['interviewId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ProjectPlanLine.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/interviews/{{=parameters.interviewId}}/feedback.The action has the following user-defined parameters:
- interviewId: Required. Specify the interview identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/interviews/-ID-/feedback.
- [Read Single] action
-
Endpoint URL address:
/interviews/{{=parameters.id}}/feedback/{{=parameters.feedbackId}}.The action has the following user-defined parameters:
- feedbackId: Required. Specify the feedback identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/interviews/-ID-/feedback.
- [Create] action
-
Endpoint URL address:
/interviews/{{=item.interviewId}}/feedback.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/interviews/-ID-/feedback.
The resource includes the fields from the CommonAttributes template.
- comment
Template: LongText.
- overallRating
Template: CommonAttributes.
- dateSubmitted
Template: DateTime.
- interviewId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/jobPostings.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/jobPostings.
- [Read Single] action
-
Endpoint URL address:
/jobPostings/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/jobPostings/-ID-.
- id
A key field. Template: ShortText.
- categories
Template: CompositeCommonAttribute.
- jobSite
Template: CommonAttributes.
- jobDescription
Template: ShortText.
- primaryLocation
Template: JobLocation.
- timeType
Template: CommonAttributes.
- jobType
Template: CommonAttributes.
- spotlightJob
Data type: DT_BOOL
- additionalLocations
Field components:
- An array.
-
Uses template:
JobLocation.
- company
Template: CommonAttributes.
- remoteType
Field components:
-
Uses template:
ShortText. - Contains the following components: name, id.
-
Uses template:
- endDate
Template: DateTime.
- url
Template: ShortText.
- startDate
Template: DateTime.
- title
Template: ShortText.
- questionnaire
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Job Posting | Questionnaire'].getData({ batchSize: 100, parameters: ['jobPostingId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
JPQuestionnaire.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/jobPostings/{{=Workday.UI.JobPostingEditor.getValue(parameters)}}/questionnaire.The action has the following user-defined parameters:
- jobPostingId: Required. Specify the job posting identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/jobPostings/-ID-/questionnaire.
- [Read Single] action
-
Endpoint URL address:
/jobPostings/{{=parameters.id}}/questionnaire/{{=Workday.UI.QuestionnaireEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- questionnaireId: Required. Specify the job questionnaire identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/jobPostings/-ID-/questionnaire.
The resource includes the fields from the JPQuestionnaire template.
Based on resource template VersionThreeNoPagination.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-.
- [Create] action
-
Endpoint URL address:
/prospects.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects.
The resource includes the fields from the SharedAttributes template.
- candidateTags
Template: CompositeCommonAttribute.
- candidatePools
Template: CompositeCommonAttribute.
- candidate
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: email, phone, name.
-
Uses template:
- contactConsent
Data type: DT_BOOL
- status
Template: SharedAttributes.
- type
Template: SharedAttributes.
- source
Template: SharedAttributes.
- level
Template: SharedAttributes.
- referredBy
Template: SharedAttributes.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}/educations.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/educations.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.id}}/educations/{{=parameters.educationId}}.The action has the following user-defined parameters:
- educationId: Required. Specify the education identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/educations/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/prospects/{{=item.prospectId}}/educations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects/-ID-/educations.
- id
A key field. Template: ShortText.
- schoolName
Template: ShortText.
- degree
Template: SharedAttributes.
- firstYearAttended
Template: ShortText.
- fieldOfStudy
Template: SharedAttributes.
- lastYearAttended
Template: ShortText.
- gradeAverage
Template: ShortText.
- prospectId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}/experiences.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/experiences.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.id}}/experiences/{{=parameters.experienceId}}.The action has the following user-defined parameters:
- experienceId: Required. Specify the experience identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/experiences/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/prospects/{{=item.prospectId}}/experiences.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects/-ID-/experiences.
- id
A key field. Template: ShortText.
- companyName
Template: ShortText.
- location
Template: ShortText.
- description
Template: LongText.
- startYear
Template: DateTime.
- currentlyWorkHere
Data type: DT_BOOL
- title
Template: ShortText.
- startMonth
Data type: DT_I4
- endYear
Template: DateTime.
- endMonth
Data type: DT_I4
- prospectId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}/languages.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/languages.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.id}}/languages/{{=parameters.languageId}}.The action has the following user-defined parameters:
- languageId: Required. Specify the language identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/languages/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/prospects/{{=item.prospectId}}/languages.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects/-ID-/languages.
- id
A key field. Template: ShortText.
- language
Template: SharedAttributes.
- abilities
Field components:
- An array.
- Contains the following components: proficiency, abilityType, id.
- native
Data type: DT_BOOL
- prospectId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}/resumeAttachments.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/resumeAttachments.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.id}}/resumeAttachments/{{=parameters.resumeAttachmentId}}.The action has the following user-defined parameters:
- resumeAttachmentId: Required. Specify the resume attachment identifier.
- [Create] action
-
Endpoint URL address:
/prospects/{{=item.prospectId}}/resumeAttachments.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects/-ID-/resumeAttachments.
- id
A key field. Template: ShortText.
- fileName
Template: ShortText.
- fileExtension
Template: ShortText.
- fileLength
Data type: DT_I4
- contentType
Template: SharedAttributes.
- prospectId
A key field. Template: ShortText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/prospects/{{=parameters.prospectId}}/skills.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/skills.
- [Read Single] action
-
Endpoint URL address:
/prospects/{{=parameters.id}}/skills/{{=parameters.skillId}}.The action has the following user-defined parameters:
- skillId: Required. Specify the skill identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/prospects/-ID-/skills/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/prospects/{{=item.prospectId}}/skills.The action has the following user-defined parameters:
- prospectId: Required. Specify the prospect identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/post-/prospects/-ID-/skills.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- prospectId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read countries] action
-
Endpoint URL address:
/values/common/countries/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#recruiting/v3/get-/values/common/countries/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/billableTransactions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#revenue/v1/get-/billableTransactions.
- [Read Single] action
-
Endpoint URL address:
/billableTransactions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#revenue/v1/get-/billableTransactions/-ID-.
- [Update] action
-
Endpoint URL address:
/billableTransactions/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#revenue/v1/patch-/billableTransactions/-ID-.
The resource includes the fields from the SharedAttributes template.
- previouslyInvoiced
Data type: DT_BOOL
- memo
Template: LongText.
- invoiceDescription
Template: LongText.
- adjustmentCount
Data type: DT_I4
- hoursToBill
Data type: DT_I4
- zeroAmountToBill
Data type: DT_BOOL
- billableRate
Data type: DT_R8
- billingStatus
Template: SharedAttributes.
- revenueStatus
Template: SharedAttributes.
- reasonForChange
Template: ShortText.
- rateToBill
Data type: DT_R8
- category
Template: SharedAttributes.
- customer
Template: SharedAttributes.
- billableAmount
Data type: DT_R8
- expenseDescriptor
Template: SharedAttributes.
- project
Template: SharedAttributes.
- transactionDate
Template: DateTime.
- amountToBill
Data type: DT_R8
- transactionSource
Template: SharedAttributes.
- resourceProvider
Template: SharedAttributes.
- billableHours
Data type: DT_I4
- projectRole
Template: SharedAttributes.
- adjustmentReason
Template: SharedAttributes.
- worker
Template: SharedAttributes.
- projectTask
Template: SharedAttributes.
- billingRateApplications
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Billing Rate Application'].getData({ batchSize: 100, parameters: ['billableTransactionId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
BillableRateApplication.
- workerDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Common | Worker'].getData({ batchSize: 100, parameters: ['workerId=' + item.worker.id] })}}expression. Field components:- An array.
-
Uses template:
Worker.
- projectDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Project'].getData({ batchSize: 100, parameters: ['projectId=' + item.project.id] })}}expression. Field components:- An array.
-
Uses template:
Project.
- customerDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Customer Account | Customer'].getData({ batchSize: 100, parameters: ['customerId=' + item.customer.id] })}}expression. Field components:- An array.
- Contains the following components: id, creditLimit, name, paymentTerms, satisfactionScore, compositeRiskScore, groups, commercialCreditScore, primaryPhone, totalBalance, category.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/billableTransactions/{{=parameters.billableTransactionId}}/billingRateApplication.The action has the following user-defined parameters:
- billableTransactionId: Required. Specify the billable transaction identifier.
- [Read Single] action
-
Endpoint URL address:
/billableTransactions/{{=parameters.id}}/billingRateApplication/{{=parameters.billingRateApplicationId}}.The action has the following user-defined parameters:
- billingRateApplicationId: Required. Specify the billing rate application identifier.
The resource includes the fields from the BillableRateApplication template.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/jobs.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/jobs.
- [Read Single] action
-
Endpoint URL address:
/jobs/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/jobs/-ID-.
The resource includes the fields from the CommonAttributes template.
- location
Template: CommonAttributes. Field components:
-
Uses template:
Descriptor. - Contains the following components: country.
-
Uses template:
- businessTitle
Template: ShortText.
- worker
Template: CommonAttributes.
- supervisoryOrganization
Template: CommonAttributes.
- nextPayPeriodStartDate
Template: Date.
- jobType
Template: Descriptor.
- jobProfile
Template: CommonAttributes.
- workspaces
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Job | Workspace'].getData({ batchSize: 100, parameters: ['jobId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
CommonAttributes.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/jobs/{{=parameters.jobId}}/workspace.The action has the following user-defined parameters:
- jobId: Required. Specify the job identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/jobs/-ID-/workspace.
- [Read Single] action
-
Endpoint URL address:
/jobs/{{=parameters.id}}/workspace/{{=parameters.workspaceId}}.The action has the following user-defined parameters:
- workspaceId: Required. Specify the workspace identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/jobs/-ID-/workspace.
The resource includes the fields from the CommonAttributes template.
- locationChain
Template: ShortText.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/supervisoryOrganizations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/supervisoryOrganizations.
- [Read Single] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/supervisoryOrganizations/-ID-.
The resource includes the fields from the CommonAttributes template.
- name
Template: ShortText.
- managers
Template: CompositeCommonAttribute.
- inactive
Data type: DT_BOOL
- code
Template: ShortText.
- members
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Supervisory Organization | Member'].getData({ batchSize: 100, parameters: ['supervisoryOrganizationId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
SupervisoryOrgMember.
- orgCharts
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Supervisory Organization | Org Chart'].getData({ batchSize: 100, parameters: ['supervisoryOrganizationId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
SupervisoryOrgChart.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.supervisoryOrganizationId}}/members.The action has the following user-defined parameters:
- supervisoryOrganizationId: Required. Specify the supervisory organization identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/supervisoryOrganizations/-ID-/members.
- [Read Single] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.id}}/members/{{=parameters.memberId}}.The action has the following user-defined parameters:
- memberId: Required. Specify the member identifier.
The resource includes the fields from the SupervisoryOrgMember template.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.supervisoryOrganizationId}}/orgChart.The action has the following user-defined parameters:
- supervisoryOrganizationId: Required. Specify the supervisory organization identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/supervisoryOrganizations/-ID-/orgChart.
- [Read Single] action
-
Endpoint URL address:
/supervisoryOrganizations/{{=parameters.id}}/orgChart/{{=parameters.orgChartId}}.The action has the following user-defined parameters:
- orgChartId: Required. Specify the org chart identifier.
The resource includes the fields from the SupervisoryOrgChart template.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-.
The resource includes the fields from the Worker template.
- checkIns
The gathered value is processed with
{{=connection.resourceManager['Worker | CheckIn'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
WorkerCheckIn.
- checkInTopics
The gathered value is processed with
{{=connection.resourceManager['Worker | CheckIn Topic'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
WorkerCheckInTopic.
- explicitSkills
The gathered value is processed with
{{=connection.resourceManager['Worker | Explicit Skill'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
WorkerExplicitSkill.
- externalSkillLevel
The gathered value is processed with
{{=connection.resourceManager['Worker | External Skill Level'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
WorkerExternalSkillLevel.
- serviceDates
The gathered value is processed with
{{=connection.resourceManager['Worker | Service Date'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
- Contains the following components: hireDate, continuousServiceDate.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/checkIns.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/checkIns.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/checkIns/{{=parameters.checkInId}}.The action has the following user-defined parameters:
- checkInId: Required. Specify the checkIn identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/checkIns.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkIns.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/post-/workers/-ID-/checkIns.
- [Update] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkIns/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/patch-/workers/-ID-/checkIns/-subresourceID-.
- [Delete] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkIns/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/delete-/workers/-ID-/checkIns/-subresourceID-.
The resource includes the fields from the WorkerCheckIn template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/checkInTopics.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/checkInTopics.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/checkInTopics/{{=parameters.checkInTopicId}}.The action has the following user-defined parameters:
- checkInTopicId: Required. Specify the checkIn topic identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/checkInTopics/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkInTopics.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/post-/workers/-ID-/checkInTopics.
- [Update] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkInTopics/{{=item.id}}.
The action uses PATCH method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/patch-/workers/-ID-/checkInTopics/-subresourceID-.
- [Delete] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/checkInTopics/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/delete-/workers/-ID-/checkInTopics/-subresourceID-.
The resource includes the fields from the WorkerCheckInTopic template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/explicitSkills.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/explicitSkills.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/explicitSkills/{{=parameters.explicitSkillId}}.The action has the following user-defined parameters:
- explicitSkillId: Required. Specify the explicit skill identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/explicitSkills/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/explicitSkills.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/post-/workers/-ID-/explicitSkills.
The resource includes the fields from the WorkerExplicitSkill template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/externalSkillLevel.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/externalSkillLevel.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/externalSkillLevel/{{=parameters.externalSkillLevelId}}.The action has the following user-defined parameters:
- externalSkillLevelId: Required. Specify the external skill level identifier.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/externalSkillLevel.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/post-/workers/-ID-/externalSkillLevel.
- [Update] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/externalSkillLevel/{{=item.id}}.
The resource includes the fields from the WorkerExternalSkillLevel template.
- workerId
A key field. Template: ShortText.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/serviceDates.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/serviceDates.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/serviceDates/{{=parameters.serviceDateId}}.The action has the following user-defined parameters:
- serviceDateId: Required. Specify the service date identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/serviceDates/-subresourceID-.
- hireDate
Template: DateTime. A read-only field.
- continuousServiceDate
Template: DateTime. A read-only field.
Based on resource template VersionSix.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/serviceDates.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/skillItems.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/serviceDates/{{=parameters.serviceDateId}}.The action has the following user-defined parameters:
- serviceDateId: Required. Specify the service date identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/workers/-ID-/skillItems/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/workers/{{=item.workerId}}/serviceDates.The following request parameters will be automatically processed:
-
application/json:
{{={ skillItems: item } }}
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/post-/workers/-ID-/skillItems.
-
application/json:
The resource includes the fields from the WorkerSkillItem template.
- descriptor
Template: LongText.
- skillItem
Template: SharedAttributes.
- workerId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read assignmentTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/assignmentTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/assignmentTypes/.
- [Read companyInsiderTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/companyInsiderTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/companyInsiderTypes/.
- [Read contingentWorkerTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/contingentWorkerTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/contingentWorkerTypes/.
- [Read currencies] action
-
Endpoint URL address:
/values/jobChangesGroup/currencies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/currencies/.
- [Read employeeTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/employeeTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/employeeTypes/.
- [Read frequencies] action
-
Endpoint URL address:
/values/jobChangesGroup/frequencies/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/frequencies/.
- [Read headcountOptions] action
-
Endpoint URL address:
/values/jobChangesGroup/headcountOptions/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/headcountOptions/.
- [Read jobClassifications] action
-
Endpoint URL address:
/values/jobChangesGroup/jobClassifications/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/jobClassifications/.
- [Read jobProfiles] action
-
Endpoint URL address:
/values/jobChangesGroup/jobProfiles/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/jobProfiles/.
- [Read jobRequisitions] action
-
Endpoint URL address:
/values/jobChangesGroup/jobRequisitions/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/jobRequisitions/.
- [Read jobs] action
-
Endpoint URL address:
/values/jobChangesGroup/jobs/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/jobs/.
- [Read locations] action
-
Endpoint URL address:
/values/jobChangesGroup/locations/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/locations/.
- [Read payRateTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/payRateTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/payRateTypes/.
- [Read proposedPosition] action
-
Endpoint URL address:
/values/jobChangesGroup/proposedPosition/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/proposedPosition/.
- [Read reason] action
-
Endpoint URL address:
/values/jobChangesGroup/reason/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/reason/.
- [Read supervisoryOrganization] action
-
Endpoint URL address:
/values/jobChangesGroup/supervisoryOrganization/.
- [Read templates] action
-
Endpoint URL address:
/values/jobChangesGroup/templates/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/templates/.
- [Read timeTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/timeTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/timeTypes/.
- [Read workers] action
-
Endpoint URL address:
/values/jobChangesGroup/workers/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/workers/.
- [Read workersCompensationCodeOverrides] action
-
Endpoint URL address:
/values/jobChangesGroup/workersCompensationCodeOverrides/.
- [Read workerTypes] action
-
Endpoint URL address:
/values/jobChangesGroup/workerTypes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/workerTypes/.
- [Read workShifts] action
-
Endpoint URL address:
/values/jobChangesGroup/workShifts/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/workShifts/.
- [Read workSpaces] action
-
Endpoint URL address:
/values/jobChangesGroup/workSpaces/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/workSpaces/.
- [Read workStudyAwards] action
-
Endpoint URL address:
/values/jobChangesGroup/workStudyAwards/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#staffing/v6/get-/values/jobChangesGroup/workStudyAwards/.
- [Read businessUnits] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/businessUnits/.
- [Read companies] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/companies/.
- [Read costCenters] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/costCenters/.
- [Read customs] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/customs/.
- [Read funds] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/funds/.
- [Read gifts] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/gifts/.
- [Read grants] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/grants/.
- [Read orgAssignmentJobs] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/jobs/.
- [Read positions] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/positions/.
- [Read programs] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/programs/.
- [Read regions] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/regions/.
- [Read orgAssignmentWorkers] action
-
Endpoint URL address:
/values/organizationAssignmentChangesGroup/workers/.
The resource includes the fields from the SharedAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/academicCalendars.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicCalendars.
- [Read Single] action
-
Endpoint URL address:
/academicCalendars/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicCalendars/-ID-.
The resource includes the fields from the CommonAttributes template.
- nonInstructionalDaysCalendar
Template: CommonAttributes.
- periodTypes
Field components:
- An array.
-
Uses template:
CommonAttributes.
- academicYears
The gathered value is processed with
{{=connection.resourceManager['Academic Calendar | Academic Year'].getData({ batchSize: 100, parameters: ['academicCalendarId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
AcademicYear.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/academicCalendars/{{=parameters.academicCalendarId}}/academicYears.The action has the following user-defined parameters:
- academicCalendarId: Required. Specify the academic calendar identifier.
- [Read Single] action
-
Endpoint URL address:
/academicCalendars/{{=parameters.id}}/academicYears/{{=parameters.academicYearId}}.The action has the following user-defined parameters:
- academicYearId: Required. Specify the academic year identifier.
The resource includes the fields from the AcademicYear template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/academicLevels.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicLevels.
- [Read Single] action
-
Endpoint URL address:
/academicLevels/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicLevels/-ID-.
The resource includes the fields from the CommonAttributes template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/academicPeriods.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicPeriods.
- [Read Single] action
-
Endpoint URL address:
/academicPeriods/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicPeriods/-ID-.
The resource includes the fields from the CommonAttributes template.
- academicCalendar
Template: SharedAttributes.
- periodType
Template: SharedAttributes.
- startDate
Template: DateTime.
- weeksOfInstruction
Template: ShortText.
- periodWeights
Field components:
- An array.
-
Uses template:
Descriptor.
- endDate
Template: Date.
- standard
Data type: DT_BOOL
- academicYear
Template: AcademicYear.
- standardEndDate
Template: DateTime.
- periodUsages
Template: CompositeCommonAttribute.
- standardStartDate
Template: DateTime.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/academicUnits.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicUnits.
- [Read Single] action
-
Endpoint URL address:
/academicUnits/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/academicUnits/-ID-.
- superior
Template: SuperiorSubOrdinate.
- cipCode
Template: SharedAttributes.
- institution
Data type: DT_BOOL
- externalURL
Template: SharedAttributes.
- company
Template: SharedAttributes.
- subtype
Template: SharedAttributes.
- code
Template: ShortText.
- levels
Template: CompositeCommonAttribute.
- relatedSupervisoryOrganizations
Template: CompositeCommonAttribute.
- subordinates
Field components:
- An array.
-
Uses template:
SuperiorSubOrdinate.
- inactive
Data type: DT_BOOL
- name
Template: ShortText.
- id
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/educationalCredentials.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/educationalCredentials.
- [Read Single] action
-
Endpoint URL address:
/educationalCredentials/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/educationalCredentials/-ID-.
The resource includes the fields from the EducationalCredential template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/programsOfStudy.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/programsOfStudy.
- [Read Single] action
-
Endpoint URL address:
/programsOfStudy/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentAcademicFoundation/v1/get-/programsOfStudy/-ID-.
- academicLevel
Template: CommonAttributes.
- educationalCredentials
Field components:
- An array.
-
Uses template:
EducationalCredential.
- academicUnit
Template: SuperiorSubOrdinate.
- name
Template: ShortText.
- programType
Template: SharedAttributes.
- cipCode
Template: SharedAttributes.
- id
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/holds.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/holds.
- [Read Single] action
-
Endpoint URL address:
/holds/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/holds/-ID-.
The resource includes the fields from the CommonAttributes template.
- typeContexts
Field components:
- An array.
-
Uses template:
TypeContext.
- removedOn
Template: DateTime. A read-only field.
- reason
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: description, resolutionInstructions.
-
Uses template:
- createdOn
Template: DateTime. A read-only field.
- createdBy
Template: ShortText.
- overrideEvent
Template: OverrideEvent.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/immigrationEvents.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/immigrationEvents.
- [Read Single] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/immigrationEvents/-ID-.
The resource includes the fields from the CommonAttributes template.
- dependentImmigrationData
Field components:
- An array.
-
Uses template:
DependentImmigrationData.
- application
Template: SharedAttributes.
- status
Template: ShortText.
- immigrationData
Template: ImmigrationData.
- immigrationPages
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Immigration Page'].getData({ batchSize: 100, parameters: ['immigrationEventId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ImmigrationPage.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.immigrationEventId}}/dependentImmigrationData.The action has the following user-defined parameters:
- immigrationEventId: Required. Specify the immigration event identifier.
- [Read Single] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.id}}/dependentImmigrationData/{{=parameters.dependentImmigrationDataId}}.The action has the following user-defined parameters:
- dependentImmigrationDataId: Required. Specify the dependent immigration data identifier.
- [Create] action
-
Endpoint URL address:
/immigrationEvents/{{=item.immigrationEventId}}/dependentImmigrationData.
- [Update] action
-
Endpoint URL address:
/immigrationEvents/{{=item.immigrationEventId}}/dependentImmigrationData/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/immigrationEvents/{{=item.immigrationEventId}}/dependentImmigrationData/{{=item.id}}.
The resource includes the fields from the DependentImmigrationData template.
- immigrationEventId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.immigrationEventId}}/immigrationData.The action has the following user-defined parameters:
- immigrationEventId: Required. Specify the immigration event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/immigrationEvents/-ID-/immigrationData.
- [Read Single] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.id}}/immigrationData/{{=parameters.immigrationDataId}}.The action has the following user-defined parameters:
- immigrationDataId: Required. Specify the immigration data identifier.
- [Create] action
-
Endpoint URL address:
/immigrationEvents/{{=item.immigrationEventId}}/immigrationData.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/post-/immigrationEvents/-ID-/immigrationData.
- [Update] action
-
Endpoint URL address:
/immigrationEvents/{{=item.immigrationEventId}}/immigrationData/{{=item.id}}.
The resource includes the fields from the ImmigrationData template.
- immigrationEventId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.immigrationEventId}}/immigrationPages.The action has the following user-defined parameters:
- immigrationEventId: Required. Specify the immigration event identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/immigrationEvents/-ID-/immigrationPages.
- [Read Single] action
-
Endpoint URL address:
/immigrationEvents/{{=parameters.id}}/immigrationPages/{{=parameters.immigrationPageId}}.The action has the following user-defined parameters:
- immigrationPageId: Required. Specify the immigration page identifier.
The resource includes the fields from the ImmigrationPage template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students/-ID-.
The resource includes the fields from the CommonAttributes template.
- location
Template: SharedAttributes.
- Student_ID
Data type: DT_I4
- internationalStudent
Data type: DT_BOOL
- person
Template: SharedAttributes.
- firstGeneration
Data type: DT_BOOL
- primaryStudentRecord
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: programOfStudy, academicUnit, academicLevel, classStanding, status.
- militaryRelationship
Data type: DT_BOOL
- preferredName
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students/{{=parameters.studentId}}/applyHoldEvents.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students/-ID-/applyHoldEvents.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}/applyHoldEvents/{{=parameters.applyHoldEventId}}.The action has the following user-defined parameters:
- applyHoldEventId: Required. Specify the apply hold event identifier.
The resource includes the fields from the CommonAttributes template.
- reason
Template: SharedAttributes.
- typeContext
Field components:
- An array.
-
Uses template:
TypeContext.
- student
Template: SharedAttributes.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students/{{=parameters.studentId}}/immigrationEvents.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students/-ID-/immigrationEvents.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}/immigrationEvents/{{=parameters.immigrationEventId}}.The action has the following user-defined parameters:
- immigrationEventId: Required. Specify the immigration event identifier.
The resource includes the fields from the CommonAttributes template.
- dependentImmigrationData
Field components:
- An array.
-
Uses template:
DependentImmigrationData.
- application
Template: SharedAttributes.
- status
Template: ShortText.
- immigrationData
Template: ImmigrationData.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students/{{=parameters.studentId}}/residencies.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students/-ID-/residencies.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}/residencies/{{=parameters.residencyId}}.The action has the following user-defined parameters:
- residencyId: Required. Specify the residency identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCore/v1/get-/students/-ID-/residencies/-subresourceID-.
The resource includes the fields from the CommonAttributes template.
- effectiveAcademicPeriod
Template: SharedAttributes.
- events
Field components:
- An array.
-
Uses template:
Identifier.
- detail
Template: SharedAttributes.
- documents
Template: CompositeCommonAttribute.
- reason
Template: SharedAttributes.
- effective
Template: DateTime.
- institutionalAcademicUnits
Template: CompositeCommonAttribute.
- declaration
Template: ShortText.
- status
Template: SharedAttributes.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students/{{=parameters.studentId}}/holds.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentEngagement/v1/get-/students/-ID-/holds.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}/holds/{{=parameters.holdId}}.The action has the following user-defined parameters:
- holdId: Required. Specify the hold identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentEngagement/v1/get-/students/-ID-/holds/-subresourceID-.
The resource includes the fields from the CommonAttributes template.
- overrideEvent
Template: OverrideEvent.
- reason
Template: CommonAttributes. Field components:
-
Uses template:
LongText. - Contains the following components: description, resolutionInstructions.
-
Uses template:
- createdBy
Template: ShortText.
- typeContexts
Field components:
- An array.
-
Uses template:
TypeContext.
- removedOn
Template: DateTime. A read-only field.
- createdOn
Template: DateTime. A read-only field.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/students/{{=parameters.studentId}}/payments.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentFinance/v1/get-/students/-ID-/payments.
- [Read Single] action
-
Endpoint URL address:
/students/{{=parameters.id}}/payments/{{=parameters.paymentId}}.The action has the following user-defined parameters:
- paymentId: Required. Specify the payment identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentFinance/v1/get-/students/-ID-/payments/-subresourceID-.
- [Create] action
-
Endpoint URL address:
/students/{{=item.studentId}}/payments.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentFinance/v1/post-/students/-ID-/payments.
- [Update] action
-
Endpoint URL address:
/students/{{=item.studentId}}/payments/{{=item.id}}.
The resource includes the fields from the CommonAttributes template.
- institutionalAcademicUnit
Template: CommonAttributes.
- reference
Template: ShortText.
- amount
Data type: DT_R8
- paymentDate
Template: Date.
- studentFinanceTransactionDate
Template: ShortText.
- academicPeriod
Template: CommonAttributes.
- paymentItem
Template: CommonAttributes.
- paymentType
Template: CommonAttributes.
- studentId
A key field. Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/courses.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courses.
- [Read Single] action
-
Endpoint URL address:
/courses/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courses/-ID-.
The resource includes the fields from the Course template.
- subjectDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Course Subject'].getData({ batchSize: 100, parameters: ['courseSubjectId=' + item.courseSubject.id] })}}expression. Field components:- An array.
-
Uses template:
CourseSubject.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/courseSections.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courseSections.
- [Read Single] action
-
Endpoint URL address:
/courseSections/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courseSections/-ID-.
The resource includes the fields from the CommonAttributes template.
- instructionalFormat
Template: SharedAttributes.
- components
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: meetingPattern, location.
- cluster
Template: SharedAttributes.
- learningOutcomes
Template: CompositeCommonAttribute.
- academicPeriod
Template: SharedAttributes.
- owningInstitutionalAcademicUnit
Template: Unit.
- courseSubject
Template: SharedAttributes.
- campusLocations
Template: CompositeCommonAttribute.
- capacity
Data type: DT_I4
- status
Template: SharedAttributes.
- eligibilityRule
Template: SharedAttributes.
- tags
Template: CompositeCommonAttribute.
- deliveryMode
Template: SharedAttributes.
- academicLevel
Template: SharedAttributes.
- startDate
Template: DateTime. A read-only field.
- hidden
Data type: DT_BOOL
- owningAcademicUnit
Template: Unit.
- instuctors
Template: CompositeCommonAttribute.
- course
Template: SharedAttributes.
- endDate
Template: DateTime. A read-only field.
- offeringAcademicUnits
Field components:
- An array.
-
Uses template:
Unit.
- competencies
Template: CompositeCommonAttribute.
- courseDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Course'].getData({ batchSize: 100, parameters: ['courseId=' + item.course.id] })}}expression. Field components:- An array.
-
Uses template:
Course.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/courseSubjects.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courseSubjects.
- [Read Single] action
-
Endpoint URL address:
/courseSubjects/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#studentCurriculum/v1/get-/courseSubjects/-ID-.
The resource includes the fields from the CourseSubject template.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/activeTasks.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#systemMetrics/v1/get-/activeTasks.
- [Read Single] action
-
Endpoint URL address:
/activeTasks/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#systemMetrics/v1/get-/activeTasks/-ID-.
- origin
Template: ShortText.
- startTime
Template: DateTime. A read-only field.
- cpuTimeMillis
Template: ShortText.
- task
Template: SharedAttributes.
- runningSubtaskCount
Template: ShortText.
- queuedSubtaskCount
Template: ShortText.
- account
Template: SharedAttributes.
- taskDurationMillis
Template: ShortText.
- bytesAllocated
Template: ShortText.
- status
Template: ShortText.
- queueMillis
Template: ShortText.
- instancesAccessed
Template: ShortText.
- queueName
Template: ShortText.
Based on resource template VersionOnePagination.
- [Read] action
-
Endpoint URL address:
/activeUserSessions.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#systemMetrics/v1/get-/activeUserSessions.
- [Read Single] action
-
Endpoint URL address:
/activeUserSessions/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#systemMetrics/v1/get-/activeTasks/-ID-.
The resource includes the fields from the CommonAttributes template.
- signonTime
Template: DateTime. A read-only field.
- systemAccount
Template: SharedAttributes.
- deviceType
Template: SharedAttributes.
- role
Template: SharedAttributes.
- authenticationType
Template: SharedAttributes.
- elapsedMinutes
Template: ShortText.
Based on resource template VersionTwoPagination.
- [Read] action
-
Endpoint URL address:
/mentorships.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#talentManagement/v2/get-/mentorships.
- [Read Single] action
-
Endpoint URL address:
/mentorships/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#talentManagement/v2/get-/mentorships/-ID-.
The resource includes the fields from the CommonAttributes template.
- purpose
Template: LongText.
- closeMentorshipReason
Template: SharedAttributes.
- startDate
Template: DateTime.
- mentorType
Template: SharedAttributes.
- mentee
Template: SharedAttributes.
- mentorship
Template: SharedAttributes.
- mentor
Template: SharedAttributes.
- endDate
Template: DateTime.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/timeClockEvents.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/timeClockEvents.
- [Read Single] action
-
Endpoint URL address:
/timeClockEvents/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/timeClockEvents/-ID-.
- [Create] action
-
Endpoint URL address:
/timeClockEvents.The action has the following user-defined parameters:
- studentId: Required. Specify the student identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/post-/timeClockEvents.
- [Update] action
-
Endpoint URL address:
/timeClockEvents/{{=item.id}}.
The action uses PUT method.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/put-/timeClockEvents/-ID-.
- [Delete] action
-
Endpoint URL address:
/timeClockEvents/{{=item.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/delete-/timeClockEvents/-ID-.
The resource includes the fields from the SharedAttributes template.
- dateTime
Template: DateTime.
- timeZone
Template: SharedAttributes.
- fund
Template: SharedAttributes.
- overrideRate
Data type: DT_R8
- position
Template: SharedAttributes.
- reference_ID
Template: ShortText.
- timeEntryCode
Template: SharedAttributes.
- projectPlanTask
Template: SharedAttributes.
- project
Template: SharedAttributes.
- eventType
Template: SharedAttributes.
- region
Template: SharedAttributes.
- jobProfile
Template: SharedAttributes.
- location
Template: SharedAttributes.
- grant
Template: SharedAttributes.
- gift
Template: SharedAttributes.
- program
Template: SharedAttributes.
- currency
Template: SharedAttributes.
- comment
Template: LongText.
- businessUnit
Template: SharedAttributes.
- costCenter
Template: SharedAttributes.
- worker
Template: SharedAttributes.
- allocationPool
Template: SharedAttributes.
- appropriation
Template: SharedAttributes.
- planTaskDetails
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Plan Task'].getData({ batchSize: 100, parameters: ['planTaskId=' + item.projectPlanTask.id] })}}expression. Field components:- An array.
-
Uses template:
ProjectPlanTask.
- projectDetails
Template: Project. A read-only field. The value is gathered from
/v1/projects/{{=item.project.id}}address.- workerDetails
Template: Worker. A read-only field. The value is gathered from
/v1/workers/{{=item.worker.id}}address.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/timeValidations.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/timeValidations.
- criticalValidations
Template: LongText.
- warningValidations
Template: LongText.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/workerTimeBlocks.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workerTimeBlocks.
- [Read Single] action
-
Endpoint URL address:
/workerTimeBlocks/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workerTimeBlocks/-ID-.
The resource includes the fields from the CommonAttributes template.
- calculatedTimeDetails
Field components:
- An array.
- Contains the following components: overrideRate, shiftDate, calculatedQuantity, currency, calculatedDate, calculatedInTimeZone, calculationTags, calendarDate, calculatedOutTimeZone, id.
- appropriation
Template: SharedAttributes.
- allocationPool
Template: SharedAttributes.
- program
Template: SharedAttributes.
- jobProfile
Template: SharedAttributes.
- costCenter
Template: SharedAttributes.
- location
Template: SharedAttributes.
- grant
Template: SharedAttributes.
- businessUnit
Template: SharedAttributes.
- region
Template: SharedAttributes.
- position
Template: SharedAttributes.
- reportedQuantity
Template: ShortText.
- fund
Template: SharedAttributes.
- status
Template: SharedAttributes.
- gift
Template: SharedAttributes.
- comment
Template: ShortText.
- unit
Template: SharedAttributes.
- worker
Template: SharedAttributes.
- calendarDate
Template: DateTime. A read-only field.
- timeEntryCode
Template: SharedAttributes.
- projectRole
Template: SharedAttributes.
- overrideRate
Data type: DT_R8
- projectPlanPhase
Template: SharedAttributes.
- inTimeZone
Template: SharedAttributes.
- outTimeZone
Template: SharedAttributes.
- inTime
Template: DateTime. A read-only field.
- outReason
Template: SharedAttributes.
- outTime
Template: DateTime. A read-only field.
- project
Template: SharedAttributes.
- doNotBill
Data type: DT_BOOL
- projectPlanTask
Template: SharedAttributes.
- currency
Template: SharedAttributes.
- projectDetails
Template: Project. A read-only field. The value is gathered from
/v1/projects/{{=item.project.id}}address.- workerDetails
Template: Worker. A read-only field. The value is gathered from
/v1/workers/{{=item.worker.id}}address.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/workers.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers/-ID-.
The resource includes the fields from the Worker template.
- timetotals
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Worker | Time Total'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
TimeTotal.
- period
A read-only field. The gathered value is processed with
{{=connection.resourceManager['Worker | Period'].getData({ batchSize: 100, parameters: ['workerId=' + item.workerId] })}}expression. Field components:- An array.
-
Uses template:
WorkerPeriod.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/timeTotals.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers/-ID-/timeTotals.
- [Read Single] action
-
Endpoint URL address:
/workers/{{=parameters.id}}/timeTotals/{{=parameters.timeTotalId}}.The action has the following user-defined parameters:
- timeTotalId: Required. Specify the time total identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers/-ID-/timeTotals/-subresourceID-.
The resource includes the fields from the TimeTotal template.
Based on resource template VersionThreePagination.
- [Read] action
-
Endpoint URL address:
/workers/{{=parameters.workerId}}/period.The action has the following user-defined parameters:
- workerId: Required. Specify the worker identifier.
Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/workers/-ID-/period.
The resource includes the fields from the WorkerPeriod template.
Based on resource template VersionThreePagination.
- [Read default time entry code] action
-
Endpoint URL address:
/values/timeTypes/defaultTimeEntryCode/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeTypes/defaultTimeEntryCode/.
- [Read project plan tasks] action
-
Endpoint URL address:
/values/timeTypes/projectPlanTasks/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeTypes/projectPlanTasks/.
- [Read projects] action
-
Endpoint URL address:
/values/timeTypes/projects/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeTypes/projects/.
- [Read time entry codes] action
-
Endpoint URL address:
/values/timeTypes/timeEntryCodes/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeTypes/timeEntryCodes/.
- [Read outReason] action
-
Endpoint URL address:
/values/timeTypes/outReason/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeValues/outReason/.
- [Read worker time zone] action
-
Endpoint URL address:
/values/timeTypes/workerTimeZone/.Documentation: https://community.workday.com/sites/default/files/file-hosting/restapi/index.html#timeTracking/v3/get-/values/timeValues/workerTimeZone/.
The resource includes the fields from the SharedAttributes template.
- [Read] action
-
Endpoint URL address:
/wql/v1/data.
The result is paginated.The action has the following user-defined parameters:
- query: Required. Specify the WQL statement.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
query:
{{=parameters.query}} -
_includeUserParameters:
{{=parameters}}
- [External]
-
The external fields URL address:
/wql/v1/data. The external fields list is extracted from:{{=Workday.getWqlFields(response)}}.
- [Read] action
-
The result is extracted from:{{=response.data}}.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Read Single] action
-
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify prime entity identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPagination.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
-
offset:
Based on resource template Base.
Based on resource template NoPagination.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- CommonAttributes
Field components:
-
Uses template:
ShortText. - Contains the following components: id, descriptor.
-
Uses template:
- SharedAttributes
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: href.
-
Uses template:
- Descriptor
Field components:
-
Uses template:
LongText. - Contains the following components: descriptor.
-
Uses template:
- TimeOffDetails
Field components:
-
Uses template:
SharedAttributes. - Contains the following components: position, comment, reason, timeOffType, quantity, status, date, unit, worker.
-
Uses template:
- ValidTimeOffDates
Field components:
-
Uses template:
DateTime. - Contains the following components: date, unit, dailyDefaultQuantity.
-
Uses template:
- EligibleAbsenceType
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: unitOfTime, positionBased, position, absenceReasons, reasonRequired, displayStartAndEndTime, category, additionalFields, absenceTypeGroup, dailyDefaultQuantity, calculateQuantityBasedOnStartAndEndTime, entryOption, startAndEndTimeRequired.
-
Uses template:
- LeaveOfAbsence
Field components:
-
Uses template:
ShortText. - Contains the following components: id, businessProcessStepStatus, reason, additionalFields, actualLastDayOfLeave, latestLeaveComment, worker, estimatedLastDayOfLeave, lastDayOfWork, leaveImpactFields, position, priorLeaveEvent, status, firstDayOfLeave, leaveType.
-
Uses template:
- Line
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: type, unitOfMeasure, itemIdentifiers, internalMemo, splits, itemDescription, billable, unitCost, extendedAmount, spendCategory, memo, itemTags, item, quantity, splitBy, worktags.
-
Uses template:
- Value
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: booleanValue, restrictToEnvironments, numericValue, stringValue.
-
Uses template:
- Attribute
Field components:
-
Uses template:
SharedAttributes. - Contains the following components: value, required, type, name, alias, description, id.
-
Uses template:
- Comment
Field components:
-
Uses template:
SharedAttributes. - Contains the following components: person, comment, commentDate.
-
Uses template:
- Attachment
Field components:
-
Uses template:
ShortText. - Contains the following components: id, uploadedBy, description, category, contentType, fileLength, fileName, uploadDate, fileExtension.
-
Uses template:
- CompletedSteps
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: awaitingPersons, event, completedDate, creationDate, status, completedByPerson, order, parallelStepInboxOrder, comments, dueDate.
-
Uses template:
- InProgressSteps
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: delayedDate, dueDate, anonymous, businessProcessStep, order, parallelStepInboxOrder, awaitingPersons, creationDate, status.
-
Uses template:
- RemainingSteps
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: completionStep, stepType, groups, step, dueDate, parallelStepInboxOrder, order.
-
Uses template:
- BusinessTitleChange
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: currentBusinessTitle, proposedBusinessTitle, effective, due, initiated, initiator, subject.
-
Uses template:
- TimeOffPlan
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: timeOffBalance, unitOfTime.
-
Uses template:
- DirectReport
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: primaryWorkPhone, isManager, primaryWorkEmail, businessTitle, primarySupervisoryOrganization.
-
Uses template:
- History
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: primaryWorkEmail, isManager, primaryWorkPhone, location, primarySupervisoryOrganization, primaryWorkAddressText, yearsOfService, businessTitle, dateOfBirth, supervisoryOrganizationsManaged.
-
Uses template:
- InboxTask
Template: SharedAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: initiator, stepType, status, overallProcess, subject, due, assigned.
-
Uses template:
- Organization
Template: SharedAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: organizationType.
-
Uses template:
- PaySlip
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: gross, status, net, date.
-
Uses template:
- SupervisoryManagedOrganization
Template: SharedAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: manager, workers, name, code.
-
Uses template:
- TimeOffEntry
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: units, employee, unitOfTime, timeOffRequest, date, timeOff.
-
Uses template:
- ScoreCardGoalResult
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: eligibiltyRule, performanceScores, weightedFundingPercent.
-
Uses template:
- ScoreCardGoal
Field components:
-
Uses template:
ShortText. - Contains the following components: id, goalWeight, goalDescription, goalName.
-
Uses template:
- Worker
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: primaryWorkEmail, isManager, primaryWorkPhone, location, primarySupervisoryOrganization, primaryWorkAddressText, yearsOfService, businessTitle, dateOfBirth, supervisoryOrganizationsManaged.
-
Uses template:
- ChargeControl
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: minimumAmount, maximumAmount.
- CustomerActivity
Field components:
-
Uses template:
ShortText. - Contains the following components: id, invoiceOpportunity, paymentReference, transactionAmountSigned, transactionDate, applicationStatus, transactionType, transactionStatus, transactionNumber, invoiceDueDate.
-
Uses template:
- PrintRun
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: pdf, deliveryMethod, printedDateTime, printRunType.
-
Uses template:
- Identifier
Field components:
-
Uses template:
ShortText. - Contains the following components: id.
-
Uses template:
- Period
Field components:
-
Uses template:
ShortText. - Contains the following components: id, status, periodIsEarliestOpen, periodEndDate, periodStartDate.
-
Uses template:
- CaseTimelineAttachment
Field components:
-
Uses template:
ShortText. - Contains the following components: fileName, comment, href, id.
-
Uses template:
- ExternalCreator
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, blocked, email.
-
Uses template:
- Who
Template: CommonAttributes. Field components:
-
Uses template:
ExternalCreator. - Contains the following components: externalCreator, worker.
-
Uses template:
- CaseType
Field components:
-
Uses template:
ShortText. - Contains the following components: name, confidential, externalLink, hasQuestionnaire, questionnaire, external, description, id.
-
Uses template:
- BusinessProcessParameter
Field components:
-
Uses template:
SharedAttributes. - Contains the following components: overallBusinessProcess, action, comment, comments, transactionStatus, warningValidations, overallStatus, attachments, criticalValidations, for.
-
Uses template:
- AdditionalJob
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: businessTitle, supervisoryOrganization, jobType, jobProfile, location, workSpace.
-
Uses template:
- PrimaryJob
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: businessTitle, supervisoryOrganization, jobType, jobProfile, location, workSpace.
-
Uses template:
- Person
Field components:
-
Uses template:
ShortText. - Contains the following components: phone, email, id.
-
Uses template:
- FeedbackEvent
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: feedbackConfidential, feedbackAbout, feedbackOverallStatus, showFeedbackProviderName, requestDate, expirationDate, feedbackQuestions, feedbackTemplate, feedbackResponders, businessProcessParameters.
-
Uses template:
- Goal
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, relatesTo, activityStreamableItem, dueDate, description, associatedReviews, category, supports, worker, status, completedOn, createdBy, state.
-
Uses template:
- Usage
Field components:
-
Uses template:
CommonAttributes. - Contains the following components: primary, usageType, usedFor, public.
-
Uses template:
- WebAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: id, comment, url, usage.
-
Uses template:
- PeopleEmail
Field components:
-
Uses template:
ShortText. - Contains the following components: id, usage, emailAddress, emailComment.
-
Uses template:
- PeopleAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: id, addressLine4Local, citySubdivision2Local, addressLine8Local, citySubdivision1Local, addressLine1, addressLine9, regionSubdivision1Local, addressLine8, addressLine2, fullFormattedAddress, addressLine6Local, regionSubdivision2, countryCity, addressLine4, postalCode, fullFormattedLocalAddress, addressLine1Local, citySubdivision1, addressLine6, usage, city, addressLine3, citySubdivision2, addressLine9Local, effective, addressLine7Local, addressLine5, regionSubdivision1, cityLocal, addressLine2Local, countryRegion, addressLine3Local, country, addressLine5Local, addressLine7.
-
Uses template:
- PeoplePhone
Template: CommonAttributes. Field components:
-
Uses template:
Usage. - Contains the following components: usage, countryPhoneCode, completePhoneNumber, extension, deviceType.
-
Uses template:
- PeopleInstantMessenger
Field components:
-
Uses template:
ShortText. - Contains the following components: id, comment, type, userName.
-
Uses template:
- AdditionalName
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: secondaryLocal, salutation, secondaryLast, primary, title, primaryLocal2, tertiaryLast, social, full, firstLocal, hereditary, first, middleLocal, firstLocal2, primaryLocal, country, middle.
-
Uses template:
- LegalName
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: secondaryLocal, salutation, secondaryLast, primary, title, primaryLocal2, tertiaryLast, social, full, firstLocal, hereditary, first, middleLocal, firstLocal2, primaryLocal, country, middle.
-
Uses template:
- Photo
Field components:
-
Uses template:
ShortText. - Contains the following components: id, width, contentType, fileLength, height, fileName, href.
-
Uses template:
- PreferredName
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: secondaryLocal, salutation, secondaryLast, primary, title, primaryLocal2, tertiaryLast, social, full, firstLocal, hereditary, first, middleLocal, firstLocal2, primaryLocal, country, middle.
-
Uses template:
- TableCreatdBY
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: fullName.
-
Uses template:
- TableType
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: fullName.
-
Uses template:
- TBField
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, ordinal, description, parseFormat, type, precision, scale, businessObject, context, displayName, defaultValue, fieldId, required, externalId.
-
Uses template:
- Schema
Field components:
- Contains the following components: fields, parseOptions.
- Stats
Field components:
- Contains the following components: processsedFiles, wBucketSize, totalRowCount, errorRowCount, producedEncodedFilesSize.
- WorkTag
Field components:
- Contains the following components: worktags.
- Split
Template: CommonAttributes. Field components:
-
Uses template:
LongText. - Contains the following components: percent, billable, memo, quantity, amount, worktags.
-
Uses template:
- PurchaseOrder
Field components:
- An array.
-
Uses template:
SharedAttributes. - Contains the following components: poDocumentDate, documentStatus, poNumber.
- RequisitionLine
Template: SharedAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: shipToContact, unitOfMeasure, itemURL, shipToAddressReference, itemRanking, item, supplier, shipToAddress, spendCategory, unitCost, quantity, worktags, catalogItem, webItemImageURL, lotSerialInformation, lineCompany, formattedUnitCost, writeInService, writeInGoods, endDate, supplierContract, webItem, createdMoment, memo, requestedDeliveryDate, deliverToLocation, startDate, formattedExtendedAmount, serviceRequisitionLine, warningCustomValidations, itemImage, noCharge, formattedShippingAddress, lineDeliverToLocationChain, commodityCode, criticalCustomValidations, supplierItemIdentifier, rfqRequired, extendedAmount, orderFromConnection, itemDescription.
-
Uses template:
- ReuisitionCancelClose
Template: CommonAttributes. Field components:
-
Uses template:
LongText. - Contains the following components: reasonCode, comments.
-
Uses template:
- CompositeCommonAttribute
Field components:
- An array.
-
Uses template:
CommonAttributes.
- Project
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: billable, includeProjectIDInName, objective, estimatedBudget, realizedRevenueSavings, projectState, probabilityOfSuccess, outOfScope, inactive, Project_ID, primaryHierarchy, estimatedRevenueSavings, percentComplete, totalSavingsRemaining, successRating, customer, overview, capital, owner, company, description, status, riskLevel, startDate, problemStatement, worktags, measuresOfSuccess, name, currency, endDate, importanceRating, groups, projectDependencies, optionalHierarchies, externalProjectReference, externalLink, businessEventRecords, inScope, priority.
-
Uses template:
- ForecastLineAllocation
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: forecastedHours, date.
-
Uses template:
- ProjectResource
Field components:
- An array.
-
Uses template:
CommonAttributes. - Contains the following components: processingUserHasAccessToViewWorker, unnamedResource.
- ProjectPlanTask
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: editable, closed, deletable, milestone, task, endDate, startDate, utilization, percentComplete, customTaskName, memo, phase, taskResourceCount, billableTask, order.
-
Uses template:
- ProjectPlanLine
Template: CommonAttributes. Field components:
-
Uses template:
CompositeCommonAttribute. - Contains the following components: pendingWorkers, role, resourceType, excludedWorkers, costRateCurrencyOverride, endDate, startDate, roleCategory, costRateOverride, requirements, jobRequisition, estimatedHours, bookingStatus, memo, percentAllocation, workerGroup, toBeHired, projectResources.
-
Uses template:
- JobLocation
Template: CommonAttributes. Field components:
- Contains the following components: country, region.
- JPQuestionnaire
Template: SharedAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: referenceIdValue, questionnaireInstructions, questions, name, questionnaireDisplayName.
-
Uses template:
- BillableRateApplication
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: billingRateRuleType, reasonForChange, amountToBill, ruleName, quantityToBill, rateAdjustmentAmount, rateStartingAmount, applicationOrder, rateEndingAmount.
-
Uses template:
- SupervisoryOrgMember
Template: CommonAttributes. Field components:
-
Uses template:
CommonAttributes. - Contains the following components: location, businessTitle, worker, supervisoryOrganization, nextPayPeriodStartDate, jobType, jobProfile.
-
Uses template:
- SuperiorSubOrdinate
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: name, managers, inactive, code, institution.
-
Uses template:
- SupervisoryOrgChart
Template: CommonAttributes. Field components:
-
Uses template:
SuperiorSubOrdinate. - Contains the following components: superior, subordinates.
-
Uses template:
- WorkerCheckIn
Field components:
-
Uses template:
ShortText. - Contains the following components: id, associatedTopics, creator, archived, checkInAttachments, participant, date, description.
-
Uses template:
- WorkerCheckInTopic
Field components:
-
Uses template:
LongText. - Contains the following components: sharedNotes, privateNotes, archived, name, checkInTopicAttachments, participant, associatedCheckIns, creator, id.
-
Uses template:
- WorkerSkillSource
Template: CommonAttributes. Field components:
-
Uses template:
Identifier. - Contains the following components: skillSource, sourceType, sourceTypeID, dateCreated.
-
Uses template:
- WorkerSkillItem
Field components:
-
Uses template:
ShortText. - Contains the following components: skillName, remoteID, id.
-
Uses template:
- WorkerSkill
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: remoteID, skillSources, skillItem.
-
Uses template:
- WorkerExplicitSkill
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: remoteID, skillSources, skillItem, skills.
-
Uses template:
- WorkerExternalSkillLevel
Field components:
-
Uses template:
ShortText. - Contains the following components: id, externalSkillName, externalSkillLevel, skillVendorName, skillVendorId, context, effectiveMoment, externalSkillId.
-
Uses template:
- AcademicYear
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: startDate, endDate.
-
Uses template:
- EducationalCredential
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: type, name, description.
-
Uses template:
- DependentImmigrationData
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: relationshipToStudent, sevisIssueDate, middleName, lastName, sevisExpirationDate, firstName, countryOfBirth, dateOfBirth, sevisId, countryOfCitizenship, immigrationStatus.
-
Uses template:
- ImmigrationData
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: activeSevisId, activeVisaType, issuingInstitution.
-
Uses template:
- ImmigrationPage
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: type, name, hidden, description.
-
Uses template:
- Unit
Field components:
-
Uses template:
ShortText. - Contains the following components: id, institution, inactive, name.
-
Uses template:
- CourseSubject
Template: CommonAttributes. Field components:
-
Uses template:
ShortText. - Contains the following components: abbreviation, inactive, institutionalAcademicUnits.
-
Uses template:
- Course
Template: CommonAttributes. Field components:
-
Uses template:
CompositeCommonAttribute. - Contains the following components: competencies, listingNumber, institutionalAcademicUnit, learningOutcomes, tags, academicUnits, typicalPeriodsOffered, title, instructionalFormats, academicLevel, description, courseSubject, allowedLocations, eligibilityRule.
-
Uses template:
- OverrideEvent
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: startDate, appliedOn, createdBy, holdTypes, endDate.
-
Uses template:
- TypeContext
Template: CommonAttributes. Field components:
-
Uses template:
SharedAttributes. - Contains the following components: holdType, studentAwardItem, federalSchoolCode, academicRecord, financialAidAwardYear, academicPeriod, institution, federalSchoolCodeRuleSet.
-
Uses template:
- TimeTotal
Field components:
-
Uses template:
LongText. - Contains the following components: periodLabel, submitText, totals, certifyText.
-
Uses template:
- WorkerPeriod
Template: CommonAttributes. Field components:
-
Uses template:
DateTime. - Contains the following components: openTimeEntry, unlockTimeEntry, paymentDate, periodStartDate, periodEndDate, closeTimeEntry, lockTimeEntry.
-
Uses template:
- ActionT
- NoBodyActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.