CData Cloud offers access to Workday across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to Workday through CData Cloud.
CData Cloud allows you to standardize and configure connections to Workday as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Workday in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Workday and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Workday through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Workday by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
API | Prerequisites | Connection Parameters |
WQL | Enable WQL service (See below) | ConnectionType: WQL |
Reports as a Service | Set up catalog report (see Fine-Tuning Data Access) | ConnectionType: Reports |
REST | Automatically enabled | ConnectionType: REST |
SOAP | Automatically enabled | See Authenticating to Workday SOAP API, below |
To obtain the BaseURL and Tenant properties, log into Workday and search for View API Clients. On this screen, Workday displays the Workday REST API Endpoint, a URL that includes both the BaseURL and Tenant.
The format of the REST API Endpoint is:
https://domain.com/subdirectories/mycompany, where:
For example, in the REST API endpoint https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the BaseURL is https://wd3-impl-services1.workday.com and the Tenant is mycompany.
The following content describes how to authenticate in a non-SSO environment (separate logins for each application accessed), which requires a custom OAuth API client. For details regarding authenticating in an SSO environment, and information about creating both types of custom API client applications to connect to Workday, see Creating a Custom API Client Application.
OAuth connections require that you write a custom OAuth application. For information about how to create a custom OAuth application, see Creating a Custom API Client Application.
For a complete list of connection string properties available in Workday, see Connection.
Note: If you want to connect via SOAP, you can use Basic authentication, which doesn't require a custom OAuth application. See Authenticating to Workday SOAP API.
Click Connect to Workday to open the OAuth endpoint in your default browser. Log in and grant permissions to the application.
The driver then completes the OAuth process as follows:
After you have an API client configured, set the following properties to connect using Workday credentials:
If you created an API client for use with AzureAD, set the following properties:
To authenticate as an ISU, you must first create either an API Client or an API Client for Integrations, as described in Creating a Custom API Client Application. You can create either an API Client for Integrations or an API Client using the JWT bearer grant type.
If you created an API Client for Integrations, set the following properties to connect:
If you created an API Client with JWT, set the following properties to connect:
Connections using the SOAP API support all the same authentication schemes that the WQL and reporting services do, in addition to basic authentication. Each of the above configurations can be used with SOAP by setting the UseWQL property to false.
To use basic authentication (which does not require configuring an API client) set the following connection parameters:
Other authentication methods are configured the same way as for the WQL and reporting services.
When connecting with ConnectionType set to SOAP, the following properties will determine what tables are exposed:
When connecting with ConnectionType set to Reports, the Cloud supports reading reports that have been exposed through Workday Reports as a Service (RaaS). Workday does not have a built-in way for the Cloud to determine which reports have been exposed via RaaS, so you must create a custom report to use this feature:
After the report is created, you need to add a few columns and filters:
Note that the Current User filter is optional but recommended. It is there to ensure that the Cloud does not surface reports that your account does not have permissions to view. However, if the report has performance issues then the filter can be removed.
The final step is to find the URL associated with the report. This URL is used to set the CustomReportURL connection property.
The permissions used by the Begin and Submit stored procedures (see REST) are configured differently to other REST resources. The permissions for each change resource is determined by its underlying business process. For example, executing BeginOrganizationAssignmentChange triggers the Change Organization Assignments for Worker business process within Workday
If you find that the the Cloud is unable to start a business process, update the processs security policy as follows:
While connecting, you may receive an error stating "Invalid Request". This is a server-side Workday error. It often indicates that your user account has not been granted the permissions required to either connect via the API, or to obtain the specific information you have requested.
The tables and columns are retrieved from a publicly available service that requires no authentication, so this error may appear while either testing the connection, or when trying to retrieve data after metadata has been obtained.
While connecting, you may receive an error stating "Processing error occurred. The task submitted is not authorized".
This is a server-side error Workday error. This error typically indicates that your Workday account does not have the necessary module activated to access the table or Service you are attempting to connect to.
Ensure the correct module is activated if you receive this error. The Cloud is unable to dynamically determine which modules are available at runtime, but the exposed services can be configured via the Service connection property.
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
When ConnectionType is set to WQL, the Cloud models Workday data sources as views. You can get a complete list of these data sources using the Data Sources standard report in Workday. The Cloud exposes each data source using its WQL Alias which is shown on the View Data Source page.
The Cloud exposes two kinds of data sources: Prism data sources and Core data sources. All Prism data sources start with the prefix cds_.
The Cloud does not list all the data sources defined within Workday:
You can use UseSplitTables to work around this limtiation by splitting each data source into multiple views with fewer columns.
When ConnectionType is set to Reports, the Cloud also grants access to reports that are exposed using Reports as a Service (RaaS). These reports are exposed as views within the Reports schema. Accessing these reports requires extra connection setup beyond the basic settings for WQL access. See Fine-Tuning Data Access for details on what is required.
The data model included in the REST section is only available when ConnectionType is set to REST.
The data models listed in Service are only available in the SOAP API. ConnectionType must be set to SOAP in order to use them.
Many WQL data sources, reports, REST endpoints, and SOAP services have prompts that affect what rows Workday reports.
The Cloud exposes these prompts as input columns that have the _Prompt suffix.
Most prompts accept only a single value, but prompts that accept multiple values can be set with IN or equals:
SELECT * FROM [Account Balance Data] WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde') AND Region_Prompt = 'ef1234567890abcd' AND Include_Managers_Prompt = TRUE AND Start_Date_Prompt = '2022-01-01'
Other filters may be included with prompts.
These do not affect the way Workday generates the report, but the Cloud removes non-matching rows from the response:
SELECT * FROM [Account Balance Data] /* Prompts */ WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde') AND Region_Prompt = 'ef1234567890abcd' AND Include_Managers_Prompt = TRUE AND Start_Date_Prompt = '2022-01-01' /* Other filters */ AND Department = 'Sales and Marketing' AND Account_Type = 'LIABILITY'
This section contains examples of views that may be accessible when ConnectionType is set to WQL. All the data sources used by these views are part of core Workday and the HCM module.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
allAllowancePlans | Accesses the Allowance Plan as the primary object and returns one row per plan. Includes all allowance plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time. |
allBonusPlans | Accesses the Bonus Plan as the primary object and returns one row per bonus plan. Includes all active bonus plans. Does not contain built-in prompts. The data source delivers the additions and removals for bonus plans over time. |
allCompensationPlans | Accesses the Compensation Plan as the primary object and returns one row per plan. Includes all active plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time. |
allCompensationRuleAssignments | Accesses the Compensation Rule as its primary object. The Compensation Rule object returns one row per Compensation Rule. Includes all Compensation Rules. Does not contain any built-in prompts. |
allJobProfiles | Accesses Job Profile as the primary object and returns one row per job profile. Includes all active and inactive job profiles. Does not contain built-in prompts. |
allMeritPlans | Accesses the Merit Plan as the primary object and returns one row per plan. Includes all active and inactive plans. Does not contain any built-in prompts. The data source delivers the additions and removals for plans over time. |
allOpenPositions | Accesses the Position as its primary object. The Position object returns one row per position. Includes only open positions that are in supervisory organizations that the user has access. Does not contain any built-in prompts. |
allPre_Hires | Accesses Pre-Hire as the primary object and returns one row per pre-hire. Includes all pre-hires as well as pre-hires converted to hires. Does not contain built-in prompts. |
allWorkdayAccounts | Accesses the Workday Account object and returns one row per Workday account. Includes all Workday accounts ever created, either currently enabled or not. Does not contain built-in prompts. This data source will show settings of the user login information and preferences in Workday. |
allWorkers | Accesses the Worker as its primary object and returns one row per worker. Includes all workers even workers to be hired in the future. Does not contain any built-in prompts. This data source can be used to build reports on all workers. Helpful Tips - 1) If the worker is hired in the future, all fields will be returned based on the effective date. 2) If no effective date is specified, the system will use the current date as the effective date. 3) If the effective date is less than the worker's hire date, no effective dated information (such as position information, compensation information and so on) will be returned. 4) If effective dated behavior is desired, use the "All Active and Terminated workers" data source instead. |
classes | Returns all classes accessible by the current user |
organizationsIManage | Accesses the Organization as its primary object. The Organization object returns one row per organization. Only includes supervisory organizations that the user manages. Prompts the user at run-time for Supervisory Organization to automatically filter the report results. |
positionsValidForCompensationSelectionRule | Accesses the Position Group as its primary object. The Position Group object returns one row per Position Group. Includes all unfilled and filled Positions. Prompts the user at run-time for a Compensation Rule to automatically filter the report results. |
topLevelOrganizations | Accesses the Organization object and returns one row per organization. Includes all active and inactive organizations with no superior. Does not contain built-in prompts. |
topLevelOrganizationsAndSubordinates | Accesses the Organization as its primary object. The Organization object returns one row per organization. |
Accesses the Allowance Plan as the primary object and returns one row per plan. Includes all allowance plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_CompensationPlanEqualToHourly | Bool | Compensation Plan = Hourly | |
cf_FrequencyForCompensationPlan_id | String | Frequency for Compensation Plan id | |
cf_FrequencyForCompensationPlan_descriptor | String | Frequency for Compensation Plan descriptor | |
cf_CompensationPlanEqualToAllowance | Bool | Compensation Plan = Allowance | |
cf_CompensationPlanEqualToBonus | Bool | Compensation Plan = Bonus | |
cf_CompensationPlanTypeEqualToMerit | Bool | Compensation Plan Type = Merit | |
cf_CompensationPlanEqualToCommission | Bool | Compensation Plan = Commission | |
cf_CompensationPlanEqualToStock | Bool | Compensation Plan = Stock | |
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Compensation Plan = Salary Plan (Unit, Period or Salary) | |
compensationPlanName | String | Compensation Plan Name | |
description | String | Description | |
compensationPlanDefaults_id | String | Compensation Plan Defaults id | |
compensationPlanDefaults_descriptor | String | Compensation Plan Defaults descriptor | |
compensationPlanProcessHistory | String | Compensation Plan Process History | |
compensationPackages | String | Compensation Packages | |
eligibilityRules | String | Eligibility Rules | |
compensationPlan_id | String | Compensation Plan id | |
compensationPlan_descriptor | String | Compensation Plan descriptor | |
positionsInCompensationPlan | String | Positions in Compensation Plan | |
employeesInCompensationPlan | String | Employees in Compensation Plan | |
calculationType_id | String | Calculation Type id | |
calculationType_descriptor | String | Calculation Type descriptor | |
calculation_id | String | Calculation id | |
calculation_descriptor | String | Calculation descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Bonus Plan as the primary object and returns one row per bonus plan. Includes all active bonus plans. Does not contain built-in prompts. The data source delivers the additions and removals for bonus plans over time.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_CompensationPlanEqualToHourly | Bool | Compensation Plan = Hourly | |
cf_FrequencyForCompensationPlan_id | String | Frequency for Compensation Plan id | |
cf_FrequencyForCompensationPlan_descriptor | String | Frequency for Compensation Plan descriptor | |
cf_CompensationPlanEqualToAllowance | Bool | Compensation Plan = Allowance | |
cf_CompensationPlanEqualToBonus | Bool | Compensation Plan = Bonus | |
cf_CompensationPlanTypeEqualToMerit | Bool | Compensation Plan Type = Merit | |
cf_CompensationPlanEqualToCommission | Bool | Compensation Plan = Commission | |
cf_CompensationPlanEqualToStock | Bool | Compensation Plan = Stock | |
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Compensation Plan = Salary Plan (Unit, Period or Salary) | |
compensationPlanName | String | Compensation Plan Name | |
description | String | Description | |
compensationPlanDefaults_id | String | Compensation Plan Defaults id | |
compensationPlanDefaults_descriptor | String | Compensation Plan Defaults descriptor | |
compensationPlanProcessHistory | String | Compensation Plan Process History | |
compensationPackages | String | Compensation Packages | |
eligibilityRules | String | Eligibility Rules | |
compensationPlan_id | String | Compensation Plan id | |
compensationPlan_descriptor | String | Compensation Plan descriptor | |
positionsInCompensationPlan | String | Positions in Compensation Plan | |
employeesInCompensationPlan | String | Employees in Compensation Plan | |
calculationType_id | String | Calculation Type id | |
calculationType_descriptor | String | Calculation Type descriptor | |
calculation_id | String | Calculation id | |
calculation_descriptor | String | Calculation descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Compensation Plan as the primary object and returns one row per plan. Includes all active plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_CompensationPlanEqualToHourly | Bool | Compensation Plan = Hourly | |
cf_FrequencyForCompensationPlan_id | String | Frequency for Compensation Plan id | |
cf_FrequencyForCompensationPlan_descriptor | String | Frequency for Compensation Plan descriptor | |
cf_CompensationPlanEqualToAllowance | Bool | Compensation Plan = Allowance | |
cf_CompensationPlanEqualToBonus | Bool | Compensation Plan = Bonus | |
cf_CompensationPlanTypeEqualToMerit | Bool | Compensation Plan Type = Merit | |
cf_CompensationPlanEqualToCommission | Bool | Compensation Plan = Commission | |
cf_CompensationPlanEqualToStock | Bool | Compensation Plan = Stock | |
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Compensation Plan = Salary Plan (Unit, Period or Salary) | |
compensationPlanName | String | Compensation Plan Name | |
description | String | Description | |
compensationPlanDefaults_id | String | Compensation Plan Defaults id | |
compensationPlanDefaults_descriptor | String | Compensation Plan Defaults descriptor | |
compensationPlanProcessHistory | String | Compensation Plan Process History | |
compensationPackages | String | Compensation Packages | |
eligibilityRules | String | Eligibility Rules | |
compensationPlan_id | String | Compensation Plan id | |
compensationPlan_descriptor | String | Compensation Plan descriptor | |
positionsInCompensationPlan | String | Positions in Compensation Plan | |
employeesInCompensationPlan | String | Employees in Compensation Plan | |
workdayID | String | Workday ID | |
referenceID1 | String | Reference ID | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Compensation Rule as its primary object. The Compensation Rule object returns one row per Compensation Rule. Includes all Compensation Rules. Does not contain any built-in prompts.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
positionsAndPositionGroupsSelectedByCompensationRule | String | Positions and Position Groups Selected by Compensation Rule | |
compensationRuleName | String | Compensation Rule Name | |
compensationRuleAssignment_id | String | Compensation Rule Assignment id | |
compensationRuleAssignment_descriptor | String | Compensation Rule Assignment descriptor | |
compensationComponents | String | Compensation Components | |
employeesSelectedByCompensationRule | String | Employees Selected by Compensation Rule | |
compensationGradeProfiles | String | Compensation Grade Profiles | |
compensationGrades | String | Compensation Grades | |
compensationPlans | String | Compensation Plans | |
compensationPackages | String | Compensation Packages | |
workdayID | String | Workday ID | |
compensationEligibilityRule_id | String | Compensation Eligibility Rule id | |
compensationEligibilityRule_descriptor | String | Compensation Eligibility Rule descriptor | |
referenceID | String | Reference ID | |
createdMoment | Date | Created Moment | |
lastFunctionallyUpdated | Date | Last Functionally Updated | |
currentOMSVersion_id | String | Current OMS Version id | |
currentOMSVersion_descriptor | String | Current OMS Version descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses Job Profile as the primary object and returns one row per job profile. Includes all active and inactive job profiles. Does not contain built-in prompts.
Name | Type | References | Description |
cf_JobProfileDegrees | String | Job Profile Degrees | |
cf_CompensationSurvey | String | Compensation Survey | |
cf_JobEvaluationScore | String | Job Evaluation Score | |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_countriesWherePayRateTypeEqualToSalaried | String | Countries where Pay Rate Type = Salaried | |
cf_countriesWherePayRateTypeEqualToHourly | String | Countries where Pay Rate Type = Hourly | |
cf_CompensationGroup_id | String | Compensation Group id | |
cf_CompensationGroup_descriptor | String | Compensation Group descriptor | |
jobProfileName | String | Job Profile Name | |
jobFamilyGroupAndFamily | String | All Job Families and Groups for Job Profile | |
jobProfileSummary | String | Job Profile Summary | |
jobProfile_id | String | Job Profile id | |
jobProfile_descriptor | String | Job Profile descriptor | |
jobClassifications | String | Job Classifications | |
managementLevel_id | String | Management Level id | |
managementLevel_descriptor | String | Management Level descriptor | |
ID | String | ID | |
compensationGradesImpactedByRules | String | Compensation Grades impacted by rules | |
jobExempt | Bool | Job Exempt | |
averagePay_Amount_value | Decimal | Average Pay - Amount value | |
averagePay_Amount_currency | String | Average Pay - Amount currency | |
employeeCount | Int | Employee Count | |
highestPay_Amount_value | Decimal | Highest Pay - Amount value | |
highestPay_Amount_currency | String | Highest Pay - Amount currency | |
lowestPay_Amount_value | Decimal | Lowest Pay - Amount value | |
lowestPay_Amount_currency | String | Lowest Pay - Amount currency | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Merit Plan as the primary object and returns one row per plan. Includes all active and inactive plans. Does not contain any built-in prompts. The data source delivers the additions and removals for plans over time.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_CompensationPlanEqualToHourly | Bool | Compensation Plan = Hourly | |
cf_FrequencyForCompensationPlan_id | String | Frequency for Compensation Plan id | |
cf_FrequencyForCompensationPlan_descriptor | String | Frequency for Compensation Plan descriptor | |
cf_CompensationPlanEqualToAllowance | Bool | Compensation Plan = Allowance | |
cf_CompensationPlanEqualToBonus | Bool | Compensation Plan = Bonus | |
cf_CompensationPlanTypeEqualToMerit | Bool | Compensation Plan Type = Merit | |
cf_CompensationPlanEqualToCommission | Bool | Compensation Plan = Commission | |
cf_CompensationPlanEqualToStock | Bool | Compensation Plan = Stock | |
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Compensation Plan = Salary Plan (Unit, Period or Salary) | |
compensationPlanName | String | Compensation Plan Name | |
description | String | Description | |
compensationPlanDefaults_id | String | Compensation Plan Defaults id | |
compensationPlanDefaults_descriptor | String | Compensation Plan Defaults descriptor | |
compensationPlanProcessHistory | String | Compensation Plan Process History | |
compensationPackages | String | Compensation Packages | |
eligibilityRules | String | Eligibility Rules | |
compensationPlan_id | String | Compensation Plan id | |
compensationPlan_descriptor | String | Compensation Plan descriptor | |
positionsInCompensationPlan | String | Positions in Compensation Plan | |
employeesInCompensationPlan | String | Employees in Compensation Plan | |
workdayID | String | Workday ID | |
referenceID1 | String | Reference ID | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Position as its primary object. The Position object returns one row per position. Includes only open positions that are in supervisory organizations that the user has access. Does not contain any built-in prompts.
Name | Type | References | Description |
cf_SupervisoryOrganizationHierarchy_id | String | Supervisory Organization Hierarchy id | |
cf_SupervisoryOrganizationHierarchy_descriptor | String | Supervisory Organization Hierarchy descriptor | |
cf_EarliestHireDate_Quarter | String | Earliest Hire Date - Quarter | |
cf_MonthsFromEarliestHireDate | Int | Months from Earliest Hire Date | |
cf_TimeToFill1 | Int | Time to Fill | |
cf_OpenPositionCountAtEndOfLastQuarter | Int | Open Position Count at End of Last Quarter | |
cf_ExecutiveGroup1_id | String | Executive Group id | |
cf_ExecutiveGroup1_descriptor | String | Executive Group descriptor | |
cf_AnnualPositionBurdenInUSD1_value | Decimal | Annual Position Burden in USD value | |
cf_AnnualPositionBurdenInUSD1_currency | String | Annual Position Burden in USD currency | |
cf_DaysFromEarliestHireDate | Int | Days from Earliest Hire Date | |
cf_NumberOfMonthsPositionUnfilled | Int | # of Months Position Unfilled | |
cf_PositionCount_Frozen | Int | Position Count - Frozen | |
cf_AnnualPositionBurdenInUSDOpenPositionsOnly_value | Decimal | Annual Position Burden in USD (Open Positions Only) value | |
cf_AnnualPositionBurdenInUSDOpenPositionsOnly_currency | String | Annual Position Burden in USD (Open Positions Only) currency | |
cf_IsPositionOpenAndEarliestHireDateCurrent | Bool | Is Position Open and Earliest Hire Date Current | |
cf_EarliestHireDate9Months1 | Date | Earliest Hire Date + 9 Months | |
cf_CompensationRangeMidpointInUSD_value | Decimal | Compensation Range Midpoint in USD value | |
cf_CompensationRangeMidpointInUSD_currency | String | Compensation Range Midpoint in USD currency | |
cf_EarliestHireDate6Months1 | Date | Earliest Hire Date + 6 Months | |
cf_OpenPositionCount_GAndA | Int | Open Position Count - G and A | |
cf_TimeInPositionRange_id | String | Time in Position Range id | |
cf_TimeInPositionRange_descriptor | String | Time in Position Range descriptor | |
cf_IsInGAndA | Bool | Is in G and A | |
cf_AvailableYearQuarter | String | Available Year Quarter | |
cf_EarliestHireDate3Months1 | Date | Earliest Hire Date + 3 Months | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses Pre-Hire as the primary object and returns one row per pre-hire. Includes all pre-hires as well as pre-hires converted to hires. Does not contain built-in prompts.
Name | Type | References | Description |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
cf_WorkerCountryISOCodeOnExpensePayee | String | Worker Country ISO Code on Expense Payee | |
pre_Hire_id | String | Pre-Hire id | |
pre_Hire_descriptor | String | Pre-Hire descriptor | |
source_id | String | Source id | |
source_descriptor | String | Source descriptor | |
referredBy | String | Referred by | |
pre_HirePools | String | Pre-Hire Pools | |
datePre_HireAddedToSystem | Date | Date Pre-Hire Added to System | |
notEligibleForHireComment | String | Eligible for Rehire Comment | |
comment | String | Comment | |
resume | String | Resume | |
pre_HireConsideration | String | Pre-Hire Consideration | |
availableForHire | Bool | Available For Hire | |
roleName | String | Role Name | |
email_Primary | String | Email - Primary | |
phone_Primary | String | Phone - Primary | |
organizationRoleAssignments | String | Organization Role Assignments | |
integrationIdentifier | String | Integration Identifier | |
organizationRoles | String | Organization Roles | |
externalIDForSystemID | String | External ID for System ID | |
raceEthnicity_id | String | Race/Ethnicity id | |
raceEthnicity_descriptor | String | Race/Ethnicity descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Workday Account object and returns one row per Workday account. Includes all Workday accounts ever created, either currently enabled or not. Does not contain built-in prompts. This data source will show settings of the user login information and preferences in Workday.
Name | Type | References | Description |
forUnitTestingMulti | String | For Unit Testing Multi | |
cf_ClickableAddedRoleAssignments | String | Clickable Added Role Assignments | |
cf_ClickableRemovedRoleAssignments | String | Clickable Removed Role Assignments | |
cf_SecurityGroupsWithAccessToSettlePayments_Payroll | String | Security Groups with Access to Settle Payments - Payroll | |
cf_SecurityGroupsWithAccessToInputEditOrProcessPayroll | String | Security Groups with Access to Input , Edit or Process Payroll | |
cf_SecurityGroupsWithAccessToRefundCustomers | String | Security Groups with access to refund customers | |
cf_SecurityGroupsWithAccessToCreateModifyCustomers | String | Security Groups with access to create / modify customers | |
cf_ReportsAndTasks_View | String | Reports and Tasks - View | |
cf_SecurityGroupsWithAccessToCreateModifySuppliers | String | Security Groups with access to create / modify suppliers | |
cf_ReportsAndTasks_Modify | String | Reports and Tasks - Modify | |
cf_SecurityGroupsWithAccessToCreateEditSupplierInvoices | String | Security Groups with access to create / edit supplier invoices | |
cf_BusinessProcessPolicy_Approve | String | Business Process Policy - Approve | |
cf_BusinessProcessPolicy_Cancel | String | Business Process Policy - Cancel | |
cf_SecurityGroupsWithAccessToSettlePayments_Suppliers | String | Security Groups with Access to Settle Payments - Suppliers | |
cf_BusinessProcessPolicy_Rescind | String | Business Process Policy - Rescind | |
cf_SecurityGroupsWithAccessToCreateModifyExpenseReports | String | Security Groups with access to create / modify expense reports | |
cf_BusinessProcessPolicy_Initiate | String | Business Process Policy - Initiate | |
cf_SecurityGroupsWithAccessToSettlePayments_Expenses | String | Security Groups with Access to Settle Payments - Expenses | |
cf_BusinessProcessPolicy_View | String | Business Process Policy - View | |
cf_BusinessProcessPolicy_ViewCompleted | String | Business Process Policy - View Completed | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Worker as its primary object and returns one row per worker. Includes all workers even workers to be hired in the future. Does not contain any built-in prompts. This data source can be used to build reports on all workers. Helpful Tips - 1) If the worker is hired in the future, all fields will be returned based on the effective date. 2) If no effective date is specified, the system will use the current date as the effective date. 3) If the effective date is less than the worker's hire date, no effective dated information (such as position information, compensation information and so on) will be returned. 4) If effective dated behavior is desired, use the "All Active and Terminated workers" data source instead.
Name | Type | References | Description |
cf_ContractPayRateAnnualized_value | Decimal | Contract Pay Rate Annualized value | |
cf_ContractPayRateAnnualized_currency | String | Contract Pay Rate Annualized currency | |
cf_NumberOfTerminations | Int | # of Terminations | |
cf_DisciplinaryActions_Completed | String | Disciplinary Actions - Completed | |
cf_RetirementEligibility_id | String | Retirement Eligibility id | |
cf_RetirementEligibility_descriptor | String | Retirement Eligibility descriptor | |
cf_LocationSiteHierarchyLevel2_id | String | Location Site Hierarchy (Level 2) id | |
cf_LocationSiteHierarchyLevel2_descriptor | String | Location Site Hierarchy (Level 2) descriptor | |
cf_TotalBasePayAnnualizedInCAD_Amount_value | Decimal | Total Base Pay Annualized in CAD - Amount value | |
cf_TotalBasePayAnnualizedInCAD_Amount_currency | String | Total Base Pay Annualized in CAD - Amount currency | |
cf_TotalBasePayHourly_Amount_value | Decimal | Total Base Pay Hourly - Amount value | |
cf_TotalBasePayHourly_Amount_currency | String | Total Base Pay Hourly - Amount currency | |
cf_PrimaryAddressHomeStateText | String | Primary Address Home State (Text) | |
cf_NumberOfHires | Int | # of Hires | |
cf_SpendAuthorizationsNotInUseByActiveExpenseReports | String | Spend Authorizations Not In Use by Active Expense Reports | |
cf_FormatPercentOfExpenseReportsWithWarningValidations | String | Format Percent of Expense Reports with Warning Validations | |
cf_LegalName_LastNameUppercase | String | Legal Name - Last Name (Uppercase) | |
cf_Apparel | String | Apparel | |
cf_TopLevelSupervisoryOrganizationGMS_id | String | Top Level Supervisory Organization (GMS) id | |
cf_TopLevelSupervisoryOrganizationGMS_descriptor | String | Top Level Supervisory Organization (GMS) descriptor | |
cf_HireDate90Days | Date | Hire Date + 90 Days | |
cf_TotalBasePayAnnualizedInEUR_Amount_value | Decimal | Total Base Pay Annualized in EUR - Amount value | |
cf_TotalBasePayAnnualizedInEUR_Amount_currency | String | Total Base Pay Annualized in EUR - Amount currency | |
cf_TotalBasePayMonthly_Amount_value | Decimal | Total Base Pay Monthly - Amount value | |
cf_TotalBasePayMonthly_Amount_currency | String | Total Base Pay Monthly - Amount currency | |
cf_PerformanceImprovementPlans_InProgressOrCompleted | String | Performance Improvement Plans - In Progress or Completed | |
cf_ExternalPayrollActualHoursWorkedInLast12Months | Int | External Payroll Actual Hours Worked in Last 12 Months | |
cf_PreferredName_LastNameUppercase | String | Preferred Name - Last Name (Uppercase) | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Returns all classes accessible by the current user
Name | Type | References | Description |
class1_id | String | Class id | |
class1_descriptor | String | Class descriptor | |
classOfInstance1_id | String | Class of Instance id | |
classOfInstance1_descriptor | String | Class of Instance descriptor | |
superclasses | String | Superclasses | |
instanceSet1_id | String | Instance Set id | |
instanceSet1_descriptor | String | Instance Set descriptor | |
name1 | String | Name | |
metadata | Bool | Metadata | |
countClassReportFieldForClass | Int | Count Class Report Field for Class | |
totalInstancesOfClassIncludingSubclasses | Int | Total Instances of Class Including Subclasses | |
comment | String | Comment | |
classReportFieldsForClassAndSuperClasses | String | Class Report Fields for Class and Super Classes | |
DEPRECATED | Bool | DEPRECATED | |
translatableDataForClassOrSupersOrSubs | String | Translatable Data for Class or Supers or Subs | |
securityGroups1 | String | Security Groups | |
iManSetupDataClass_id | String | iMan Setup Data class id | |
iManSetupDataClass_descriptor | String | iMan Setup Data class descriptor | |
setupDataClass_id | String | Setup Data class id | |
setupDataClass_descriptor | String | Setup Data class descriptor | |
workdayID | String | Workday ID | |
businessObjectName | String | Business Object Name | |
customerAccessibleReportFields | String | Customer Accessible Report Fields | |
customerAccessibleDataSources | String | Customer Accessible Data Sources | |
secured_id | String | Secured id | |
secured_descriptor | String | Secured descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Organization as its primary object. The Organization object returns one row per organization. Only includes supervisory organizations that the user manages. Prompts the user at run-time for Supervisory Organization to automatically filter the report results.
Name | Type | References | Description |
cf_BusinessUnitManager_id | String | Business Unit Manager id | |
cf_BusinessUnitManager_descriptor | String | Business Unit Manager descriptor | |
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Terminations Count - Including Subordinate Organizations | |
cf_CompanyCostingManager_id | String | Company Costing Manager id | |
cf_CompanyCostingManager_descriptor | String | Company Costing Manager descriptor | |
cf_CostCenterManager_id | String | Cost Center Manager id | |
cf_CostCenterManager_descriptor | String | Cost Center Manager descriptor | |
cf_ManagerCount_IncludingSubordinateOrganizations | Int | Manager Count - Including Subordinate Organizations | |
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Beginning Employee Count - Including Subordinate Organizations | |
cf_RegionCostingManager_id | String | Region Costing Manager id | |
cf_RegionCostingManager_descriptor | String | Region Costing Manager descriptor | |
cf_MidYearReviewPercentCompleteRange_id | String | Mid Year Review Percent Complete Range id | |
cf_MidYearReviewPercentCompleteRange_descriptor | String | Mid Year Review Percent Complete Range descriptor | |
cf_EmployeeVoluntaryTerminationsCount | Int | Employee Voluntary Terminations Count | |
cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Ending Employee Count - Including Subordinate Organizations | |
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Voluntary Terminations Count - including Subordinate Organizations | |
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Ending Contingent Worker Count - Including Subordinate Organizations | |
cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average Headcount - Including Subordinate Organizations | |
cf_SupervisoryOrganizationHierarchy_id | String | Supervisory Organization Hierarchy id | |
cf_SupervisoryOrganizationHierarchy_descriptor | String | Supervisory Organization Hierarchy descriptor | |
cf_BeginningContingentWorkerCountInclSubOrgs | Int | Beginning Contingent Worker Count (incl Sub Orgs) | |
cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover Percent - Including Subordinate Organizations | |
cf_OrgHierarchy_id | String | Org Hierarchy id | |
cf_OrgHierarchy_descriptor | String | Org Hierarchy descriptor | |
cf_EmployeeToManagerRatio | Int | Employee to Manager Ratio | |
cf_TopPerformerEmployeeCount | Int | Top Performer Employee Count | |
cf_BeginningEmployeeCount | Int | Beginning Employee Count | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Position Group as its primary object. The Position Group object returns one row per Position Group. Includes all unfilled and filled Positions. Prompts the user at run-time for a Compensation Rule to automatically filter the report results.
Name | Type | References | Description |
cf_SupervisoryOrganizationHierarchy_id | String | Supervisory Organization Hierarchy id | |
cf_SupervisoryOrganizationHierarchy_descriptor | String | Supervisory Organization Hierarchy descriptor | |
cf_TimeInPositionRange_id | String | Time in Position Range id | |
cf_TimeInPositionRange_descriptor | String | Time in Position Range descriptor | |
cf_PositionsFrozen | Int | Positions Frozen | |
cf_QuarterAvailable | String | Quarter Available | |
cf_PositionText | String | Position Text | |
cf_AnnualPositionBurdenInUSD_value | Decimal | Annual Position Burden in USD value | |
cf_AnnualPositionBurdenInUSD_currency | String | Annual Position Burden in USD currency | |
cf_NumberOfMonthsUnfilledRange_id | String | Number of Months Unfilled Range id | |
cf_NumberOfMonthsUnfilledRange_descriptor | String | Number of Months Unfilled Range descriptor | |
cf_EarliestHireDate9Months | Date | Earliest Hire Date + 9 Months | |
cf_TimeInPosition_Days | Int | Time in Position - Days | |
cf_AnnualEmployeeBurdenInUSD_value | Decimal | Annual Employee Burden in USD value | |
cf_AnnualEmployeeBurdenInUSD_currency | String | Annual Employee Burden in USD currency | |
cf_DefaultCompensationRangeMidpointInUSD_value | Decimal | Default Compensation Range Midpoint in USD value | |
cf_DefaultCompensationRangeMidpointInUSD_currency | String | Default Compensation Range Midpoint in USD currency | |
cf_EarliestHireDate6Months | Date | Earliest Hire Date + 6 Months | |
cf_AnnualContingentWorkerBurdenInUSD_value | Decimal | Annual Contingent Worker Burden in USD value | |
cf_AnnualContingentWorkerBurdenInUSD_currency | String | Annual Contingent Worker Burden in USD currency | |
cf_EarliestHireDate3Months | Date | Earliest Hire Date + 3 Months | |
cf_MyOrganizations_id | String | My Organizations id | |
cf_MyOrganizations_descriptor | String | My Organizations descriptor | |
cf_PositionCount_AllStatuses | Int | Position Count - All Statuses | |
cf_AnnualCompensationPayWithBurdenInUSD_value | Decimal | Annual Compensation / Pay with Burden in USD value | |
cf_AnnualCompensationPayWithBurdenInUSD_currency | String | Annual Compensation / Pay with Burden in USD currency | |
cf_Worker_id | String | Worker id | |
cf_Worker_descriptor | String | Worker descriptor | |
cf_AnnualCompensationPayInUSD_value | Decimal | Annual Compensation / Pay in USD value | |
cf_AnnualCompensationPayInUSD_currency | String | Annual Compensation / Pay in USD currency | |
cf_WorkerType_id | String | Worker Type id | |
cf_WorkerType_descriptor | String | Worker Type descriptor | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Organization object and returns one row per organization. Includes all active and inactive organizations with no superior. Does not contain built-in prompts.
Name | Type | References | Description |
cf_BusinessUnitManager_id | String | Business Unit Manager id | |
cf_BusinessUnitManager_descriptor | String | Business Unit Manager descriptor | |
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Terminations Count - Including Subordinate Organizations | |
cf_CompanyCostingManager_id | String | Company Costing Manager id | |
cf_CompanyCostingManager_descriptor | String | Company Costing Manager descriptor | |
cf_CostCenterManager_id | String | Cost Center Manager id | |
cf_CostCenterManager_descriptor | String | Cost Center Manager descriptor | |
cf_ManagerCount_IncludingSubordinateOrganizations | Int | Manager Count - Including Subordinate Organizations | |
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Beginning Employee Count - Including Subordinate Organizations | |
cf_RegionCostingManager_id | String | Region Costing Manager id | |
cf_RegionCostingManager_descriptor | String | Region Costing Manager descriptor | |
cf_MidYearReviewPercentCompleteRange_id | String | Mid Year Review Percent Complete Range id | |
cf_MidYearReviewPercentCompleteRange_descriptor | String | Mid Year Review Percent Complete Range descriptor | |
cf_EmployeeVoluntaryTerminationsCount | Int | Employee Voluntary Terminations Count | |
cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Ending Employee Count - Including Subordinate Organizations | |
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Voluntary Terminations Count - including Subordinate Organizations | |
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Ending Contingent Worker Count - Including Subordinate Organizations | |
cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average Headcount - Including Subordinate Organizations | |
cf_SupervisoryOrganizationHierarchy_id | String | Supervisory Organization Hierarchy id | |
cf_SupervisoryOrganizationHierarchy_descriptor | String | Supervisory Organization Hierarchy descriptor | |
cf_BeginningContingentWorkerCountInclSubOrgs | Int | Beginning Contingent Worker Count (incl Sub Orgs) | |
cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover Percent - Including Subordinate Organizations | |
cf_OrgHierarchy_id | String | Org Hierarchy id | |
cf_OrgHierarchy_descriptor | String | Org Hierarchy descriptor | |
cf_EmployeeToManagerRatio | Int | Employee to Manager Ratio | |
cf_TopPerformerEmployeeCount | Int | Top Performer Employee Count | |
cf_BeginningEmployeeCount | Int | Beginning Employee Count | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
Accesses the Organization as its primary object. The Organization object returns one row per organization.
Name | Type | References | Description |
cf_BusinessUnitManager_id | String | Business Unit Manager id | |
cf_BusinessUnitManager_descriptor | String | Business Unit Manager descriptor | |
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Terminations Count - Including Subordinate Organizations | |
cf_CompanyCostingManager_id | String | Company Costing Manager id | |
cf_CompanyCostingManager_descriptor | String | Company Costing Manager descriptor | |
cf_CostCenterManager_id | String | Cost Center Manager id | |
cf_CostCenterManager_descriptor | String | Cost Center Manager descriptor | |
cf_ManagerCount_IncludingSubordinateOrganizations | Int | Manager Count - Including Subordinate Organizations | |
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Beginning Employee Count - Including Subordinate Organizations | |
cf_RegionCostingManager_id | String | Region Costing Manager id | |
cf_RegionCostingManager_descriptor | String | Region Costing Manager descriptor | |
cf_MidYearReviewPercentCompleteRange_id | String | Mid Year Review Percent Complete Range id | |
cf_MidYearReviewPercentCompleteRange_descriptor | String | Mid Year Review Percent Complete Range descriptor | |
cf_EmployeeVoluntaryTerminationsCount | Int | Employee Voluntary Terminations Count | |
cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Ending Employee Count - Including Subordinate Organizations | |
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Employee Voluntary Terminations Count - including Subordinate Organizations | |
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Ending Contingent Worker Count - Including Subordinate Organizations | |
cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average Headcount - Including Subordinate Organizations | |
cf_SupervisoryOrganizationHierarchy_id | String | Supervisory Organization Hierarchy id | |
cf_SupervisoryOrganizationHierarchy_descriptor | String | Supervisory Organization Hierarchy descriptor | |
cf_BeginningContingentWorkerCountInclSubOrgs | Int | Beginning Contingent Worker Count (incl Sub Orgs) | |
cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover Percent - Including Subordinate Organizations | |
cf_OrgHierarchy_id | String | Org Hierarchy id | |
cf_OrgHierarchy_descriptor | String | Org Hierarchy descriptor | |
cf_EmployeeToManagerRatio | Int | Employee to Manager Ratio | |
cf_TopPerformerEmployeeCount | Int | Top Performer Employee Count | |
cf_BeginningEmployeeCount | Int | Beginning Employee Count | |
effectiveAsOfDate | Date | Pseudo-column used to filter the data source | |
effectiveAsOfMoment | Datetime | Pseudo-column used to filter the data source | |
entryDate | Date | Pseudo-column used to filter the data source | |
entryMoment | Datetime | Pseudo-column used to filter the data source |
This section lists all the tables and views supported when ConnectionType is set to REST.
The Workday REST API contains different types of entities that must each be accessed in separate ways. Which category a table belongs to affects its performance, structure, and imposes different requirements inserting and modifying rows.
Each type of table has its own rules for determining primary and foreign keys. Foreign keys are always prefixed with the name of the table they refer to. For example, the Requisitions_Id column on the RequisitionsWorktags child table refers to the Id column of the Requisitions parent table.
In addition, each type of table exposes different prompt columns. The next section goes into detail on when these prompts take effect.
Each type of table handles filters on its Id columns differently:
Each type of table also has its own behaviors around prompts:
Owned and owned child tables have the additional requirement that their owner's Id must be given in order to read from them.
This can be done in several ways:
-- Provide one or multiple owner Id values SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id = '...' SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id IN ('...', '...') --- Provide a collection of owner Ids via subquery SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id IN (SELECT Id FROM Requisitions) -- If no subquery or values are given, the Cloud automatically adds the appropriate subquery SELECT * FROM RequisitionsRequisitionLines
Prompts are also considered when the Cloud generates subqueries for owned and owned child entities.
For example, if this query is executed:
SELECT * FROM RequisitionsRequisitionLines WHERE FromDate_Prompt = 'January 1 2020' AND ToDate_Prompt = 'March 31 2020'
The Cloud includes the date prompts in the generated subquery because they are inherited from the Requisitions table:
SELECT * FROM RequisitionsRequisitionLines WHERE Requisisions_Id IN ( SELECT Id FROM Requisitions WHERE FromDate_Prompt = 'January 1 2020' AND ToDate_Prompt = 'March 31 2020' )
Note that some owned tables include prompts with a _Prompt_For_ suffix. This means that both the owned table and the owner table have a prompt with the same name. For example, DataSourcesDataSourceFilters includes a prompt called Alias_Prompt which accepts the alias of the filter, as well as a prompt called Alias_Prompt_For_DataSources which accepts the alias of the data source that owns the filter.
Some REST entities are tables that can be used with INSERT, UPDATE, or DELETE. However, note that not every table supports every operation.
To perform an INSERT, the query must specify owner and parent Ids (when the table has them) in addition to writable data fields.
An INSERT must never include values for the Id column or any prompts.
For example, all of these queries are valid INSERTs:
-- No Id on a base table INSERT INTO ExpenseEntries(Amount_Currency, Amount_Value, Date) VALUES ('USD', 185.67, 'June 1 2021') -- Parent Id on a child table INSERT INTO ExpenseEntriesAttachments(ExpenseEntries_Id, ContentType_Id, FileName) VALUES ('...', '...', 'receipt.jpg') -- Owner Id on an owned table INSERT INTO WorkersBusinessTitleChanges(Workers_Id, ProposedBusinessTitle) VALUES ('...', 'Head of Security')
Ids are not required to perform an UPDATE or a DELETE.
If the Id, parent Id or owner Id is missing the Cloud will first find all matching rows and then update or delete them individually:
-- Delete a single row by Id DELETE FROM ExpenseEntries WHERE Id = '...' -- Delete a single child row by Id DELETE FROM ExpenseEntriesAttachments WHERE Id = '...' AND ExpenseEntries_Id = '...' -- Delete all children belonging to the same parent DELETE FROM ExpenseEntriesAttachments WHERE Id = '...'
The Workday REST API exposes several resources that allow you to discover ID values, which can be used for certain fields. All value tables have names ending in Values and share the same basic structure:
CollectionToken column and Collection_Prompt are used for hierarchical resources like location data or organizations. You must issue multiple queries to get prompt values out of these resources:
The Workday REST API has a concept of change resources, which are used to configure and execute certain business processes. The Cloud supports these change resources by providing a family of tables and stored procedures that act on each business process. For example, the Change Organization Assignment business process has two stored procedures, BeginOrganizationAssignmentChange and SubmitOrganizationAssignmentChange, along with several tables that control the parameters of the business process.
At a high level, the procedure for invoking these business processes is as follows:
The Cloud exposes two types of change tables: collection change tables and single-value change tables.
Collection change tables support SELECT, INSERT, UPDATE, and DELETE.
They represent bulk changes that are applied to an entity, such as adding multiple addresses or phone numbers to a single worker.
SELECT * FROM WorkContactInformationChangesWebAddresses WHERE WorkContactInformationChange_Id = 'abcxyz123' INSERT INTO WorkContactInformationChangesWebAddresses( WorkContactInformationChange_Id, Url, Usage_Primary, Usage_UsageType_Id) VALUES ('abcxyz123', 'https://www.company.com/~bobsmith', true, '...') UPDATE WorkContactInformationChangesWebAddresses SET Usage_Comment = 'Worker home page' WHERE WorkContactInformationChange_Id = 'abcxyz123' AND Id = '...' DELETE FROM WorkContactInformationChangesWebAddresses WHERE WorkContactInformationChange_Id = 'abcxyz123'
Single-value change tables support only SELECT and UPDATE.
They represent parameters that can have only a single value in the entire business process.
For example, when changing a job's organization, the job can only be moved to a single target company.
SELECT * FROM OrganizationAssignmentChangesCompany WHERE OrganizationAssignmentChange_Id = 'abcxyz123' UPDATE OrganizationAssignmentChangesCompany SET Company_Id = '...' WHERE OrganizationAssignmentChange_Id = 'abcxyz123'
Refer to the documentation for each specific change table to see what operations it supports.
The Cloud models the data in Workday as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
AdHocProjectTimeTransactions | Retrieves an ad hoc project time transaction instance. |
Attachments | Will return attachments |
BillableTransactions | Retrieves a single billable transaction instance. |
Cases | Retrieves a case with the specified ID that the user is secured to view. |
CasesTimeline | Retrieves a comment timeline item for a case with the specified timeline ID. |
EventDrivenIntegrationVendorResponse | Retrieves a single Event-Driven Integration vendor response. |
ExpenseEntries | Retrieves a single instance of a Quick Expense. |
ExpenseEntriesAttachments | Reads attachments entries from the ExpenseEntries table |
ExpenseReports | Retrieves a single instance of an Expense Report. |
ExternalCreators | Retrieves contact details for a single external \~case\~ contact instance. |
HomeContactInformationChangesAddresses | An address as it exists staged for update by the parent business process. |
HomeContactInformationChangesEmailAddresses | An email address as it exists staged for update by the parent business process. |
HomeContactInformationChangesInstantMessengers | An instant messenger as it exists staged for update by the parent business process. |
HomeContactInformationChangesPhoneNumbers | A phone number as it exists staged for update by the parent business process. |
HomeContactInformationChangesWebAddresses | A web address as it exists staged for update by the parent business process. |
ImmigrationEventsDependentImmigrationData | Retrieves a dependent immigration data instance for the specified student ID. |
ImmigrationEventsImmigrationData | Retrieves an immigration data instance for the specified immigration event. |
InterviewsFeedback | No description available |
JobChangesAdministrative | Retrieves the administrative options for the specified job change ID. |
JobChangesBusinessTitle | Retrieves a business title for the specified job change ID. |
JobChangesComment | Returns the comment information for the specified job change ID. |
JobChangesContract | Retrieves the contract options for the specified change job ID. |
JobChangesJobClassification | Retrieves a job classification for the specified job change ID. |
JobChangesJobProfile | Retrieves a job profile for the specified job change ID. |
JobChangesLocation | Returns the location information for the specified job change ID. |
JobChangesMoveTeam | Retrieves a move team option from the specified job change ID. |
JobChangesOpening | Retrieves the opening options for the specified job change ID. |
JobChangesPosition | Retrieves a position for the specified job change ID. |
JobChangesStartDetails | Retrieves the start details for the specified job change ID. |
MessageTemplates | Retrieves a message template with the specific ID. |
OrganizationAssignmentChangesBusinessUnit | Retrieves a business unit for the specified organization assignment change ID. |
OrganizationAssignmentChangesComment | Retrieves the comment information for the specified organization assignment change ID. |
OrganizationAssignmentChangesCompany | Retrieves a company for the specified organization assignment change ID. |
OrganizationAssignmentChangesCostCenter | Retrieves a cost center for the specified organization assignment change ID. |
OrganizationAssignmentChangesCosting | Retrieves the costing organizations for the specified organization assignment change ID. |
OrganizationAssignmentChangesCustomOrganizations | Retrieves the custom organizations for the specified organization assignment change ID. |
OrganizationAssignmentChangesRegion | Retrieves a region for the specified organization assignment change ID. |
OrganizationAssignmentChangesStartDetails | Retrieves the start details for the specified organization assignment change ID. |
PayGroupsPeriods | Retrieves a payroll period for the specified Payroll Interface pay group ID. |
Payments | Retrieves a single customer invoice payment instance. |
PaymentsRemittanceDetails | Retrieves a single customer invoice payment remittance line instance. |
PayrollInputs | Retrieves a single payroll input instance. |
PayrollInputsInputDetails | Reads inputDetails entries from the PayrollInputs table |
PayrollInputsRunCategories | Reads runCategories entries from the PayrollInputs table |
PayrollInputsWorktags | Reads worktags entries from the PayrollInputs table |
PlanPhases | Retrieves a single project plan phase instance. |
PlanTasks | Retrieves a single project plan task instance. |
Projects | Retrieves a single project instance. |
Prospects | Retrieves a single \~prospect\~ instance. |
ProspectsEducations | Retrieves a single education instance for a \~prospect\~. |
ProspectsExperiences | Retrieves a single experience instance for a \~prospect\~. |
ProspectsLanguages | Retrieves a single language instance for a \~prospect\~. |
ProspectsResumeAttachments | Retrieves a single resume attachment instance for a \~prospect\~. |
ProspectsSkills | Retrieves a single skill instance for a \~prospect\~. |
Requests | Retrieves the request with the specified ID. |
Requisitions | Retrieves a requisition. |
RequisitionsAttachments | Retrieves the metadata or the attachment content of the specified requisition. |
RequisitionsRequisitionLines | Retrieves a requisition line for the specified requisition. |
RequisitionsRequisitionLinesWorktags | Reads worktags entries from the RequisitionsRequisitionLines table |
RequisitionsWorktags | Reads worktags entries from the Requisitions table |
ResourceForecastLinesAllocations | Retrieve Resource Forecast Line Allocation. |
ResourcePlanLines | Retrieves a single resource plan line instance. |
ScorecardResults | Provides the ability to set up and retrieve Scores on Scorecard Results. |
Scorecards | Retrieves Compensation Scorecard information. |
ScorecardsDefaultScorecardGoals | Reads defaultScorecardGoals entries from the Scorecards table |
ScorecardsScorecardProfiles | Reads scorecardProfiles entries from the Scorecards table |
StudentsPayments | Retrieves a single student payment instance for the specified student ID. |
SupplierInvoiceRequests | Retrieves a single supplier invoice instance. |
SupplierInvoiceRequestsAttachments | Retrieves a single attachment instance. |
TaskResources | Retrieves a single task resource instance. |
TaskResourcesProjectResources | Reads projectResources entries from the TaskResources table |
TimeClockEvents | Retrieves a time clock event. |
WorkContactInformationChangesAddresses | An address as it exists staged for update by the parent business process. |
WorkContactInformationChangesEmailAddresses | An email address as it exists staged for update by the parent business process. |
WorkContactInformationChangesInstantMessengers | An instant messenger as it exists staged for update by the parent business process. |
WorkContactInformationChangesPhoneNumbers | A phone number as it exists staged for update by the parent business process. |
WorkContactInformationChangesWebAddresses | A web address as it exists staged for update by the parent business process. |
WorkersAnytimeFeedbackEvents | Retrieves a feedback given event instance with the specified ID. |
WorkersBusinessTitleChanges | Retrieves a business title change instance for a specific worker. |
WorkersCheckIns | Retrieves a single Check-In instance. |
WorkersCheckInsAssociatedTopics | Reads associatedTopics entries from the WorkersCheckIns table |
WorkersCheckInsCheckInAttachments | Reads checkInAttachments entries from the WorkersCheckIns table |
WorkersCheckInTopics | Retrieves a single Check-In topic instance. |
WorkersCheckInTopicsAssociatedCheckIns | Reads associatedCheckIns entries from the WorkersCheckInTopics table |
WorkersCheckInTopicsCheckInTopicAttachments | Reads checkInTopicAttachments entries from the WorkersCheckInTopics table |
Retrieves an ad hoc project time transaction instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
BillingStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BillingStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
BillingStatus_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Hours | Decimal | False |
Supported for: SELECT, INSERT. The number of hours for an ad hoc project time transaction. |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
IncludeCost | Bool | False |
Supported for: SELECT, INSERT. If true, costs are calculated for the ad hoc project time transaction. |
Memo | String | False |
Supported for: SELECT, INSERT. The memo for the ad hoc project time transaction. |
ProjectRole_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectRole_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectRole_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Project_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Project_Href | String | False |
Supported for: SELECT. A link to the instance |
Project_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RateToBill_Currency | String | False |
Supported for: SELECT, INSERT. The actual rate that the ad hoc project time transaction is billed at. |
RateToBill_Value | Decimal | False |
Supported for: SELECT, INSERT. The actual rate that the ad hoc project time transaction is billed at. |
StandardCostRate_Currency | String | False |
Supported for: SELECT, INSERT. The hourly standard cost rate for hours logged on the ad hoc project time transaction. |
StandardCostRate_Value | Decimal | False |
Supported for: SELECT, INSERT. The hourly standard cost rate for hours logged on the ad hoc project time transaction. |
Task_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Task_Href | String | False |
Supported for: SELECT. A link to the instance |
Task_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
TransactionDate | Datetime | False |
Supported for: SELECT, INSERT. The date of the ad hoc project time transaction using the yyyy-mm-dd format. |
Worker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Worker_Href | String | False |
Supported for: SELECT. A link to the instance |
Worker_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ProjectOrProjectHierarchy_Prompt | String | False |
The Workday ID or reference ID of a project or project hierarchy. You can use a returned project id or primaryHierarchy {id} from GET /projects. |
Will return attachments
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ContentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ContentType_Href | String | False |
Supported for: SELECT. A link to the instance |
ContentType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
FileLength | Decimal | False |
Supported for: SELECT, INSERT. File length of the attachment |
FileName | String | False |
Supported for: SELECT, INSERT. File name of the attachment |
Retrieves a single billable transaction instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
AdjustmentCount | Decimal | False |
Supported for: SELECT. The count of the billing rate application for the billable transaction. |
AdjustmentReason_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
AdjustmentReason_Href | String | False |
Supported for: SELECT. A link to the instance |
AdjustmentReason_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
AmountToBill_Currency | String | False |
Supported for: SELECT, UPDATE. The amount to bill for a billable transaction, excluding applicable tax. |
AmountToBill_Value | Decimal | False |
Supported for: SELECT, UPDATE. The amount to bill for a billable transaction, excluding applicable tax. |
BillableAmount_Currency | String | False |
Supported for: SELECT. The original amount to bill the customer, excluding extended amounts on tax only customer invoices. |
BillableAmount_Value | Decimal | False |
Supported for: SELECT. The original amount to bill the customer, excluding extended amounts on tax only customer invoices. |
BillableHours | Decimal | False |
Supported for: SELECT. The original hours to bill the customer. |
BillableRate_Currency | String | False |
Supported for: SELECT. The original rate to bill the customer. |
BillableRate_Value | Decimal | False |
Supported for: SELECT. The original rate to bill the customer. |
BillingStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BillingStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
BillingStatus_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Category_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Category_Href | String | False |
Supported for: SELECT. A link to the instance |
Category_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Customer_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Customer_Href | String | False |
Supported for: SELECT. A link to the instance |
Customer_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, UPDATE. A preview of the instance |
ExpenseDescriptor_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ExpenseDescriptor_Href | String | False |
Supported for: SELECT. A link to the instance |
ExpenseDescriptor_Id | String | False |
Supported for: SELECT. wid / id / reference id |
HoursToBill | Decimal | False |
Supported for: SELECT, UPDATE. The actual hours available to bill for the billable transaction. |
Href | String | False |
Supported for: SELECT, UPDATE. A link to the instance |
InvoiceDescription | String | False |
Supported for: SELECT. The description for the supplier invoice line item, expense report line item, or usage-based transaction. |
Memo | String | False |
Supported for: SELECT, UPDATE. The memo for the project billable transaction. |
PreviouslyInvoiced | Bool | False |
Supported for: SELECT. If true, the billable transaction has been previously invoiced. |
ProjectRole_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectRole_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectRole_Id | String | False |
Supported for: SELECT. wid / id / reference id |
ProjectTask_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectTask_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectTask_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Project_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Project_Href | String | False |
Supported for: SELECT. A link to the instance |
Project_Id | String | False |
Supported for: SELECT. wid / id / reference id |
RateToBill_Currency | String | False |
Supported for: SELECT, UPDATE. The actual rate that the billable transaction is billed at. |
RateToBill_Value | Decimal | False |
Supported for: SELECT, UPDATE. The actual rate that the billable transaction is billed at. |
ReasonForChange | String | False |
Supported for: SELECT, UPDATE. The reason for the rate change for the billable transaction. |
ResourceProvider_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ResourceProvider_Href | String | False |
Supported for: SELECT. A link to the instance |
ResourceProvider_Id | String | False |
Supported for: SELECT. wid / id / reference id |
RevenueStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RevenueStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
RevenueStatus_Id | String | False |
Supported for: SELECT. wid / id / reference id |
TransactionDate | Datetime | False |
Supported for: SELECT. The date of the billable transaction. |
TransactionSource_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
TransactionSource_Href | String | False |
Supported for: SELECT. A link to the instance |
TransactionSource_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Worker_Href | String | False |
Supported for: SELECT. A link to the instance |
Worker_Id | String | False |
Supported for: SELECT. wid / id / reference id |
ZeroAmountToBill | Bool | False |
Supported for: SELECT, UPDATE. If true, the billable transaction has a zero rate. |
BillingStatus_Prompt | String | False |
Accepts multiple inputs. Filters the billable transactions by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
Customer_Prompt | String | False |
The Workday ID of the customer associated with the project for the billable transaction. To get a valid ID, you can call GET /customers in the Customer Accounts REST service. |
FromDate_Prompt | Date | False |
Filters the billable transactions with transaction date on or after the specified date. Use the yyyy-mm-dd format. |
Phase_Prompt | String | False |
The Workday ID of the project phase associated with the billable transaction for the time entry. To get a valid ID, call GET /planPhases in the Projects REST service. |
Project_Prompt | String | False |
The Workday ID of the project associated with the billable transactions. To get a valid ID, you can call GET /projects in the Projects REST service. |
SpendCategory_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the spend category for the billable transaction associated with the expense report line. |
Task_Prompt | String | False |
The Workday ID of the project task associated with the billable transaction for the time entry. To get a valid ID, call GET /planTasks in the Projects REST service. |
TimeCode_Prompt | String | False |
The Workday ID of the time code for the billable transaction associated with the time entry. |
ToDate_Prompt | Date | False |
Filters the billable transactions with transaction date on or before the specified date. Use the yyyy-mm-dd format. |
TransactionSource_Prompt | String | False |
Filters the billable transactions by transaction source. Specify the Workday ID of the transaction source. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the worker associated with the billable transaction. To get a valid ID, call GET /workers in the Staffing service. |
Retrieves a case with the specified ID that the user is secured to view.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* \~Case\~ Attachment ID. */ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ descriptor: Text /* A preview of the instance */ }]
[{ questionnaireAttachments: [{ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] answerMultipleChoices: [{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] answerNumeric: Numeric /* The answer in a numeric format. */ answerText: Text /* The text answer for a questionnaire. */ answerDate: Date /* The answer in a date format. */ questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */ *id: Text /* wid / id / reference id */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
AboutWorker_Id | String | False |
Supported for: INSERT. wid / id / reference id |
About_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
About_Id | String | False |
Supported for: SELECT. Id of the instance |
About_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
About_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
About_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Assignee_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Assignee_Id | String | False |
Supported for: SELECT. Id of the instance |
Assignee_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Assignee_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
Assignee_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Attachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Case Creation Attachments. |
By_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
By_ExternalCreator_Email | String | False |
Supported for: SELECT. External Case Creator Email. |
By_ExternalCreator_Id | String | False |
Supported for: SELECT. Id of the instance |
By_ExternalCreator_Name | String | False |
Supported for: SELECT. External Case Creator Name and External in Parenthesis or Purged External Case Creator text. |
By_Id | String | False |
Supported for: SELECT. Id of the instance |
By_Worker_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
By_Worker_Id | String | False |
Supported for: SELECT. Id of the instance |
By_Worker_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
By_Worker_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
By_Worker_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
CaseID | String | False |
Supported for: SELECT, INSERT. Case ID. |
CaseLink | String | False |
Supported for: SELECT, INSERT. The link to view the Case. |
CaseType_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Confidential | Bool | False |
Supported for: SELECT. If true, the case is confidential. |
CreationDate | Datetime | False |
Supported for: SELECT. The date that the case was created on. |
DetailedMessage | String | False |
Supported for: SELECT, INSERT. The description of the case. |
ForExternalCreator_Id | String | False |
Supported for: INSERT. wid / id / reference id |
ForWorker_Id | String | False |
Supported for: INSERT. wid / id / reference id |
For_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
For_ExternalCreator_Email | String | False |
Supported for: SELECT. External Case Creator Email. |
For_ExternalCreator_Id | String | False |
Supported for: SELECT. Id of the instance |
For_ExternalCreator_Name | String | False |
Supported for: SELECT. External Case Creator Name and External in Parenthesis or Purged External Case Creator text. |
For_Id | String | False |
Supported for: SELECT. Id of the instance |
For_Worker_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
For_Worker_Id | String | False |
Supported for: SELECT. Id of the instance |
For_Worker_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
For_Worker_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
For_Worker_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
FormattedCreationDate | String | False |
Supported for: SELECT. The creation date of the case formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone. |
QuestionnaireHolder_Id | String | False |
Supported for: INSERT. wid / id / reference id |
QuestionnaireResponses_Descriptor | String | False |
Supported for: INSERT. A preview of the instance |
QuestionnaireResponses_Id | String | False |
Supported for: INSERT. Id of the instance |
QuestionnaireResponses_QuestionnaireAnswers_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The set of answers for a questionnaire. |
QuestionnaireResponses_QuestionnaireTargetContext_Id | String | False |
Supported for: INSERT. wid / id / reference id |
QuestionnaireResponses_QuestionnaireTarget_Id | String | False |
Supported for: INSERT. wid / id / reference id |
ServiceTeam_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ServiceTeam_Href | String | False |
Supported for: SELECT. A link to the instance |
ServiceTeam_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Source_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Status_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Status_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Title | String | False |
Supported for: SELECT, INSERT. The title of the case. |
Type_Confidential | Bool | False |
Supported for: SELECT. Case type confidential flag for REST service. |
Type_Description | String | False |
Supported for: SELECT. Case Type Description. |
Type_Id | String | False |
Supported for: SELECT. Id of the instance |
Type_Inactive | Bool | False |
Supported for: SELECT. True if the case type is inactive. |
Type_Name | String | False |
Supported for: SELECT. Returns the display id of the instance. |
Type_ServiceCategory_Description | String | False |
Supported for: SELECT. The description of the service category. |
Type_ServiceCategory_Id | String | False |
Supported for: SELECT. Id of the instance |
Type_ServiceCategory_Name | String | False |
Supported for: SELECT. The name of the service category. |
Desc_Prompt | Boolean | False |
If true, sorts results in descending order. |
MyCases_Prompt | Boolean | False |
Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | False |
Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | False |
The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Retrieves a comment timeline item for a case with the specified timeline ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* \~Case\~ Attachment ID. */ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
No description available |
Cases_Id [KEY] | String | False |
The Workday ID of the Cases that owns this |
Attachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Case Timeline Item (Derived) has Case Attachment (Derived) [RL]. |
Comment_TextBody | String | False |
Supported for: SELECT, INSERT. Comment |
CreationDate | Datetime | False |
Supported for: SELECT. The date that the case timeline item was created on. |
Description | String | False |
Supported for: SELECT. Used by the Case Creation Timeline Item, contains the detailed message written by case creators. |
FormattedCreationDate | String | False |
Supported for: SELECT. The creation date of the timeline item formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone. |
Guidance_KbArticle_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Guidance_KbArticle_Id | String | False |
Supported for: SELECT. Id of the instance |
Guidance_UiTask_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Guidance_UiTask_Id | String | False |
Supported for: SELECT. Id of the instance |
Guidance_UiTask_Url | String | False |
Supported for: SELECT. Returns the fully qualified URL for the given Task |
QuestionnaireResponse_Questionnaire_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
QuestionnaireResponse_Questionnaire_Href | String | False |
Supported for: SELECT. A link to the instance |
QuestionnaireResponse_Questionnaire_Id | String | False |
Supported for: SELECT. wid / id / reference id |
SubmittedBy_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
SubmittedBy_ExternalCreator_Email | String | False |
Supported for: SELECT. External Case Creator Email. |
SubmittedBy_ExternalCreator_Id | String | False |
Supported for: SELECT. Id of the instance |
SubmittedBy_ExternalCreator_Name | String | False |
Supported for: SELECT. External Case Creator Name and External in Parenthesis or Purged External Case Creator text. |
SubmittedBy_Id | String | False |
Supported for: SELECT. Id of the instance |
SubmittedBy_Worker_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
SubmittedBy_Worker_Id | String | False |
Supported for: SELECT. Id of the instance |
SubmittedBy_Worker_Person_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SubmittedBy_Worker_Person_Href | String | False |
Supported for: SELECT. A link to the instance |
SubmittedBy_Worker_Person_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Type_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Type_Id | String | False |
Supported for: SELECT. Id of the instance |
Desc_Prompt | Boolean | False |
Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
MyCases_Prompt | Boolean | False |
Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | False |
Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | False |
Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Retrieves a single Event-Driven Integration vendor response.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ recordType: Text /* The type of error being recorded. Examples: Data error, Configuration error. */ diagnosis: Text /* An explanation for the root cause of the error. */ group: [{ groupData: [{ name: Text /* The name of the reported field attribute. Examples: Amount, Currency, Status. */ value: Text /* The value of the reported field attribute. Examples: 2000, USD, Active. */ }] groupValue: Text /* The specific name of the type of data being provided by the third-party payroll system. Examples: Car Allowance, Home Address. */ groupName: Text /* The group category holding the data being provided by the third-party payroll system. Examples: Allowance, Address. */ }] messageNumber: Text /* An integer number identifying the error reported. */ messageCategory: Text /* The category for where the error occurred. Examples: Worker Data, Organization, Supervisory, Staffing. */ procedure: Text /* The steps to fix the error. */ *vendorErrorMessage: Text /* Required detailed error message that explains what occurred in the third-party payroll system while processing the worker changes sent through event-driven integration. */ who: Text /* Lists the names, positions, or roles of the concerned audience for handling the error resolution. */ *severity: { /* The severity level for the vendor-defined integration error message. */ *id: Text /* wid / id / reference id */ } functionalArea: Text /* The functional area that was impacted by the error reported. Examples: Position, Compensation, Personal data. */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Required Workday ID for the Event-Driven Integration. Workday provides this to the third-party payroll vendor as part of the initial file delivery. |
ErrorMessageSet_Errors_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. A data set containing a group of payroll messages and exceptions returned by payroll vendor for the worker changes sent by Event Driven Integration. |
OverallStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
OverallStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
OverallStatus_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Relaunchable | Bool | False |
Supported for: SELECT, INSERT. If true, Workday displays the Resend to Payroll button on the Review Event Driven Integration for Third Party Payroll step to resubmit worker changes after making any corrections. If false, Workday doesn't display the button. The field might be set to false if there isn�t anything the user can do to fix the errors and resubmitting the changes will result in the same errors. |
SetLsrd | Bool | False |
Supported for: SELECT, INSERT. If true, Workday updates the LSRD for that particular worker. The next time you run the batch PECI integration, only changes that occurred after running the Event-Driven Integration is included for the worker. If false, Workday sends the original data again during the next transmission, either through the event-driven integration or the Payroll Effective Change Interface integration. |
SkipReview | Bool | False |
Supported for: SELECT, INSERT. If true, Workday displays the Review Event Driven Integration for Third Party Payroll step on the Maintain Local Payroll Data task. |
SkipReviewReason | String | False |
Supported for: SELECT, INSERT. The reason that gives guidance whether or not to complete the Maintain Local Payroll Data step after the Review Event Driven Integration for Third Party Payroll step. This field applies when you configured the Hire business process with the Maintain Local Payroll Data step right after the Review Event Driven Integration for Third Party Payroll step. Workday displays this reason on the Maintain Local Payroll Data task after the Review Event Driven Integration for Third Party Payroll step. |
Retrieves a single instance of a Quick Expense.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Amount_Currency | String | False |
Supported for: SELECT, INSERT, UPDATE. Amount for Expense Entry |
Amount_Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. Amount for Expense Entry |
Attachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. CRF for Entries REST operation to expose Attachment related to Optical Character Recognition |
Date | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. Date of Expense Entry |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EntryType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
EntryType_Href | String | False |
Supported for: SELECT. A link to the instance |
EntryType_Id | String | False |
Supported for: SELECT. wid / id / reference id |
ExpenseEntryStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ExpenseEntryStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
ExpenseEntryStatus_Id | String | False |
Supported for: SELECT. wid / id / reference id |
ExpenseItem_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ExpenseItem_Href | String | False |
Supported for: SELECT. A link to the instance |
ExpenseItem_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
HasOCRReceipt | Bool | False |
Supported for: SELECT, INSERT. Boolean value indicating whether the Mobile Expense has an OCR image. |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
Image_Id | String | False |
Supported for: UPDATE. wid / id / reference id |
Memo | String | False |
Supported for: SELECT, INSERT, UPDATE. Memo for the Entry |
Merchant | String | False |
Supported for: SELECT, INSERT, UPDATE. Expense Merchant Name |
ScanStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ScanStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
ScanStatus_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
EntryType_Prompt | String | False |
No description available |
ExpenseEntryStatus_Prompt | String | False |
No description available |
FromDate_Prompt | Date | False |
No description available |
ToDate_Prompt | Date | False |
No description available |
Reads attachments entries from the ExpenseEntries table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ExpenseEntries_Id [KEY] | String | False |
The Wordkay ID of the ExpenseEntries that contains this |
ContentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ContentType_Href | String | False |
Supported for: SELECT. A link to the instance |
ContentType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
FileLength | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. File length of the attachment |
FileName | String | False |
Supported for: SELECT, INSERT, UPDATE. File name of the attachment |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
EntryType_Prompt | String | False |
No description available |
ExpenseEntryStatus_Prompt | String | False |
No description available |
FromDate_Prompt | Date | False |
No description available |
ToDate_Prompt | Date | False |
No description available |
Retrieves a single instance of an Expense Report.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Company_Id | String | False |
Supported for: INSERT. wid / id / reference id |
CreationDate | Datetime | False |
Supported for: SELECT, INSERT. Creation Date label to be used for REST API |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
ExpenseReportMemo | String | False |
Supported for: SELECT, INSERT. Memo label to be used for REST API |
ExpenseReportStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ExpenseReportStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
ExpenseReportStatus_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Href | String | False |
Supported for: SELECT. A link to the instance |
Payee_Id | String | False |
Supported for: INSERT. wid / id / reference id |
TotalAmount_Currency | String | False |
Supported for: SELECT. Total Amount for the Expense Report |
TotalAmount_Value | Decimal | False |
Supported for: SELECT. Total Amount for the Expense Report |
Worktag_Descriptor | String | False |
Supported for: INSERT. A preview of the instance |
Worktag_Id | String | False |
Supported for: INSERT. Id of the instance |
ExpenseReportMemo_Prompt | String | False |
No description available |
ExpenseReportStatus_Prompt | String | False |
Accepts multiple inputs. No description available |
FromDate_Prompt | Date | False |
No description available |
ToDate_Prompt | Date | False |
No description available |
Retrieves contact details for a single external \~case\~ contact instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Blocked | Bool | False |
Supported for: SELECT, INSERT. If true, the external contact is blocked and they can't create cases. |
String | False |
Supported for: SELECT, INSERT. The email for the external case contact. | |
Name | String | False |
Supported for: SELECT, INSERT. The name for the external case contact. |
Email_Prompt | String | False |
The email address that identifies the external case contact. |
HideBlockedCreators_Prompt | Boolean | False |
If true, blocked contacts are excluded from the response. |
An address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AddressLine1 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 1 |
AddressLine1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 1 |
AddressLine2 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 2 |
AddressLine2Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 2 |
AddressLine3 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 3 |
AddressLine3Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 3 |
AddressLine4 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 4 |
AddressLine4Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 4 |
AddressLine5 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 5 |
AddressLine5Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 5 |
AddressLine6 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 6 |
AddressLine6Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 6 |
AddressLine7 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 7 |
AddressLine7Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 7 |
AddressLine8 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 8 |
AddressLine8Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 8 |
AddressLine9 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 9 |
AddressLine9Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 9 |
City | String | False |
Supported for: SELECT, INSERT, UPDATE. City |
CityLocal | String | False |
Supported for: SELECT, INSERT, UPDATE. City - Local |
CitySubdivision1 | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 1 |
CitySubdivision1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 1 - Local |
CitySubdivision2 | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 2 |
CitySubdivision2Local | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 2 - Local |
CountryCity_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryCity_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
CountryRegion_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryRegion_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Country_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Country_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Effective | Datetime | False |
Supported for: SELECT. The date this business process takes effect. |
NumberDaysWFH | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. Number of Days WFH |
PostalCode | String | False |
Supported for: SELECT, INSERT, UPDATE. Postal Code |
RegionSubdivision1 | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1 |
RegionSubdivision1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1 - Local |
RegionSubdivision2 | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 2 |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. Returns the description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Is Primary |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Is Public Visibility |
Usage_UsageType_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Used For |
PrimaryOnly_Prompt | Boolean | False |
No description available |
UsedFor_Prompt | String | False |
No description available |
An email address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EmailAddress | String | False |
Supported for: SELECT, INSERT, UPDATE. The email address. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public email addresses. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
An instant messenger as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Type_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Type_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
UserName | String | False |
Supported for: SELECT, INSERT, UPDATE. The instant messenger account username. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public instant messenger account usernames. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
A phone number as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
CompletePhoneNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | False |
Supported for: SELECT, INSERT, UPDATE. The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryPhoneCode_Country_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
CountryPhoneCode_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryPhoneCode_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
DeviceType_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
DeviceType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Extension | String | False |
Supported for: SELECT, INSERT, UPDATE. The phone extension. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public phone numbers. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
A web address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
HomeContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Url | String | False |
Supported for: SELECT, INSERT, UPDATE. The complete URL address for the web address. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public web addresses. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
Retrieves a dependent immigration data instance for the specified student ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ImmigrationEvents_Id [KEY] | String | False |
The Workday ID of the ImmigrationEvents that owns this |
CountryOfBirth_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CountryOfBirth_Href | String | False |
Supported for: SELECT. A link to the instance |
CountryOfBirth_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CountryOfCitizenship_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CountryOfCitizenship_Href | String | False |
Supported for: SELECT. A link to the instance |
CountryOfCitizenship_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
DateOfBirth | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The student dependent�s date of birth. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
FirstName | String | False |
Supported for: SELECT, INSERT, UPDATE. The first name of the student�s dependent. |
ImmigrationStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ImmigrationStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
ImmigrationStatus_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
LastName | String | False |
Supported for: SELECT, INSERT, UPDATE. The last name of the student�s dependent. |
MiddleName | String | False |
Supported for: SELECT, INSERT, UPDATE. The middle name of the student�s dependent. |
RelationshipToStudent_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RelationshipToStudent_Href | String | False |
Supported for: SELECT. A link to the instance |
RelationshipToStudent_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
SevisExpirationDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The expiration date of the SEVIS ID for the student�s dependent. |
SevisId | String | False |
Supported for: SELECT, INSERT, UPDATE. The SEVIS ID of the student�s dependent. |
SevisIssueDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The issue date of the SEVIS ID for the student�s dependent. |
Retrieves an immigration data instance for the specified immigration event.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ImmigrationEvents_Id [KEY] | String | False |
The Workday ID of the ImmigrationEvents that owns this |
ActiveSevisId | String | False |
Supported for: SELECT, INSERT, UPDATE. The current active SEVIS ID for the student immigration data. |
ActiveVisaType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ActiveVisaType_Href | String | False |
Supported for: SELECT. A link to the instance |
ActiveVisaType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
IssuingInstitution_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
IssuingInstitution_Href | String | False |
Supported for: SELECT. A link to the instance |
IssuingInstitution_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
No description available
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Interviews_Id [KEY] | String | False |
The Workday ID of the Interviews that owns this |
Comment | String | False |
Supported for: SELECT, INSERT. The interviewer's overall and competency comments. |
DateSubmitted | Datetime | False |
Supported for: SELECT, INSERT. The feedback submission date. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
OverallRating_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
OverallRating_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
InterviewStatus_Prompt | String | False |
Only used when a Interviews_Id filter is not provided. Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Retrieves the administrative options for the specified job change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AssignmentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
AssignmentType_Href | String | False |
Supported for: SELECT. A link to the instance |
AssignmentType_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
CompanyInsiderTypes_Aggregate | String | False |
Supported for: SELECT, UPDATE. A JSON aggregate. The new company insider types for the worker as of the effective date. |
DefaultWeeklyHours | Decimal | False |
Supported for: SELECT, UPDATE. The new default weekly hours for the worker as of the effective date. |
EndEmploymentDate | Datetime | False |
Supported for: SELECT, UPDATE. The new End Employment Date for the worker. If the worker has an Employee Contract sub event, this field will return that end date instead. |
ExpectedAssignmentEndDate | Datetime | False |
Supported for: SELECT, UPDATE. For a past or current business process, the value of the Expected Assignment End Date field that is being (or was) proposed in the process. |
FirstDayOfWork | Datetime | False |
Supported for: SELECT, UPDATE. The first day of work for the worker, as specified on the Hire, Add International Assignment, or Add Job transaction. This field will not return a value for any other transaction. |
Fte | Decimal | False |
Supported for: SELECT, UPDATE. Full Time Equivalent for a worker calculated by scheduled weekly hours divided by default weekly hours either current or proposed. |
NotifyBy | Datetime | False |
Supported for: SELECT, UPDATE. Returns the date that the employee should be notified for a termination. |
PaidFte | Decimal | False |
Supported for: SELECT, UPDATE. The paid full time equivalent for the worker as of the effective date. |
PayRateType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
PayRateType_Href | String | False |
Supported for: SELECT. A link to the instance |
PayRateType_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
PositionWorkerType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
PositionWorkerType_Href | String | False |
Supported for: SELECT. A link to the instance |
PositionWorkerType_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
SpecifyPaidFte | Bool | False |
Supported for: SELECT, UPDATE. True if paid full time equivalent is specified on a worker as of the effective date. |
SpecifyWorkingFte | Bool | False |
Supported for: SELECT, UPDATE. True if working full time equivalent is specified on a worker as of the effective date. |
TimeType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
TimeType_Href | String | False |
Supported for: SELECT. A link to the instance |
TimeType_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
WorkStudy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkStudy_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkStudy_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
WorkersCompensationCodeOverride_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkersCompensationCodeOverride_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkersCompensationCodeOverride_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
WorkingFte | Decimal | False |
Supported for: SELECT, UPDATE. The working full time equivalent for the worker as of the effective date. |
Retrieves a business title for the specified job change ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
BusinessTitle | String | False |
Supported for: SELECT, UPDATE. The new business title for the worker as of the effective date. If there is no business title override, this field defaults to the job title or job profile name. |
Returns the comment information for the specified job change ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Comment | String | False |
Supported for: SELECT, UPDATE. The business process comment for a worker event before it's submitted. |
Retrieves the contract options for the specified change job ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AssignmentDetails | String | False |
Supported for: SELECT, UPDATE. The new contract assignment details for the contingent worker as of the effective date. |
ContractEndDate | Datetime | False |
Supported for: SELECT, UPDATE. The contract end date for the position as of this business process. |
ContractPayRate_Currency | String | False |
Supported for: SELECT, UPDATE. The new contract pay rate for the contingent worker as of the effective date. |
ContractPayRate_Value | Decimal | False |
Supported for: SELECT, UPDATE. The new contract pay rate for the contingent worker as of the effective date. |
Currency_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Currency_Href | String | False |
Supported for: SELECT. A link to the instance |
Currency_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Frequency_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Frequency_Href | String | False |
Supported for: SELECT. A link to the instance |
Frequency_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
PurchaseOrder_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
PurchaseOrder_Href | String | False |
Supported for: SELECT. A link to the instance |
PurchaseOrder_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves a job classification for the specified job change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AdditionalJobClassifications_Aggregate | String | False |
Supported for: SELECT, UPDATE. A JSON aggregate. Additional Job Classifications Proposed By Staffing Event |
Retrieves a job profile for the specified job change ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
JobProfile_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
JobProfile_Href | String | False |
Supported for: SELECT. A link to the instance |
JobProfile_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
JobTitle | String | False |
Supported for: SELECT, UPDATE. The new job title for the worker as of the effective date. |
Returns the location information for the specified job change ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Location_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Location_Href | String | False |
Supported for: SELECT. A link to the instance |
Location_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
ScheduledHours | Decimal | False |
Supported for: SELECT, UPDATE. The new scheduled hours for the worker as of the effective date. |
WorkShift_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkShift_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkShift_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
WorkSpace_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkSpace_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkSpace_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves a move team option from the specified job change ID.
Name | Type | ReadOnly | Description |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
MoveTeam | Bool | False |
Supported for: SELECT, UPDATE. Returns a boolean that indicates whether teams reporting to the Manager moved with them during the Change Job Event. |
Retrieves the opening options for the specified job change ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Descriptor | String | False |
Supported for: SELECT, UPDATE. A preview of the instance |
HeadcountOption_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
HeadcountOption_Href | String | False |
Supported for: SELECT. A link to the instance |
HeadcountOption_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
OpeningAvailableForOverlap | Bool | False |
Supported for: SELECT, UPDATE. Returns true if the value for 'Available for job overlap' box is checked |
Retrieves a position for the specified job change ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AvailableForOverlap | Bool | False |
Supported for: SELECT, UPDATE. Returns true if the value for 'Available for job overlap' box is checked |
ClosePosition | Bool | False |
Supported for: SELECT, UPDATE. Returns true if the position is being closed. |
CreatePosition | Bool | False |
Supported for: SELECT, UPDATE. Returns true if the position is being created. |
Descriptor | String | False |
Supported for: SELECT, UPDATE. A preview of the instance |
JobRequisition_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
JobRequisition_Href | String | False |
Supported for: SELECT. A link to the instance |
JobRequisition_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Position_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Position_Href | String | False |
Supported for: SELECT. A link to the instance |
Position_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves the start details for the specified job change ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
JobChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Date | Datetime | False |
Supported for: SELECT, UPDATE. The date this business process takes effect. |
Descriptor | String | False |
Supported for: SELECT, UPDATE. A preview of the instance |
Job_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Job_Href | String | False |
Supported for: SELECT. A link to the instance |
Job_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Location_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Location_Href | String | False |
Supported for: SELECT. A link to the instance |
Location_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Reason_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Reason_Href | String | False |
Supported for: SELECT. A link to the instance |
Reason_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
SupervisoryOrganization_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SupervisoryOrganization_Href | String | False |
Supported for: SELECT. A link to the instance |
SupervisoryOrganization_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Template_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Template_Href | String | False |
Supported for: SELECT. A link to the instance |
Template_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
UseNextPayPeriod | Bool | False |
Supported for: SELECT, UPDATE. Next Pay Period? |
Worker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Worker_Href | String | False |
Supported for: SELECT. A link to the instance |
Worker_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves a message template with the specific ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
CreatedBy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CreatedBy_Href | String | False |
Supported for: SELECT. A link to the instance |
CreatedBy_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CreatedOn | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. Gives the date that the instance was originally created. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EmailDetail_Body | String | False |
Supported for: SELECT, INSERT, UPDATE. Message content of the email. |
EmailDetail_Name | String | False |
Supported for: SELECT, INSERT, UPDATE. Email Configuration Data container for REST API. |
EmailDetail_ReplyTo | String | False |
Supported for: SELECT, INSERT, UPDATE. Reply To |
EmailDetail_Subject | String | False |
Supported for: SELECT, INSERT, UPDATE. Email subject line. |
Inactive | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Indicates template is active or has been disabled. |
LastUpdated | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. No description available |
LastUpdatedBy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
LastUpdatedBy_Href | String | False |
Supported for: SELECT. A link to the instance |
LastUpdatedBy_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Name | String | False |
Supported for: SELECT, INSERT, UPDATE. Message Template Name |
NotificationType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
NotificationType_Href | String | False |
Supported for: SELECT. A link to the instance |
NotificationType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
PushDetail_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
PushDetail_Message | String | False |
Supported for: SELECT, INSERT, UPDATE. Message content of a push notification. |
PushDetail_RedirectURL | String | False |
Supported for: SELECT, INSERT, UPDATE. The URL to launch the appropriate mobile app upon acknowledgement. |
ReferenceID | String | False |
Supported for: SELECT, INSERT, UPDATE. The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the 'Organization ID' |
UsageCount | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. Count of instances using this Message Template |
Inactive_Prompt | Boolean | False |
No description available |
Name_Prompt | String | False |
No description available |
NotificationType_Prompt | String | False |
No description available |
Retrieves a business unit for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
BusinessUnit_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessUnit_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessUnit_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves the comment information for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Comment | String | False |
Supported for: SELECT, UPDATE. The business process comment for a worker event before it's submitted. |
Retrieves a company for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Company_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Company_Href | String | False |
Supported for: SELECT. A link to the instance |
Company_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves a cost center for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
CostCenter_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CostCenter_Href | String | False |
Supported for: SELECT. A link to the instance |
CostCenter_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves the costing organizations for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Fund_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Fund_Href | String | False |
Supported for: SELECT. A link to the instance |
Fund_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Gift_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Gift_Href | String | False |
Supported for: SELECT. A link to the instance |
Gift_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Grant_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Grant_Href | String | False |
Supported for: SELECT. A link to the instance |
Grant_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Program_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Program_Href | String | False |
Supported for: SELECT. A link to the instance |
Program_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves the custom organizations for the specified organization assignment change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ organizationType: { /* Includes these organization types: Company, Cost Center, Custom orgs, Location Hierarchy, Matrix, Pay Group, Region, Retiree, Supervisory. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
CustomOrganizations_Aggregate | String | False |
Supported for: SELECT, UPDATE. A JSON aggregate. The new custom organizations for the worker as of the effective date. |
Retrieves a region for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Region_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Region_Href | String | False |
Supported for: SELECT. A link to the instance |
Region_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves the start details for the specified organization assignment change ID.
Name | Type | ReadOnly | Description |
OrganizationAssignmentChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Date | Datetime | False |
Supported for: SELECT, UPDATE. The date this business process takes effect. |
Position_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Position_Href | String | False |
Supported for: SELECT. A link to the instance |
Position_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
SupervisoryOrganization_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SupervisoryOrganization_Href | String | False |
Supported for: SELECT. A link to the instance |
SupervisoryOrganization_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Worker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Worker_Href | String | False |
Supported for: SELECT. A link to the instance |
Worker_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
Retrieves a payroll period for the specified Payroll Interface pay group ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
PayGroups_Id [KEY] | String | False |
The Workday ID of the PayGroups that owns this |
PeriodEndDate | Datetime | False |
Supported for: SELECT, UPDATE. The end date of a payroll period. |
PeriodIsEarliestOpen | Bool | False |
Supported for: SELECT, UPDATE. Returns true if this period is the earliest open pay period. |
PeriodStartDate | Datetime | False |
Supported for: SELECT, UPDATE. The start date of a payroll period. |
Status | String | False |
Supported for: SELECT, UPDATE. The status of a payroll period. |
PeriodEndDate_Prompt | Date | False |
The end date of a payroll period using the yyyy-mm-dd format. This should not be used with the showMostRecentOnly query parameter. If both periodEndDate and showMostRecentOnly query parameters are provided, the API will only consider the periodEndDate query parameter. |
ShowMostRecentOnly_Prompt | Boolean | False |
If true, the operation returns the 5 most recent pay periods. This should not be used with periodEndDate query parameter. If both showMostRecentOnly and periodEndDate query parameters are provided, the API will ignore showMostRecentOnly query parameter. |
Country_Prompt | String | False |
Only used when a PayGroups_Id filter is not provided. The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API. |
Retrieves a single customer invoice payment instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Amount_Currency | String | False |
Supported for: INSERT. The amount of the customer payment in transaction currency. |
Amount_Value | Decimal | False |
Supported for: INSERT. The amount of the customer payment in transaction currency. |
Company_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Date | Datetime | False |
Supported for: INSERT. The date the customer payment was made. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Memo | String | False |
Supported for: INSERT. A memo associated with the customer payment. |
ReadyToAutoApply | Bool | False |
Supported for: INSERT. True if the customer payment is ready for automatic application for a cash sale. |
Reference | String | False |
Supported for: INSERT. The reference to a customer payment that's processed through a settlement run. This field is blank when the Payment Status is In Progress or when the Payment Type is Check or ETF. |
RemitFromCustomer_Id | String | False |
Supported for: INSERT. wid / id / reference id |
TransactionNumber | String | False |
Supported for: INSERT. The transaction number for the reporting transaction. |
Type_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Retrieves a single customer invoice payment remittance line instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Payments_Id [KEY] | String | False |
The Workday ID of the Payments that owns this |
AmountToPay_Currency | String | False |
Supported for: INSERT. The amount to pay specified on the invoice line of the customer payment. |
AmountToPay_Value | Decimal | False |
Supported for: INSERT. The amount to pay specified on the invoice line of the customer payment. |
BillToCustomer_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Invoice_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Retrieves a single payroll input instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ type: { /* Returns the Related Calculation for which entry was made on the current \~Worker\~ Input line. */ name: Text /* The alternate ID of the related calculation for the pay component and pay component related calculation. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } value: Numeric /* The value for the input line. */ id: Text /* Id of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Adjustment | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, the input is for an adjustment as opposed to an override. |
Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The text comment for this input. |
Currency_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Currency_Href | String | False |
Supported for: SELECT. A link to the instance |
Currency_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EndDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The end date after which this input does not apply. |
FieldEditability | String | False |
Supported for: SELECT, INSERT, UPDATE. The editability status indicating the fields that can be updated in the payroll input request. Possible values: all, none, endDateOnly |
InputDetails_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The details for this payroll input. |
Ongoing | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, the payroll input is ongoing. |
PayComponent_Code | String | False |
Supported for: SELECT, INSERT, UPDATE. The payroll code of the pay component. |
PayComponent_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
PayComponent_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Position_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Position_Href | String | False |
Supported for: SELECT. A link to the instance |
Position_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
RunCategories_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The run category for the payroll input. |
StartDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The start date before which this input does not apply. |
Worker_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Worker_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Worktags_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The worktags associated with the payroll input. |
EndDate_Prompt | Date | False |
The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | False |
The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service. |
Reads inputDetails entries from the PayrollInputs table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
PayrollInputs_Id [KEY] | String | False |
The Wordkay ID of the PayrollInputs that contains this |
Type_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Type_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Type_Name | String | False |
Supported for: SELECT, INSERT, UPDATE. The alternate ID of the related calculation for the pay component and pay component related calculation. |
Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The value for the input line. |
EndDate_Prompt | Date | False |
The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | False |
The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service. |
Reads runCategories entries from the PayrollInputs table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
PayrollInputs_Id [KEY] | String | False |
The Wordkay ID of the PayrollInputs that contains this |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EndDate_Prompt | Date | False |
The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | False |
The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service. |
Reads worktags entries from the PayrollInputs table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
PayrollInputs_Id [KEY] | String | False |
The Wordkay ID of the PayrollInputs that contains this |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EndDate_Prompt | Date | False |
The end date filter which returns payroll inputs that are active on or before the end date, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the pay component for the payroll input. You can use a returned id from GET /values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | False |
The start date filter which returns payroll inputs that are active on or after the start date, using the date format yyyy-mm-dd. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of worker for the payroll input. You can use a returned id from GET /workers in the Staffing service. |
Retrieves a single project plan phase instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ChildrenCount | Decimal | False |
Supported for: SELECT. The number of children for the current Project Plan Phase. |
Deletable | Bool | False |
Supported for: SELECT. If true, the project plan phase can be deleted. |
Description | String | False |
Supported for: SELECT. The description of the phase associated with a Project Plan Phase object. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Editable | Bool | False |
Supported for: SELECT. If true, the project phase can be edited. |
HasChildren | Bool | False |
Supported for: SELECT. If true, the project plan phase has 1 or more child phases or tasks. |
LevelNumber | Decimal | False |
Supported for: SELECT. The level number of the project plan phase. |
Order | String | False |
Supported for: SELECT, INSERT, UPDATE. Specifies the display order of the phase in the project plan. |
ParentPhase_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ParentPhase_Href | String | False |
Supported for: SELECT. A link to the instance |
ParentPhase_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Phase_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Phase_Href | String | False |
Supported for: SELECT. A link to the instance |
Phase_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Project_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Project_Href | String | False |
Supported for: SELECT. A link to the instance |
Project_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
SequenceNumber | String | False |
Supported for: SELECT. The sequence number of the project plan phase. |
FilterBy_Prompt | String | False |
Accepts multiple inputs. Accepts both Project Plan Phase or Project Plan Task WID. Query helps to filter results set based on filterCondition either to include or exclude WIDs. |
FilterCondition_Prompt | String | False |
To be used along with filterBy Query field to include or exclude instances in the GET response. Valid values are "Is" and "Not Equal to" (case-insensitive). |
Parent_Prompt | String | False |
No description available |
Project_Prompt | String | False |
No description available |
TopLevelPhase_Prompt | Boolean | False |
No description available |
Retrieves a single project plan task instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
BillableTask | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if a project plan task is non-billable. |
Closed | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Closed project plan tasks. Users can't enter time for these tasks. |
CustomTaskName | String | False |
Supported for: SELECT, INSERT, UPDATE. The name of the custom task in the project plan. |
Deletable | Bool | False |
Supported for: SELECT. If true, the project plan task can be deleted. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Editable | Bool | False |
Supported for: SELECT. If true, the project task can be edited. |
EndDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The end date of the project task. |
Memo | String | False |
Supported for: SELECT, INSERT, UPDATE. The comments for the Project Plan Task. |
Milestone | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if a project plan task is a milestone. |
Order | String | False |
Supported for: SELECT, INSERT, UPDATE. The order of the Project Plan Task |
PercentComplete | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The progress of the project task. |
Phase_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Phase_Href | String | False |
Supported for: SELECT. A link to the instance |
Phase_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
StartDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The start date of the project task. |
TaskResourceCount | Decimal | False |
Supported for: SELECT. Number of Task Resource lines for Project Plan Task. |
Task_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Task_Href | String | False |
Supported for: SELECT. A link to the instance |
Task_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Utilization | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if a project plan task qualifies for utilization. |
FilterBy_Prompt | String | False |
Accepts multiple inputs. Accepts both Project Plan Phase or Project Plan Task WID. Query helps to filter results set based on filterCondition either to include or exclude WIDs. |
FilterCondition_Prompt | String | False |
No description available |
PlanPhase_Prompt | String | False |
No description available |
Project_Prompt | String | False |
No description available |
Retrieves a single project instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ delayedDate: Date /* The date the delayed step will trigger. */ businessProcessStep: { /* Retired. We retire this report field because it doesn't return all the steps on the business process definition that are associated with the business process event step. A business process event step can be associated with multiple steps from the business process definition if those steps were automatically skipped. Example: Entry conditions to those steps aren't met. We recommend that you use the Steps report field instead. */ *id: Text /* wid / id / reference id */ } businessEventValidation: [{ conditionRule: Text /* The condition rule as a text expression. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] status: { /* The status of this business process step. */ *id: Text /* wid / id / reference id */ } event: { /* Identifies the business process and allows you to drill into the details and access related actions. */ *id: Text /* wid / id / reference id */ } completedByPerson: { /* The person that completed the step as Assignee */ *id: Text /* wid / id / reference id */ } completedOn: Date /* The date when this step was completed */ due: Date /* Returns the due date for this step. */ creationDate: Date /* The date when the event record was created. */ awaitingPersons: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] comments: [{ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ } conmentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ }] descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Billable | Bool | False |
Supported for: SELECT, INSERT. True if the project is billable. |
BusinessEventRecords_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The Project Event business process record that's initiated when you create or change a project. |
Capital | Bool | False |
Supported for: SELECT, INSERT. True if the project is capital. |
Company_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Company_Href | String | False |
Supported for: SELECT. A link to the instance |
Company_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Currency_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Currency_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Customer_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Customer_Href | String | False |
Supported for: SELECT. A link to the instance |
Customer_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Description | String | False |
Supported for: SELECT, INSERT. The description of the project. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
EndDate | Datetime | False |
Supported for: SELECT, INSERT. The approved project end date. |
EstimatedBudget_Currency | String | False |
Supported for: SELECT, INSERT. The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedBudget_Value | Decimal | False |
Supported for: SELECT, INSERT. The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedRevenueSavings_Currency | String | False |
Supported for: SELECT, INSERT. The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
EstimatedRevenueSavings_Value | Decimal | False |
Supported for: SELECT, INSERT. The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
ExternalLink | String | False |
Supported for: SELECT, INSERT. The link to an external site. |
ExternalProjectReference | String | False |
Supported for: SELECT, INSERT. Returns the external project reference. |
Groups_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Identifies the project groups of a project. Project groups are used to organize projects for worktag prompting. |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
ImportanceRating_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ImportanceRating_Href | String | False |
Supported for: SELECT. A link to the instance |
ImportanceRating_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
InScope | String | False |
Supported for: SELECT, INSERT. A description of what is considered to be in scope for the project. |
Inactive | Bool | False |
Supported for: SELECT, INSERT. True if the current project or the associated project hierarchy is inactive. |
IncludeProjectIDInName | Bool | False |
Supported for: SELECT, INSERT. Indicates whether to display the ID in the Project name. |
MeasuresOfSuccess | String | False |
Supported for: SELECT, INSERT. A description of what the project will be measured against to determine if it is successful. |
Name | String | False |
Supported for: SELECT, INSERT. The approved project name. |
Objective | String | False |
Supported for: SELECT, INSERT. A description of the desired outcome of the project. |
OptionalHierarchies_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Optional Project Hierarchies |
OutOfScope | String | False |
Supported for: SELECT, INSERT. A description of what is considered to be out of scope for the project. |
Overview | String | False |
Supported for: SELECT, INSERT. Project overview describing additional details about the project |
Owner_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Owner_Href | String | False |
Supported for: SELECT. A link to the instance |
Owner_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
PercentComplete | Decimal | False |
Supported for: SELECT, INSERT. The percent complete for the project. |
PrimaryHierarchy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
PrimaryHierarchy_Href | String | False |
Supported for: SELECT. A link to the instance |
PrimaryHierarchy_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Priority_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Priority_Href | String | False |
Supported for: SELECT. A link to the instance |
Priority_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ProbabilityOfSuccess | Decimal | False |
Supported for: SELECT, INSERT. The number indicating the probability of project success. |
ProblemStatement | String | False |
Supported for: SELECT, INSERT. A description of the problem to be resolved by the project. |
ProjectDependencies_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Project Dependencies |
ProjectID | String | False |
Supported for: SELECT, INSERT. Project_ID |
ProjectState_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectState_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectState_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RealizedRevenueSavings_Currency | String | False |
Supported for: SELECT, INSERT. The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RealizedRevenueSavings_Value | Decimal | False |
Supported for: SELECT, INSERT. The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RiskLevel_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RiskLevel_Href | String | False |
Supported for: SELECT. A link to the instance |
RiskLevel_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
StartDate | Datetime | False |
Supported for: SELECT, INSERT. Start Date |
Status_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Status_Href | String | False |
Supported for: SELECT. A link to the instance |
Status_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
SuccessRating_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SuccessRating_Href | String | False |
Supported for: SELECT. A link to the instance |
SuccessRating_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
TotalSavingsRemaining_Currency | String | False |
Supported for: SELECT. The total amount of savings remaining in project currency. |
TotalSavingsRemaining_Value | Decimal | False |
Supported for: SELECT. The total amount of savings remaining in project currency. |
Worktags_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Worktags |
Retrieves a single \~prospect\~ instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
CandidatePools_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The active, static pools for the candidate. |
CandidateTags_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The candidate tags associated with the candidate. |
Candidate_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Email | String | False |
Supported for: SELECT, INSERT. The candidate's email address. |
Candidate_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_Country_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_Country_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_FirstName | String | False |
Supported for: SELECT, INSERT. The first or given name for a person. |
Candidate_Name_FirstNameLocal | String | False |
Supported for: SELECT, INSERT. The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_FirstNameLocal2 | String | False |
Supported for: SELECT, INSERT. The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_FullName | String | False |
Supported for: SELECT, INSERT. The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used. |
Candidate_Name_Hereditary_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_Hereditary_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_LastName | String | False |
Supported for: SELECT, INSERT. The person's family name. |
Candidate_Name_LastNameLocal | String | False |
Supported for: SELECT, INSERT. The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_LastNameLocal2 | String | False |
Supported for: SELECT, INSERT. The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_MiddleName | String | False |
Supported for: SELECT, INSERT. The person's middle name. |
Candidate_Name_MiddleNameLocal | String | False |
Supported for: SELECT, INSERT. The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_Salutation_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_Salutation_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_SecondaryLastName | String | False |
Supported for: SELECT, INSERT. The secondary family name for a person. |
Candidate_Name_SecondaryLocal | String | False |
Supported for: SELECT, INSERT. The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Candidate_Name_Social_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_Social_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Name_TertiaryLastName | String | False |
Supported for: SELECT, INSERT. The person's tertiary last name. |
Candidate_Name_Title_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Name_Title_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Phone_CountryPhoneCode_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Candidate_Phone_CountryPhoneCode_Href | String | False |
Supported for: SELECT. A link to the instance |
Candidate_Phone_CountryPhoneCode_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Candidate_Phone_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Candidate_Phone_DeviceType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Candidate_Phone_DeviceType_Href | String | False |
Supported for: SELECT. A link to the instance |
Candidate_Phone_DeviceType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Candidate_Phone_Extension | String | False |
Supported for: SELECT, INSERT. The phone number extension. |
Candidate_Phone_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Candidate_Phone_PhoneNumber | String | False |
Supported for: SELECT, INSERT. The full primary phone number of the person. |
ContactConsent | Bool | False |
Supported for: SELECT, INSERT. If true, the candidate agrees to be contacted. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
Level_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Level_Href | String | False |
Supported for: SELECT. A link to the instance |
Level_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ReferredBy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ReferredBy_Href | String | False |
Supported for: SELECT. A link to the instance |
ReferredBy_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Source_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Source_Href | String | False |
Supported for: SELECT. A link to the instance |
Source_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Status_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Status_Href | String | False |
Supported for: SELECT. A link to the instance |
Status_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Type_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Type_Href | String | False |
Supported for: SELECT. A link to the instance |
Type_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Retrieves a single education instance for a \~prospect\~.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Prospects_Id [KEY] | String | False |
The Workday ID of the Prospects that owns this |
Degree_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Degree_Href | String | False |
Supported for: SELECT. A link to the instance |
Degree_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
FieldOfStudy_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
FieldOfStudy_Href | String | False |
Supported for: SELECT. A link to the instance |
FieldOfStudy_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
FirstYearAttended | Datetime | False |
Supported for: SELECT, INSERT. The first year the candidate attended this educational institution. |
GradeAverage | String | False |
Supported for: SELECT, INSERT. The candidate's grade average at this educational institution. |
LastYearAttended | Datetime | False |
Supported for: SELECT, INSERT. The last year the candidate attended this educational institution. |
SchoolName | String | False |
Supported for: SELECT, INSERT. The name of the school the candidate attended or is attending. |
Retrieves a single experience instance for a \~prospect\~.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Prospects_Id [KEY] | String | False |
The Workday ID of the Prospects that owns this |
CompanyName | String | False |
Supported for: SELECT, INSERT. The company name the candidate entered in their job history. |
CurrentlyWorkHere | Bool | False |
Supported for: SELECT, INSERT. If true, the candidate currently works at this company. |
Description | String | False |
Supported for: SELECT, INSERT. Any responsibilities or accomplishments that the candidate gained at the associated company. |
EndMonth | Decimal | False |
Supported for: SELECT, INSERT. The month the candidate ended employment at this company. |
EndYear | Datetime | False |
Supported for: SELECT, INSERT. The year the candidate ended employment at this company. |
Location | String | False |
Supported for: SELECT, INSERT. The location of this company. |
StartMonth | Decimal | False |
Supported for: SELECT, INSERT. The month the candidate started employment at this company. |
StartYear | Datetime | False |
Supported for: SELECT, INSERT. The year the candidate started employment at this company. |
Title | String | False |
Supported for: SELECT, INSERT. The business title for the candidate's work experience. |
Retrieves a single language instance for a \~prospect\~.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ proficiency: { /* Returns the proficiency for a specific ability of a language. */ *id: Text /* wid / id / reference id */ } abilityType: { /* Returns the language ability type. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Prospects_Id [KEY] | String | False |
The Workday ID of the Prospects that owns this |
Abilities_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The abilities associated with this language skill. |
Language_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Language_Href | String | False |
Supported for: SELECT. A link to the instance |
Language_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Native | Bool | False |
Supported for: SELECT, INSERT. If true, this language skill is the native language. |
Retrieves a single resume attachment instance for a \~prospect\~.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Prospects_Id [KEY] | String | False |
The Workday ID of the Prospects that owns this |
ContentType_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Descriptor | String | False |
Supported for: INSERT. A preview of the instance |
FileExtension | String | False |
Supported for: SELECT. The file extension of the attachment. |
FileLength | Decimal | False |
Supported for: SELECT, INSERT. The file length of the attachment. |
FileName | String | False |
Supported for: SELECT, INSERT. The file name of the attachment. |
Retrieves a single skill instance for a \~prospect\~.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Prospects_Id [KEY] | String | False |
The Workday ID of the Prospects that owns this |
Name | String | False |
Supported for: SELECT, INSERT. The name of the candidate skill. |
Retrieves the request with the specified ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ questionnaireAttachments: [{ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] answerMultipleChoices: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] answerNumeric: Numeric /* The answer in a numeric format. */ answerText: Text /* The text answer for a questionnaire. */ answerDate: Date /* The answer in a date format. */ questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */ *id: Text /* wid / id / reference id */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Comment | String | False |
Supported for: INSERT. Latest Comment for the Request Event of the Request |
CompletionDate | Datetime | False |
Supported for: SELECT. The date the request was completed. |
Description | String | False |
Supported for: SELECT, INSERT. Returns the description of the Request |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Href | String | False |
Supported for: SELECT. A link to the instance |
Initiator_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Initiator_Href | String | False |
Supported for: SELECT. A link to the instance |
Initiator_Id | String | False |
Supported for: SELECT. wid / id / reference id |
OnBehalfOf_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
OnBehalfOf_Href | String | False |
Supported for: SELECT. A link to the instance |
OnBehalfOf_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
QuestionnaireResponses_BusinessProcessType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
QuestionnaireResponses_BusinessProcessType_Href | String | False |
Supported for: SELECT. A link to the instance |
QuestionnaireResponses_BusinessProcessType_Id | String | False |
Supported for: SELECT. wid / id / reference id |
QuestionnaireResponses_CreationDate | Datetime | False |
Supported for: SELECT. The submission date for the Questionnaire Response |
QuestionnaireResponses_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
QuestionnaireResponses_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
QuestionnaireResponses_QuestionnaireAnswers_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The set of answers for a questionnaire. |
QuestionnaireResponses_QuestionnaireResponseStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
QuestionnaireResponses_QuestionnaireResponseStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
QuestionnaireResponses_QuestionnaireResponseStatus_Id | String | False |
Supported for: SELECT. wid / id / reference id |
QuestionnaireResponses_QuestionnaireTargetContext_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
QuestionnaireResponses_QuestionnaireTargetContext_Href | String | False |
Supported for: SELECT. A link to the instance |
QuestionnaireResponses_QuestionnaireTargetContext_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
QuestionnaireResponses_QuestionnaireTarget_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
QuestionnaireResponses_QuestionnaireTarget_Href | String | False |
Supported for: SELECT. A link to the instance |
QuestionnaireResponses_QuestionnaireTarget_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
QuestionnaireResponses_TotalScore | Decimal | False |
Supported for: SELECT. The total score for a questionnaire response is the sum of the questionnaire answers' score. |
RequestDate | Datetime | False |
Supported for: SELECT. The date that the request business process was initiated. |
RequestEvent_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RequestEvent_Href | String | False |
Supported for: SELECT. A link to the instance |
RequestEvent_Id | String | False |
Supported for: SELECT. wid / id / reference id |
RequestID | String | False |
Supported for: INSERT. Request ID |
RequestId_2 | String | False |
Supported for: SELECT. The ID of the request based on the ID generator format. |
RequestType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RequestType_Href | String | False |
Supported for: SELECT. A link to the instance |
RequestType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ResolutionDetails_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ResolutionDetails_Href | String | False |
Supported for: SELECT. A link to the instance |
ResolutionDetails_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Resolution_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Resolution_Href | String | False |
Supported for: SELECT. A link to the instance |
Resolution_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Status_Href | String | False |
Supported for: SELECT. A link to the instance |
Status_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Subtype_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Subtype_Href | String | False |
Supported for: SELECT. A link to the instance |
Subtype_Id | String | False |
Supported for: SELECT. wid / id / reference id |
WorkdayObjectValue_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkdayObjectValue_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkdayObjectValue_Id | String | False |
Supported for: SELECT. wid / id / reference id |
CompletedOnOrAfter_Prompt | Date | False |
No description available |
CompletedOnOrBefore_Prompt | Date | False |
No description available |
InitiatedOnOrAfter_Prompt | Date | False |
No description available |
InitiatedOnOrBefore_Prompt | Date | False |
No description available |
Initiator_Prompt | String | False |
Accepts multiple inputs. The WID for the person who initiated the request. You can GET /workers in the /common service to retrieve a worker's WID. |
OnBehalfOf_Prompt | String | False |
The Workday ID of the person this request is being initiated on behalf of. |
RequestId_Prompt | String | False |
The ID of the request based on the ID generator format. |
RequestSubtype_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the request subtype. You can specify more than 1 requestSubtype query parameter. |
RequestType_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the request type. You can specify more than 1 requestType query parameter. |
ResolutionDetails_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the resolution details. You can specify more than 1 resolutionDetails query parameter. |
Resolution_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the resolution of the request. You can specify more than 1 resolution query parameter. |
WorkdayObjectValue_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the business object associated with the request. |
Retrieves a requisition.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ supplier: { /* The supplier as a worktag. */ *id: Text /* wid / id / reference id */ } startDate: Date /* The start date requested for the service on the requisition line. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] requestedDeliveryDate: Date /* The delivery date requested for the goods on the line. This field does not appear on the payload when a date isn't selected or when the line isn't for goods. */ warningCustomValidations: Text /* The list of failing warning custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. */ criticalCustomValidations: Text /* The list of failing critical custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. */ lotSerialInformation: { /* Returns/Updates the instances of the Lot Serial Information for lines on the requisition for REST API. */ serialNumber: Text /* The lot number for the bill only transaction. */ lotNumber: Text /* The lot serial number for the bill only transaction. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } itemDescription: Text /* The line item description for the requisition line. */ noCharge: Boolean /* If true, the requisition line is a no charge requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. */ item: { /* The item for the document line. */ *id: Text /* wid / id / reference id */ } writeInService: Boolean /* If true, the requisition line is a service line with no purchase item, supplier item, or catalog item. */ memo: Text /* The line memo for the requisition line. */ writeInGoods: Boolean /* If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item. */ quantity: Numeric /* The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative. */ unitOfMeasure: { /* The unit of measure for the document line. */ *id: Text /* wid / id / reference id */ } orderFromConnection: { /* The order-from supplier connection on the requisition line. The order-from connection populates on the requisition line based on sourcing rules or manual entry. */ *id: Text /* wid / id / reference id */ } unitCost: Currency /* The unit cost for the requisition line. */ spendCategory: { /* Returns the Spend Category defined on the Line for the Business Document Line Distribution. */ *id: Text /* wid / id / reference id */ } shipToAddress: { /* The Address Reference related to the Ship-To Address of the document line. Note: This CRF is only used internally via Closely Related Field configuration for Ship-To Address. */ *id: Text /* wid / id / reference id */ } deliverToLocation: { /* The final location where the goods or services are delivered. Example: an "\~employee\~(s)" work station or stock room. */ *id: Text /* wid / id / reference id */ } lineCompany: { /* Returns the Company for the Business Document Line Distribution instance. */ *id: Text /* wid / id / reference id */ } rfqRequired: Boolean /* If true, a request for quote is required for the requisition line. */ supplierItemIdentifier: Text /* The alphanumeric identifier assigned by a supplier to an item. This can be different from the manufacturer identification number. */ supplierContract: { /* The supplier contract associated to the goods or services on the requisition line. The supplier contract may determine the pricing for the good or the service. */ *id: Text /* wid / id / reference id */ } endDate: Date /* The end date requested for the service on the requisition line. */ shipToContact: { /* The Ship To contact \~worker\~ for the document line. */ *id: Text /* wid / id / reference id */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
AdditionalInformation | String | False |
Supported for: SELECT, INSERT, UPDATE. The additional procedure details that a particular requisition is being created to accommodate. |
Amount_Currency | String | False |
Supported for: SELECT. The total amount for the requisition. This value displays in the currency for the requisition. Workday calculates this value as the sum of all requisition lines including additional charges such as tax and freight. |
Amount_Value | Decimal | False |
Supported for: SELECT. The total amount for the requisition. This value displays in the currency for the requisition. Workday calculates this value as the sum of all requisition lines including additional charges such as tax and freight. |
Comments | String | False |
Supported for: SELECT. Comments for canceling or closing a requisition. |
Company_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Company_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
CriticalCustomValidations | String | False |
Supported for: SELECT, INSERT, UPDATE. The list of failing critical custom validation messages that have been configured at the requisition header as a single string. These validations may represent aggregations at the line level. Each message is delimited by HTML encoded line feed character. |
Currency_CurrencySymbol | String | False |
Supported for: SELECT. The three letter currency symbol for the currency. |
Currency_Descriptor | String | False |
Supported for: SELECT. The full name of the currency. |
Currency_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
DeliverToLocationChain | String | False |
Supported for: SELECT. The deliver-to location and the associated hierarchy of deliver-to locations for the requisition. When creating new requisition lines, this value is the line's default deliver-to location. |
DeliverToLocation_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
DeliverToLocation_Id | String | False |
Supported for: SELECT, UPDATE. Id of the instance |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
ExternalSourceableId | String | False |
Supported for: SELECT, INSERT, UPDATE. The External Sourceable ID for the requisition. |
ExternalSystemId_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ExternalSystemId_Href | String | False |
Supported for: SELECT. A link to the instance |
ExternalSystemId_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
FormattedAmount | String | False |
Supported for: SELECT. The total amount for the requisition that shows the currency symbol. The locale of the current user determines the positive or negative display format, currency symbol placement, grouping separator, and decimal separator. |
FormattedFreight | String | False |
Supported for: SELECT. The freight amount for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user. |
FormattedOtherCharges | String | False |
Supported for: SELECT. The other charges for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user. |
FormattedShippingAddress | String | False |
Supported for: SELECT. The shipping address for the requisition as a single string. Each line of the shipping address is delimited by HTML encoded line feed character. |
FormattedSubtotal | String | False |
Supported for: SELECT. The line subtotal for the requisition. Positive/negative display format, grouping separator, and decimal separator is based on the locale of the current logged in user. |
FreightAmount_Currency | String | False |
Supported for: SELECT, INSERT, UPDATE. The total amount of freight charges that are applicable for the taxable document. |
FreightAmount_Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The total amount of freight charges that are applicable for the taxable document. |
HighPriority | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Returns true if the "High Priority" checkbox was checked on the Requisition. |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
InternalMemo | String | False |
Supported for: SELECT, INSERT, UPDATE. The internal memo on a document. This type of memo is viewable by only internal workers of your company, and not any outside party. |
InventorySite_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
InventorySite_Href | String | False |
Supported for: SELECT. A link to the instance |
InventorySite_Id | String | False |
Supported for: SELECT. wid / id / reference id |
MedicalRecordNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The medical record number that a particular requisition is being created to accommodate. |
Memo | String | False |
Supported for: SELECT, INSERT, UPDATE. The transaction memo for the reporting transaction. |
OtherCharges_Currency | String | False |
Supported for: SELECT, INSERT, UPDATE. The total amount of other charges that are applicable for the taxable document. |
OtherCharges_Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The total amount of other charges that are applicable for the taxable document. |
ParLocation_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ParLocation_Href | String | False |
Supported for: SELECT. A link to the instance |
ParLocation_Id | String | False |
Supported for: SELECT. wid / id / reference id |
PatientId | String | False |
Supported for: SELECT, INSERT, UPDATE. The patient id that a particular requisition is being created to accommodate. |
PhysicianId | String | False |
Supported for: SELECT, INSERT, UPDATE. The physician id that a particular requisition is being created to accommodate. |
Procedure | String | False |
Supported for: SELECT, INSERT, UPDATE. The procedure that a particular requisition is being created to accommodate. |
ProcedureDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The procedure date that a particular requisition is being created to accommodate. |
ProcedureNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The procedure number that a particular requisition is being created to accommodate. |
ReasonCode_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ReasonCode_Href | String | False |
Supported for: SELECT. A link to the instance |
ReasonCode_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Requester_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Requester_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Requester_Image_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Requester_Image_Href | String | False |
Supported for: SELECT. A link to the instance |
Requester_Image_Id | String | False |
Supported for: SELECT. Id of the instance |
Requester_Image_Url | String | False |
Supported for: SELECT. The relative url for this image in UI Server. |
RequestingEntity_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RequestingEntity_Href | String | False |
Supported for: SELECT. A link to the instance |
RequestingEntity_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RequisitionDate | Datetime | False |
Supported for: SELECT. The date when the items of the requisition were requested. |
RequisitionLines_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The requisition lines on the requisition. These lines may not be returned in the same order. |
RequisitionType_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
RequisitionType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
RequisitionType_RequisitionTypeDetails_BillOnly | Bool | False |
Supported for: SELECT. Bill Only flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_Consignment | Bool | False |
Supported for: SELECT. Consignment flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_HasService | Bool | False |
Supported for: SELECT. Does the requisition type have a service. |
RequisitionType_RequisitionTypeDetails_Inactive | Bool | False |
Supported for: SELECT. Inactive flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_InventoryReplenishment | Bool | False |
Supported for: SELECT. Inventory Replenishment flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_JustInTime | Bool | False |
Supported for: SELECT. Just In Time flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_ParReplenishment | Bool | False |
Supported for: SELECT. Par Replenishment flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_ProcedureInformation | Bool | False |
Supported for: SELECT. Procedure Information flag defined on Maintain Requisition Types Task. |
RequisitionType_RequisitionTypeDetails_SupplierContractRequest | Bool | False |
Supported for: SELECT. Supplier Contract Request flag defined on Maintain Requisition Types Task |
ShippingAddress_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ShippingAddress_Href | String | False |
Supported for: SELECT. A link to the instance |
ShippingAddress_Id | String | False |
Supported for: SELECT, UPDATE. wid / id / reference id |
SourcingBuyer_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SourcingBuyer_Href | String | False |
Supported for: SELECT. A link to the instance |
SourcingBuyer_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Status_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Status_Href | String | False |
Supported for: SELECT. A link to the instance |
Status_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Submitter_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Submitter_Href | String | False |
Supported for: SELECT. A link to the instance |
Submitter_Id | String | False |
Supported for: SELECT. wid / id / reference id |
SupplierRepresentative | String | False |
Supported for: SELECT, INSERT, UPDATE. The supplier representative that a particular requisition is being created to accommodate. |
VerifiedBy | String | False |
Supported for: SELECT, INSERT, UPDATE. The procedure verified by that a particular requisition is being created to accommodate. |
WarningCustomValidations | String | False |
Supported for: SELECT, INSERT, UPDATE. The list of failing warning custom validation messages that have been configured at the requisition header as a single string. These validations may represent aggregations at the line level. Each message is delimited by HTML encoded line feed character. |
ExternalSourceableId_Prompt | String | False |
No description available |
ExternalSystemId_Prompt | String | False |
No description available |
FromDate_Prompt | Date | False |
Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | False |
Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | False |
Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedByPerson_Prompt | String | False |
Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | False |
Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
SubmittedBy_Prompt | String | False |
Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
ToDate_Prompt | Date | False |
Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Retrieves the metadata or the attachment content of the specified requisition.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Requisitions_Id [KEY] | String | False |
The Workday ID of the Requisitions that owns this |
AttachmentCategory_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
AttachmentCategory_Id | String | False |
Supported for: SELECT, UPDATE. Id of the instance |
Comment | String | False |
Supported for: SELECT, UPDATE. The comment for the attachment. |
ContentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ContentType_Href | String | False |
Supported for: SELECT. A link to the instance |
ContentType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
External | Bool | False |
Supported for: SELECT, UPDATE. If true, an external supplier can view the attachment on the purchase order once the purchase order has been issued. |
FileLength | Decimal | False |
Supported for: SELECT, INSERT. The length of the attachment. |
FileName | String | False |
Supported for: SELECT, INSERT. The file name of the attachment. |
Href | String | False |
Supported for: INSERT. A link to the instance |
ExternalSourceableId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
ExternalSystemId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
FromDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedBy_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
SubmittedByPerson_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
ToDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Retrieves a requisition line for the specified requisition.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Requisitions_Id [KEY] | String | False |
The Workday ID of the Requisitions that owns this |
CatalogItem | Bool | False |
Supported for: SELECT. If true, the business document line is for a catalog item. |
CreatedMoment | Datetime | False |
Supported for: SELECT. The moment at which the requisition line was originally created. |
CriticalCustomValidations | String | False |
Supported for: SELECT, INSERT, UPDATE. The list of failing critical custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. |
DeliverToLocation_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
DeliverToLocation_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EndDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The end date requested for the service on the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. |
ExtendedAmount_Currency | String | False |
Supported for: SELECT. The extended amount for the requisition line. Excludes extended amounts on tax only invoices. |
ExtendedAmount_Value | Decimal | False |
Supported for: SELECT. The extended amount for the requisition line. Excludes extended amounts on tax only invoices. |
FormattedExtendedAmount | String | False |
Supported for: SELECT. The extended amount for the business document line that shows the currency symbol. The locale of the current user determines the positive or negative display format, currency symbol placement, grouping separator, and decimal separator. |
FormattedShippingAddress | String | False |
Supported for: SELECT. The shipping address for the requisition line as a single string. Each line of the shipping address is delimited by HTML encoded line feed character. |
FormattedUnitCost | String | False |
Supported for: SELECT. The unit cost for the business document line showing the currency symbol. Positive/negative display format, currency symbol placement, grouping separator, and decimal separator is based on the locale of the current logged in user. |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
ItemDescription | String | False |
Supported for: SELECT, INSERT, UPDATE. The line item description for the requisition line. |
ItemImage_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
ItemImage_Href | String | False |
Supported for: SELECT. A link to the instance |
ItemImage_Id | String | False |
Supported for: SELECT. Id of the instance |
ItemImage_InternalURL | String | False |
Supported for: SELECT. The URL for the image in Workdays UI Server. |
ItemRanking | Decimal | False |
Supported for: INSERT, UPDATE. itemRanking |
ItemURL | String | False |
Supported for: SELECT. The Workday Instance View URL for a Procurement Item Instance - From a Line |
Item_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Item_Href | String | False |
Supported for: SELECT. A link to the instance |
Item_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
LineCompany_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
LineCompany_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
LineDeliverToLocationChain | String | False |
Supported for: SELECT. The deliver-to location and the associated hierarchy of deliver-to locations for the requisition line. |
LotSerialInformation_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
LotSerialInformation_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
LotSerialInformation_LotNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The lot number for the bill only transaction. |
LotSerialInformation_SerialNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The lot serial number for the bill only transaction. |
Memo | String | False |
Supported for: SELECT, INSERT, UPDATE. The line memo for the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. |
NoCharge | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, the requisition line is a no charge requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. |
OrderFromConnection_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
OrderFromConnection_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Quantity | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The quantity on the requisition line. This value can have 20 integer places, is precise to 2 decimal places, and cannot be negative. |
RequestedDeliveryDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The delivery date requested for the goods on the line. This field does not appear on the payload when a date isn't selected or when the line isn't for goods. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. |
RfqRequired | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, a request for quote is required for the requisition line. |
SearchTerm | String | False |
Supported for: INSERT, UPDATE. Search term used to query through Search Catalog for current item on this requisition line. |
ServiceRequisitionLine | Bool | False |
Supported for: SELECT. If true, the requisition line is for a service. |
ShipToAddressReference_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ShipToAddressReference_Href | String | False |
Supported for: SELECT. A link to the instance |
ShipToAddressReference_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ShipToAddress_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | False |
Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ShipToContact_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | False |
Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
SpendCategory_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | False |
Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
StartDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The start date requested for the service on the requisition line. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. |
SupplierContract_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
SupplierContract_Href | String | False |
Supported for: SELECT. A link to the instance |
SupplierContract_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
SupplierItemIdentifier | String | False |
Supported for: SELECT, INSERT, UPDATE. The alphanumeric identifier assigned by a supplier to an item. This value can be unique for each supplier of the item, and is different from the manufacturer identification number. |
Supplier_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Supplier_Href | String | False |
Supported for: SELECT. A link to the instance |
Supplier_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
UnitCost_Currency | String | False |
Supported for: SELECT, INSERT, UPDATE. The unit cost for the requisition line. |
UnitCost_Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The unit cost for the requisition line. |
UnitOfMeasure_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
UnitOfMeasure_Href | String | False |
Supported for: SELECT. A link to the instance |
UnitOfMeasure_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
WarningCustomValidations | String | False |
Supported for: SELECT, INSERT, UPDATE. The list of failing warning custom validation messages that have been configured at the requisition line level as a single string. Each message is delimited by HTML encoded line feed character. |
WebItem | Bool | False |
Supported for: SELECT. If true, the requisition line is for a web item. |
WebItemImageURL | String | False |
Supported for: SELECT. The URL for the supplier's image of the web item on the requisition line. This field returns blank when the line is not for a web item, or when configuration in Workday prevents external images from that supplier website. |
Worktags_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The worktags for the requisition line. |
WriteInGoods | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item. |
WriteInService | Bool | False |
Supported for: SELECT, INSERT, UPDATE. If true, the requisition line is a service line with no purchase item, supplier item, or catalog item. |
ExternalSourceableId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
ExternalSystemId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
FromDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedBy_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
SubmittedByPerson_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
ToDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads worktags entries from the RequisitionsRequisitionLines table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
RequisitionsRequisitionLines_Id [KEY] | String | False |
The Wordkay ID of the RequisitionsRequisitionLines that contains this |
Requisitions_Id [KEY] | String | False |
The Workday ID of the Requisitions that owns this |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
WorktagType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorktagType_Href | String | False |
Supported for: SELECT. A link to the instance |
WorktagType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ExternalSourceableId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
ExternalSystemId_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. No description available |
FromDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedBy_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
SubmittedByPerson_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | False |
Only used when a Requisitions_Id filter is not provided. Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
ToDate_Prompt | Date | False |
Only used when a Requisitions_Id filter is not provided. Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads worktags entries from the Requisitions table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Requisitions_Id [KEY] | String | False |
The Wordkay ID of the Requisitions that contains this |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
WorktagType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorktagType_Href | String | False |
Supported for: SELECT. A link to the instance |
WorktagType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ExternalSourceableId_Prompt | String | False |
No description available |
ExternalSystemId_Prompt | String | False |
No description available |
FromDate_Prompt | Date | False |
Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | False |
Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | False |
Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedByPerson_Prompt | String | False |
Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | False |
Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
SubmittedBy_Prompt | String | False |
Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
ToDate_Prompt | Date | False |
Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Retrieve Resource Forecast Line Allocation.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
ResourceForecastLines_Id [KEY] | String | False |
The Workday ID of the ResourceForecastLines that owns this |
Date | Datetime | False |
Supported for: SELECT, INSERT. The date for the forecasted hours. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
ForecastedHours | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The number of hours forecasted for the worker on the date. |
Project_Prompt | String | False |
Only used when a ResourceForecastLines_Id filter is not provided. No description available |
ProjectResource_Prompt | String | False |
Only used when a ResourceForecastLines_Id filter is not provided. No description available |
ProjectRole_Prompt | String | False |
Only used when a ResourceForecastLines_Id filter is not provided. No description available |
Retrieves a single resource plan line instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ delayedDate: Date /* The date the delayed step will trigger. */ businessProcessStep: { /* Retired. We retire this report field because it doesn't return all the steps on the business process definition that are associated with the business process event step. A business process event step can be associated with multiple steps from the business process definition if those steps were automatically skipped. Example: Entry conditions to those steps aren't met. We recommend that you use the Steps report field instead. */ *id: Text /* wid / id / reference id */ } businessEventValidation: [{ conditionRule: Text /* The condition rule as a text expression. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] status: { /* The status of this business process step. */ *id: Text /* wid / id / reference id */ } event: { /* Identifies the business process and allows you to drill into the details and access related actions. */ *id: Text /* wid / id / reference id */ } completedByPerson: { /* The person that completed the step as Assignee */ *id: Text /* wid / id / reference id */ } completedOn: Date /* The date when this step was completed */ due: Date /* Returns the due date for this step. */ creationDate: Date /* The date when the event record was created. */ awaitingPersons: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] comments: [{ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ } conmentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ }] descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ values: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] category: { /* The requirement category for the \~project role\~. */ *id: Text /* wid / id / reference id */ } optional: Boolean /* The optional status of a requirement. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
BookingStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BookingStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
BookingStatus_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessEventRecords_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The Project Resource Plan Line Event business process record that's initiated when you create or change a resource plan line for a given resource plan. |
CostRateCurrencyOverride_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CostRateCurrencyOverride_Href | String | False |
Supported for: SELECT. A link to the instance |
CostRateCurrencyOverride_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
CostRateOverride_Currency | String | False |
Supported for: SELECT, INSERT. The amount per hour a worker will contribute to the time cost of a project. |
CostRateOverride_Value | Decimal | False |
Supported for: SELECT, INSERT. The amount per hour a worker will contribute to the time cost of a project. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
EndDate | Datetime | False |
Supported for: SELECT, INSERT. The date the resource plan line ends. |
EstimatedHours | Decimal | False |
Supported for: SELECT, INSERT. The total number of work hours estimated for the role on project resource plan line. |
ExcludedWorkers_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line. |
JobRequisition_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
JobRequisition_Href | String | False |
Supported for: SELECT. A link to the instance |
JobRequisition_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Memo | String | False |
Supported for: SELECT, INSERT. Additional details for the resource plan line. |
PercentAllocation | Decimal | False |
Supported for: SELECT, INSERT. The percent allocation of the worker's time on the project in their assigned role for the resource plan line. |
Project_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Requirements_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Contains the specific requirements by category for the project role. |
ResourceType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ResourceType_Href | String | False |
Supported for: SELECT. A link to the instance |
ResourceType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RoleCategory_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RoleCategory_Href | String | False |
Supported for: SELECT. A link to the instance |
RoleCategory_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Role_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Role_Href | String | False |
Supported for: SELECT. A link to the instance |
Role_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
StartDate | Datetime | False |
Supported for: SELECT, INSERT. The date the resource plan line starts. |
ToBeHired | Bool | False |
Supported for: SELECT, INSERT. Returns true if the resource plan line requires a worker a resource still needs to be hired. |
UnnamedResources | Decimal | False |
Supported for: INSERT. The unnamed resource assigned as a placeholder on the resource plan. |
WorkerGroup_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
WorkerGroup_Href | String | False |
Supported for: SELECT. A link to the instance |
WorkerGroup_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Workers_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The workers assigned to the resource plan line. |
ProjectResourcePlan_Prompt | String | False |
No description available |
Project_Prompt | String | False |
No description available |
Provides the ability to set up and retrieve Scores on Scorecard Results.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
DefaultScorecardGoalsResult_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
DefaultScorecardGoalsResult_EligibiltyRule_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
DefaultScorecardGoalsResult_EligibiltyRule_Href | String | False |
Supported for: SELECT. A link to the instance |
DefaultScorecardGoalsResult_EligibiltyRule_Id | String | False |
Supported for: SELECT. wid / id / reference id |
DefaultScorecardGoalsResult_Id | String | False |
Supported for: SELECT. Id of the instance |
DefaultScorecardGoalsResult_WeightedFundingPercent | Decimal | False |
Supported for: SELECT. Calculates the total Weighted Funding Percent for all the scores in the scorecard result set. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
EvaluationDate | Datetime | False |
Supported for: SELECT, INSERT. Scorecard Result Evaluation Date |
ScorecardDescription | String | False |
Supported for: SELECT. Returns the Scorecard's Description |
ScorecardID_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
ScorecardName | String | False |
Supported for: SELECT. The goal name of the scorecard criteria result. |
Retrieves Compensation Scorecard information.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ goalDescription: Text /* The description of the Compensation Scorecard Goal */ *goalWeight: Numeric /* The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9] */ *goalName: Text /* The name of the Compensation Scorecard Goal. */ id: Text /* Id of the instance */ }]
[{ *profileScorecardGoals: [{ goalDescription: Text /* The description of the Compensation Scorecard Goal */ *goalWeight: Numeric /* The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9] */ *goalName: Text /* The name of the Compensation Scorecard Goal. */ id: Text /* Id of the instance */ }] *eligibilityRule: { /* The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
DefaultScorecardGoals_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The goals for the Compensation Scorecard. |
EffectiveDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The Effective Date of the Compensation Scorecard in format YYYY-MM-DD. |
Inactive | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Indicates whether the Scorecard is inactive using a value of true/false. |
ScorecardDescription | String | False |
Supported for: SELECT, INSERT, UPDATE. The description of the Compensation Scorecard. |
ScorecardName | String | False |
Supported for: SELECT, INSERT, UPDATE. The name of the Compensation Scorecard. |
ScorecardProfiles_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The profiles for the Compensation Scorecard. |
EffectiveDate_Prompt | Date | False |
Effective date the scorecard task takes effect. |
Reads defaultScorecardGoals entries from the Scorecards table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Scorecards_Id [KEY] | String | False |
The Wordkay ID of the Scorecards that contains this |
GoalDescription | String | False |
Supported for: SELECT, INSERT, UPDATE. The description of the Compensation Scorecard Goal. |
GoalName | String | False |
Supported for: SELECT, INSERT, UPDATE. The name of the Compensation Scorecard Goal. |
GoalWeight | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9] |
EffectiveDate_Prompt | Date | False |
Effective date the scorecard task takes effect. |
Reads scorecardProfiles entries from the Scorecards table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ goalWeight: Numeric /* The weight given to the Compensation Scorecard \~Goal\~. [90% will be displayed as 0.9] */ goalDescription: Text /* The description of the Compensation Scorecard \~Goal\~. */ goalName: Text /* The name of the Compensation Scorecard \~Goal\~. */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Scorecards_Id [KEY] | String | False |
The Wordkay ID of the Scorecards that contains this |
EligibilityRule_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
EligibilityRule_Href | String | False |
Supported for: SELECT. A link to the instance |
EligibilityRule_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ProfileScorecardGoals_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. The goals for the Compensation Scorecard. |
EffectiveDate_Prompt | Date | False |
Effective date the scorecard task takes effect. |
Retrieves a single student payment instance for the specified student ID.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Students_Id [KEY] | String | False |
The Workday ID of the Students that owns this |
AcademicPeriod_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
AcademicPeriod_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Amount_Currency | String | False |
Supported for: SELECT, INSERT, UPDATE. The amount of the customer payment in transaction currency. |
Amount_Value | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The amount of the customer payment in transaction currency. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
InstitutionalAcademicUnit_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
InstitutionalAcademicUnit_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
PaymentDate | Datetime | False |
Supported for: SELECT, INSERT. The transaction date for the reporting transaction. If you used a filtering criteria for expense reports, use the Expense Report Date report field instead. |
PaymentItem_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
PaymentItem_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
PaymentType_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
PaymentType_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
Reason_Descriptor | String | False |
Supported for: UPDATE. A preview of the instance |
Reason_Id | String | False |
Supported for: UPDATE. Id of the instance |
Reference | String | False |
Supported for: SELECT, INSERT. The reference to a customer payment that's processed through a settlement run. This field is blank when the Payment Status is In Progress or when the Payment Type is Check or ETF. |
StudentFinanceTransactionDate | Datetime | False |
Supported for: SELECT, INSERT. The start and end date of a date range that filters payments by the student payment transaction date, using the yyyy-mm-dd format. |
AcademicPeriod_Prompt | String | False |
The academic period associated with this object. When the object is associated with both a starting and an ending academic period, such as a financial aid period record, this report field returns the starting academic period. |
FromDate_Prompt | Date | False |
Limit student payments to payments made on or after this date, using the yyyy-mm-dd format. |
InstitutionalAcademicUnit_Prompt | String | False |
The academic unit, an organizational type for academic appointments. |
PaymentItem_Prompt | String | False |
The student payment item that is associated with the student payment. |
PaymentReference_Prompt | String | False |
The check number or EFT number associated with a student payment. |
PaymentType_Prompt | String | False |
The payment type for the reporting transaction. |
ToDate_Prompt | Date | False |
Limit student payments to payments made on or before this date, using the yyyy-mm-dd format. |
AcademicLevel_Prompt | String | False |
Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | False |
Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | False |
Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | False |
Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | False |
Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Retrieves a single supplier invoice instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ unitCost: Currency /* The unit cost for the document line. */ internalMemo: Text /* The internal line memo for the supplier invoice request line. */ worktags: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] itemDescription: Text /* The description of the item on the document line. This is a text-only value. */ splits: [{ percent: Numeric /* The percentage specified for the Business Document Line distribution line split. */ billable: Boolean /* True if the supplier invoice request line or line split are billable. */ memo: Text /* The memo for a line split */ quantity: Numeric /* The quantity specified for the Business Document Line distribution line split. */ amount: Currency /* The amount on the transaction line split. This value displays in the same currency as the business document. */ worktags: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] order: Text /* The order of the lines on a transaction. You can use this field to compare other transactions, such as supplier invoice matching events. */ billable: Boolean /* True if the supplier invoice request line or line split are billable. */ splitBy: { /* The distribution method for supplier invoice request line. */ *id: Text /* wid / id / reference id */ } quantity: Numeric /* The quantity on the transaction line. This value can have 20 integer places, is precise to 2 decimal places, and can be negative. */ extendedAmount: Currency /* The extended amount for the document line. Excludes extended amount on tax only invoices. */ spendCategory: { /* Returns the Spend Category defined on the Line for the Business Document Line Distribution. */ *id: Text /* wid / id / reference id */ } unitOfMeasure: { /* The unit of measure for the document line. */ *id: Text /* wid / id / reference id */ } memo: Text /* The memo on the document line. */ serviceLine: Boolean /* The line type for supplier invoice request line. */ item: { /* The item for the document line. */ *id: Text /* wid / id / reference id */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Company_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Company_Href | String | False |
Supported for: SELECT. A link to the instance |
Company_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ControlTotalAmount_Currency | String | False |
Supported for: SELECT, INSERT. The amount entered that should match the total of the line amounts. |
ControlTotalAmount_Value | Decimal | False |
Supported for: SELECT, INSERT. The amount entered that should match the total of the line amounts. |
Currency_CurrencyID | String | False |
Supported for: SELECT. The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the 'Organization ID' |
Currency_Descriptor | String | False |
Supported for: SELECT. A preview of the instance |
Currency_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
DueDate | Datetime | False |
Supported for: SELECT. The due date for payment for this Supplier Invoice Request. Example: If the payment terms are Net 30, the Due Date field is 30 days after the invoice date. |
FreightAmount_Currency | String | False |
Supported for: SELECT, INSERT. The freight amount for the supplier invoice request. |
FreightAmount_Value | Decimal | False |
Supported for: SELECT, INSERT. The freight amount for the supplier invoice request. |
HandlingCode_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
HandlingCode_Href | String | False |
Supported for: SELECT. A link to the instance |
HandlingCode_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
InvoiceDate | Datetime | False |
Supported for: SELECT, INSERT. The date when a request for a supplier invoice is created. |
InvoiceReceivedDate | Datetime | False |
Supported for: SELECT, INSERT. The date the invoice was recieved |
Lines_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The Supplier Invoice Request Lines for a Supplier Invoice Request. |
Memo | String | False |
Supported for: SELECT, INSERT. The memo for the supplier invoice request. |
PaymentTerms_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
PaymentTerms_Href | String | False |
Supported for: SELECT. A link to the instance |
PaymentTerms_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ReferenceNumber | String | False |
Supported for: SELECT, INSERT. The reference number that is encoded with key payment information on the invoice request document. |
ReferenceType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ReferenceType_Href | String | False |
Supported for: SELECT. A link to the instance |
ReferenceType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RemitToConnection_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
RemitToConnection_Href | String | False |
Supported for: SELECT. A link to the instance |
RemitToConnection_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
RequestNumber | String | False |
Supported for: SELECT. The unique number assigned to the Supplier Invoice Request at the time of creation. |
Requester_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Requester_Href | String | False |
Supported for: SELECT. A link to the instance |
Requester_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
ShipToAddress_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | False |
Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Status_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Status_Href | String | False |
Supported for: SELECT. A link to the instance |
Status_Id | String | False |
Supported for: SELECT. wid / id / reference id |
StatutoryInvoiceType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
StatutoryInvoiceType_Href | String | False |
Supported for: SELECT. A link to the instance |
StatutoryInvoiceType_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
Supplier_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Supplier_Href | String | False |
Supported for: SELECT. A link to the instance |
Supplier_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
SuppliersInvoiceNumber | String | False |
Supported for: SELECT, INSERT. The reference number provided by the supplier for the supplier invoice request. |
TaxAmount_Currency | String | False |
Supported for: SELECT, INSERT. Tax amount for the supplier invoice request. |
TaxAmount_Value | Decimal | False |
Supported for: SELECT, INSERT. Tax amount for the supplier invoice request. |
Company_Prompt | String | False |
Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | False |
The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | False |
The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | False |
Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | False |
Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | False |
Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | False |
The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | False |
The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Retrieves a single attachment instance.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
SupplierInvoiceRequests_Id [KEY] | String | False |
The Workday ID of the SupplierInvoiceRequests that owns this |
ContentType_Id | String | False |
Supported for: INSERT. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
FileExtension | String | False |
Supported for: SELECT. Type of the file extension for an attachment. |
FileLength | Decimal | False |
Supported for: SELECT, INSERT. File length of the attachment |
FileName | String | False |
Supported for: SELECT, INSERT. File name of the attachment |
Company_Prompt | String | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | False |
Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Retrieves a single task resource instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Allocation | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The allocation percentage for the task resource. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EndDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The date the task resource ends. |
EstimatedHours | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The number of hours estimated for the task resource. |
Memo | String | False |
Supported for: SELECT, INSERT, UPDATE. The memo specified on the Project Task Resource. |
ProjectPlanLine_AssociationResourcePlanDetail | Bool | False |
Supported for: SELECT. Flag denoting whether resource plan detail is association type |
ProjectPlanLine_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
ProjectPlanLine_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
ProjectPlanTask_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectPlanTask_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectPlanTask_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ProjectResources_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The workers or unnamed resources assigned to the resource plan. |
StartDate | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The date the task resource starts. |
WarningCustomValidations | String | False |
Supported for: SELECT. Warning Custom Validations |
ProjectPlanTask_Prompt | String | False |
Accepts multiple inputs. No description available |
Project_Prompt | String | False |
Accepts multiple inputs. No description available |
Reads projectResources entries from the TaskResources table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
TaskResources_Id [KEY] | String | False |
The Wordkay ID of the TaskResources that contains this |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
ProcessingUserHasAccessToViewWorker | Bool | False |
Supported for: SELECT. Processing user has view access to Worker |
UnnamedResource | Bool | False |
Supported for: SELECT. If true, the project resource is an unnamed resource. |
ProjectPlanTask_Prompt | String | False |
Accepts multiple inputs. No description available |
Project_Prompt | String | False |
Accepts multiple inputs. No description available |
Retrieves a time clock event.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
AllocationPool_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
AllocationPool_Href | String | False |
Supported for: SELECT. A link to the instance |
AllocationPool_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Appropriation_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Appropriation_Href | String | False |
Supported for: SELECT. A link to the instance |
Appropriation_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
BusinessUnit_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessUnit_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessUnit_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The comment associated with the time clock event. |
CostCenter_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CostCenter_Href | String | False |
Supported for: SELECT. A link to the instance |
CostCenter_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Currency_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Currency_Href | String | False |
Supported for: SELECT. A link to the instance |
Currency_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization01_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization01_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization01_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization02_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization02_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization02_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization03_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization03_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization03_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization04_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization04_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization04_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization05_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization05_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization05_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization06_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization06_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization06_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization07_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization07_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization07_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization08_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization08_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization08_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization09_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization09_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization09_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomOrganization10_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomOrganization10_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomOrganization10_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag01_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag01_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag01_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag02_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag02_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag02_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag03_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag03_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag03_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag04_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag04_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag04_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag05_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag05_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag05_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag06_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag06_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag06_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag07_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag07_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag07_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag08_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag08_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag08_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag09_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag09_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag09_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag10_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag10_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag10_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag11_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag11_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag11_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag12_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag12_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag12_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag13_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag13_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag13_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag14_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag14_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag14_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
CustomWorktag15_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
CustomWorktag15_Href | String | False |
Supported for: SELECT. A link to the instance |
CustomWorktag15_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
DateTime | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. The date time for a time clock event. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EventType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
EventType_Href | String | False |
Supported for: SELECT. A link to the instance |
EventType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Fund_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Fund_Href | String | False |
Supported for: SELECT. A link to the instance |
Fund_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Gift_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Gift_Href | String | False |
Supported for: SELECT. A link to the instance |
Gift_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Grant_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Grant_Href | String | False |
Supported for: SELECT. A link to the instance |
Grant_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Href | String | False |
Supported for: SELECT, INSERT, UPDATE. A link to the instance |
JobProfile_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
JobProfile_Href | String | False |
Supported for: SELECT. A link to the instance |
JobProfile_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Location_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Location_Href | String | False |
Supported for: SELECT. A link to the instance |
Location_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
OverrideRate | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. The override rate for a time clock event. |
Position_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Position_Href | String | False |
Supported for: SELECT. A link to the instance |
Position_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Program_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Program_Href | String | False |
Supported for: SELECT. A link to the instance |
Program_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ProjectPlanTask_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ProjectPlanTask_Href | String | False |
Supported for: SELECT. A link to the instance |
ProjectPlanTask_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Project_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Project_Href | String | False |
Supported for: SELECT. A link to the instance |
Project_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
ReferenceID | String | False |
Supported for: SELECT, INSERT, UPDATE. The Reference ID to use for lookups within our Workday Web Services. |
Region_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Region_Href | String | False |
Supported for: SELECT. A link to the instance |
Region_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
TimeEntryCode_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
TimeEntryCode_Href | String | False |
Supported for: SELECT. A link to the instance |
TimeEntryCode_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
TimeZone_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
TimeZone_Href | String | False |
Supported for: SELECT. A link to the instance |
TimeZone_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Worker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Worker_Href | String | False |
Supported for: SELECT. A link to the instance |
Worker_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
FromDate_Prompt | Date | False |
The start date of the time event using the yyyy-mm-dd format. |
ToDate_Prompt | Date | False |
The end date of the time event using the yyyy-mm-dd format. |
Worker_Prompt | String | False |
Accepts multiple inputs. The Workday ID of the worker for the time block or clock event. You can specify multiple worker query parameters. |
An address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
AddressLine1 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 1 |
AddressLine1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 1 |
AddressLine2 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 2 |
AddressLine2Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 2 |
AddressLine3 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 3 |
AddressLine3Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 3 |
AddressLine4 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 4 |
AddressLine4Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 4 |
AddressLine5 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 5 |
AddressLine5Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 5 |
AddressLine6 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 6 |
AddressLine6Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 6 |
AddressLine7 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 7 |
AddressLine7Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 7 |
AddressLine8 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 8 |
AddressLine8Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 8 |
AddressLine9 | String | False |
Supported for: SELECT, INSERT, UPDATE. Address Line 9 |
AddressLine9Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Local Address Line 9 |
City | String | False |
Supported for: SELECT, INSERT, UPDATE. City |
CityLocal | String | False |
Supported for: SELECT, INSERT, UPDATE. City - Local |
CitySubdivision1 | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 1 |
CitySubdivision1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 1 - Local |
CitySubdivision2 | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 2 |
CitySubdivision2Local | String | False |
Supported for: SELECT, INSERT, UPDATE. City Subdivision 2 - Local |
CountryCity_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryCity_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
CountryRegion_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryRegion_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Country_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Country_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Effective | Datetime | False |
Supported for: SELECT. The date this business process takes effect. |
PostalCode | String | False |
Supported for: SELECT, INSERT, UPDATE. Postal Code |
RegionSubdivision1 | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1 |
RegionSubdivision1Local | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1 - Local |
RegionSubdivision2 | String | False |
Supported for: SELECT, INSERT, UPDATE. Region Subdivision 2 |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. Returns the description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Returns Boolean Value False |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. Is Public Visibility |
Usage_UsageType_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Used For |
PublicOnly_Prompt | Boolean | False |
No description available |
UsedFor_Prompt | String | False |
No description available |
An email address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
EmailAddress | String | False |
Supported for: SELECT, INSERT, UPDATE. The email address. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public email addresses. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
An instant messenger as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Type_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
Type_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
UserName | String | False |
Supported for: SELECT, INSERT, UPDATE. The instant messenger account username. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public instant messenger account usernames. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
A phone number as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
CompletePhoneNumber | String | False |
Supported for: SELECT, INSERT, UPDATE. The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | False |
Supported for: SELECT, INSERT, UPDATE. The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryPhoneCode_Country_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
CountryPhoneCode_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
CountryPhoneCode_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
DeviceType_Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
DeviceType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Extension | String | False |
Supported for: SELECT, INSERT, UPDATE. The phone extension. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public phone numbers. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
A web address as it exists staged for update by the parent business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkContactInformationChange_Id [KEY] | String | False |
The ID of the change process. Must be set in all queries. |
Url | String | False |
Supported for: SELECT, INSERT, UPDATE. The complete URL address for the web address. |
Usage_Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. The description for a given communication method. |
Usage_Primary | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type. |
Usage_Public | Bool | False |
Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. Id of the instance |
Usage_UsedFor_Aggregate | String | False |
Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc. |
PrimaryOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | False |
If true, returns only the IDs of the person's public web addresses. |
UsageType_Prompt | String | False |
Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint. |
UsedFor_Prompt | String | False |
Specifies usage behavior, such as mailing, billing, or shipping. |
Retrieves a feedback given event instance with the specified ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Badge_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Badge_Href | String | False |
Supported for: SELECT. A link to the instance |
Badge_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessProcessParameters_Action_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessProcessParameters_Action_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessProcessParameters_Action_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | False |
Supported for: SELECT, INSERT. Returns a null. |
BusinessProcessParameters_CriticalValidations | String | False |
Supported for: SELECT. Validation message for an action event triggered by a condition. |
BusinessProcessParameters_For_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessProcessParameters_For_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessProcessParameters_For_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessProcessParameters_OverallBusinessProcess_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessProcessParameters_OverallBusinessProcess_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessProcessParameters_OverallStatus | String | False |
Supported for: SELECT. The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_TransactionStatus_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
BusinessProcessParameters_TransactionStatus_Href | String | False |
Supported for: SELECT. A link to the instance |
BusinessProcessParameters_TransactionStatus_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
BusinessProcessParameters_WarningValidations | String | False |
Supported for: SELECT. Warning message for an action event triggered by a condition. |
Comment | String | False |
Supported for: SELECT, INSERT. The comment text for an anytime feedback event. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
FeedbackAlsoAbout_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The other workers this feedback event is about. |
FeedbackGivenDate | Datetime | False |
Supported for: SELECT, INSERT. The date the feedback was provided. |
FromWorker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
FromWorker_Href | String | False |
Supported for: SELECT. A link to the instance |
FromWorker_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
HiddenFromManager | Bool | False |
Supported for: SELECT, INSERT. True if the feedback event is private between the feedback provider and the worker. Private feedback isn't shared with managers. |
HiddenFromWorker | Bool | False |
Supported for: SELECT, INSERT. True if the feedback event is confidential between the feedback provider and the manager. Workers don't see confidential feedback. |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
RelatesTo_Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
RelatesTo_Id | String | False |
Supported for: SELECT, INSERT. Id of the instance |
ShowFeedbackProviderName | Bool | False |
Supported for: SELECT, INSERT. True if the feedback provider's name has chosen to be displayed. Names not chosen to be displayed are not shared. |
ToWorker_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ToWorker_Href | String | False |
Supported for: SELECT. A link to the instance |
ToWorker_Id | String | False |
Supported for: SELECT, INSERT. wid / id / reference id |
WorkersToNotify_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. The workers that were selected to be notified of the feedback given event. |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a business title change instance for a specific worker.
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
CurrentBusinessTitle | String | False |
Supported for: SELECT. The business title for the worker prior to this business process. If there is no business title override, this field defaults to the job title or job profile name. |
Descriptor | String | False |
Supported for: SELECT, INSERT. A preview of the instance |
Due | Datetime | False |
Supported for: SELECT. The date the business process needs to be completed. |
Effective | Datetime | False |
Supported for: SELECT. The date this business process takes effect. |
Href | String | False |
Supported for: SELECT, INSERT. A link to the instance |
Initiated | Datetime | False |
Supported for: SELECT. The date and time this business process was initiated. |
Initiator_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Initiator_Href | String | False |
Supported for: SELECT. A link to the instance |
Initiator_Id | String | False |
Supported for: SELECT. wid / id / reference id |
ProposedBusinessTitle | String | False |
Supported for: SELECT, INSERT. The new business title for the worker as of the effective date. If there is no business title override, this field defaults to the job title or job profile name. |
Subject_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Subject_Href | String | False |
Supported for: SELECT. A link to the instance |
Subject_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a single Check-In instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ }]
[{ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } comment: Text /* Returns comment for the Attachment */ fileLength: Numeric /* File length of the attachment */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Archived | Bool | False |
Supported for: SELECT. Indicates that the check-in is archived. |
AssociatedTopics_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Topics included in a check-in. |
CheckInAttachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Returns all attachments for the Check-In. |
Creator_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Creator_Href | String | False |
Supported for: SELECT. A link to the instance |
Creator_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Date | Datetime | False |
Supported for: SELECT, INSERT, UPDATE. Date of check-in. |
Description | String | False |
Supported for: SELECT, INSERT, UPDATE. Description of check-in. |
Participant_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Participant_Href | String | False |
Supported for: SELECT. A link to the instance |
Participant_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads associatedTopics entries from the WorkersCheckIns table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkersCheckIns_Id [KEY] | String | False |
The Wordkay ID of the WorkersCheckIns that contains this |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Archived | Bool | False |
Supported for: SELECT. Indicates that the topic is archived. |
Name | String | False |
Supported for: SELECT. Topic name. |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads checkInAttachments entries from the WorkersCheckIns table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkersCheckIns_Id [KEY] | String | False |
The Wordkay ID of the WorkersCheckIns that contains this |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. Returns comment for the Attachment |
ContentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ContentType_Href | String | False |
Supported for: SELECT. A link to the instance |
ContentType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
FileLength | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. File length of the attachment |
FileName | String | False |
Supported for: SELECT, INSERT, UPDATE. File name of the attachment |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a single Check-In topic instance.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ }]
[{ comment: Text /* Returns comment for the Attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileName: Text /* File name of the attachment */ fileLength: Numeric /* File length of the attachment */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Archived | Bool | False |
Supported for: SELECT. Indicates that the topic is archived. |
AssociatedCheckIns_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Check-ins associated to topic. |
CheckInTopicAttachments_Aggregate | String | False |
Supported for: INSERT. A JSON aggregate. Returns all attachments for the Check-In Topic. |
Creator_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Creator_Href | String | False |
Supported for: SELECT. A link to the instance |
Creator_Id | String | False |
Supported for: SELECT. wid / id / reference id |
Name | String | False |
Supported for: SELECT, INSERT, UPDATE. Topic name. |
Participant_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
Participant_Href | String | False |
Supported for: SELECT. A link to the instance |
Participant_Id | String | False |
Supported for: SELECT. wid / id / reference id |
PrivateNotes | String | False |
Supported for: SELECT, INSERT, UPDATE. Personal notes of the topic. |
SharedNotes | String | False |
Supported for: SELECT, INSERT, UPDATE. Shared notes of the topic. |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads associatedCheckIns entries from the WorkersCheckInTopics table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkersCheckInTopics_Id [KEY] | String | False |
The Wordkay ID of the WorkersCheckInTopics that contains this |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Archived | Bool | False |
Supported for: SELECT. Indicates that the check-in is archived. |
Date | Datetime | False |
Supported for: SELECT. Date of check-in. |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads checkInTopicAttachments entries from the WorkersCheckInTopics table
Name | Type | ReadOnly | Description |
Id [KEY] | String | False |
Id of the instance |
WorkersCheckInTopics_Id [KEY] | String | False |
The Wordkay ID of the WorkersCheckInTopics that contains this |
Workers_Id [KEY] | String | False |
The Workday ID of the Workers that owns this |
Comment | String | False |
Supported for: SELECT, INSERT, UPDATE. Returns comment for the Attachment |
ContentType_Descriptor | String | False |
Supported for: SELECT. A description of the instance |
ContentType_Href | String | False |
Supported for: SELECT. A link to the instance |
ContentType_Id | String | False |
Supported for: SELECT, INSERT, UPDATE. wid / id / reference id |
Descriptor | String | False |
Supported for: SELECT, INSERT, UPDATE. A preview of the instance |
FileLength | Decimal | False |
Supported for: SELECT, INSERT, UPDATE. File length of the attachment |
FileName | String | False |
Supported for: SELECT, INSERT, UPDATE. File name of the attachment |
Search_Prompt | String | False |
Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
AcademicCalendars | Retrieves the academic calendar with the specified ID. |
AcademicCalendarsAcademicYears | Retrieves the academic year associated with an academic calendar with the specified ID. |
AcademicCalendarsPeriodTypes | Reads periodTypes entries from the AcademicCalendars table |
AcademicLevels | Retrieves the academic level with the specified ID. |
AcademicPeriods | Retrieves the academic period with the specified ID. |
AcademicPeriodsPeriodUsages | Reads periodUsages entries from the AcademicPeriods table |
AcademicPeriodsPeriodWeights | Reads periodWeights entries from the AcademicPeriods table |
AcademicUnits | Retrieves the Academic Unit with the specified ID. |
AcademicUnitsLevels | Reads levels entries from the AcademicUnits table |
AcademicUnitsRelatedSupervisoryOrganizations | Reads relatedSupervisoryOrganizations entries from the AcademicUnits table |
AcademicUnitsSubordinates | Reads subordinates entries from the AcademicUnits table |
ActiveTasks | No description available |
ActiveUserSessions | Retrieves an active user session. |
ActivityLogging | Retrieves a collection of user activity log entries in a specified time frame. |
AdHocProjectTimeTransactionsWorktags | Reads worktags entries from the AdHocProjectTimeTransactions table |
AuditLogs | (End of Life Date: 2023-03-11 ) Retrieves an audit log instance. |
Balances | Retrieves the specified balance of all absence plan and leave of absence types. |
BillableTransactionsBillingRateApplication | Retrieves a single billing rate application instance. |
CasesTimelineActions | Reads actions entries from the CasesTimeline table |
CasesTimelineAttachments | Reads attachments entries from the CasesTimeline table |
CasesTimelineGuidanceKbArticleCurrentArticleData | Reads guidance.kbArticle.currentArticleData entries from the CasesTimeline table |
CasesTimelineQuestionnaireResponseQuestionAnswerPair | Reads questionnaireResponse.questionAnswerPair entries from the CasesTimeline table |
CaseSuggestions | Retrieves a list of suggestions based on case type. |
CaseTypes | Retrieves a list of case types that a worker has access to. |
CaseTypesExternalLink | Reads externalLink entries from the CaseTypes table |
ClientDetails | Returns a valid OAuth Client Details for OCFR Clients |
CommonCompaniesValues | No description available |
CommonCountriesValues | No description available |
CommonCurrenciesValues | No description available |
CommonCustomersValues | No description available |
CommonGroupsValues | No description available |
CommonHierarchiesValues | No description available |
CommonImportanceRatingsValues | No description available |
CommonOptionalHierarchiesValues | No description available |
CommonOwnersValues | No description available |
CommonPhoneCountryPhoneCodesValues | No description available |
CommonPhonePhoneDeviceTypesValues | No description available |
CommonPrioritiesValues | No description available |
CommonProjectDependenciesValues | No description available |
CommonProjectStatesValues | No description available |
CommonProjectsValues | No description available |
CommonRiskLevelsValues | No description available |
CommonStatusesValues | No description available |
CommonSuccessRatingsValues | No description available |
CommonWorktagsValues | No description available |
CommonWorktagTypesValues | No description available |
Configuration | Retrieves tenant setup configurations related to Help Case Management. |
ContractComplianceGroupCompaniesOrHierarchiesValues | No description available |
ContractComplianceGroupContractTypesValues | No description available |
Countries | Retrieves information about a country. |
CountriesAddressComponents | Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format.The webServiceAlias of the returned address components map to the enterable fields when submitting address data in other POST/PUT/PATCH operations. |
CountriesNameComponents | Retrieves a collection of configuration information about name components. |
CountryComponentsCountryCityValues | No description available |
CountryComponentsCountryRegionValues | No description available |
CountryComponentsCountryValues | No description available |
Courses | No description available |
CoursesAcademicUnits | Reads academicUnits entries from the Courses table |
CoursesAllowedLocations | Reads allowedLocations entries from the Courses table |
CoursesCompetencies | Reads competencies entries from the Courses table |
CourseSections | No description available |
CourseSectionsCampusLocations | Reads campusLocations entries from the CourseSections table |
CourseSectionsCompetencies | Reads competencies entries from the CourseSections table |
CourseSectionsComponents | Reads components entries from the CourseSections table |
CourseSectionsInstuctors | Reads instuctors entries from the CourseSections table |
CourseSectionsLearningOutcomes | Reads learningOutcomes entries from the CourseSections table |
CourseSectionsOfferingAcademicUnits | Reads offeringAcademicUnits entries from the CourseSections table |
CourseSectionsTags | Reads tags entries from the CourseSections table |
CoursesInstructionalFormats | Reads instructionalFormats entries from the Courses table |
CoursesLearningOutcomes | Reads learningOutcomes entries from the Courses table |
CoursesTags | Reads tags entries from the Courses table |
CoursesTypicalPeriodsOffered | Reads typicalPeriodsOffered entries from the Courses table |
CourseSubjects | No description available |
CourseSubjectsInstitutionalAcademicUnits | Reads institutionalAcademicUnits entries from the CourseSubjects table |
CredstoreByRefIdGet | No description available |
Currencies | Retrieves the details of a specified currency. |
Customers | Retrieves a single customer instance. |
CustomersActivities | Retrieves an activity instance for a specific customer. |
CustomersGroups | Reads groups entries from the Customers table |
DataSources | Retrieves a data source for the specified {ID} for use in a WQL query. |
DataSourcesDataSourceFilters | Retrieves the data source filter with the specified {ID} for a specific data source. |
DataSourcesDataSourceFiltersOptionalParameters | Reads optionalParameters entries from the DataSourcesDataSourceFilters table |
DataSourcesDataSourceFiltersRequiredParameters | Reads requiredParameters entries from the DataSourcesDataSourceFilters table |
DataSourcesFields | Retrieves the field with a specified {ID} for the specific data source. |
DataSourcesOptionalParameters | Reads optionalParameters entries from the DataSources table |
DataSourcesRequiredParameters | Reads requiredParameters entries from the DataSources table |
EducationalCredentials | Retrieves the educational credential with the specified ID. |
EventDrivenIntegrationVendorResponseErrorMessageSetErrors | Reads errorMessageSet.errors entries from the EventDrivenIntegrationVendorResponse table |
Events | Retrieves a business process event. |
EventsAttachments | Retrieves attachments for a business process event. |
EventsComments | Retrieves comments for a business process event. |
EventsCompletedSteps | Retrieves completed steps for a business process event. |
EventsCompletedStepsAwaitingPersons | Reads awaitingPersons entries from the EventsCompletedSteps table |
EventsCompletedStepsComments | Reads comments entries from the EventsCompletedSteps table |
EventsInProgressSteps | Retrieves in progress steps for a business process event. |
EventsInProgressStepsAwaitingPersons | Reads awaitingPersons entries from the EventsInProgressSteps table |
EventsRemainingSteps | Retrieves remaining steps for a business process event. |
EventsRemainingStepsGroups | Reads groups entries from the EventsRemainingSteps table |
EventsSubBusinessProcesses | Reads subBusinessProcesses entries from the Events table |
EventSteps | Retrieves a business process event step. |
EventStepsAwaitingPersons | Reads awaitingPersons entries from the EventSteps table |
EventStepsComments | Reads comments entries from the EventSteps table |
ExpenseItems | Retrieves a single instance of an expense item. |
HolidayEvents | No description available |
ImmigrationEvents | Retrieves an immigration event. |
ImmigrationEventsImmigrationPages | No description available |
Interviews | No description available |
InterviewsInterviewers | Reads interviewers entries from the Interviews table |
InterviewsInterviewStatuses | Reads interviewStatuses entries from the Interviews table |
InterviewsJobRequisitionPrimaryRecruiters | Reads jobRequisition.primaryRecruiters entries from the Interviews table |
InterviewsJobRequisitionRecruiters | Reads jobRequisition.recruiters entries from the Interviews table |
InterviewsWorkersPendingFeedback | Reads workersPendingFeedback entries from the Interviews table |
Invoices | Retrieves a single customer invoice or adjustment instance. |
InvoicesDisputeReasons | Reads disputeReasons entries from the Invoices table |
InvoicesPrintRuns | Retrieves a single customer invoice print run. |
InvoicesPrintRunsDeliveryMethod | Reads deliveryMethod entries from the InvoicesPrintRuns table |
InvoicesRelatedAdjustments | Reads relatedAdjustments entries from the Invoices table |
JobChangeReasons | Retrieves a job change reason instance. |
JobChangesGroupAssignmentTypesValues | No description available |
JobChangesGroupCompanyInsiderTypesValues | No description available |
JobChangesGroupContingentWorkerTypesValues | No description available |
JobChangesGroupCurrenciesValues | No description available |
JobChangesGroupEmployeeTypesValues | No description available |
JobChangesGroupFrequenciesValues | No description available |
JobChangesGroupHeadcountOptionsValues | No description available |
JobChangesGroupJobClassificationsValues | No description available |
JobChangesGroupJobProfilesValues | No description available |
JobChangesGroupJobRequisitionsValues | No description available |
JobChangesGroupJobsValues | No description available |
JobChangesGroupLocationsValues | No description available |
JobChangesGroupPayRateTypesValues | No description available |
JobChangesGroupProposedPositionValues | No description available |
JobChangesGroupReasonValues | No description available |
JobChangesGroupSupervisoryOrganizationValues | No description available |
JobChangesGroupTemplatesValues | No description available |
JobChangesGroupTimeTypesValues | No description available |
JobChangesGroupWorkersCompensationCodeOverridesValues | No description available |
JobChangesGroupWorkersValues | No description available |
JobChangesGroupWorkerTypesValues | No description available |
JobChangesGroupWorkShiftsValues | No description available |
JobChangesGroupWorkSpacesValues | No description available |
JobChangesGroupWorkStudyAwardsValues | No description available |
JobFamilies | Retrieves a single job family instance. |
JobFamiliesJobProfiles | Reads jobProfiles entries from the JobFamilies table |
JobPostings | Retrieves a job posting. |
JobPostingsAdditionalLocations | Reads additionalLocations entries from the JobPostings table |
JobPostingsCategories | Reads categories entries from the JobPostings table |
JobProfiles | Retrieves a single job profile instance. |
JobProfilesCompanyInsiderTypes | Reads companyInsiderTypes entries from the JobProfiles table |
JobProfilesJobExempts | Reads jobExempts entries from the JobProfiles table |
JobProfilesJobFamilies | Reads jobFamilies entries from the JobProfiles table |
JobProfilesPayRateTypes | Reads payRateTypes entries from the JobProfiles table |
JobProfilesRestrictedToCountries | Reads restrictedToCountries entries from the JobProfiles table |
JobProfilesWorkersCompensationCodes | Reads workersCompensationCodes entries from the JobProfiles table |
Jobs | Retrieves a single job instance. |
JobsPayGroup | Retrieves a single pay group instance. |
JobsPayGroupPayGroupDetails | Reads payGroupDetails entries from the JobsPayGroup table |
JobsWorkspace | Retrieves a single workspace instance. |
LeaveStatusValues | No description available |
Mentorships | Get all mentorships |
NameComponentsAcademicValues | No description available |
NameComponentsHereditaryValues | No description available |
NameComponentsHonoraryValues | No description available |
NameComponentsProfessionalValues | No description available |
NameComponentsReligiousValues | No description available |
NameComponentsRoyalValues | No description available |
NameComponentsSalutationValues | No description available |
NameComponentsSocialValues | No description available |
NameComponentsTitleValues | No description available |
NotificationTypes | Retrieves a notification type. |
OrganizationAssignmentChangesGroupBusinessUnitsValues | No description available |
OrganizationAssignmentChangesGroupCompaniesValues | No description available |
OrganizationAssignmentChangesGroupCostCentersValues | No description available |
OrganizationAssignmentChangesGroupCustomsValues | No description available |
OrganizationAssignmentChangesGroupFundsValues | No description available |
OrganizationAssignmentChangesGroupGiftsValues | No description available |
OrganizationAssignmentChangesGroupGrantsValues | No description available |
OrganizationAssignmentChangesGroupJobsValues | No description available |
OrganizationAssignmentChangesGroupPositionsValues | No description available |
OrganizationAssignmentChangesGroupProgramsValues | No description available |
OrganizationAssignmentChangesGroupRegionsValues | No description available |
OrganizationAssignmentChangesGroupWorkersValues | No description available |
Organizations | Retrieves an organization instance. |
OrganizationTypes | Retrieves an organization type instance. |
PayGroupDetails | Retrieves a single pay group detail instance. |
PayGroupDetailsPayRunGroup | Reads payRunGroup entries from the PayGroupDetails table |
PayGroups | Retrieves a single pay group instance. |
PayGroupsPayGroupDetails | Reads payGroupDetails entries from the PayGroups table |
PayrollInputsGroupPayComponentsValues | No description available |
PayrollInputsGroupPositionsValues | No description available |
PayrollInputsGroupRunCategoriesValues | No description available |
PayrollInputsGroupWorktagsValues | No description available |
People | Retrieves a person in your Workday tenant. |
PeopleAdditionalNames | Retrieves an additional name. |
PeopleAudioNamePronunciation | Retrieves an Audio Name Pronunciation |
PeopleHomeAddresses | Retrieves a home address. |
PeopleHomeAddressesUsageUsedFor | Reads usage.usedFor entries from the PeopleHomeAddresses table |
PeopleHomeEmails | Retrieves a home email address. |
PeopleHomeEmailsUsageUsedFor | Reads usage.usedFor entries from the PeopleHomeEmails table |
PeopleHomeInstantMessengers | Retrieves a home instant messenger account username. |
PeopleHomeInstantMessengersUsageUsedFor | Reads usage.usedFor entries from the PeopleHomeInstantMessengers table |
PeopleHomePhones | Retrieves a home phone number. |
PeopleHomePhonesUsageUsedFor | Reads usage.usedFor entries from the PeopleHomePhones table |
PeopleHomeWebAddresses | Retrieves a home web address. |
PeopleHomeWebAddressesUsageUsedFor | Reads usage.usedFor entries from the PeopleHomeWebAddresses table |
PeopleLegalName | Retrieves the legal name instance. |
PeoplePersonalInformation | Retrieves a person's personal information. |
PeoplePhotos | Retrieves a personal photo. |
PeoplePreferredName | Retrieves the preferred name instance. |
PeoplePublicContactInformation | Retrieves a person's public contact information. |
PeopleWorkAddresses | Retrieves a work address. |
PeopleWorkAddressesUsageUsedFor | Reads usage.usedFor entries from the PeopleWorkAddresses table |
PeopleWorkEmails | Retrieves a work email address. |
PeopleWorkEmailsUsageUsedFor | Reads usage.usedFor entries from the PeopleWorkEmails table |
PeopleWorkInstantMessengers | Retrieves a work instant messenger account username. |
PeopleWorkInstantMessengersUsageUsedFor | Reads usage.usedFor entries from the PeopleWorkInstantMessengers table |
PeopleWorkPhones | Retrieves a work phone number. |
PeopleWorkPhonesUsageUsedFor | Reads usage.usedFor entries from the PeopleWorkPhones table |
PeopleWorkWebAddresses | Retrieves a work web address. |
PeopleWorkWebAddressesUsageUsedFor | Reads usage.usedFor entries from the PeopleWorkWebAddresses table |
PersonalInformationCountryAllowedCountryValues | No description available |
PersonalInformationCountryPopulatedCountryValues | No description available |
ProgramsOfStudy | Retrieves the program of study with the specified ID. |
ProgramsOfStudyEducationalCredentials | Reads educationalCredentials entries from the ProgramsOfStudy table |
ProjectPlanProjectPhasesValues | No description available |
ProjectPlanProjectPlanPhasesValues | No description available |
ProjectPlanProjectPlanTasksValues | No description available |
ProjectPlanProjectTasksValues | No description available |
ProjectsBusinessEventRecords | Reads businessEventRecords entries from the Projects table |
ProjectsGroups | Reads groups entries from the Projects table |
ProjectsOptionalHierarchies | Reads optionalHierarchies entries from the Projects table |
ProjectsProjectDependencies | Reads projectDependencies entries from the Projects table |
ProjectsWorktags | Reads worktags entries from the Projects table |
ProspectsCandidatePools | Reads candidatePools entries from the Prospects table |
ProspectsCandidateTags | Reads candidateTags entries from the Prospects table |
ProspectsLanguagesAbilities | Reads abilities entries from the ProspectsLanguages table |
PurchaseOrders | Retrieves a purchase order. |
PurchaseOrdersBillToAddress | Reads billToAddress entries from the PurchaseOrders table |
PurchaseOrdersGoodsLines | Reads goodsLines entries from the PurchaseOrders table |
PurchaseOrdersProjectBasedServiceLines | Reads projectBasedServiceLines entries from the PurchaseOrders table |
PurchaseOrdersServiceLines | Reads serviceLines entries from the PurchaseOrders table |
PurchaseOrdersTaxCodes | Reads taxCodes entries from the PurchaseOrders table |
RequestsQuestionnaireResponsesQuestionnaireAnswers | Reads questionnaireResponses.questionnaireAnswers entries from the Requests table |
RequestsQuestionnaireResponsesSurveyTarget | Reads questionnaireResponses.surveyTarget entries from the Requests table |
RequisitionsGroupCommodityCodesValues | No description available |
RequisitionsGroupCompaniesValues | No description available |
RequisitionsGroupCurrenciesValues | No description available |
RequisitionsGroupDeliverToLocationValues | No description available |
RequisitionsGroupInventorySiteValues | No description available |
RequisitionsGroupLineCompanyValues | No description available |
RequisitionsGroupOrderFromConnectionValues | No description available |
RequisitionsGroupParLocationValues | No description available |
RequisitionsGroupRequestersValues | No description available |
RequisitionsGroupRequestingEntityValues | No description available |
RequisitionsGroupRequisitionTypesValues | No description available |
RequisitionsGroupResolvedWorktagsValues | No description available |
RequisitionsGroupResourceProviderValues | No description available |
RequisitionsGroupShipToAddressValues | No description available |
RequisitionsGroupSourcingBuyerValues | No description available |
RequisitionsGroupSpendCategoryValues | No description available |
RequisitionsGroupSupplierContractValues | No description available |
RequisitionsGroupUnitOfMeasureValues | No description available |
RequisitionsGroupWorktagsValues | No description available |
RequisitionsPurchaseOrders | Reads purchaseOrders entries from the Requisitions table |
RequisitionsRelatedPurchaseOrders | Retrieves a related purchase order for the specified requisition. |
RequisitionTemplates | Retrieves the goods and service line details of a requisition template. |
RequisitionTemplatesGoodsLines | Reads goodsLines entries from the RequisitionTemplates table |
RequisitionTemplatesServiceLines | Reads serviceLines entries from the RequisitionTemplates table |
ResourceForecastLines | Retrieves a single resource forecast line instance. |
ResourcePlanBookingStatusValues | No description available |
ResourcePlanCostRateCurrenciesValues | No description available |
ResourcePlanLinesExcludedWorkers | Reads excludedWorkers entries from the ResourcePlanLines table |
ResourcePlanLinesPendingWorkers | Reads pendingWorkers entries from the ResourcePlanLines table |
ResourcePlanLinesProjectResources | Reads projectResources entries from the ResourcePlanLines table |
ResourcePlanLinesRequirements | Reads requirements entries from the ResourcePlanLines table |
ResourcePlanRequirementCategoriesValues | No description available |
ResourcePlanRequirementsValues | No description available |
ResourcePlanResourceTypesValues | No description available |
ResourcePlanRoleCategoriesValues | No description available |
ResourcePlanRolesValues | No description available |
ResourcePlanWorkerGroupsValues | No description available |
ResourcePlanWorkersValues | No description available |
ScorecardResultsDefaultScorecardGoalsResultPerformanceScores | Reads defaultScorecardGoalsResult.performanceScores entries from the ScorecardResults table |
ScorecardResultsProfileScorecardGoalsResult | Reads profileScorecardGoalsResult entries from the ScorecardResults table |
SendBackToValues | No description available |
Students | Retrieves a student instance. |
StudentsHolds | Retrieves a single student hold instance for the specified student. |
StudentsHoldsOverrideEventHoldTypes | Reads overrideEvent.holdTypes entries from the StudentsHolds table |
StudentsHoldsTypeContexts | Reads typeContexts entries from the StudentsHolds table |
StudentsImmigrationEvents | Retrieves an immigration event for the specified student. |
StudentsImmigrationEventsDependentImmigrationData | Reads dependentImmigrationData entries from the StudentsImmigrationEvents table |
StudentsPrimaryStudentRecord | Reads primaryStudentRecord entries from the Students table |
StudentsResidencies | Retrieves residence information for the specified student. |
StudentsResidenciesDocuments | Reads documents entries from the StudentsResidencies table |
StudentsResidenciesEvents | Reads events entries from the StudentsResidencies table |
StudentsResidenciesInstitutionalAcademicUnits | Reads institutionalAcademicUnits entries from the StudentsResidencies table |
SupervisoryOrganizations | Retrieves a supervisory organization instance. |
SupervisoryOrganizationsMembers | Retrieves a single member instance. |
SupervisoryOrganizationsOrgChart | Retrieves a single organization chart instance. |
SupervisoryOrganizationsOrgChartSubordinates | Reads subordinates entries from the SupervisoryOrganizationsOrgChart table |
SupervisoryOrganizationsOrgChartSuperiorManagers | Reads superior.managers entries from the SupervisoryOrganizationsOrgChart table |
SupervisoryOrganizationsWorkers | Retrieves a worker instance for a specific supervisory organization. |
SupplierContracts | Retrieves a supplier contract. |
SupplierContractsCatalogs | Reads catalogs entries from the SupplierContracts table |
SupplierContractsChargeControls | Reads chargeControls entries from the SupplierContracts table |
SupplierContractsMultiParticipants | Reads multiParticipants entries from the SupplierContracts table |
SupplierContractsMultiSuppliers | Reads multiSuppliers entries from the SupplierContracts table |
SupplierContractsServiceLines | Reads serviceLines entries from the SupplierContracts table |
SupplierInvoiceRequestsLines | Retrieves a single supplier invoice line instance. |
SupplierInvoiceRequestsLinesItemIdentifiers | Reads itemIdentifiers entries from the SupplierInvoiceRequestsLines table |
SupplierInvoiceRequestsLinesItemTags | Reads itemTags entries from the SupplierInvoiceRequestsLines table |
SupplierInvoiceRequestsLinesSplits | Reads splits entries from the SupplierInvoiceRequestsLines table |
SupplierInvoiceRequestsLinesWorktags | Reads worktags entries from the SupplierInvoiceRequestsLines table |
SystemMetricsOverview | Retrieves system metrics. |
TaxRates | Retrieves a single or a collection of company SUI rates. |
TaxRatesGroupCompanyInstancesValues | No description available |
TaxRatesGroupStateInstancesValues | No description available |
TimeOffStatusValues | No description available |
TimeTypesDefaultTimeEntryCodeValues | No description available |
TimeTypesProjectPlanTasksValues | No description available |
TimeTypesProjectsValues | No description available |
TimeTypesTimeEntryCodesValues | No description available |
TimeValidations | Retrieves a collection of time entry validations. |
TimeValuesOutReasonValues | No description available |
TimeValuesWorkerTimeZoneValues | No description available |
Workers | Retrieves a collection of workers and current staffing information. |
WorkersAdditionalJobs | Reads additionalJobs entries from the Workers table |
WorkersAnytimeFeedbackEventsBusinessProcessParametersAttachments | Reads businessProcessParameters.attachments entries from the WorkersAnytimeFeedbackEvents table |
WorkersAnytimeFeedbackEventsBusinessProcessParametersComments | Reads businessProcessParameters.comments entries from the WorkersAnytimeFeedbackEvents table |
WorkersAnytimeFeedbackEventsFeedbackAlsoAbout | Reads feedbackAlsoAbout entries from the WorkersAnytimeFeedbackEvents table |
WorkersAnytimeFeedbackEventsRelatedFeedbackEvents | Reads relatedFeedbackEvents entries from the WorkersAnytimeFeedbackEvents table |
WorkersAnytimeFeedbackEventsWorkersToNotify | Reads workersToNotify entries from the WorkersAnytimeFeedbackEvents table |
WorkersDirectReports | Retrieves a direct report instance for a specific worker. |
WorkersEligibleAbsenceTypes | Retrieves the eligible absence type for the specified worker. |
WorkersEligibleAbsenceTypesAbsenceReasons | Reads absenceReasons entries from the WorkersEligibleAbsenceTypes table |
WorkersEligibleAbsenceTypesAdditionalFields | Reads additionalFields entries from the WorkersEligibleAbsenceTypes table |
WorkersEligibleAbsenceTypesPosition | Reads position entries from the WorkersEligibleAbsenceTypes table |
WorkersExplicitSkills | Get Explicit Skills for Skill Enabled |
WorkersExplicitSkillsSkillSources | Reads skillSources entries from the WorkersExplicitSkills table |
WorkersGoals | Retrieves a single goal instance for a specific worker. |
WorkersGoalsActivityStreamableItem | Reads activityStreamableItem entries from the WorkersGoals table |
WorkersGoalsAssociatedReviews | Reads associatedReviews entries from the WorkersGoals table |
WorkersGoalsCategory | Reads category entries from the WorkersGoals table |
WorkersGoalsRelatesTo | Reads relatesTo entries from the WorkersGoals table |
WorkersHistory | Retrieves a history instance for a specific worker. |
WorkersInboxTasks | Retrieves an inbox task instance for a specific worker. |
WorkersLeavesOfAbsence | Retrieves the leave of absence for the specified worker. |
WorkersOrganizations | Retrieves an organization instance for a specific worker. |
WorkersPaySlips | Retrieves a pay slip instance for a specific worker. |
WorkersPeriod | Retrieves a period from the period schedule the worker is eligible for. |
WorkersServiceDates | Retrieves a single service date information instance. |
WorkersSkillItems | No description available |
WorkersSupervisoryOrganizationsManaged | Retrieves a supervisory organization managed by a specific worker. |
WorkersTimeOffDetails | Retrieves a collection of time off details for the specified worker. |
WorkersTimeOffEntries | Retrieves a time off entry for a specific worker. |
WorkersTimeOffPlans | Retrieves a particular time off plan for a specific worker. |
WorkersTimeTotals | Retrieves a summary of reported hours for a worker over a period. |
WorkersToNotifyWorkersToNotifyValues | No description available |
WorkersValidTimeOffDates | Retrieves the valid time off dates for the specified worker. |
WorkerTimeBlocks | Retrieves a worker time block. |
WorkerTimeBlocksCalculatedTimeDetails | Reads calculatedTimeDetails entries from the WorkerTimeBlocks table |
Retrieves the academic calendar with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
NonInstructionalDaysCalendar_Descriptor | String | Supported for: SELECT. A preview of the instance |
NonInstructionalDaysCalendar_Id | String | Supported for: SELECT. Id of the instance |
Retrieves the academic year associated with an academic calendar with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicCalendars_Id [KEY] | String | The Workday ID of the AcademicCalendars that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EndDate | Datetime | Supported for: SELECT. The End Date for this Date Range. |
StartDate | Datetime | Supported for: SELECT. The Start Date for this Date Range. |
Reads periodTypes entries from the AcademicCalendars table
Name | Type | Description |
Id [KEY] | String | The Workday ID of the Academic Period Type. |
AcademicCalendars_Id [KEY] | String | The Wordkay ID of the AcademicCalendars that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Standard | Bool | Supported for: SELECT. If true, the period order is standard. |
Retrieves the academic level with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Retrieves the academic period with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicCalendar_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicCalendar_Href | String | Supported for: SELECT. A link to the instance |
AcademicCalendar_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicYear_Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicYear_EndDate | Datetime | Supported for: SELECT. The End Date for this Date Range. |
AcademicYear_Id | String | Supported for: SELECT. Id of the instance |
AcademicYear_StartDate | Datetime | Supported for: SELECT. The Start Date for this Date Range. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EndDate | Datetime | Supported for: SELECT. The End Date of the Academic Period. |
PeriodType_Descriptor | String | Supported for: SELECT. A description of the instance |
PeriodType_Href | String | Supported for: SELECT. A link to the instance |
PeriodType_Id | String | Supported for: SELECT. wid / id / reference id |
Standard | Bool | Supported for: SELECT. If true, this is a Standard Academic Period of the Academic Calendar. |
StandardEndDate | Datetime | Supported for: SELECT. Returns the Standard End Date of this Academic Period if it is a standard period for an Academic Calendar. |
StandardStartDate | Datetime | Supported for: SELECT. The Standard Start Date of this Academic Period if it is a standard period for an Academic Calendar. |
StartDate | Datetime | Supported for: SELECT. The Start Date of the Academic Period. |
WeeksOfInstruction | Decimal | Supported for: SELECT. The number of Weeks of Instruction for this Academic Period. |
AcademicCalendar_Prompt | String | The Workday ID of the academic calendar for the academic period. You can use a return id from GET /academicCalendars |
AcademicYear_Prompt | String | The Workday ID of the academic year for the academic period. You can use a return id from GET /academicCalendars/{ID}/academicYears |
FromDate_Prompt | Date | Filter academic periods by their start date using yyyy-mm-dd format. If used without toDate, returns all academic periods with start date on or after fromDate. If used with toDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
ToDate_Prompt | Date | Filter academic periods by their end date using yyyy-mm-dd format. If used without fromDate, returns all academic periods with end date on or before toDate. If used with fromDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
Reads periodUsages entries from the AcademicPeriods table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicPeriods_Id [KEY] | String | The Wordkay ID of the AcademicPeriods that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicCalendar_Prompt | String | The Workday ID of the academic calendar for the academic period. You can use a return id from GET /academicCalendars |
AcademicYear_Prompt | String | The Workday ID of the academic year for the academic period. You can use a return id from GET /academicCalendars/{ID}/academicYears |
FromDate_Prompt | Date | Filter academic periods by their start date using yyyy-mm-dd format. If used without toDate, returns all academic periods with start date on or after fromDate. If used with toDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
ToDate_Prompt | Date | Filter academic periods by their end date using yyyy-mm-dd format. If used without fromDate, returns all academic periods with end date on or before toDate. If used with fromDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
Reads periodWeights entries from the AcademicPeriods table
Name | Type | Description |
AcademicPeriods_Id | String | The Wordkay ID of the AcademicPeriods that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicCalendar_Prompt | String | The Workday ID of the academic calendar for the academic period. You can use a return id from GET /academicCalendars |
AcademicYear_Prompt | String | The Workday ID of the academic year for the academic period. You can use a return id from GET /academicCalendars/{ID}/academicYears |
FromDate_Prompt | Date | Filter academic periods by their start date using yyyy-mm-dd format. If used without toDate, returns all academic periods with start date on or after fromDate. If used with toDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
ToDate_Prompt | Date | Filter academic periods by their end date using yyyy-mm-dd format. If used without fromDate, returns all academic periods with end date on or before toDate. If used with fromDate, returns all academic periods whose start and/or end dates are within the inclusive date range specified by fromDate and toDate. |
Retrieves the Academic Unit with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CipCode_Descriptor | String | Supported for: SELECT. A description of the instance |
CipCode_Href | String | Supported for: SELECT. A link to the instance |
CipCode_Id | String | Supported for: SELECT. wid / id / reference id |
Code | String | Supported for: SELECT. The code for the Academic Unit, as of the effective date. |
Company_Descriptor | String | Supported for: SELECT. A description of the instance |
Company_Href | String | Supported for: SELECT. A link to the instance |
Company_Id | String | Supported for: SELECT. wid / id / reference id |
ExternalURL_Descriptor | String | Supported for: SELECT. A description of the instance |
ExternalURL_Href | String | Supported for: SELECT. A link to the instance |
ExternalURL_Id | String | Supported for: SELECT. wid / id / reference id |
Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
Subtype_Descriptor | String | Supported for: SELECT. A description of the instance |
Subtype_Href | String | Supported for: SELECT. A link to the instance |
Subtype_Id | String | Supported for: SELECT. wid / id / reference id |
Superior_Id | String | Supported for: SELECT. Id of the instance |
Superior_Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Superior_Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Superior_Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
EffectiveDate_Prompt | Date | The effective date of the Academic Unit, using the yyyy-mm-dd format. The default is the current date. |
Inactive_Prompt | Boolean | If true, this method retrieves Academic Units that are inactive as of the effective date. The default is false. |
Institution_Prompt | Boolean | If true, this method retrieves Academic Units that are designated as institutions as of the effective date. The default is false. |
Superior_Prompt | String | The Workday ID of the immediate superior of the Academic Units, as of the effective date. You can use a returned id from GET /academicUnits. |
Reads levels entries from the AcademicUnits table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicUnits_Id [KEY] | String | The Wordkay ID of the AcademicUnits that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EffectiveDate_Prompt | Date | The effective date of the Academic Unit, using the yyyy-mm-dd format. The default is the current date. |
Inactive_Prompt | Boolean | If true, this method retrieves Academic Units that are inactive as of the effective date. The default is false. |
Institution_Prompt | Boolean | If true, this method retrieves Academic Units that are designated as institutions as of the effective date. The default is false. |
Superior_Prompt | String | The Workday ID of the immediate superior of the Academic Units, as of the effective date. You can use a returned id from GET /academicUnits. |
Reads subordinates entries from the AcademicUnits table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicUnits_Id [KEY] | String | The Wordkay ID of the AcademicUnits that contains this |
Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
EffectiveDate_Prompt | Date | The effective date of the Academic Unit, using the yyyy-mm-dd format. The default is the current date. |
Inactive_Prompt | Boolean | If true, this method retrieves Academic Units that are inactive as of the effective date. The default is false. |
Institution_Prompt | Boolean | If true, this method retrieves Academic Units that are designated as institutions as of the effective date. The default is false. |
Superior_Prompt | String | The Workday ID of the immediate superior of the Academic Units, as of the effective date. You can use a returned id from GET /academicUnits. |
No description available
Name | Type | Description |
Account_Descriptor | String | Supported for: SELECT. A description of the instance |
Account_Href | String | Supported for: SELECT. A link to the instance |
Account_Id | String | Supported for: SELECT. wid / id / reference id |
BytesAllocated | Decimal | Supported for: SELECT. The memory allocated for task in mebibytes (MiB). |
CpuTimeMillis | Decimal | Supported for: SELECT. The time spend by the CPU to process the task. |
InstancesAccessed | Decimal | Supported for: SELECT. The count of all the instances traversed to process the task. |
Origin | String | Supported for: SELECT. Returns the service that launched the task. |
QueueMillis | Decimal | Supported for: SELECT. The duration of time the task has been waiting in the queue. |
QueueName | String | Supported for: SELECT. The name of the queue currently processing the task. |
QueuedSubtaskCount | Decimal | Supported for: SELECT. The count of queued self and child processes executed within this sample. |
RunningSubtaskCount | Decimal | Supported for: SELECT. The count of running self and child processes executed within this sample. |
StartTime | Datetime | Supported for: SELECT. Start time of the task. |
Status | String | Supported for: SELECT. Indicates the status the task is currently in as either queued or running. |
TaskDurationMillis | Decimal | Supported for: SELECT. The duration of time the task has been both queued and running. |
Task_Descriptor | String | Supported for: SELECT. A description of the instance |
Task_Href | String | Supported for: SELECT. A link to the instance |
Task_Id | String | Supported for: SELECT. wid / id / reference id |
Retrieves an active user session.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AuthenticationType_Descriptor | String | Supported for: SELECT. A description of the instance |
AuthenticationType_Href | String | Supported for: SELECT. A link to the instance |
AuthenticationType_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DeviceType_Descriptor | String | Supported for: SELECT. A description of the instance |
DeviceType_Href | String | Supported for: SELECT. A link to the instance |
DeviceType_Id | String | Supported for: SELECT. wid / id / reference id |
ElapsedMinutes | Decimal | Supported for: SELECT. Elapsed signon time in minutes or elapsed time from the signon start if session is still active. |
Role_Descriptor | String | Supported for: SELECT. A description of the instance |
Role_Href | String | Supported for: SELECT. A link to the instance |
Role_Id | String | Supported for: SELECT. wid / id / reference id |
SignonTime | Datetime | Supported for: SELECT. The time that the user's session started. |
SystemAccount_Descriptor | String | Supported for: SELECT. A description of the instance |
SystemAccount_Href | String | Supported for: SELECT. A link to the instance |
SystemAccount_Id | String | Supported for: SELECT. wid / id / reference id |
Retrieves a collection of user activity log entries in a specified time frame.
Name | Type | Description |
ActivityAction | String | Supported for: SELECT. The type of action that was executed. |
DeviceType | String | Supported for: SELECT. The device type from the user signon used to make the request. |
IpAddress | String | Supported for: SELECT. The user's IP Address from the user signon used to make the request. |
RequestTime | Datetime | Supported for: SELECT. The request time of the action. |
SessionId | String | Supported for: SELECT. The system ID for tracking signons from the user signon used to make the request. |
SystemAccount | String | Supported for: SELECT. The system account that initiated the request. |
Target_Descriptor | String | Supported for: SELECT. A description of the instance |
Target_Href | String | Supported for: SELECT. A link to the instance |
Target_Id | String | Supported for: SELECT. wid / id / reference id |
TaskDisplayName | String | Supported for: SELECT. The action executed in the transaction. |
TaskId | String | Supported for: SELECT. The Workday ID of the task executed in the transaction. |
UserActivityEntryCount | Decimal | Supported for: SELECT. Returns the User Activity Count for the inputted filter parameters |
UserAgent | String | Supported for: SELECT. The client browser and operating system information from the user signon used to make this request. |
From_Prompt | Date | (Required) The date and time of the earliest log entry. The default timezone is UTC/GMT. The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC. |
InstancesReturned_Prompt | Long | This number multiplied by 10,000 determines the total number of requested user activity instances. Example: A value of 5 requests a maximum of 50,000 instances. The default and maximum values are 25. By default, the method requests the maximum 250,000 instances. To fine-tune the performance, set this parameter to a lower number. While the instancesReturned parameter controls the total number of requested instances, the limit parameter controls the number of returned instances in a paginated response. |
ReturnUserActivityEntryCount_Prompt | Boolean | If true, returns only the total count of user activity instances for the specified parameters. |
SystemAccount_Prompt | String | No description available |
TaskId_Prompt | String | No description available |
To_Prompt | Date | (Required) The date and time of the latest log entry. The default timezone is UTC/GMT. The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC. |
Reads worktags entries from the AdHocProjectTimeTransactions table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AdHocProjectTimeTransactions_Id [KEY] | String | The Wordkay ID of the AdHocProjectTimeTransactions that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProjectOrProjectHierarchy_Prompt | String | The Workday ID or reference ID of a project or project hierarchy. You can use a returned project id or primaryHierarchy {id} from GET /projects. |
(End of Life Date: 2023-03-11 ) Retrieves an audit log instance.
Name | Type | Description |
ActivityAction | String | Supported for: SELECT. The type of action that was executed. |
DeviceType | String | Supported for: SELECT. The device type from the user signon used to make the request. |
IpAddress | String | Supported for: SELECT. The user's IP Address from the user signon used to make the request. |
RequestTime | Datetime | Supported for: SELECT. The request time of the action. |
SessionId | String | Supported for: SELECT. The system ID for tracking signons from the user signon used to make the request. |
SystemAccount | String | Supported for: SELECT. The system account that initiated the request. |
Target_Descriptor | String | Supported for: SELECT. A description of the instance |
Target_Href | String | Supported for: SELECT. A link to the instance |
Target_Id | String | Supported for: SELECT. wid / id / reference id |
TaskDisplayName | String | Supported for: SELECT. The action executed in the transaction. |
TaskId | String | Supported for: SELECT. The Workday ID of the task executed in the transaction. |
UserActivityEntryCount | Decimal | Supported for: SELECT. Returns the User Activity Count for the inputted filter parameters |
UserAgent | String | Supported for: SELECT. The client browser and operating system information from the user signon used to make this request. |
From_Prompt | Date | No description available |
InstancesReturned_Prompt | Long | No description available |
ReturnUserActivityEntryCount_Prompt | Boolean | No description available |
SystemAccount_Prompt | String | No description available |
TaskId_Prompt | String | No description available |
To_Prompt | Date | No description available |
Retrieves the specified balance of all absence plan and leave of absence types.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
AbsencePlan_AbsenceTable_Aggregate | String | Supported for: SELECT. A JSON aggregate. Returns the Absence Table for the Absence Balance. |
AbsencePlan_Descriptor | String | Supported for: SELECT. Descriptor for Absence Container based on Calendar Display Option |
AbsencePlan_Id | String | Supported for: SELECT. ID for Absence Container. |
AbsencePlan_Timeoffs | String | Supported for: SELECT. The Time Off name for which the balance is returned. |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
DateOfFirstAbsence | Datetime | Supported for: SELECT. The first day of leave for the corresponding leave type for which the balance is returned. |
EffectiveDate | Datetime | Supported for: SELECT. The date for which the balance is returned. |
Position_Descriptor | String | Supported for: SELECT. A preview of the instance |
Position_Id | String | Supported for: SELECT. Id of the instance |
Quantity | Decimal | Supported for: SELECT. The balance for the time off, absence table or leave type. |
Unit_Descriptor | String | Supported for: SELECT. A description of the instance |
Unit_Href | String | Supported for: SELECT. A link to the instance |
Unit_Id | String | Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | Supported for: SELECT. A description of the instance |
Worker_Href | String | Supported for: SELECT. A link to the instance |
Worker_Id | String | Supported for: SELECT. wid / id / reference id |
Category_Prompt | String | The Workday ID of the Time Off, Leave Type, or Absence Table. |
Effective_Prompt | Date | Absence balances as of the specified date using the yyyy-mm-dd format. |
Worker_Prompt | String | The Workday ID of the worker for which balances are returned. |
Retrieves a single billing rate application instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
BillableTransactions_Id [KEY] | String | The Workday ID of the BillableTransactions that owns this |
AmountToBill_Currency | String | Supported for: SELECT. The total amount in the base currency of the billing schedule applied to the billing rate rule break of the billable transaction the billing rate application is for. |
AmountToBill_Value | Decimal | Supported for: SELECT. The total amount in the base currency of the billing schedule applied to the billing rate rule break of the billable transaction the billing rate application is for. |
ApplicationOrder | Decimal | Supported for: SELECT. The order of application for the billing rate. |
BillingRateRuleType | String | Supported for: SELECT. The type of rate rule for the billing rate application. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
QuantityToBill | Decimal | Supported for: SELECT. The units applied to the billing rate rule break on this transaction. |
RateAdjustmentAmount_Currency | String | Supported for: SELECT. The total rate adjustment amount for the billable transaction. |
RateAdjustmentAmount_Value | Decimal | Supported for: SELECT. The total rate adjustment amount for the billable transaction. |
RateEndingAmount_Currency | String | Supported for: SELECT. The ending rate amount, after adjustment for the billable transaction. |
RateEndingAmount_Value | Decimal | Supported for: SELECT. The ending rate amount, after adjustment for the billable transaction. |
RateStartingAmount_Currency | String | Supported for: SELECT. The starting rate amount, before adjustment for the billable transaction. |
RateStartingAmount_Value | Decimal | Supported for: SELECT. The starting rate amount, before adjustment for the billable transaction. |
ReasonForChange | String | Supported for: SELECT. The purpose for the change for this billing rate. |
RuleName | String | Supported for: SELECT. The billing rate rule name for the billing rate transaction. |
BillingStatus_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. Accepts multiple inputs. Filters the billable transactions by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
Customer_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. The Workday ID of the customer associated with the project for the billable transaction. To get a valid ID, you can call GET /customers in the Customer Accounts REST service. |
FromDate_Prompt | Date | Only used when a BillableTransactions_Id filter is not provided. Filters the billable transactions with transaction date on or after the specified date. Use the yyyy-mm-dd format. |
Phase_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. The Workday ID of the project phase associated with the billable transaction for the time entry. To get a valid ID, call GET /planPhases in the Projects REST service. |
Project_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. The Workday ID of the project associated with the billable transactions. To get a valid ID, you can call GET /projects in the Projects REST service. |
SpendCategory_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. Accepts multiple inputs. The Workday ID of the spend category for the billable transaction associated with the expense report line. |
Task_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. The Workday ID of the project task associated with the billable transaction for the time entry. To get a valid ID, call GET /planTasks in the Projects REST service. |
TimeCode_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. The Workday ID of the time code for the billable transaction associated with the time entry. |
ToDate_Prompt | Date | Only used when a BillableTransactions_Id filter is not provided. Filters the billable transactions with transaction date on or before the specified date. Use the yyyy-mm-dd format. |
TransactionSource_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. Filters the billable transactions by transaction source. Specify the Workday ID of the transaction source. |
Worker_Prompt | String | Only used when a BillableTransactions_Id filter is not provided. Accepts multiple inputs. The Workday ID of the worker associated with the billable transaction. To get a valid ID, call GET /workers in the Staffing service. |
Reads actions entries from the CasesTimeline table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CasesTimeline_Id [KEY] | String | The Wordkay ID of the CasesTimeline that contains this |
Cases_Id [KEY] | String | The Workday ID of the Cases that owns this |
Text | String | Supported for: SELECT. Case Action Text. |
Desc_Prompt | Boolean | Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
MyCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Reads attachments entries from the CasesTimeline table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CasesTimeline_Id [KEY] | String | The Wordkay ID of the CasesTimeline that contains this |
Cases_Id [KEY] | String | The Workday ID of the Cases that owns this |
Comment | String | Supported for: SELECT. Questionnaire attachment comment |
FileName | String | Supported for: SELECT. File name of the attachment |
Href | String | Supported for: SELECT. A link to the instance |
Desc_Prompt | Boolean | Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
MyCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Reads guidance.kbArticle.currentArticleData entries from the CasesTimeline table
Name | Type | Description |
CasesTimeline_Id | String | The Wordkay ID of the CasesTimeline that contains this |
Cases_Id | String | The Workday ID of the Cases that owns this |
Url | String | Supported for: SELECT. Static URL to the article view, which will always be resolved to the published version in the users language. |
Desc_Prompt | Boolean | Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
MyCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Reads questionnaireResponse.questionAnswerPair entries from the CasesTimeline table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ fileName: Text /* File name of the attachment */ comment: Text /* Questionnaire attachment comment */ id: Text /* Id of the instance */ href: Text /* A link to the instance */ }]
Name | Type | Description |
CasesTimeline_Id | String | The Wordkay ID of the CasesTimeline that contains this |
Cases_Id | String | The Workday ID of the Cases that owns this |
Answer | String | Supported for: SELECT. Answer text. |
Attachments_Aggregate | String | Supported for: SELECT. A JSON aggregate. Questionnaire Attachments. |
Question | String | Supported for: SELECT. Question body. |
Desc_Prompt | Boolean | Only used when a Cases_Id filter is not provided. If true, sorts results in descending order. |
MyCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves cases owned by the processing user. |
OpenCases_Prompt | Boolean | Only used when a Cases_Id filter is not provided. Retrieves open cases and cases that were resolved or canceled less than 7 days ago. |
Sort_Prompt | String | Only used when a Cases_Id filter is not provided. The field to sort results by. The default is creationDate. Note: Currently supports creationDate only. |
Retrieves a list of suggestions based on case type.
Name | Type | Description |
CaseSuggestionContentId | String | Supported for: SELECT. The Workday Id of the Task, Learning Content, Help Article, or website link returned as a Case Suggestion. |
Description | String | Supported for: SELECT. Case Suggestion Description. |
Name | String | Supported for: SELECT. Will display the name of the Task, Knowledge Base Article, Learning Content Suggested or the display name of a Link Suggestion. |
Order | String | Supported for: SELECT. Case Suggestion Display Order. |
Type_Descriptor | String | Supported for: SELECT. A description of the instance |
Type_Href | String | Supported for: SELECT. A link to the instance |
Type_Id | String | Supported for: SELECT. wid / id / reference id |
Url | String | Supported for: SELECT. URL to open Case Suggestion. |
CaseType_Prompt | String | The Workday ID of the case type to retrieve suggestions for. You can use GET /helpCase/caseTypes/view to retrieve a list of case types and their IDs. |
Retrieves a list of case types that a worker has access to.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Confidential | Bool | Supported for: SELECT. Case type confidential flag for REST service. |
Description | String | Supported for: SELECT. Case Type Description. |
External | Bool | Supported for: SELECT. Returns true if the case type is external. |
HasQuestionnaire | Bool | Supported for: SELECT. Boolean value returning true if the Case Type has a questionnaire. |
Name | String | Supported for: SELECT. The name of the case type. |
Questionnaire_Id | String | Supported for: SELECT. Id of the instance |
Worker_Prompt | String | The worker to use to determine access to case types. |
Reads externalLink entries from the CaseTypes table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CaseTypes_Id [KEY] | String | The Wordkay ID of the CaseTypes that contains this |
Link | String | Supported for: SELECT. Case Type External Link. |
LinkDescription | String | Supported for: SELECT. Case Type External Link. |
Worker_Prompt | String | The worker to use to determine access to case types. |
Returns a valid OAuth Client Details for OCFR Clients
Name | Type | Description |
AuthorizationEndpoint | String | Supported for: SELECT. Authorization Endpoint |
ClientId | String | Supported for: SELECT. OAuth 2.0 Client ID |
TokenEndpoint | String | Supported for: SELECT. Token Endpoint |
Client_name_Prompt | String | Client Name |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
WorktagType_Prompt | String | No description available |
Retrieves tenant setup configurations related to Help Case Management.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
ConfidentialCasesMessage | String | Supported for: SELECT. Confidential Cases Message. |
DisplayServiceCategories | Bool | Supported for: SELECT. No description available |
FileConfigurations_AllFileTypesSupported | Bool | Supported for: SELECT. True if all file attachment types allowed. |
FileConfigurations_MaxFileSizeInMB | Decimal | Supported for: SELECT. Max Attachment Size. |
FileConfigurations_SupportedFileTypes_Aggregate | String | Supported for: SELECT. A JSON aggregate. Returns the allowed file types for a tenant. |
MaxAttachments | Decimal | Supported for: SELECT. Maximum number of attachments that can be added to a case at one time. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Retrieves information about a country.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Alpha2Code | String | Supported for: SELECT. The ISO alpha-2 code for a country. |
Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EnabledForAddressLookup | Bool | Supported for: SELECT. True if the country is enabled for Address Lookup. |
Href | String | Supported for: SELECT. A link to the instance |
Retrieves the allowed address components and their configuration for the Country and a given Address Configuration Format.The webServiceAlias of the returned address components map to the enterable fields when submitting address data in other POST/PUT/PATCH operations.
Name | Type | Description |
Countries_Id | String | The Workday ID of the Countries that owns this |
ComponentType_Descriptor | String | Supported for: SELECT. A description of the instance |
ComponentType_Href | String | Supported for: SELECT. A link to the instance |
ComponentType_Id | String | Supported for: SELECT. wid / id / reference id |
Label | String | Supported for: SELECT. Country-specific label override for an address component. If no country-specific override exists, the generic component name is used. For example, for the US, the label State overrides the underlying generic component name Region. |
Order | String | Supported for: SELECT. The order in which the address component appears on the address maintenance page. The order of an address component is country-specific. |
Required | Bool | Supported for: SELECT. True if the address component is required for the country. |
Type | String | Supported for: SELECT. No description available |
WebServiceAlias | String | Supported for: SELECT. The custom Web Service Alias defined on an address component. For use with the Recruiting API. |
AddressConfigurationFormat_Prompt | String | The Address Configuration Format to return values for. |
CurrentAddress_Prompt | String | The existing address being updated. |
UseWesternScript_Prompt | Boolean | Enables Local Script components for Countries using Local Script in Default Format. |
Retrieves a collection of configuration information about name components.
Name | Type | Description |
Countries_Id | String | The Workday ID of the Countries that owns this |
ComponentType_Descriptor | String | Supported for: SELECT. A description of the instance |
ComponentType_Href | String | Supported for: SELECT. A link to the instance |
ComponentType_Id | String | Supported for: SELECT. wid / id / reference id |
Label | String | Supported for: SELECT. The country-specific label override for a name component. If no country-specific override exists, the generic name component name is used. For example, for Russia, the label Patronymic Name overrides the underlying generic component name Secondary. |
Order | String | Supported for: SELECT. The order assigned to the name component on the Maintain Name Components by Country task. The order of a name component is specific to a country. |
Required | Bool | Supported for: SELECT. True if the name component is required for the country. |
ShowDisplayOnlyOnPreferred | Bool | Supported for: SELECT. True if the name component is display only on preferred. This field is for China only. |
Type | String | Supported for: SELECT. No description available |
WebServiceAlias | String | Supported for: SELECT. The custom Web Service Alias defined on a name component. For use with the Recruiting API. |
CurrentName_Prompt | String | The Workday ID of the person's current name being updated. |
NameConfigurationFormat_Prompt | String | The Name Configuration Format for which to return values. |
UseWesternScript_Prompt | Boolean | If true, this method returns the set of allowed and required name components that uses Western Script. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicLevel_Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Id | String | Supported for: SELECT. Id of the instance |
CourseSubject_Descriptor | String | Supported for: SELECT. A description of the instance |
CourseSubject_Href | String | Supported for: SELECT. A link to the instance |
CourseSubject_Id | String | Supported for: SELECT. wid / id / reference id |
Description | String | Supported for: SELECT. The course description from the course definition associated with this student course. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EligibilityRule_Descriptor | String | Supported for: SELECT. A preview of the instance |
EligibilityRule_EligibilityRuleMeaning | String | Supported for: SELECT. The meaning of the eligibility rule. |
EligibilityRule_Id | String | Supported for: SELECT. Id of the instance |
InstitutionalAcademicUnit_Id | String | Supported for: SELECT. Id of the instance |
InstitutionalAcademicUnit_Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
InstitutionalAcademicUnit_Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
InstitutionalAcademicUnit_Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
ListingNumber | String | Supported for: SELECT. The course number of the course listing. |
Title | String | Supported for: SELECT. The course title from the course definition associated with this student course. |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads academicUnits entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads allowedLocations entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads competencies entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicLevel_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicLevel_Href | String | Supported for: SELECT. A link to the instance |
AcademicLevel_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicPeriod_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicPeriod_Href | String | Supported for: SELECT. A link to the instance |
AcademicPeriod_Id | String | Supported for: SELECT. wid / id / reference id |
Capacity | Decimal | Supported for: SELECT. The enrollment capacity for the course section. |
Cluster_Descriptor | String | Supported for: SELECT. A description of the instance |
Cluster_Href | String | Supported for: SELECT. A link to the instance |
Cluster_Id | String | Supported for: SELECT. wid / id / reference id |
CourseSubject_Descriptor | String | Supported for: SELECT. A description of the instance |
CourseSubject_Href | String | Supported for: SELECT. A link to the instance |
CourseSubject_Id | String | Supported for: SELECT. wid / id / reference id |
Course_Descriptor | String | Supported for: SELECT. A description of the instance |
Course_Href | String | Supported for: SELECT. A link to the instance |
Course_Id | String | Supported for: SELECT. wid / id / reference id |
DeliveryMode_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliveryMode_Href | String | Supported for: SELECT. A link to the instance |
DeliveryMode_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EligibilityRule_Descriptor | String | Supported for: SELECT. A preview of the instance |
EligibilityRule_EligibilityRuleMeaning | String | Supported for: SELECT. The meaning of the eligibility rule. |
EligibilityRule_Id | String | Supported for: SELECT. Id of the instance |
EndDate | Datetime | Supported for: SELECT. The End Date of the Course Section |
Hidden | Bool | Supported for: SELECT. Returns true if the Course Section is set as hidden. |
InstructionalFormat_Descriptor | String | Supported for: SELECT. A description of the instance |
InstructionalFormat_Href | String | Supported for: SELECT. A link to the instance |
InstructionalFormat_Id | String | Supported for: SELECT. wid / id / reference id |
OwningAcademicUnit_Id | String | Supported for: SELECT. Id of the instance |
OwningAcademicUnit_Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
OwningAcademicUnit_Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
OwningAcademicUnit_Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
OwningInstitutionalAcademicUnit_Id | String | Supported for: SELECT. Id of the instance |
OwningInstitutionalAcademicUnit_Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
OwningInstitutionalAcademicUnit_Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
OwningInstitutionalAcademicUnit_Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
StartDate | Datetime | Supported for: SELECT. The Start Date of the Course Section |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads campusLocations entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads competencies entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads components entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Location | String | Supported for: SELECT. Location Display ID of the Activity Offering Component. |
MeetingPattern_Descriptor | String | Supported for: SELECT. A description of the instance |
MeetingPattern_Href | String | Supported for: SELECT. A link to the instance |
MeetingPattern_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads instuctors entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads learningOutcomes entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads offeringAcademicUnits entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads tags entries from the CourseSections table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSections_Id [KEY] | String | The Wordkay ID of the CourseSections that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicPeriods from studentAcademicFoundation service. |
CampusLocation_Prompt | String | Accepts multiple inputs. No description available |
CourseSubject_Prompt | String | The subject for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
Course_Prompt | String | The course for the course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courses. |
DeliveryMode_Prompt | String | The delivery mode for the course section.You can specify using the Workday ID or Reference ID. You can use the following values: Correspondence, Hybrid, In-Person, Online, Other Distance Mode. |
InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, Workshop. |
OfferingAcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit that offers this course section. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Status_Prompt | String | The section status of the course section. You can specify using the Workday ID or Reference ID. You can use the following values: Preliminary, Open, Closed, Waitlist, Hold, Canceled. |
Reads instructionalFormats entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads learningOutcomes entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads tags entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
Reads typicalPeriodsOffered entries from the Courses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Courses_Id [KEY] | String | The Wordkay ID of the Courses that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Prompt | String | The academic level used by the courses. You can specify using the Workday ID or Reference ID. You can use a returned id from GET /academicLevels from studentAcademicFoundation service. |
AcademicUnit_Prompt | String | Accepts multiple inputs. The academic unit used by the course. You can specify multiple academicUnit query parameters using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
CourseSubject_Prompt | String | The subject for the course. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /courseSubjects. |
EffectiveDate_Prompt | Date | The effective date of the Course's effective-dated fields: competencies, academicLevel, typicalPeriodsOffered, academicUnits, allowedLocations, owningInstitutionalAcademicUnit, tags, description, eligibilityRule, instructionalFormats, learningOutcomes, and title. Format for input is as such: YYYY-MM-DD. |
InstitutionalAcademicUnit_Prompt | String | The institution academic unit used by the courses. You can specify by using the Workday ID or Reference ID. You can use a returned id from GET /academicUnits from studentAcademicFoundation service. |
Search_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Abbreviation | String | Supported for: SELECT. The abbreviation for a Course Subject. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. Indicates if a Course Subject is inactive. |
Inactive_Prompt | Boolean | Indicates if a Course Subject is inactive. |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institution Academic Units. |
Reads institutionalAcademicUnits entries from the CourseSubjects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CourseSubjects_Id [KEY] | String | The Wordkay ID of the CourseSubjects that contains this |
Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
Inactive_Prompt | Boolean | Indicates if a Course Subject is inactive. |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institution Academic Units. |
No description available
Name | Type | Description |
AccessToServices | String | Supported for: SELECT. No description available |
AppId | String | Supported for: SELECT. No description available |
AuthorizationEndpoint | String | Supported for: SELECT. No description available |
ClientId | String | Supported for: SELECT. No description available |
ClientSecret | String | Supported for: SELECT. No description available |
ExternalReferenceId | String | Supported for: SELECT. No description available |
GrantType | String | Supported for: SELECT. No description available |
JwtAlg | String | Supported for: SELECT. No description available |
JwtAudience | String | Supported for: SELECT. No description available |
JwtIssuer | String | Supported for: SELECT. No description available |
JwtKid | String | Supported for: SELECT. No description available |
JwtSubject | String | Supported for: SELECT. No description available |
Password | String | Supported for: SELECT. No description available |
PrivateKey | String | Supported for: SELECT. No description available |
RevokeEndpoint | String | Supported for: SELECT. No description available |
Scope | String | Supported for: SELECT. No description available |
TokenEndpoint | String | Supported for: SELECT. No description available |
UserAccount_Descriptor | String | Supported for: SELECT. A description of the instance |
UserAccount_Href | String | Supported for: SELECT. A link to the instance |
UserAccount_Id | String | Supported for: SELECT. wid / id / reference id |
Username | String | Supported for: SELECT. No description available |
WorkdayID | String | Supported for: SELECT. No description available |
Id_Prompt | String | No description available |
Kid_Prompt | String | No description available |
Retrieves the details of a specified currency.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Code | String | Supported for: SELECT. ID |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Precision | Decimal | Supported for: SELECT. Precision |
Retrieves a single customer instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
CommercialCreditScore | Decimal | Supported for: SELECT. The Dun and Bradstreet Commercial credit score of the customer. |
CompositeRiskScore | Decimal | Supported for: SELECT. The Dun and Bradstreet risk score of the customer. |
CreditLimit_Currency | String | Supported for: SELECT. The maximum credit limit for the customer. |
CreditLimit_Value | Decimal | Supported for: SELECT. The maximum credit limit for the customer. |
Name | String | Supported for: SELECT. The name of the customer. |
PaymentTerms_Descriptor | String | Supported for: SELECT. A description of the instance |
PaymentTerms_Href | String | Supported for: SELECT. A link to the instance |
PaymentTerms_Id | String | Supported for: SELECT. wid / id / reference id |
PrimaryPhone | String | Supported for: SELECT. The primary phone number of the customer. |
SatisfactionScore | Decimal | Supported for: SELECT. The customer satisfaction score. |
TotalBalance_Currency | String | Supported for: SELECT. The total customer balance due in the customer currency, as of the report run time. Workday calculates the total balance by adding the amount of all approved and uncanceled customer invoices and subtracting the total amount of all approved and uncanceled customer payments. The customer currency can be the default currency for the tenant, or the currency you define for a given customer. |
TotalBalance_Value | Decimal | Supported for: SELECT. The total customer balance due in the customer currency, as of the report run time. Workday calculates the total balance by adding the amount of all approved and uncanceled customer invoices and subtracting the total amount of all approved and uncanceled customer payments. The customer currency can be the default currency for the tenant, or the currency you define for a given customer. |
Name_Prompt | String | No description available |
Retrieves an activity instance for a specific customer.
Name | Type | Description |
Id [KEY] | String | Returns the Workday ID for a given object. |
Customers_Id [KEY] | String | The Workday ID of the Customers that owns this |
ApplicationStatus | String | Supported for: SELECT. The payment or application status of the customer invoice, customer invoice adjustment or customer invoice payment. For customer invoice payments, the application status can be Unapplied, Applied with On Account, or Fully Applied. For invoices, the payment status can be Paid, Partially Paid, or Unpaid. |
InvoiceDueDate | Datetime | Supported for: SELECT. The due date of the customer invoice or invoice adjustment as of the defined reporting date. |
InvoiceOpportunity_Id | String | Supported for: SELECT. Returns the Workday ID for a given object. |
InvoiceOpportunity_Name | String | Supported for: SELECT. The non-unique name of the Opportunity. This is for internal use only. |
InvoiceOpportunity_OpportunityReferenceID | String | Supported for: SELECT. The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the 'Organization ID' |
PaymentReference | String | Supported for: SELECT. The check number for a customer payment. This is a reference number that's available only when processed through a settlement run and not a check number. |
TransactionAmountSigned_Currency | String | Supported for: SELECT. The positive or negative sign of the transaction amount for this customer transaction. This is for internal use only on a REST API. |
TransactionAmountSigned_Value | Decimal | Supported for: SELECT. The positive or negative sign of the transaction amount for this customer transaction. This is for internal use only on a REST API. |
TransactionDate | Datetime | Supported for: SELECT. The date of the customer transaction. This field is for internal use only on a REST API. |
TransactionNumber | String | Supported for: SELECT. The transaction number for the reporting transaction. This is for internal use only on a REST API. |
TransactionStatus | String | Supported for: SELECT. The current status of the transaction. Applicable for all transaction types. This is for internal use only on a REST API. |
TransactionType | String | Supported for: SELECT. The transaction type of this customer transaction. This is for internal use only on a REST API. |
FromDate_Prompt | Date | No description available |
ToDate_Prompt | Date | No description available |
Name_Prompt | String | Only used when a Customers_Id filter is not provided. No description available |
Reads groups entries from the Customers table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Customers_Id [KEY] | String | The Wordkay ID of the Customers that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Name_Prompt | String | No description available |
Retrieves a data source for the specified {ID} for use in a WQL query.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. A description describing the data source. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
FilterIsRequired | Bool | Supported for: SELECT. returns if the filer is required |
Href | String | Supported for: SELECT. A link to the instance |
SupportsEffectiveDate | Bool | Supported for: SELECT. returns if the data source supports effective date |
SupportsEntryDate | Bool | Supported for: SELECT. returns if the data source supports entry date |
Alias_Prompt | String | The alias of the data source. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data sources. |
Retrieves the data source filter with the specified {ID} for a specific data source.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
DataSources_Id [KEY] | String | The Workday ID of the DataSources that owns this |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. A description of the data source filter. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Alias_Prompt | String | The alias of the data source filter. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data source filters. |
Alias_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The alias of the data source. |
SearchString_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The string to be searched in case insensitive manner within the descriptors of the data sources. |
Reads optionalParameters entries from the DataSourcesDataSourceFilters table
Name | Type | Description |
DataSourcesDataSourceFilters_Id | String | The Wordkay ID of the DataSourcesDataSourceFilters that contains this |
DataSources_Id | String | The Workday ID of the DataSources that owns this |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. Description for Query Parameter for External Promptable |
Type | String | Supported for: SELECT. Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". |
WorkData_Descriptor | String | Supported for: SELECT. A description of the instance |
WorkData_Href | String | Supported for: SELECT. A link to the instance |
WorkData_Id | String | Supported for: SELECT. wid / id / reference id |
Alias_Prompt | String | The alias of the data source filter. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data source filters. |
Alias_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The alias of the data source. |
SearchString_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The string to be searched in case insensitive manner within the descriptors of the data sources. |
Reads requiredParameters entries from the DataSourcesDataSourceFilters table
Name | Type | Description |
DataSourcesDataSourceFilters_Id | String | The Wordkay ID of the DataSourcesDataSourceFilters that contains this |
DataSources_Id | String | The Workday ID of the DataSources that owns this |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. Description for Query Parameter for External Promptable |
Type | String | Supported for: SELECT. Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". |
WorkData_Descriptor | String | Supported for: SELECT. A description of the instance |
WorkData_Href | String | Supported for: SELECT. A link to the instance |
WorkData_Id | String | Supported for: SELECT. wid / id / reference id |
Alias_Prompt | String | The alias of the data source filter. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data source filters. |
Alias_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The alias of the data source. |
SearchString_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The string to be searched in case insensitive manner within the descriptors of the data sources. |
Retrieves the field with a specified {ID} for the specific data source.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Description for Query Parameter for External Promptable */ type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */ alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */ workData: { *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } }]
[{ alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */ type: Text /* The type of the field */ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ description: Text /* Description for Query Parameter for External Promptable */ type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */ alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */ workData: { *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
DataSources_Id [KEY] | String | The Workday ID of the DataSources that owns this |
Alias | String | Supported for: SELECT. WQL Alias Internal |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
OptionalParameters_Aggregate | String | Supported for: SELECT. A JSON aggregate. Optional Parameters for WQL |
RelatedFields_Aggregate | String | Supported for: SELECT. A JSON aggregate. Related Business Object Fields |
RequiredParameters_Aggregate | String | Supported for: SELECT. A JSON aggregate. Required Parameters for WQL |
Type | String | Supported for: SELECT. Field Type |
Alias_Prompt | String | The alias of the data source field. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data source fields. |
Alias_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The alias of the data source. |
SearchString_Prompt_For_DataSources | String | Only used when a DataSources_Id filter is not provided. The string to be searched in case insensitive manner within the descriptors of the data sources. |
Reads optionalParameters entries from the DataSources table
Name | Type | Description |
DataSources_Id | String | The Wordkay ID of the DataSources that contains this |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. Description for Query Parameter for External Promptable |
Type | String | Supported for: SELECT. Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". |
WorkData_Descriptor | String | Supported for: SELECT. A description of the instance |
WorkData_Href | String | Supported for: SELECT. A link to the instance |
WorkData_Id | String | Supported for: SELECT. wid / id / reference id |
Alias_Prompt | String | The alias of the data source. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data sources. |
Reads requiredParameters entries from the DataSources table
Name | Type | Description |
DataSources_Id | String | The Wordkay ID of the DataSources that contains this |
Alias | String | Supported for: SELECT. This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. |
Description | String | Supported for: SELECT. Description for Query Parameter for External Promptable |
Type | String | Supported for: SELECT. Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". |
WorkData_Descriptor | String | Supported for: SELECT. A description of the instance |
WorkData_Href | String | Supported for: SELECT. A link to the instance |
WorkData_Id | String | Supported for: SELECT. wid / id / reference id |
Alias_Prompt | String | The alias of the data source. |
SearchString_Prompt | String | The string to be searched in case insensitive manner within the descriptors of the data sources. |
Retrieves the educational credential with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Description | String | Supported for: SELECT. Description of Educational Credentail |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Name | String | Supported for: SELECT. Name of Educational Credential |
Type_Descriptor | String | Supported for: SELECT. A description of the instance |
Type_Href | String | Supported for: SELECT. A link to the instance |
Type_Id | String | Supported for: SELECT. wid / id / reference id |
Reads errorMessageSet.errors entries from the EventDrivenIntegrationVendorResponse table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ groupData: [{ name: Text /* The name of the reported field attribute. Examples: Amount, Currency, Status. */ value: Text /* The value of the reported field attribute. Examples: 2000, USD, Active. */ }] groupValue: Text /* The specific name of the type of data being provided by the third-party payroll system. Examples: Car Allowance, Home Address. */ groupName: Text /* The group category holding the data being provided by the third-party payroll system. Examples: Allowance, Address. */ }]
Name | Type | Description |
EventDrivenIntegrationVendorResponse_Id | String | The Wordkay ID of the EventDrivenIntegrationVendorResponse that contains this |
Diagnosis | String | Supported for: SELECT. An explanation for the root cause of the error. |
FunctionalArea | String | Supported for: SELECT. The functional area that was impacted by the error reported. Examples: Position, Compensation, Personal data. |
Group_Aggregate | String | Supported for: SELECT. A JSON aggregate. A group of optional data supplementing the main error being reported (Additional information). |
MessageCategory | String | Supported for: SELECT. The category for where the error occurred. Examples: Worker Data, Organization, Supervisory, Staffing. |
MessageNumber | String | Supported for: SELECT. An integer number identifying the error reported. |
Procedure | String | Supported for: SELECT. The steps to fix the error. |
RecordType | String | Supported for: SELECT. The type of error being recorded. Examples: Data error, Configuration error. |
Severity_Descriptor | String | Supported for: SELECT. A description of the instance |
Severity_Href | String | Supported for: SELECT. A link to the instance |
Severity_Id | String | Supported for: SELECT. wid / id / reference id |
VendorErrorMessage | String | Supported for: SELECT. Required detailed error message that explains what occurred in the third-party payroll system while processing the worker changes sent through event-driven integration. |
Who | String | Supported for: SELECT. Lists the names, positions, or roles of the concerned audience for handling the error resolution. |
Retrieves a business process event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CompletedDate | Datetime | Supported for: SELECT. The date and time the business process was completed. |
CreationDate | Datetime | Supported for: SELECT. Date the business process was initiated. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. The date the business process needs to be completed. |
EffectiveDate | Datetime | Supported for: SELECT. The date this business process takes effect. |
For_Descriptor | String | Supported for: SELECT. A description of the instance |
For_Href | String | Supported for: SELECT. A link to the instance |
For_Id | String | Supported for: SELECT. wid / id / reference id |
Initiator_Descriptor | String | Supported for: SELECT. A description of the instance |
Initiator_Href | String | Supported for: SELECT. A link to the instance |
Initiator_Id | String | Supported for: SELECT. wid / id / reference id |
OverallBusinessProcess_Descriptor | String | Supported for: SELECT. A description of the instance |
OverallBusinessProcess_Href | String | Supported for: SELECT. A link to the instance |
OverallBusinessProcess_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | No description available |
CompletedOnOrBefore_Prompt | Date | No description available |
InitiatedOnOrAfter_Prompt | Date | No description available |
InitiatedOnOrBefore_Prompt | Date | No description available |
Initiator_Prompt | String | Accepts multiple inputs. No description available |
Status_Prompt | String | Accepts multiple inputs. No description available |
Worker_Prompt | String | No description available |
Retrieves attachments for a business process event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
ContentType_Descriptor | String | Supported for: SELECT. A description of the instance |
ContentType_Href | String | Supported for: SELECT. A link to the instance |
ContentType_Id | String | Supported for: SELECT. wid / id / reference id |
Description | String | Supported for: SELECT. Event attachment description |
FileLength | Decimal | Supported for: SELECT. File length of the attachment |
FileName | String | Supported for: SELECT. File name of the attachment |
UploadDate | Datetime | Supported for: SELECT. Returns Date the Business Process Attachment was updated. |
UploadedBy_Descriptor | String | Supported for: SELECT. A description of the instance |
UploadedBy_Href | String | Supported for: SELECT. A link to the instance |
UploadedBy_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Retrieves comments for a business process event.
Name | Type | Description |
Events_Id | String | The Workday ID of the Events that owns this |
Comment | String | Supported for: SELECT. Comment |
CommentDate | Datetime | Supported for: SELECT. Gives the moment at which the instance was originally created. |
Person_Descriptor | String | Supported for: SELECT. A description of the instance |
Person_Href | String | Supported for: SELECT. A link to the instance |
Person_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Retrieves completed steps for a business process event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
CompletedByPerson_Descriptor | String | Supported for: SELECT. A description of the instance |
CompletedByPerson_Href | String | Supported for: SELECT. A link to the instance |
CompletedByPerson_Id | String | Supported for: SELECT. wid / id / reference id |
CompletedDate | Datetime | Supported for: SELECT. The date when this step was completed |
CreationDate | Datetime | Supported for: SELECT. The date when the event record was created. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. Returns the due date for this step. |
Event_Descriptor | String | Supported for: SELECT. A description of the instance |
Event_Href | String | Supported for: SELECT. A link to the instance |
Event_Id | String | Supported for: SELECT. wid / id / reference id |
Order | String | Supported for: SELECT. Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead. |
ParallelStepInboxOrder | String | Supported for: SELECT. The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value. |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Reads awaitingPersons entries from the EventsCompletedSteps table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
EventsCompletedSteps_Id [KEY] | String | The Wordkay ID of the EventsCompletedSteps that contains this |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Reads comments entries from the EventsCompletedSteps table
Name | Type | Description |
EventsCompletedSteps_Id | String | The Wordkay ID of the EventsCompletedSteps that contains this |
Events_Id | String | The Workday ID of the Events that owns this |
Comment | String | Supported for: SELECT. Comment |
CommentDate | Datetime | Supported for: SELECT. Gives the moment at which the instance was originally created. |
Person_Descriptor | String | Supported for: SELECT. A description of the instance |
Person_Href | String | Supported for: SELECT. A link to the instance |
Person_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Retrieves in progress steps for a business process event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
Anonymous | Bool | Supported for: SELECT. Returns if the event step has been anonymously assigned. |
BusinessProcessStep_Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcessStep_Id | String | Supported for: SELECT. Id of the instance |
CreationDate | Datetime | Supported for: SELECT. The date when the event record was created. |
DelayedDate | Datetime | Supported for: SELECT. The date the delayed step will trigger. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. Returns the due date for this step. |
Order | String | Supported for: SELECT. Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead. |
ParallelStepInboxOrder | String | Supported for: SELECT. The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value. |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Reads awaitingPersons entries from the EventsInProgressSteps table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
EventsInProgressSteps_Id [KEY] | String | The Wordkay ID of the EventsInProgressSteps that contains this |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Retrieves remaining steps for a business process event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
CompletionStep | Bool | Supported for: SELECT. Returns true if this step completes the business process. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate_Descriptor | String | Supported for: SELECT. A description of the instance |
DueDate_Href | String | Supported for: SELECT. A link to the instance |
DueDate_Id | String | Supported for: SELECT. wid / id / reference id |
Order | String | Supported for: SELECT. Returns the order of this step within the business process definition it is part of. |
ParallelStepInboxOrder | String | Supported for: SELECT. This report field controls ordering of parallel steps in Inbox. It will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. |
Step | String | Supported for: SELECT. Returns the alternate name of the workflow step for the business process definition. |
StepType_Descriptor | String | Supported for: SELECT. A description of the instance |
StepType_Href | String | Supported for: SELECT. A link to the instance |
StepType_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Reads groups entries from the EventsRemainingSteps table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
EventsRemainingSteps_Id [KEY] | String | The Wordkay ID of the EventsRemainingSteps that contains this |
Events_Id [KEY] | String | The Workday ID of the Events that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcess_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
CompletedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrAfter_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
InitiatedOnOrBefore_Prompt | Date | Only used when a Events_Id filter is not provided. No description available |
Initiator_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Status_Prompt | String | Only used when a Events_Id filter is not provided. Accepts multiple inputs. No description available |
Worker_Prompt | String | Only used when a Events_Id filter is not provided. No description available |
Reads subBusinessProcesses entries from the Events table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Events_Id [KEY] | String | The Wordkay ID of the Events that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcess_Prompt | String | Accepts multiple inputs. No description available |
CompletedOnOrAfter_Prompt | Date | No description available |
CompletedOnOrBefore_Prompt | Date | No description available |
InitiatedOnOrAfter_Prompt | Date | No description available |
InitiatedOnOrBefore_Prompt | Date | No description available |
Initiator_Prompt | String | Accepts multiple inputs. No description available |
Status_Prompt | String | Accepts multiple inputs. No description available |
Worker_Prompt | String | No description available |
Retrieves a business process event step.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
BusinessProcessStep_Descriptor | String | Supported for: SELECT. A description of the instance |
BusinessProcessStep_Href | String | Supported for: SELECT. A link to the instance |
BusinessProcessStep_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Descriptor | String | Supported for: SELECT. A description of the instance |
BusinessProcess_Href | String | Supported for: SELECT. A link to the instance |
BusinessProcess_Id | String | Supported for: SELECT. wid / id / reference id |
CompletedByPerson_Descriptor | String | Supported for: SELECT. A description of the instance |
CompletedByPerson_Href | String | Supported for: SELECT. A link to the instance |
CompletedByPerson_Id | String | Supported for: SELECT. wid / id / reference id |
CompletedDate | Datetime | Supported for: SELECT. The date when this step was completed |
CreationDate | Datetime | Supported for: SELECT. The date when the event record was created. |
DelayedDate | Datetime | Supported for: SELECT. The date the delayed step will trigger. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. Returns the due date for this step. |
Event_Descriptor | String | Supported for: SELECT. A description of the instance |
Event_Href | String | Supported for: SELECT. A link to the instance |
Event_Id | String | Supported for: SELECT. wid / id / reference id |
Order | String | Supported for: SELECT. Retired. We retire this report field because when there are multiple steps on the business process definition that are associated with this event step, this report field doesn't return the order for each associated step. We recommend that you use the Order report field instead. |
OverallProcess_Descriptor | String | Supported for: SELECT. A description of the instance |
OverallProcess_Href | String | Supported for: SELECT. A link to the instance |
OverallProcess_Id | String | Supported for: SELECT. wid / id / reference id |
ParallelStepInboxOrder | String | Supported for: SELECT. The order that parallel steps display in the Inbox. This will be populated only if this Business Process Type allows configuration of Parallel Step Inbox Order. If there are multiple steps from the business process definition that are associated to this event step, this field returns no value. |
Questionnaire_Descriptor | String | Supported for: SELECT. A description of the instance |
Questionnaire_Href | String | Supported for: SELECT. A link to the instance |
Questionnaire_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
StepEvent_Descriptor | String | Supported for: SELECT. A description of the instance |
StepEvent_Href | String | Supported for: SELECT. A link to the instance |
StepEvent_Id | String | Supported for: SELECT. wid / id / reference id |
StepHelpText | String | Supported for: SELECT. This CRF returns the step help text that is configured for the Workflow Step of the Event Record. |
StepType_Descriptor | String | Supported for: SELECT. A description of the instance |
StepType_Href | String | Supported for: SELECT. A link to the instance |
StepType_Id | String | Supported for: SELECT. wid / id / reference id |
Task_Descriptor | String | Supported for: SELECT. A description of the instance |
Task_Href | String | Supported for: SELECT. A link to the instance |
Task_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Accepts multiple inputs. No description available |
CreatedOnOrAfter_Prompt | Date | No description available |
CreatedOnOrBefore_Prompt | Date | No description available |
DueDateOnOrAfter_Prompt | Date | No description available |
DueDateOnOrBefore_Prompt | Date | No description available |
StepType_Prompt | String | Accepts multiple inputs. No description available |
Reads awaitingPersons entries from the EventSteps table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
EventSteps_Id [KEY] | String | The Wordkay ID of the EventSteps that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BusinessProcess_Prompt | String | Accepts multiple inputs. No description available |
CreatedOnOrAfter_Prompt | Date | No description available |
CreatedOnOrBefore_Prompt | Date | No description available |
DueDateOnOrAfter_Prompt | Date | No description available |
DueDateOnOrBefore_Prompt | Date | No description available |
StepType_Prompt | String | Accepts multiple inputs. No description available |
Reads comments entries from the EventSteps table
Name | Type | Description |
EventSteps_Id | String | The Wordkay ID of the EventSteps that contains this |
Comment | String | Supported for: SELECT. Comment |
CommentDate | Datetime | Supported for: SELECT. Gives the moment at which the instance was originally created. |
Person_Descriptor | String | Supported for: SELECT. A description of the instance |
Person_Href | String | Supported for: SELECT. A link to the instance |
Person_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessProcess_Prompt | String | Accepts multiple inputs. No description available |
CreatedOnOrAfter_Prompt | Date | No description available |
CreatedOnOrBefore_Prompt | Date | No description available |
DueDateOnOrAfter_Prompt | Date | No description available |
DueDateOnOrBefore_Prompt | Date | No description available |
StepType_Prompt | String | Accepts multiple inputs. No description available |
Retrieves a single instance of an expense item.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
DisallowFixedItems_Prompt | Boolean | No description available |
SearchString_Prompt | String | No description available |
No description available
Name | Type | Description |
Date | Datetime | Supported for: SELECT. The Date of a Holiday Event. |
HolidayName | String | Supported for: SELECT. The Name of a Holiday Event. |
Worker_Descriptor | String | Supported for: SELECT. A preview of the instance |
Worker_Id | String | Supported for: SELECT. Id of the instance |
FromDate_Prompt | Date | No description available |
ToDate_Prompt | Date | No description available |
Worker_Prompt | String | Accepts multiple inputs. No description available |
Retrieves an immigration event.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Application_Descriptor | String | Supported for: SELECT. A description of the instance |
Application_Href | String | Supported for: SELECT. A link to the instance |
Application_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ImmigrationData_ActiveSevisId | String | Supported for: SELECT. The current active SEVIS ID for the student immigration data. |
ImmigrationData_ActiveVisaType_Descriptor | String | Supported for: SELECT. A description of the instance |
ImmigrationData_ActiveVisaType_Href | String | Supported for: SELECT. A link to the instance |
ImmigrationData_ActiveVisaType_Id | String | Supported for: SELECT. wid / id / reference id |
ImmigrationData_Descriptor | String | Supported for: SELECT. A preview of the instance |
ImmigrationData_Id | String | Supported for: SELECT. Id of the instance |
ImmigrationData_IssuingInstitution_Descriptor | String | Supported for: SELECT. A description of the instance |
ImmigrationData_IssuingInstitution_Href | String | Supported for: SELECT. A link to the instance |
ImmigrationData_IssuingInstitution_Id | String | Supported for: SELECT. wid / id / reference id |
Status | String | Supported for: SELECT. The status of the immigration event. |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ImmigrationEvents_Id [KEY] | String | The Workday ID of the ImmigrationEvents that owns this |
Description | String | Supported for: SELECT. The description for a student configurable page. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Hidden | Bool | Supported for: SELECT. Student Configurable Tab Configuration Hidden |
Name | String | Supported for: SELECT. Name of this Student Configurable Page |
Type | String | Supported for: SELECT. The derived type of the page. |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
GiveInterviewFeedbackLink | String | Supported for: SELECT. A URL for the Give Interview Feedback task, for workers with access to the Interview Feedback Detail event awaiting processing. |
HasCompetenciesQuestionnaires | Bool | Supported for: SELECT. If true, the interviewer feedback task awaiting processing has Competencies or Questionnaires with configured XIP settings. |
JobApplication_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobApplication_Id | String | Supported for: SELECT. Id of the instance |
JobApplication_NumberOfJobs | Decimal | Supported for: SELECT. The number of jobs for a candidate on this job application. |
JobApplication_TotalYearsExperience | Decimal | Supported for: SELECT. The total years of experience for the candidate on this job application. |
JobApplication_YearsInCurrentJob | Decimal | Supported for: SELECT. The number of years the candidate has been employed at their current job |
JobRequisition_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobRequisition_HiringManager_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobRequisition_HiringManager_Id | String | Supported for: SELECT. Id of the instance |
JobRequisition_Id | String | Supported for: SELECT. Id of the instance |
OverallComment | String | Supported for: SELECT. The Overall Comment XIP configuration formatted as text. |
OverallRating | String | Supported for: SELECT. The Overall Rating XIP configuration formatted as text. |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Reads interviewers entries from the Interviews table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Interviews_Id [KEY] | String | The Wordkay ID of the Interviews that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Reads interviewStatuses entries from the Interviews table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Interviews_Id [KEY] | String | The Wordkay ID of the Interviews that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Reads jobRequisition.primaryRecruiters entries from the Interviews table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Interviews_Id [KEY] | String | The Wordkay ID of the Interviews that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Reads jobRequisition.recruiters entries from the Interviews table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Interviews_Id [KEY] | String | The Wordkay ID of the Interviews that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Reads workersPendingFeedback entries from the Interviews table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Interviews_Id [KEY] | String | The Wordkay ID of the Interviews that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InterviewStatus_Prompt | String | Accepts multiple inputs. "All applicable interview statuses for an Interview event. Statuses can be: |
Retrieves a single customer invoice or adjustment instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AdjustmentReason_Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomerAddress_AddressLine1 | String | Supported for: SELECT. The first address line for the bill-to customer. |
BillToCustomerAddress_AddressLine2 | String | Supported for: SELECT. The second address line for the bill-to customer. |
BillToCustomerAddress_AddressLine3 | String | Supported for: SELECT. The third address line for the bill-to customer. |
BillToCustomerAddress_AddressLine4 | String | Supported for: SELECT. The fourth address line for the bill-to customer. |
BillToCustomerAddress_City | String | Supported for: SELECT. The city of the bill-to customer. |
BillToCustomerAddress_CitySubdivision1 | String | Supported for: SELECT. The subdivision of the city of the bill-to customer. |
BillToCustomerAddress_CitySubdivision2 | String | Supported for: SELECT. The second subdivision of the city of the bill-to customer. |
BillToCustomerAddress_CountryRegion_Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomerAddress_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomerAddress_Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomerAddress_Id | String | Supported for: SELECT. Id of the instance |
BillToCustomerAddress_PostalCode | String | Supported for: SELECT. The postal code of the bill-to customer. |
BillToCustomerAddress_RegionSubdivision1 | String | Supported for: SELECT. The subdivision of the region of the bill-to customer. |
BillToCustomerAddress_RegionSubdivision2 | String | Supported for: SELECT. The second subdivision of the region of the bill-to customer. |
BillToCustomer_Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomer_Id | String | Supported for: SELECT. Id of the instance |
Company_Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Id | String | Supported for: SELECT. Id of the instance |
Currency_Descriptor | String | Supported for: SELECT. A preview of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DisputeAmount_Currency | String | Supported for: SELECT. The amount you dispute on a customer invoice. |
DisputeAmount_Value | Decimal | Supported for: SELECT. The amount you dispute on a customer invoice. |
DisputeDate | Datetime | Supported for: SELECT. The date you place the customer invoice in dispute. |
DueAmount_Currency | String | Supported for: SELECT. The amount due for the customer invoice. The value can be positive or negative. |
DueAmount_Value | Decimal | Supported for: SELECT. The amount due for the customer invoice. The value can be positive or negative. |
DueDate | Datetime | Supported for: SELECT. The due date of the customer invoice or invoice adjustment as of the defined reporting date. |
Href | String | Supported for: SELECT. A link to the instance |
InCollection | Bool | Supported for: SELECT. A flag when set to true, places the invoices into collections. |
InDispute | Bool | Supported for: SELECT. True if the invoice is in dispute. |
InvoiceDate | Datetime | Supported for: SELECT. The date of the customer invoice. |
InvoiceNumber | String | Supported for: SELECT. The customer invoice number. |
InvoiceStatus_Descriptor | String | Supported for: SELECT. A preview of the instance |
InvoiceStatus_Id | String | Supported for: SELECT. Id of the instance |
InvoiceType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Memo | String | Supported for: SELECT. The memo for the customer invoice. |
NetAmount_Currency | String | Supported for: SELECT. The total of all invoice line amounts minus the total Tax amount minus the Prepaid Utilization amount. This calculation doesn't deduct the withholding tax. This is the value printed on the customer invoice and can be positive or negative. |
NetAmount_Value | Decimal | Supported for: SELECT. The total of all invoice line amounts minus the total Tax amount minus the Prepaid Utilization amount. This calculation doesn't deduct the withholding tax. This is the value printed on the customer invoice and can be positive or negative. |
PaymentStatus_Descriptor | String | Supported for: SELECT. A preview of the instance |
PaymentStatus_Id | String | Supported for: SELECT. Id of the instance |
PoNumber | String | Supported for: SELECT. The purchase order number specified on the customer invoice. |
RelatedInvoice_Descriptor | String | Supported for: SELECT. A description of the instance |
RelatedInvoice_Href | String | Supported for: SELECT. A link to the instance |
RelatedInvoice_Id | String | Supported for: SELECT. wid / id / reference id |
RetentionAmount_Currency | String | Supported for: SELECT. Total retention amount from invoice lines. |
RetentionAmount_Value | Decimal | Supported for: SELECT. Total retention amount from invoice lines. |
TaxAmount_Currency | String | Supported for: SELECT. The total tax amount for the document with sign. |
TaxAmount_Value | Decimal | Supported for: SELECT. The total tax amount for the document with sign. |
TotalAmount_Currency | String | Supported for: SELECT. The total amount for the customer invoice including tax. The amount can be positive or negative. When the reporting transaction is not an instance of a customer invoice, the amount value is zero. |
TotalAmount_Value | Decimal | Supported for: SELECT. The total amount for the customer invoice including tax. The amount can be positive or negative. When the reporting transaction is not an instance of a customer invoice, the amount value is zero. |
TransactionType | String | Supported for: SELECT. The type of customer invoice document, either Invoice or Adjustment. |
WithholdingAmount_Currency | String | Supported for: SELECT. The tax amount that you withhold from the customer invoice. |
WithholdingAmount_Value | Decimal | Supported for: SELECT. The tax amount that you withhold from the customer invoice. |
BillToCustomer_Prompt | String | Accepts multiple inputs. The customer on the invoice. |
Company_Prompt | String | Accepts multiple inputs. No description available |
FromDueDate_Prompt | Date | The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
FromInvoiceDate_Prompt | Date | The date of the customer invoice, formatted as YYYY-MM-DD. |
InvoiceStatus_Prompt | String | Accepts multiple inputs. The current status of an invoice document. |
PaymentStatus_Prompt | String | Accepts multiple inputs. The payment status of an invoice document. |
ToDueDate_Prompt | Date | The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
ToInvoiceDate_Prompt | Date | The date of the customer invoice, formatted as YYYY-MM-DD. |
TransactionType_Prompt | String | The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Reads disputeReasons entries from the Invoices table
Name | Type | Description |
Invoices_Id | String | The Wordkay ID of the Invoices that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomer_Prompt | String | Accepts multiple inputs. The customer on the invoice. |
Company_Prompt | String | Accepts multiple inputs. No description available |
FromDueDate_Prompt | Date | The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
FromInvoiceDate_Prompt | Date | The date of the customer invoice, formatted as YYYY-MM-DD. |
InvoiceStatus_Prompt | String | Accepts multiple inputs. The current status of an invoice document. |
PaymentStatus_Prompt | String | Accepts multiple inputs. The payment status of an invoice document. |
ToDueDate_Prompt | Date | The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
ToInvoiceDate_Prompt | Date | The date of the customer invoice, formatted as YYYY-MM-DD. |
TransactionType_Prompt | String | The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Retrieves a single customer invoice print run.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Invoices_Id [KEY] | String | The Workday ID of the Invoices that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Pdf_Id | String | Supported for: SELECT. Id of the instance |
Pdf_Name | String | Supported for: SELECT. The name of the PDF file associated with the customer invoice. |
PrintRunType_Descriptor | String | Supported for: SELECT. A description of the instance |
PrintRunType_Href | String | Supported for: SELECT. A link to the instance |
PrintRunType_Id | String | Supported for: SELECT. wid / id / reference id |
PrintedDateTime | Datetime | Supported for: SELECT. The date when the customer invoice was printed. |
BillToCustomer_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The customer on the invoice. |
Company_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. No description available |
FromDueDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
FromInvoiceDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The date of the customer invoice, formatted as YYYY-MM-DD. |
InvoiceStatus_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The current status of an invoice document. |
PaymentStatus_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The payment status of an invoice document. |
ToDueDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
ToInvoiceDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The date of the customer invoice, formatted as YYYY-MM-DD. |
TransactionType_Prompt | String | Only used when a Invoices_Id filter is not provided. The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Reads deliveryMethod entries from the InvoicesPrintRuns table
Name | Type | Description |
InvoicesPrintRuns_Id | String | The Wordkay ID of the InvoicesPrintRuns that contains this |
Invoices_Id | String | The Workday ID of the Invoices that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
BillToCustomer_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The customer on the invoice. |
Company_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. No description available |
FromDueDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
FromInvoiceDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The date of the customer invoice, formatted as YYYY-MM-DD. |
InvoiceStatus_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The current status of an invoice document. |
PaymentStatus_Prompt | String | Only used when a Invoices_Id filter is not provided. Accepts multiple inputs. The payment status of an invoice document. |
ToDueDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The due date of the customer invoice or invoice adjustment as of the defined reporting date, formatted as YYYY-MM-DD. |
ToInvoiceDate_Prompt | Date | Only used when a Invoices_Id filter is not provided. The date of the customer invoice, formatted as YYYY-MM-DD. |
TransactionType_Prompt | String | Only used when a Invoices_Id filter is not provided. The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Retrieves a job change reason instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
IsForContingentWorker | Bool | Supported for: SELECT. Identifies whether the reason is allowed to be entered for contingent workers. |
IsForEmployee | Bool | Supported for: SELECT. Identifies whether the reason is allowed to be entered for employees. |
ManagerReason | Bool | Supported for: SELECT. Identifies whether the reason is allowed to be entered by managers. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Job_Prompt | String | No description available |
Location_Prompt | String | No description available |
ProposedManager_Prompt | String | Accepts multiple inputs. No description available |
StaffingEvent_Prompt | String | No description available |
Worker_Prompt | String | No description available |
Retrieves a single job family instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. If true, the method returns inactive job families. Default is false. |
JobFamilyGroup_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobFamilyGroup_Id | String | Supported for: SELECT. Id of the instance |
Summary | String | Supported for: SELECT. Returns the job family summary for the job family. |
Inactive_Prompt | Boolean | If true, the method returns inactive job families. Default is false. |
JobFamilyGroup_Prompt | String | Accepts multiple inputs. The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter. |
JobProfile_Prompt | String | Accepts multiple inputs. The job profile for the job family. You can specify more than 1 jobFamilyGroup query parameter. For possible values, you can use a returned id from GET /jobProfiles. |
Reads jobProfiles entries from the JobFamilies table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobFamilies_Id [KEY] | String | The Wordkay ID of the JobFamilies that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive_Prompt | Boolean | If true, the method returns inactive job families. Default is false. |
JobFamilyGroup_Prompt | String | Accepts multiple inputs. The job family group for the job family. You can specify more than 1 jobFamilyGroup query parameter. |
JobProfile_Prompt | String | Accepts multiple inputs. The job profile for the job family. You can specify more than 1 jobFamilyGroup query parameter. For possible values, you can use a returned id from GET /jobProfiles. |
Retrieves a job posting.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Company_Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Id | String | Supported for: SELECT. Id of the instance |
EndDate | Datetime | Supported for: SELECT. The end date for the job posting. |
JobDescription | String | Supported for: SELECT. The description of the job for the job posting. |
JobSite_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobSite_Id | String | Supported for: SELECT. Id of the instance |
JobType_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryLocation_Country_Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
PrimaryLocation_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryLocation_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryLocation_Id | String | Supported for: SELECT. Id of the instance |
PrimaryLocation_Region_Code | String | Supported for: SELECT. The region-only portion of the ISO 3166-2 code for a country region. |
PrimaryLocation_Region_Descriptor | String | Supported for: SELECT. A preview of the instance |
RemoteType_Id | String | Supported for: SELECT. Id of the instance |
RemoteType_Name | String | Supported for: SELECT. The external or internal name of the Job Requisition Remote Type for the given Job Posting. |
SpotlightJob | Bool | Supported for: SELECT. True if the job posting is a Spotlight Job or not. |
StartDate | Datetime | Supported for: SELECT. The start date for the job posting. |
TimeType_Descriptor | String | Supported for: SELECT. A preview of the instance |
TimeType_Id | String | Supported for: SELECT. Id of the instance |
Title | String | Supported for: SELECT. The title of the job posting, according to the associated job requisition. |
Url | String | Supported for: SELECT. External URL for Job Posting if it is posted to a published Workday External Career Site. |
Category_Prompt | String | Accepts multiple inputs. No description available |
JobSite_Prompt | String | Accepts multiple inputs. No description available |
Reads additionalLocations entries from the JobPostings table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobPostings_Id [KEY] | String | The Wordkay ID of the JobPostings that contains this |
Country_Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Region_Code | String | Supported for: SELECT. The region-only portion of the ISO 3166-2 code for a country region. |
Region_Descriptor | String | Supported for: SELECT. A preview of the instance |
Category_Prompt | String | Accepts multiple inputs. No description available |
JobSite_Prompt | String | Accepts multiple inputs. No description available |
Reads categories entries from the JobPostings table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobPostings_Id [KEY] | String | The Wordkay ID of the JobPostings that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Category_Prompt | String | Accepts multiple inputs. No description available |
JobSite_Prompt | String | Accepts multiple inputs. No description available |
Retrieves a single job profile instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AdditionalJobDescription | String | Supported for: SELECT. The formatted additional job description value on the job profile. |
CriticalJob | Bool | Supported for: SELECT. Indicates if the job is considered critical. |
DefaultJobTitle | String | Supported for: SELECT. The Job Title Default for the job profile. |
DifficultyToFill_Descriptor | String | Supported for: SELECT. A preview of the instance |
DifficultyToFill_Id | String | Supported for: SELECT. Id of the instance |
Inactive | Bool | Supported for: SELECT. Returns true if the Job Profile is inactive. |
JobCategory_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobCategory_Id | String | Supported for: SELECT. Id of the instance |
JobDescription | String | Supported for: SELECT. The formatted job description value on the job profile. |
JobLevel_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobLevel_Id | String | Supported for: SELECT. Id of the instance |
ManagementLevel_Descriptor | String | Supported for: SELECT. A preview of the instance |
ManagementLevel_Id | String | Supported for: SELECT. Id of the instance |
Name | String | Supported for: SELECT. The name of the job profile. |
Public | Bool | Supported for: SELECT. Indicates if the job profile has been marked as being public. |
Summary | String | Supported for: SELECT. The description of the responsibilities and/or qualifications for the job profile. |
WorkShiftRequired | Bool | Supported for: SELECT. Indicates if the Job Profile requires a Work Shift to be specified on associated Positions. |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads companyInsiderTypes entries from the JobProfiles table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobProfiles_Id [KEY] | String | The Wordkay ID of the JobProfiles that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads jobExempts entries from the JobProfiles table
Name | Type | Description |
JobProfiles_Id | String | The Wordkay ID of the JobProfiles that contains this |
CountryOrRegion_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryOrRegion_Id | String | Supported for: SELECT. Id of the instance |
Exempt | Bool | Supported for: SELECT. Returns the exempt value for this Job Profile Exempt. |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads jobFamilies entries from the JobProfiles table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobProfiles_Id [KEY] | String | The Wordkay ID of the JobProfiles that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Name | String | Supported for: SELECT. The job family name for the job family. |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads payRateTypes entries from the JobProfiles table
Name | Type | Description |
JobProfiles_Id | String | The Wordkay ID of the JobProfiles that contains this |
Country_Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
PayRateType_Descriptor | String | Supported for: SELECT. A preview of the instance |
PayRateType_Id | String | Supported for: SELECT. Id of the instance |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads restrictedToCountries entries from the JobProfiles table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobProfiles_Id [KEY] | String | The Wordkay ID of the JobProfiles that contains this |
Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Reads workersCompensationCodes entries from the JobProfiles table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ country: { /* Returns the \~country\~ from the primary address for the location. */ descriptor: Text /* A preview of the instance */ } id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobProfiles_Id [KEY] | String | The Wordkay ID of the JobProfiles that contains this |
Code | String | Supported for: SELECT. Returns the workers' compensation code. |
Country_Alpha3Code | String | Supported for: SELECT. The ISO alpha-3 code for a country. |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. Returns true if the worker's compensation code is inactive. |
Locations_Aggregate | String | Supported for: SELECT. A JSON aggregate. The location for the worker compensation code. |
Name | String | Supported for: SELECT. Returns the description of the worker's compensation code. |
Regions_Aggregate | String | Supported for: SELECT. A JSON aggregate. Returns the Country Regions that the worker's compensation code is used in. |
IncludeInactive_Prompt | Boolean | If true, the method returns inactive job profiles. Default is false. |
Retrieves a single job instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
BusinessTitle | String | Supported for: SELECT. The business title for the position. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Id | String | Supported for: SELECT. Id of the instance |
JobType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Id | String | Supported for: SELECT. Id of the instance |
NextPayPeriodStartDate | Datetime | Supported for: SELECT. The next pay period start date for the job. |
SupervisoryOrganization_Descriptor | String | Supported for: SELECT. A preview of the instance |
SupervisoryOrganization_Id | String | Supported for: SELECT. Id of the instance |
Worker_Descriptor | String | Supported for: SELECT. A preview of the instance |
Worker_Id | String | Supported for: SELECT. Id of the instance |
Retrieves a single pay group instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Jobs_Id [KEY] | String | The Workday ID of the Jobs that owns this |
Country_Descriptor | String | Supported for: SELECT. A description of the instance |
Country_Href | String | Supported for: SELECT. A link to the instance |
Country_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Effective_Prompt | Date | The effective date of the pay group, using the date format yyyy-mm-dd. |
Reads payGroupDetails entries from the JobsPayGroup table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
JobsPayGroup_Id [KEY] | String | The Wordkay ID of the JobsPayGroup that contains this |
Jobs_Id [KEY] | String | The Workday ID of the Jobs that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
RunCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
RunCategory_Href | String | Supported for: SELECT. A link to the instance |
RunCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Effective_Prompt | Date | The effective date of the pay group, using the date format yyyy-mm-dd. |
Retrieves a single workspace instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Jobs_Id [KEY] | String | The Workday ID of the Jobs that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
LocationChain | String | Supported for: SELECT. Location chain including bread crumbs for location. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Get all mentorships
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CloseMentorshipReason_Descriptor | String | Supported for: SELECT. A description of the instance |
CloseMentorshipReason_Href | String | Supported for: SELECT. A link to the instance |
CloseMentorshipReason_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EndDate | Datetime | Supported for: SELECT. Returns the end date of the mentorship. |
Mentee_Descriptor | String | Supported for: SELECT. A description of the instance |
Mentee_Href | String | Supported for: SELECT. A link to the instance |
Mentee_Id | String | Supported for: SELECT. wid / id / reference id |
MentorType_Descriptor | String | Supported for: SELECT. A description of the instance |
MentorType_Href | String | Supported for: SELECT. A link to the instance |
MentorType_Id | String | Supported for: SELECT. wid / id / reference id |
Mentor_Descriptor | String | Supported for: SELECT. A description of the instance |
Mentor_Href | String | Supported for: SELECT. A link to the instance |
Mentor_Id | String | Supported for: SELECT. wid / id / reference id |
Mentorship_Descriptor | String | Supported for: SELECT. A description of the instance |
Mentorship_Href | String | Supported for: SELECT. A link to the instance |
Mentorship_Id | String | Supported for: SELECT. wid / id / reference id |
Purpose | String | Supported for: SELECT. Returns the purpose of the mentorship. |
StartDate | Datetime | Supported for: SELECT. Returns the start date of the mentorship. |
CloseMentorshipReason_Prompt | String | Accepts multiple inputs. No description available |
Closed_Prompt | Boolean | No description available |
InProgress_Prompt | Boolean | No description available |
Mentee_Prompt | String | Accepts multiple inputs. No description available |
MentorType_Prompt | String | Accepts multiple inputs. No description available |
Mentor_Prompt | String | Accepts multiple inputs. No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Country_Prompt | String | No description available |
Retrieves a notification type.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Name | String | Supported for: SELECT. No description available |
ParentCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
ParentCategory_Href | String | Supported for: SELECT. A link to the instance |
ParentCategory_Id | String | Supported for: SELECT. wid / id / reference id |
ReferenceID | String | Supported for: SELECT. The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the 'Organization ID' |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EffectiveDate_Prompt | Date | No description available |
Event_Prompt | String | No description available |
OrganizationType_Prompt | String | No description available |
Worker_Prompt | String | No description available |
Retrieves an organization instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
Retrieves an organization type instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
Retrieves a single pay group detail instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
CurrentPeriodInProgress_Descriptor | String | Supported for: SELECT. A description of the instance |
CurrentPeriodInProgress_Href | String | Supported for: SELECT. A link to the instance |
CurrentPeriodInProgress_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
FirstProcessingPeriod_Descriptor | String | Supported for: SELECT. A description of the instance |
FirstProcessingPeriod_Href | String | Supported for: SELECT. A link to the instance |
FirstProcessingPeriod_Id | String | Supported for: SELECT. wid / id / reference id |
LastPeriodCompleted_Descriptor | String | Supported for: SELECT. A description of the instance |
LastPeriodCompleted_Href | String | Supported for: SELECT. A link to the instance |
LastPeriodCompleted_Id | String | Supported for: SELECT. wid / id / reference id |
NextPeriodToProcess_Descriptor | String | Supported for: SELECT. A description of the instance |
NextPeriodToProcess_Href | String | Supported for: SELECT. A link to the instance |
NextPeriodToProcess_Id | String | Supported for: SELECT. wid / id / reference id |
PayGroup_Descriptor | String | Supported for: SELECT. A preview of the instance |
PayGroup_Id | String | Supported for: SELECT. Id of the instance |
PeriodSchedule_Descriptor | String | Supported for: SELECT. A description of the instance |
PeriodSchedule_Href | String | Supported for: SELECT. A link to the instance |
PeriodSchedule_Id | String | Supported for: SELECT. wid / id / reference id |
RunCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
RunCategory_Href | String | Supported for: SELECT. A link to the instance |
RunCategory_Id | String | Supported for: SELECT. wid / id / reference id |
RunCategories_Prompt | String | Accepts multiple inputs. One or more Workday IDs of run categories for the pay group. You can use returned ids from GET /values/payrollInputsGroup/runCategories.You can specify 1 or more runCategories query parameters, example: runCategories=category1andrunCategories=category2 |
Reads payRunGroup entries from the PayGroupDetails table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PayGroupDetails_Id [KEY] | String | The Wordkay ID of the PayGroupDetails that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
RunCategories_Prompt | String | Accepts multiple inputs. One or more Workday IDs of run categories for the pay group. You can use returned ids from GET /values/payrollInputsGroup/runCategories.You can specify 1 or more runCategories query parameters, example: runCategories=category1andrunCategories=category2 |
Retrieves a single pay group instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Country_Descriptor | String | Supported for: SELECT. A description of the instance |
Country_Href | String | Supported for: SELECT. A link to the instance |
Country_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Prompt | String | The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API. |
Reads payGroupDetails entries from the PayGroups table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PayGroups_Id [KEY] | String | The Wordkay ID of the PayGroups that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
RunCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
RunCategory_Href | String | Supported for: SELECT. A link to the instance |
RunCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Country_Prompt | String | The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EndDate_Prompt | Date | The end date for the positions, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | The start date for the positions, using the date format yyyy-mm-dd. |
Worker_Prompt | String | The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EndDate_Prompt | Date | The end date for the positions, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | The start date for the positions, using the date format yyyy-mm-dd. |
Worker_Prompt | String | The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EndDate_Prompt | Date | The end date for the positions, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | The start date for the positions, using the date format yyyy-mm-dd. |
Worker_Prompt | String | The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EndDate_Prompt | Date | The end date for the positions, using the date format yyyy-mm-dd. |
PayComponent_Prompt | String | The pay component for the worktags. You can use a returned id from GET/values/payrollInputsGroup/payComponents. |
StartDate_Prompt | Date | The start date for the positions, using the date format yyyy-mm-dd. |
Worker_Prompt | String | The Workday ID of the worker. You can use a returned id from GET /workers in the Staffing service. |
Retrieves a person in your Workday tenant.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AdditionalNames | String | Supported for: SELECT. The additional names for a person. |
AudioNamePronunciation | String | Supported for: SELECT. The Media related to Audio Name Pronunciation for a Person |
HomeAddresses | String | Supported for: SELECT. The home addresses for a person. |
HomeEmails | String | Supported for: SELECT. The home email addresses for a person. |
HomeInstantMessengers | String | Supported for: SELECT. The home instant messenger accounts for a person. |
HomePhones | String | Supported for: SELECT. The home phone numbers for a person. |
HomeWebAddresses | String | Supported for: SELECT. The home web addresses for a person. |
Href | String | Supported for: SELECT. A link to the instance |
LegalName | String | Supported for: SELECT. The Legal Name for a person. |
PersonalInformation | String | Supported for: SELECT. The person. |
Photos | String | Supported for: SELECT. The image for the person. |
PreferredName | String | Supported for: SELECT. The preferred name for a person. |
SocialNetworks | String | Supported for: SELECT. The social network accounts for a person. |
UniversalID_Id | String | Supported for: SELECT. Id of the instance |
WorkAddresses | String | Supported for: SELECT. The work addresses for a person. |
WorkEmails | String | Supported for: SELECT. The work email addresses for a person. |
WorkInstantMessengers | String | Supported for: SELECT. The work instant messenger accounts for a person. |
WorkPhones | String | Supported for: SELECT. The work phone numbers for a person. |
WorkWebAddresses | String | Supported for: SELECT. The work web addresses for a person. |
Universal_ID_Prompt | String | The Universal ID of the person you want to retrieve. |
Retrieves an additional name.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
First | String | Supported for: SELECT. The first or given name for a person. |
FirstLocal | String | Supported for: SELECT. The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
FirstLocal2 | String | Supported for: SELECT. The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Full | String | Supported for: SELECT. The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used. |
Hereditary_Descriptor | String | Supported for: SELECT. A preview of the instance |
Middle | String | Supported for: SELECT. The middle name from the name. |
MiddleLocal | String | Supported for: SELECT. The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Primary | String | Supported for: SELECT. The person's family name. |
PrimaryLocal | String | Supported for: SELECT. The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
PrimaryLocal2 | String | Supported for: SELECT. The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Salutation_Descriptor | String | Supported for: SELECT. A preview of the instance |
SecondaryLast | String | Supported for: SELECT. The secondary family name for a person. |
SecondaryLocal | String | Supported for: SELECT. The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Social_Descriptor | String | Supported for: SELECT. A preview of the instance |
TertiaryLast | String | Supported for: SELECT. The person's tertiary last name. |
Title_Descriptor | String | Supported for: SELECT. A preview of the instance |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves an Audio Name Pronunciation
Name | Type | Description |
People_Id | String | The Workday ID of the People that owns this |
DownloadAudio | String | Supported for: SELECT. Download Link |
Filename | String | Supported for: SELECT. Filename |
MediaId | String | Supported for: SELECT. Media ID |
PersonId | String | Supported for: SELECT. Person ID |
CurrentAudio_Prompt | Boolean | Download only the currently active audio |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a home address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
AddressLine1 | String | Supported for: SELECT. Address Line 1 for the address. |
AddressLine1Local | String | Supported for: SELECT. Local Address Line 1 for the address. |
AddressLine2 | String | Supported for: SELECT. Address Line 2 for the address. |
AddressLine2Local | String | Supported for: SELECT. Local Address Line 2 for the address. |
AddressLine3 | String | Supported for: SELECT. Address Line 3 for the address. |
AddressLine3Local | String | Supported for: SELECT. Local Address Line 3 for the address. |
AddressLine4 | String | Supported for: SELECT. Address Line 4 for the address. |
AddressLine4Local | String | Supported for: SELECT. Local Address Line 4 for the address. |
AddressLine5 | String | Supported for: SELECT. Address Line 5 for the address. |
AddressLine5Local | String | Supported for: SELECT. Local Address Line 5 for the address. |
AddressLine6 | String | Supported for: SELECT. Address Line 6 for the address. |
AddressLine6Local | String | Supported for: SELECT. Local Address Line 6 for the address. |
AddressLine7 | String | Supported for: SELECT. Address Line 7 for the address. |
AddressLine7Local | String | Supported for: SELECT. Local Address Line 7 for the address. |
AddressLine8 | String | Supported for: SELECT. Address Line 8 for the address. |
AddressLine8Local | String | Supported for: SELECT. Local Address Line 8 for the address. |
AddressLine9 | String | Supported for: SELECT. Address Line 9 for the address. |
AddressLine9Local | String | Supported for: SELECT. Local Address Line 9 for the address. |
City | String | Supported for: SELECT. City for the address. |
CityLocal | String | Supported for: SELECT. City - Local for the address. |
CitySubdivision1 | String | Supported for: SELECT. City Subdivision 1 for the address. |
CitySubdivision1Local | String | Supported for: SELECT. City Subdivision 1 - Local for the address. |
CitySubdivision2 | String | Supported for: SELECT. City Subdivision 2 for the address. |
CitySubdivision2Local | String | Supported for: SELECT. City Subdivision 2 - Local for the address. |
CountryCity_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryCity_Id | String | Supported for: SELECT. Id of the instance |
CountryRegion_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryRegion_Id | String | Supported for: SELECT. Id of the instance |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Effective | Datetime | Supported for: SELECT. The Effective Date for the address. |
FullFormattedAddress | String | Supported for: SELECT. Full Formatted Address |
FullFormattedLocalAddress | String | Supported for: SELECT. Full Formatted Local Address |
PostalCode | String | Supported for: SELECT. The postal code for the address. |
RegionSubdivision1 | String | Supported for: SELECT. Region Subdivision 1 for the address. |
RegionSubdivision1Local | String | Supported for: SELECT. Region Subdivision 1 - Local for the address. |
RegionSubdivision2 | String | Supported for: SELECT. Region Subdivision 2 for the address. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
Effective_Prompt | Date | The effective date of the person's addresses using the yyyy-mm-dd format. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleHomeAddresses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleHomeAddresses_Id [KEY] | String | The Wordkay ID of the PeopleHomeAddresses that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Effective_Prompt | Date | The effective date of the person's addresses using the yyyy-mm-dd format. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a home email address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
EmailAddress | String | Supported for: SELECT. The email address. |
EmailComment | String | Supported for: SELECT. Comment associated with the email. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public email addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleHomeEmails table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleHomeEmails_Id [KEY] | String | The Wordkay ID of the PeopleHomeEmails that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public email addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a home instant messenger account username.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Comment | String | Supported for: SELECT. The comment associated with the instant messenger account. |
Type_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
UserName | String | Supported for: SELECT. The instant messenger account username. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public instant messenger usernames. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleHomeInstantMessengers table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleHomeInstantMessengers_Id [KEY] | String | The Wordkay ID of the PeopleHomeInstantMessengers that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public instant messenger usernames. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a home phone number.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
CompletePhoneNumber | String | Supported for: SELECT. The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | Supported for: SELECT. The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryPhoneCode_Country_Id | String | Supported for: SELECT. Id of the instance |
CountryPhoneCode_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryPhoneCode_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DeviceType_Descriptor | String | Supported for: SELECT. A preview of the instance |
DeviceType_Id | String | Supported for: SELECT. Id of the instance |
Extension | String | Supported for: SELECT. The phone extension. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public phone numbers. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleHomePhones table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleHomePhones_Id [KEY] | String | The Wordkay ID of the PeopleHomePhones that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public phone numbers. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a home web address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Comment | String | Supported for: SELECT. The comment associated with the web address. |
Url | String | Supported for: SELECT. The complete URL address for the web address. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public web addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleHomeWebAddresses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleHomeWebAddresses_Id [KEY] | String | The Wordkay ID of the PeopleHomeWebAddresses that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public web addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves the legal name instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
First | String | Supported for: SELECT. The first or given name for a person. |
FirstLocal | String | Supported for: SELECT. The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
FirstLocal2 | String | Supported for: SELECT. The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Full | String | Supported for: SELECT. The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used. |
Hereditary_Descriptor | String | Supported for: SELECT. A preview of the instance |
Middle | String | Supported for: SELECT. The middle name from the name. |
MiddleLocal | String | Supported for: SELECT. The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Primary | String | Supported for: SELECT. The person's family name. |
PrimaryLocal | String | Supported for: SELECT. The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
PrimaryLocal2 | String | Supported for: SELECT. The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Salutation_Descriptor | String | Supported for: SELECT. A preview of the instance |
SecondaryLast | String | Supported for: SELECT. The secondary family name for a person. |
SecondaryLocal | String | Supported for: SELECT. The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Social_Descriptor | String | Supported for: SELECT. A preview of the instance |
TertiaryLast | String | Supported for: SELECT. The person's tertiary last name. |
Title_Descriptor | String | Supported for: SELECT. A preview of the instance |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a person's personal information.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ description: Text /* Description for the Citizenship Status. */ citizen: Boolean /* Identifies Citizenship Status as citizen. */ inactive: Boolean /* True if the Citizenship Status is inactive. */ country: { /* The \~Country\~ for the Citizenship Status. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } name: Text /* Name for the Citizenship Status. */ descriptor: Text /* A preview of the instance */ }]
[{ disability: { /* The \~Disability\~ for a \~Disability\~ Status. */ descriptor: Text /* A preview of the instance */ } certificationID: Text /* The Certification ID for a \~Disability\~ status. */ certificationBasis: { /* The Certification Basis for a \~Disability\~ status. */ descriptor: Text /* A preview of the instance */ } grade: { /* The Grade for a \~Disability\~ status. */ descriptor: Text /* A preview of the instance */ } rehabilitationProvided: Text /* The Rehabilitation Provided for a \~Disability\~ status. */ accommodationRequested: Text /* The Accommodations Requested for a \~Disability\~ status. */ workRestrictions: Text /* The Work Restrictions for a \~Disability\~ status. */ certifiedBy: Text /* The \~Disability\~ Authority for a \~Disability\~ Status */ statusDate: Date /* The \~Disability\~ Status Date for a \~Disability\~ Status. */ degreePercent: Numeric /* The Degree for a \~Disability\~ status. */ knownDate: Date /* The Date Known for a \~Disability\~ status. */ accommodationProvided: Text /* The Accommodations Provided for a \~Disability\~ status. */ endDate: Date /* The End Date for a \~Disability\~ status. */ certifiedAt: Text /* The Certification Location for a \~Disability\~ status. */ severityRecognitionDate: Date /* The Severity Recognition Date for a \~Disability\~ status. */ workerDocuments: [{ comment: Text /* The additional comments associated with the Worker Document. */ fileName: Text /* The filename of the Worker Document. */ }] note: Text /* The Note for a \~Disability\~ status. */ remainingCapacity: Numeric /* The Remaining Capacity for a \~Disability\~ status. */ statusID: Text /* The reference id for the \~disability\~ status. This is the unique identifier for the \~disability\~ status that is assigned at creation and then maintained throughout its life as it is edited. */ fteTowardQuota: Numeric /* The FTE Toward Quota for a \~Disability\~ status. */ rehabilitationRequested: Text /* The Rehabilitation Requested for a \~Disability\~ status. */ descriptor: Text /* A preview of the instance */ }]
[{ location: { /* Location Context for the ethnicity; */ descriptor: Text /* A preview of the instance */ } descriptor: Text /* A preview of the instance */ }]
[{ location: { /* Location Context for the ethnicity; */ descriptor: Text /* A preview of the instance */ } descriptor: Text /* A preview of the instance */ }]
[{ militaryDischargeTypeReference: { /* The \~Military Discharge Type\~ reference. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } notes: Rich Text /* Notes associated with the Military Service. */ discharge: Date /* The Discharge Date for the Military Service. */ rank: { /* Military Rank for Military Service */ descriptor: Text /* A preview of the instance */ } status: { /* The Military Status for the Military Service. */ country: { /* The \~Country\~ for the Military Status. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } code: Text /* The military status code. */ description: Text /* The military status description. */ descriptor: Text /* A preview of the instance */ } militaryServiceReference: { /* The reference id for the military service entry. This is the unique identifier for the military service that is assigned at creation and then maintained throughout its life as it is edited. */ descriptor: Text /* A preview of the instance */ } begin: Date /* The Military Status Begin Date for the Military Service. */ type: { /* Military Service Type for Military Service */ descriptor: Text /* A preview of the instance */ } descriptor: Text /* A preview of the instance */ }]
[{ middleName: Text /* The middle name for a relative name. */ royalSuffix: { /* Returns the royal suffix from the name. */ descriptor: Text /* A preview of the instance */ } religiousSuffix: { /* Returns the religious suffix from the name. */ descriptor: Text /* A preview of the instance */ } localPersonName: { /* Returns the local person name from the name. */ secondaryLast: Text /* The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ secondaryLast2: Text /* The person's secondary last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ first2: Text /* The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ last2: Text /* The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ first: Text /* The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ middle2: Text /* The person's second middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ middle: Text /* The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ last: Text /* The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */ descriptor: Text /* A preview of the instance */ } lastName: Text /* The family name for a relative name. */ firstName: Text /* The first or given name for a relative name. */ honorarySuffix: { /* Returns the honorary suffix from the name. */ descriptor: Text /* A preview of the instance */ } country: { /* Returns the \~country\~ from the name. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } secondaryLastName: Text /* The secondary family name for a relative name */ salutationSuffix: { /* Returns the salutation from the name. */ descriptor: Text /* A preview of the instance */ } relativeType: { /* Returns the relative type for a relative name */ descriptor: Text /* A preview of the instance */ } socialSuffix: { /* Returns the social suffix from the name. */ descriptor: Text /* A preview of the instance */ } professionalSuffix: { /* Returns the professional suffix from the name. */ descriptor: Text /* A preview of the instance */ } fullName: Text /* The Full Name for a relative name, where provided. Workday only tracks Full Name for countries where the Full Name name component is used. */ academicSuffix: { /* Returns the academic suffix from the name. */ descriptor: Text /* A preview of the instance */ } title: { /* Returns the prefix from the name. */ descriptor: Text /* A preview of the instance */ } hereditarySuffix: { /* Returns the hereditary suffix from the name. */ descriptor: Text /* A preview of the instance */ } descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ }]
[{ militaryServicePreferenceName: Text /* \~Veteran's Preference\~ Category */ militaryServicePreferenceCode: Text /* Military Service Preference Code */ inactive: Boolean /* The Inactive flag. */ militaryServicePreferenceDescription: Text /* Military Service Preference Description */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
People_Id | String | The Workday ID of the People that owns this |
AboriginalIndigenousIdentificationDetails_Aggregate | String | Supported for: SELECT. A JSON aggregate. Returns the aboriginal/indigenous identification details for a person. |
AboriginalIndigenousIdentification_Descriptor | String | Supported for: SELECT. A preview of the instance |
ActiveMilitaryUniformedService_Descriptor | String | Supported for: SELECT. A preview of the instance |
ActiveMilitaryUniformedService_Id | String | Supported for: SELECT. Id of the instance |
AdditionalNationalities_Aggregate | String | Supported for: SELECT. A JSON aggregate. The countries of additional nationality for a person. |
BloodType_Descriptor | String | Supported for: SELECT. A preview of the instance |
CitizenshipStatuses_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Citizenship Statuses for a person. |
DateOfBirth | Datetime | Supported for: SELECT. The date of birth for a person. |
DateOfDeath | Datetime | Supported for: SELECT. The date of death for a person. |
DisabilityStatuses_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Disability Statuses for a person. |
DisabledVeteranLeaveDate | Datetime | Supported for: SELECT. The Veteran's Preference Effective Date |
EthnicitiesForVisualSurvey_Ethnicities_Aggregate | String | Supported for: SELECT. A JSON aggregate. The ethnicities indicated on the person's visual survey. |
EthnicitiesForVisualSurvey_HispanicOrLatinoForVisualSurvey | Bool | Supported for: SELECT. True if the person is indicated as Hispanic or Latino for visual survey. |
Ethnicities_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Ethnicity for a person. |
Gender_Descriptor | String | Supported for: SELECT. A preview of the instance |
HispanicOrLatino | Bool | Supported for: SELECT. True if the person has indicated they are Hispanic or Latino. |
MaritalStatus_Date | Datetime | Supported for: SELECT. The Marital Status Date for a person. |
MaritalStatus_Status_Descriptor | String | Supported for: SELECT. A preview of the instance |
MaritalStatus_Status_Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
MedicalExam_ExpirationDate | Datetime | Supported for: SELECT. Medical exam expiration date for a person. |
MedicalExam_LastExamDate | Datetime | Supported for: SELECT. The date of the last medical exam for a person. |
MedicalExam_Notes | String | Supported for: SELECT. Medical exam notes for a person. |
MilitaryServices_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Military Service for a person. |
PlaceOfBirth_City | String | Supported for: SELECT. The City of Birth for a person. |
PlaceOfBirth_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
PlaceOfBirth_Country_Id | String | Supported for: SELECT. Id of the instance |
PlaceOfBirth_Region_Descriptor | String | Supported for: SELECT. A preview of the instance |
PlaceOfBirth_Region_Id | String | Supported for: SELECT. Id of the instance |
PoliticalAffiliation_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryNationality_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryNationality_Id | String | Supported for: SELECT. Id of the instance |
RelativeNames_Aggregate | String | Supported for: SELECT. A JSON aggregate. The relative names for a person. |
Religion_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Religion for a person. |
SelectiveServiceRegistration_Descriptor | String | Supported for: SELECT. A preview of the instance |
SelectiveServiceRegistration_Id | String | Supported for: SELECT. Id of the instance |
SexualOrientationAndGenderIdentity_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Sexual Orientation and Gender Identity for a person. |
SocialBenefitsLocality_Code | String | Supported for: SELECT. Code for the Social Benefits Locality. |
SocialBenefitsLocality_Description | String | Supported for: SELECT. Description for the Social Benefits Locality. |
SocialBenefitsLocality_Descriptor | String | Supported for: SELECT. A preview of the instance |
SocialBenefitsLocality_Inactive | Bool | Supported for: SELECT. True if the Social Benefits Locality is inactive. |
SocialBenefitsLocality_Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
SocialBenefitsLocality_Name | String | Supported for: SELECT. Name for the Social Benefits Locality. |
UniformServiceReserveStatus_Descriptor | String | Supported for: SELECT. A preview of the instance |
UniformServiceReserveStatus_Id | String | Supported for: SELECT. Id of the instance |
UniformServiceReserveStatus_Inactive | Bool | Supported for: SELECT. The inactive flag. |
UniformServiceReserveStatus_UniformServiceReserveStatusCode | String | Supported for: SELECT. Uniform Service Reserve Status Code |
UniformServiceReserveStatus_UniformServiceReserveStatusDescription | String | Supported for: SELECT. Uniform Service Reserve Status Description. |
UniformServiceReserveStatus_UniformServiceReserveStatusName | String | Supported for: SELECT. Uniform Service Reserve Status Name. |
VeteransPreferenceForRIF_Descriptor | String | Supported for: SELECT. A preview of the instance |
VeteransPreferenceForRIF_Id | String | Supported for: SELECT. Id of the instance |
VeteransPreference_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Veteran's Preference for the person. |
Country_Prompt | String | No description available |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a personal photo.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
ContentType_Descriptor | String | Supported for: SELECT. A description of the instance |
ContentType_Href | String | Supported for: SELECT. A link to the instance |
ContentType_Id | String | Supported for: SELECT. wid / id / reference id |
FileLength | Decimal | Supported for: SELECT. File length of the image attachment. |
FileName | String | Supported for: SELECT. Filename of the image attachment. |
Height | Decimal | Supported for: SELECT. Height of Cropped Image. |
Href | String | Supported for: SELECT. A link to the instance |
Width | Decimal | Supported for: SELECT. Width of Cropped Image. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves the preferred name instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
First | String | Supported for: SELECT. The first or given name for a person. |
FirstLocal | String | Supported for: SELECT. The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
FirstLocal2 | String | Supported for: SELECT. The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Full | String | Supported for: SELECT. The Full Name for a person, when it is provided. Workday only tracks Full Name for countries where the Full Name name component is used. |
Hereditary_Descriptor | String | Supported for: SELECT. A preview of the instance |
Middle | String | Supported for: SELECT. The middle name from the name. |
MiddleLocal | String | Supported for: SELECT. The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Primary | String | Supported for: SELECT. The person's family name. |
PrimaryLocal | String | Supported for: SELECT. The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
PrimaryLocal2 | String | Supported for: SELECT. The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Salutation_Descriptor | String | Supported for: SELECT. A preview of the instance |
SecondaryLast | String | Supported for: SELECT. The secondary family name for a person. |
SecondaryLocal | String | Supported for: SELECT. The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. |
Social_Descriptor | String | Supported for: SELECT. A preview of the instance |
TertiaryLast | String | Supported for: SELECT. The person's tertiary last name. |
Title_Descriptor | String | Supported for: SELECT. A preview of the instance |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a person's public contact information.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ addressLine4Local: Text /* Local Address Line 4 for the address. */ citySubdivision2Local: Text /* City Subdivision 2 - Local for the address. */ addressLine8Local: Text /* Local Address Line 8 for the address. */ citySubdivision1Local: Text /* City Subdivision 1 - Local for the address. */ addressLine1: Text /* Address Line 1 for the address. */ addressLine9: Text /* Address Line 9 for the address. */ regionSubdivision1Local: Text /* Region Subdivision 1 - Local for the address. */ addressLine8: Text /* Address Line 8 for the address. */ addressLine2: Text /* Address Line 2 for the address. */ fullFormattedAddress: Text /* Full Formatted Address */ addressLine6Local: Text /* Local Address Line 6 for the address. */ regionSubdivision2: Text /* Region Subdivision 2 for the address. */ countryCity: { /* \~Country\~ City */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } addressLine4: Text /* Address Line 4 for the address. */ postalCode: Text /* The postal code for the address. */ fullFormattedLocalAddress: Text /* Full Formatted Local Address */ addressLine1Local: Text /* Local Address Line 1 for the address. */ citySubdivision1: Text /* City Subdivision 1 for the address. */ addressLine6: Text /* Address Line 6 for the address. */ usage: { /* Address Instance Referenced */ primary: Boolean /* True if the communication method has any primary usage type. */ usageType: { /* Returns the usage type for a given communication method. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } usedFor: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */ } city: Text /* City for the address. */ addressLine3: Text /* Address Line 3 for the address. */ citySubdivision2: Text /* City Subdivision 2 for the address. */ addressLine9Local: Text /* Local Address Line 9 for the address. */ effective: Date /* The Effective Date for the address. */ addressLine7Local: Text /* Local Address Line 7 for the address. */ addressLine5: Text /* Address Line 5 for the address. */ regionSubdivision1: Text /* Region Subdivision 1 for the address. */ cityLocal: Text /* City - Local for the address. */ addressLine2Local: Text /* Local Address Line 2 for the address. */ countryRegion: { /* Country Region */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } addressLine3Local: Text /* Local Address Line 3 for the address. */ country: { /* \~Country\~ */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } addressLine5Local: Text /* Local Address Line 5 for the address. */ addressLine7: Text /* Address Line 7 for the address. */ id: Text /* Id of the instance */ }]
[{ usage: { /* Current e-mail interface for the e-mail reference */ primary: Boolean /* True if the communication method has any primary usage type. */ usageType: { /* Returns the usage type for a given communication method. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } usedFor: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */ } emailAddress: Text /* The email address. */ emailComment: Text /* Comment associated with the email. */ id: Text /* Id of the instance */ }]
[{ comment: Text /* The comment associated with the instant messenger account. */ type: { /* Instant Messenger Type */ descriptor: Text /* A preview of the instance */ } userName: Text /* The instant messenger account username. */ usage: { /* Instant Messenger for the Instant Messenger Reference */ primary: Boolean /* True if the communication method has any primary usage type. */ usageType: { /* Returns the usage type for a given communication method. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } usedFor: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */ } id: Text /* Id of the instance */ }]
[{ usage: { /* Current phone for the reference */ primary: Boolean /* True if the communication method has any primary usage type. */ usageType: { /* Returns the usage type for a given communication method. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } usedFor: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */ } countryPhoneCode: { /* Phone \~country\~ */ countryPhoneCode: Text /* The phone code for a country. */ country: { /* \~Country\~ Phone Code for \~Country\~ */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } completePhoneNumber: Text /* The complete phone number. */ extension: Text /* The phone extension. */ deviceType: { /* Phone device type */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ comment: Text /* The comment associated with the web address. */ usage: { /* Current web address interface for the web address reference */ primary: Boolean /* True if the communication method has any primary usage type. */ usageType: { /* Returns the usage type for a given communication method. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } usedFor: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */ } url: Text /* The complete URL address for the web address. */ id: Text /* Id of the instance */ }]
Name | Type | Description |
People_Id | String | The Workday ID of the People that owns this |
Addresses_Aggregate | String | Supported for: SELECT. A JSON aggregate. The public address references for the person. |
Emails_Aggregate | String | Supported for: SELECT. A JSON aggregate. The public email references for the person. |
InstantMessengers_Aggregate | String | Supported for: SELECT. A JSON aggregate. The public instant messenger account references for the person. |
PhoneNumbers_Aggregate | String | Supported for: SELECT. A JSON aggregate. The public phone number references for the person. |
WebAddresses_Aggregate | String | Supported for: SELECT. A JSON aggregate. The public web address references for the person. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a work address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
AddressLine1 | String | Supported for: SELECT. Address Line 1 for the address. |
AddressLine1Local | String | Supported for: SELECT. Local Address Line 1 for the address. |
AddressLine2 | String | Supported for: SELECT. Address Line 2 for the address. |
AddressLine2Local | String | Supported for: SELECT. Local Address Line 2 for the address. |
AddressLine3 | String | Supported for: SELECT. Address Line 3 for the address. |
AddressLine3Local | String | Supported for: SELECT. Local Address Line 3 for the address. |
AddressLine4 | String | Supported for: SELECT. Address Line 4 for the address. |
AddressLine4Local | String | Supported for: SELECT. Local Address Line 4 for the address. |
AddressLine5 | String | Supported for: SELECT. Address Line 5 for the address. |
AddressLine5Local | String | Supported for: SELECT. Local Address Line 5 for the address. |
AddressLine6 | String | Supported for: SELECT. Address Line 6 for the address. |
AddressLine6Local | String | Supported for: SELECT. Local Address Line 6 for the address. |
AddressLine7 | String | Supported for: SELECT. Address Line 7 for the address. |
AddressLine7Local | String | Supported for: SELECT. Local Address Line 7 for the address. |
AddressLine8 | String | Supported for: SELECT. Address Line 8 for the address. |
AddressLine8Local | String | Supported for: SELECT. Local Address Line 8 for the address. |
AddressLine9 | String | Supported for: SELECT. Address Line 9 for the address. |
AddressLine9Local | String | Supported for: SELECT. Local Address Line 9 for the address. |
City | String | Supported for: SELECT. City for the address. |
CityLocal | String | Supported for: SELECT. City - Local for the address. |
CitySubdivision1 | String | Supported for: SELECT. City Subdivision 1 for the address. |
CitySubdivision1Local | String | Supported for: SELECT. City Subdivision 1 - Local for the address. |
CitySubdivision2 | String | Supported for: SELECT. City Subdivision 2 for the address. |
CitySubdivision2Local | String | Supported for: SELECT. City Subdivision 2 - Local for the address. |
CountryCity_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryCity_Id | String | Supported for: SELECT. Id of the instance |
CountryRegion_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryRegion_Id | String | Supported for: SELECT. Id of the instance |
Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Country_Id | String | Supported for: SELECT. Id of the instance |
Effective | Datetime | Supported for: SELECT. The Effective Date for the address. |
FullFormattedAddress | String | Supported for: SELECT. Full Formatted Address |
FullFormattedLocalAddress | String | Supported for: SELECT. Full Formatted Local Address |
PostalCode | String | Supported for: SELECT. The postal code for the address. |
RegionSubdivision1 | String | Supported for: SELECT. Region Subdivision 1 for the address. |
RegionSubdivision1Local | String | Supported for: SELECT. Region Subdivision 1 - Local for the address. |
RegionSubdivision2 | String | Supported for: SELECT. Region Subdivision 2 for the address. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
Effective_Prompt | Date | The effective date of the person's addresses using the yyyy-mm-dd format. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleWorkAddresses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleWorkAddresses_Id [KEY] | String | The Wordkay ID of the PeopleWorkAddresses that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Effective_Prompt | Date | The effective date of the person's addresses using the yyyy-mm-dd format. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a work email address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
EmailAddress | String | Supported for: SELECT. The email address. |
EmailComment | String | Supported for: SELECT. Comment associated with the email. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public email addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleWorkEmails table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleWorkEmails_Id [KEY] | String | The Wordkay ID of the PeopleWorkEmails that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary email addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public email addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a work instant messenger account username.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Comment | String | Supported for: SELECT. The comment associated with the instant messenger account. |
Type_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
UserName | String | Supported for: SELECT. The instant messenger account username. |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public instant messenger usernames. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleWorkInstantMessengers table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleWorkInstantMessengers_Id [KEY] | String | The Wordkay ID of the PeopleWorkInstantMessengers that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary instant messenger account usernames. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public instant messenger usernames. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a work phone number.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
CompletePhoneNumber | String | Supported for: SELECT. The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | Supported for: SELECT. The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryPhoneCode_Country_Id | String | Supported for: SELECT. Id of the instance |
CountryPhoneCode_Descriptor | String | Supported for: SELECT. A preview of the instance |
CountryPhoneCode_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DeviceType_Descriptor | String | Supported for: SELECT. A preview of the instance |
DeviceType_Id | String | Supported for: SELECT. Id of the instance |
Extension | String | Supported for: SELECT. The phone extension. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public phone numbers. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleWorkPhones table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleWorkPhones_Id [KEY] | String | The Wordkay ID of the PeopleWorkPhones that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary phone numbers. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public phone numbers. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Retrieves a work web address.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Comment | String | Supported for: SELECT. The comment associated with the web address. |
Url | String | Supported for: SELECT. The complete URL address for the web address. |
Usage_Primary | Bool | Supported for: SELECT. True if the communication method has any primary usage type. |
Usage_Public | Bool | Supported for: SELECT. True if the communication method is public. If no results are returned, the communication method is private. |
Usage_UsageType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Usage_UsageType_Id | String | Supported for: SELECT. Id of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public web addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
Reads usage.usedFor entries from the PeopleWorkWebAddresses table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PeopleWorkWebAddresses_Id [KEY] | String | The Wordkay ID of the PeopleWorkWebAddresses that contains this |
People_Id [KEY] | String | The Workday ID of the People that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryOnly_Prompt | Boolean | If true, returns only the IDs of the person's primary web addresses. |
PublicOnly_Prompt | Boolean | If true, returns only the IDs of the person's public web addresses. |
UsedFor_Prompt | String | Specifies usage behavior, such as mailing, billing, or shipping. |
Universal_ID_Prompt | String | Only used when a People_Id filter is not provided. The Universal ID of the person you want to retrieve. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Person_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Person_Prompt | String | No description available |
Retrieves the program of study with the specified ID.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AcademicLevel_Descriptor | String | Supported for: SELECT. A preview of the instance |
AcademicLevel_Id | String | Supported for: SELECT. Id of the instance |
AcademicUnit_Id | String | Supported for: SELECT. Id of the instance |
AcademicUnit_Inactive | Bool | Supported for: SELECT. If true, the Academic Unit is inactive, as of the effective date. |
AcademicUnit_Institution | Bool | Supported for: SELECT. If true, the Academic Unit is designated as an institution, as of the effective date. |
AcademicUnit_Name | String | Supported for: SELECT. The name of the Academic Unit, as of the effective date. |
CipCode_Descriptor | String | Supported for: SELECT. A description of the instance |
CipCode_Href | String | Supported for: SELECT. A link to the instance |
CipCode_Id | String | Supported for: SELECT. wid / id / reference id |
Name | String | Supported for: SELECT. The name of the Program of Study, as of the effective date. |
ProgramType_Descriptor | String | Supported for: SELECT. A description of the instance |
ProgramType_Href | String | Supported for: SELECT. A link to the instance |
ProgramType_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicLevel_Prompt | String | The Workday ID of the owning academic level of the program of study, as of the effective date. You can use a return id from GET /academicLevels |
AcademicUnit_Prompt | String | The Workday ID of the owning academic unit of the program of study, as of the effective date. You can use a return id from GET /academicUnits |
CipCode_Prompt | String | The Workday ID of the CIP code for the program of study, as of the effective date. |
EducationalCredentials_Prompt | String | Accepts multiple inputs. The Workday IDs of the educational credentials of the program of study, as of the effective date. You can use the return id from GET /educationalCredentials. |
EffectiveDate_Prompt | Date | The effective date of the Program of Study, using the yyyy-mm-dd format. The default is the current date. |
ProgramType_Prompt | String | The Workday ID of the program type of the program of study, as of the effective date. |
Reads educationalCredentials entries from the ProgramsOfStudy table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ProgramsOfStudy_Id [KEY] | String | The Wordkay ID of the ProgramsOfStudy that contains this |
Description | String | Supported for: SELECT. Description of Educational Credentail |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Name | String | Supported for: SELECT. Name of Educational Credential |
Type_Descriptor | String | Supported for: SELECT. A description of the instance |
Type_Href | String | Supported for: SELECT. A link to the instance |
Type_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicLevel_Prompt | String | The Workday ID of the owning academic level of the program of study, as of the effective date. You can use a return id from GET /academicLevels |
AcademicUnit_Prompt | String | The Workday ID of the owning academic unit of the program of study, as of the effective date. You can use a return id from GET /academicUnits |
CipCode_Prompt | String | The Workday ID of the CIP code for the program of study, as of the effective date. |
EducationalCredentials_Prompt | String | Accepts multiple inputs. The Workday IDs of the educational credentials of the program of study, as of the effective date. You can use the return id from GET /educationalCredentials. |
EffectiveDate_Prompt | Date | The effective date of the Program of Study, using the yyyy-mm-dd format. The default is the current date. |
ProgramType_Prompt | String | The Workday ID of the program type of the program of study, as of the effective date. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Project_Prompt | String | No description available |
TopLevelPhase_Prompt | Boolean | Indicates if the current ID is a top level Project Plan Phase. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Project_Prompt | String | No description available |
TopLevelPhase_Prompt | Boolean | Indicates if the current ID is a top level Project Plan Phase. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Project_Prompt | String | No description available |
TopLevelPhase_Prompt | Boolean | Indicates if the current ID is a top level Project Plan Phase. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Project_Prompt | String | No description available |
TopLevelPhase_Prompt | Boolean | Indicates if the current ID is a top level Project Plan Phase. |
Reads businessEventRecords entries from the Projects table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ conditionRule: Text /* The condition rule as a text expression. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } conmentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Projects_Id [KEY] | String | The Wordkay ID of the Projects that contains this |
AwaitingPersons_Aggregate | String | Supported for: SELECT. A JSON aggregate. The people this event is currently awaiting for action. |
BusinessEventValidation_Aggregate | String | Supported for: SELECT. A JSON aggregate. Business Process Validation(s) that failed for an event. |
BusinessProcessStep_Descriptor | String | Supported for: SELECT. A description of the instance |
BusinessProcessStep_Href | String | Supported for: SELECT. A link to the instance |
BusinessProcessStep_Id | String | Supported for: SELECT. wid / id / reference id |
Comments_Aggregate | String | Supported for: SELECT. A JSON aggregate. Returns the comments for the business process event step |
CompletedByPerson_Descriptor | String | Supported for: SELECT. A description of the instance |
CompletedByPerson_Href | String | Supported for: SELECT. A link to the instance |
CompletedByPerson_Id | String | Supported for: SELECT. wid / id / reference id |
CompletedOn | Datetime | Supported for: SELECT. The date when this step was completed |
CreationDate | Datetime | Supported for: SELECT. The date when the event record was created. |
DelayedDate | Datetime | Supported for: SELECT. The date the delayed step will trigger. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Due | Datetime | Supported for: SELECT. Returns the due date for this step. |
Event_Descriptor | String | Supported for: SELECT. A description of the instance |
Event_Href | String | Supported for: SELECT. A link to the instance |
Event_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
Reads groups entries from the Projects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Projects_Id [KEY] | String | The Wordkay ID of the Projects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads optionalHierarchies entries from the Projects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Projects_Id [KEY] | String | The Wordkay ID of the Projects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads projectDependencies entries from the Projects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Projects_Id [KEY] | String | The Wordkay ID of the Projects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads worktags entries from the Projects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Projects_Id [KEY] | String | The Wordkay ID of the Projects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads candidatePools entries from the Prospects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Prospects_Id [KEY] | String | The Wordkay ID of the Prospects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads candidateTags entries from the Prospects table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Prospects_Id [KEY] | String | The Wordkay ID of the Prospects that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Reads abilities entries from the ProspectsLanguages table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ProspectsLanguages_Id [KEY] | String | The Wordkay ID of the ProspectsLanguages that contains this |
Prospects_Id [KEY] | String | The Workday ID of the Prospects that owns this |
AbilityType_Descriptor | String | Supported for: SELECT. A description of the instance |
AbilityType_Href | String | Supported for: SELECT. A link to the instance |
AbilityType_Id | String | Supported for: SELECT. wid / id / reference id |
Proficiency_Descriptor | String | Supported for: SELECT. A description of the instance |
Proficiency_Href | String | Supported for: SELECT. A link to the instance |
Proficiency_Id | String | Supported for: SELECT. wid / id / reference id |
Retrieves a purchase order.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
BillToContactDetail | String | Supported for: SELECT. The bill-to contact information for the purchase order. |
BillToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
BillToContact_Href | String | Supported for: SELECT. A link to the instance |
BillToContact_Id | String | Supported for: SELECT. wid / id / reference id |
Buyer_Descriptor | String | Supported for: SELECT. A description of the instance |
Buyer_Href | String | Supported for: SELECT. A link to the instance |
Buyer_Id | String | Supported for: SELECT. wid / id / reference id |
Company_Descriptor | String | Supported for: SELECT. A description of the instance |
Company_Href | String | Supported for: SELECT. A link to the instance |
Company_Id | String | Supported for: SELECT. wid / id / reference id |
CreditCard_Descriptor | String | Supported for: SELECT. A description of the instance |
CreditCard_Href | String | Supported for: SELECT. A link to the instance |
CreditCard_Id | String | Supported for: SELECT. wid / id / reference id |
Currency_Descriptor | String | Supported for: SELECT. A description of the instance |
Currency_Href | String | Supported for: SELECT. A link to the instance |
Currency_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DocumentDate | Datetime | Supported for: SELECT. The date of the purchase order. Users can manually update this value on the purchase order during creation. |
DueDate | Datetime | Supported for: SELECT. The due date for the purchase order. |
ExcludeFromMassClose | Bool | Supported for: SELECT. If true, indicates that the purchase order is manually excluded from mass close operations. |
FreightAmount_Currency | String | Supported for: SELECT. The total amount of freight charges that are applicable for the taxable document. |
FreightAmount_Value | Decimal | Supported for: SELECT. The total amount of freight charges that are applicable for the taxable document. |
InternalMemo | String | Supported for: SELECT. The internal memo on a document. This type of memo is viewable by only internal workers of your company, and not any outside party. |
IssueOption_Descriptor | String | Supported for: SELECT. A description of the instance |
IssueOption_Href | String | Supported for: SELECT. A link to the instance |
IssueOption_Id | String | Supported for: SELECT. wid / id / reference id |
LineTotalAmount_Currency | String | Supported for: SELECT. The total extended amount for all purchase order lines. |
LineTotalAmount_Value | Decimal | Supported for: SELECT. The total extended amount for all purchase order lines. |
Memo | String | Supported for: SELECT. The memo on the purchase order. This field contains internal notes or reference text. |
OrderFromConnection_Descriptor | String | Supported for: SELECT. A description of the instance |
OrderFromConnection_Href | String | Supported for: SELECT. A link to the instance |
OrderFromConnection_Id | String | Supported for: SELECT. wid / id / reference id |
OtherCharges_Currency | String | Supported for: SELECT. The total amount of other charges that are applicable to the taxable document. |
OtherCharges_Value | Decimal | Supported for: SELECT. The total amount of other charges that are applicable to the taxable document. |
PaymentTerms_Descriptor | String | Supported for: SELECT. A description of the instance |
PaymentTerms_Href | String | Supported for: SELECT. A link to the instance |
PaymentTerms_Id | String | Supported for: SELECT. wid / id / reference id |
PaymentType_Descriptor | String | Supported for: SELECT. A description of the instance |
PaymentType_Href | String | Supported for: SELECT. A link to the instance |
PaymentType_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContactDetail | String | Supported for: SELECT. The ship-to contact for the purchase order. This field contains the contact information for questions on orders, such as expected shipment date. |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
ShippingInstructions | String | Supported for: SELECT. The shipping instructions on the purchase order. |
ShippingMethod_Descriptor | String | Supported for: SELECT. A description of the instance |
ShippingMethod_Href | String | Supported for: SELECT. A link to the instance |
ShippingMethod_Id | String | Supported for: SELECT. wid / id / reference id |
ShippingTerms_Descriptor | String | Supported for: SELECT. A description of the instance |
ShippingTerms_Href | String | Supported for: SELECT. A link to the instance |
ShippingTerms_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
SubmittedBy_Descriptor | String | Supported for: SELECT. A description of the instance |
SubmittedBy_Href | String | Supported for: SELECT. A link to the instance |
SubmittedBy_Id | String | Supported for: SELECT. wid / id / reference id |
SupplierContract_Descriptor | String | Supported for: SELECT. A description of the instance |
SupplierContract_Href | String | Supported for: SELECT. A link to the instance |
SupplierContract_Id | String | Supported for: SELECT. wid / id / reference id |
Supplier_Descriptor | String | Supported for: SELECT. A description of the instance |
Supplier_Href | String | Supported for: SELECT. A link to the instance |
Supplier_Id | String | Supported for: SELECT. wid / id / reference id |
TaxAmount_Currency | String | Supported for: SELECT. The total tax amount for the document. |
TaxAmount_Value | Decimal | Supported for: SELECT. The total tax amount for the document. |
TaxOption_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxOption_Href | String | Supported for: SELECT. A link to the instance |
TaxOption_Id | String | Supported for: SELECT. wid / id / reference id |
TotalAmount_Currency | String | Supported for: SELECT. The total extended amount of all purchase order lines for the purchase order. |
TotalAmount_Value | Decimal | Supported for: SELECT. The total extended amount of all purchase order lines for the purchase order. |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads billToAddress entries from the PurchaseOrders table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Wordkay ID of the PurchaseOrders that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads goodsLines entries from the PurchaseOrders table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ memo: Text /* The memo for a purchase order line split. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] percent: Numeric /* The percentage for a purchase order line split. */ quantity: Numeric /* The quantity for the purchase order line split. */ location: { /* The location as a worktag. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } amount: Currency /* The amount on the purchase order transaction line split. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Wordkay ID of the PurchaseOrders that contains this |
DeliverTo_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliverTo_Href | String | Supported for: SELECT. A link to the instance |
DeliverTo_Id | String | Supported for: SELECT. wid / id / reference id |
DeliveryType_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliveryType_Href | String | Supported for: SELECT. A link to the instance |
DeliveryType_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. The date when the purchase order line is due for delivery. This value is based on the creation date of the purchase order and lead time for the item. |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. |
ItemDescription | String | Supported for: SELECT. The line item description for the purchase order line. |
ItemName_Descriptor | String | Supported for: SELECT. A description of the instance |
ItemName_Href | String | Supported for: SELECT. A link to the instance |
ItemName_Id | String | Supported for: SELECT. wid / id / reference id |
LeadTime | Decimal | Supported for: SELECT. The lead time for the purchase order goods line. |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The memo on the purchase order line. This field contains internal notes or reference text. |
Prepaid | Bool | Supported for: SELECT. If true, the purchase order line is prepaid. |
QuantityInvoiced | Decimal | Supported for: SELECT. The quantity on a document line associated to 1 or more supplier invoice lines. You can use this field to identify fully invoiced purchase orders with 2 or more separate invoice lines that partially fulfill the quantity on the purchase order. |
QuantityOrdered | Decimal | Supported for: SELECT. The quantity on the purchase order line. |
QuantityReceived | Decimal | Supported for: SELECT. The quantity received. If a Return exists, the quantity returned is deducted from the quantity received. |
QuantityShipped | Decimal | Supported for: SELECT. The total quantity shipped for the purchase order line. |
RequestedAsNoCharge | Bool | Supported for: SELECT. If true, the document line is associated to a No Charge requisition line. Requesters select No Charge when there is no expected cost for the requisition line. |
Retention | Bool | Supported for: SELECT. If true, the purchase order line has retention. |
ShipToAddress_Descriptor | String | Supported for: SELECT. A preview of the instance |
ShipToAddress_Id | String | Supported for: SELECT. Id of the instance |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits on the purchase order. This field contains details of the line splits. This field is empty when the purchase order doesn't have line splits. |
SupplierItemIdentifier | String | Supported for: SELECT. The alphanumeric identifier assigned by a supplier to an item. This value can be unique for each supplier of the item, and is different from the manufacturer identification number. |
TaxApplicability_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxApplicability_Href | String | Supported for: SELECT. A link to the instance |
TaxApplicability_Id | String | Supported for: SELECT. wid / id / reference id |
TaxCode_Descriptor | String | Supported for: SELECT. A preview of the instance |
TaxCode_Id | String | Supported for: SELECT. Id of the instance |
TaxRecoverability_Aggregate | String | Supported for: SELECT. A JSON aggregate. The tax recoverability percentage on a taxable purchase order line. |
UnitCost_Currency | String | Supported for: SELECT. The unit cost for the purchase order line. |
UnitCost_Value | Decimal | Supported for: SELECT. The unit cost for the purchase order line. |
UnitOfMeasure_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfMeasure_Href | String | Supported for: SELECT. A link to the instance |
UnitOfMeasure_Id | String | Supported for: SELECT. wid / id / reference id |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Worktags for the purchase order line. |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads projectBasedServiceLines entries from the PurchaseOrders table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ memo: Text /* The memo for a purchase order line split. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] percent: Numeric /* The percentage for a purchase order line split. */ quantity: Numeric /* The quantity for the purchase order line split. */ location: { /* The location as a worktag. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } amount: Currency /* The amount on the purchase order transaction line split. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ amount: Currency /* The amount for the project subtask. The value can be negative and will be precise up to 6 decimal places. */ description: Text /* The description of a project subtask on the document line. The project subtasks are always on the project based service lines for procurement transactions. */ task: { /* Returns the \~Project\~ Plan Task associated with this \~Project\~ Subtask */ phase: { /* The unique \~project plan phase\~ in a \~project\~. The \~project plan phase\~ is unique to the \~project\~ while the \~project phase\~ is globally unique in the tenant. */ name: Text /* The name of the phrase associated with a project plan. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } name: Text /* The project plan task name. */ startDate: Date /* The project plan task start date. */ endDate: Date /* The project plan task end date. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Wordkay ID of the PurchaseOrders that contains this |
AmountInvoiced_Currency | String | Supported for: SELECT. The total extended line amount of all invoice lines for the project based purchase order line. |
AmountInvoiced_Value | Decimal | Supported for: SELECT. The total extended line amount of all invoice lines for the project based purchase order line. |
AmountReceived_Currency | String | Supported for: SELECT. The total extended line amount of all receipt lines for the project based purchase order line. |
AmountReceived_Value | Decimal | Supported for: SELECT. The total extended line amount of all receipt lines for the project based purchase order line. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the purchase order line. Excludes the extended amounts on Tax Only Invoices. |
Memo | String | Supported for: SELECT. The memo for the project based purchase order line. |
Prepaid | Bool | Supported for: SELECT. If true, the purchase order line is prepaid. |
Project_Descriptor | String | Supported for: SELECT. A preview of the instance |
Project_EndDate | Datetime | Supported for: SELECT. The approved project end date. |
Project_Id | String | Supported for: SELECT. Id of the instance |
Project_Name | String | Supported for: SELECT. The approved project name. |
Project_Reference | String | Supported for: SELECT. The reference ID of a project from an external or third-party system. |
Project_StartDate | Datetime | Supported for: SELECT. The approved project start date. |
Retention | Bool | Supported for: SELECT. If true, retention check box is selected. |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits for the project based purchase order line. The field is empty if the line doesn't have splits. |
Subtasks_Aggregate | String | Supported for: SELECT. A JSON aggregate. The project subtask for the project based purchase order line. Projects are always on project based service lines. |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The worktags for the project based purchase order line. |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads serviceLines entries from the PurchaseOrders table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ memo: Text /* The memo for a purchase order line split. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] percent: Numeric /* The percentage for a purchase order line split. */ quantity: Numeric /* The quantity for the purchase order line split. */ location: { /* The location as a worktag. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } amount: Currency /* The amount on the purchase order transaction line split. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Wordkay ID of the PurchaseOrders that contains this |
AmountInvoiced_Currency | String | Supported for: SELECT. The total extended line amount of all invoice lines for the purchase order line. This field works with Goods and Service lines. The currency is the currency of the purchase order. |
AmountInvoiced_Value | Decimal | Supported for: SELECT. The total extended line amount of all invoice lines for the purchase order line. This field works with Goods and Service lines. The currency is the currency of the purchase order. |
AmountOrdered_Currency | String | Supported for: SELECT. The extended amount for the purchase order line. Excludes extended amounts on Tax Only Invoices. |
AmountOrdered_Value | Decimal | Supported for: SELECT. The extended amount for the purchase order line. Excludes extended amounts on Tax Only Invoices. |
AmountReceived_Currency | String | Supported for: SELECT. The total extended line amount of all receipt lines for the purchase order line. |
AmountReceived_Value | Decimal | Supported for: SELECT. The total extended line amount of all receipt lines for the purchase order line. |
DeliverTo_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliverTo_Href | String | Supported for: SELECT. A link to the instance |
DeliverTo_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DueDate | Datetime | Supported for: SELECT. The date when the purchase order line is due for delivery. This value is based on the creation date of the purchase order and lead time for the item. |
EndDate | Datetime | Supported for: SELECT. The end date for the simple service order line. |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the purchase order line. Excludes extended amounts on tax only invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the purchase order line. Excludes extended amounts on tax only invoices. |
ItemDescription | String | Supported for: SELECT. The line item description for the purchase order line. |
ItemName_Descriptor | String | Supported for: SELECT. A description of the instance |
ItemName_Href | String | Supported for: SELECT. A link to the instance |
ItemName_Id | String | Supported for: SELECT. wid / id / reference id |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The line memo for the purchase order line. |
Prepaid | Bool | Supported for: SELECT. If true, the purchase order line is prepaid. |
Retention | Bool | Supported for: SELECT. If true, the purchase order line has retention. |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits on the purchase order line. Empty when the purchase order line doesn't have splits. |
StartDate | Datetime | Supported for: SELECT. The start date for the simple service order line. |
TaxApplicability_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxApplicability_Href | String | Supported for: SELECT. A link to the instance |
TaxApplicability_Id | String | Supported for: SELECT. wid / id / reference id |
TaxCode_Descriptor | String | Supported for: SELECT. A preview of the instance |
TaxCode_Id | String | Supported for: SELECT. Id of the instance |
TaxRecoverability_Aggregate | String | Supported for: SELECT. A JSON aggregate. The tax recoverability percentage on a taxable purchase order line. |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The Worktags for the purchase order line. |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads taxCodes entries from the PurchaseOrders table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
PurchaseOrders_Id [KEY] | String | The Wordkay ID of the PurchaseOrders that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Buyer_Prompt | String | Accepts multiple inputs. Filters the purchase orders by buyer. Specify the Workday ID of the worker assigned as buyer on the purchase order. You can specify multiple buyer query parameters. |
Company_Prompt | String | Accepts multiple inputs. Filters the purchase orders by company. Specify the Workday ID of the company. You can specify multiple company query parameters. |
ExcludeCanceled_Prompt | Boolean | If true, this method excludes the purchase orders with Canceled status. The default is false. |
ExcludeClosed_Prompt | Boolean | If true, this method excludes the purchase orders with Closed status. The default is false. |
FromDate_Prompt | Date | Filters the purchase orders with document date on or after the specified date. Use the yyyy-mm-dd format. |
OrderFromConnection_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier order-from connections. Specify the Workday ID of the order-from connection. You can specify multiple order-from connection query parameters. |
Status_Prompt | String | Accepts multiple inputs. Filters the purchase orders by status. Specify the Workday ID of the status. You can specify multiple status query parameters. |
SubmittedBy_Prompt | String | Accepts multiple inputs. Filters the purchase orders by the worker who submitted the purchase order. Specify the Workday ID of the worker. You can specify multiple submittedBy query parameters. You can use a returned id from GET /workers in the Staffing REST web service. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the purchase orders by supplier. Specify the Workday ID of the supplier. You can specify multiple supplier query parameters. |
ToDate_Prompt | Date | Filters the purchase orders with document date on or before the specified date. Use the yyyy-mm-dd format. |
Reads questionnaireResponses.questionnaireAnswers entries from the Requests table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } fileLength: Numeric /* File length of the attachment */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Requests_Id [KEY] | String | The Wordkay ID of the Requests that contains this |
AnswerDate | Datetime | Supported for: SELECT. The answer in a date format. |
AnswerMultipleChoiceOrder | String | Supported for: SELECT. The Question Multiple Choice Answer Order for Questionnaire Answer (REST API) |
AnswerMutlipleChoice_Descriptor | String | Supported for: SELECT. A description of the instance |
AnswerMutlipleChoice_Href | String | Supported for: SELECT. A link to the instance |
AnswerMutlipleChoice_Id | String | Supported for: SELECT. wid / id / reference id |
AnswerNumeric | Decimal | Supported for: SELECT. The answer in a numeric format. |
AnswerText | String | Supported for: SELECT. The text answer for a questionnaire. |
Branching | Bool | Supported for: SELECT. Is Answer for a Branching Question |
Descriptor | String | Supported for: SELECT. A preview of the instance |
QuestionBody | String | Supported for: SELECT. The question body for a questionnaire answer in rich text. Used in REST services only. |
QuestionItem_Descriptor | String | Supported for: SELECT. A description of the instance |
QuestionItem_Href | String | Supported for: SELECT. A link to the instance |
QuestionItem_Id | String | Supported for: SELECT. wid / id / reference id |
QuestionOrder | String | Supported for: SELECT. The Question Item Order for Questionnaire Answer (REST API) |
QuestionnaireAttachments_Aggregate | String | Supported for: SELECT. A JSON aggregate. Questionnaire Attachments for Questionnaire Response. |
CompletedOnOrAfter_Prompt | Date | No description available |
CompletedOnOrBefore_Prompt | Date | No description available |
InitiatedOnOrAfter_Prompt | Date | No description available |
InitiatedOnOrBefore_Prompt | Date | No description available |
Initiator_Prompt | String | Accepts multiple inputs. The WID for the person who initiated the request. You can GET /workers in the /common service to retrieve a worker's WID. |
OnBehalfOf_Prompt | String | The Workday ID of the person this request is being initiated on behalf of. |
RequestId_Prompt | String | The ID of the request based on the ID generator format. |
RequestSubtype_Prompt | String | Accepts multiple inputs. The Workday ID of the request subtype. You can specify more than 1 requestSubtype query parameter. |
RequestType_Prompt | String | Accepts multiple inputs. The Workday ID of the request type. You can specify more than 1 requestType query parameter. |
ResolutionDetails_Prompt | String | Accepts multiple inputs. The Workday ID of the resolution details. You can specify more than 1 resolutionDetails query parameter. |
Resolution_Prompt | String | Accepts multiple inputs. The Workday ID of the resolution of the request. You can specify more than 1 resolution query parameter. |
WorkdayObjectValue_Prompt | String | Accepts multiple inputs. The Workday ID of the business object associated with the request. |
Reads questionnaireResponses.surveyTarget entries from the Requests table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Requests_Id [KEY] | String | The Wordkay ID of the Requests that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
CompletedOnOrAfter_Prompt | Date | No description available |
CompletedOnOrBefore_Prompt | Date | No description available |
InitiatedOnOrAfter_Prompt | Date | No description available |
InitiatedOnOrBefore_Prompt | Date | No description available |
Initiator_Prompt | String | Accepts multiple inputs. The WID for the person who initiated the request. You can GET /workers in the /common service to retrieve a worker's WID. |
OnBehalfOf_Prompt | String | The Workday ID of the person this request is being initiated on behalf of. |
RequestId_Prompt | String | The ID of the request based on the ID generator format. |
RequestSubtype_Prompt | String | Accepts multiple inputs. The Workday ID of the request subtype. You can specify more than 1 requestSubtype query parameter. |
RequestType_Prompt | String | Accepts multiple inputs. The Workday ID of the request type. You can specify more than 1 requestType query parameter. |
ResolutionDetails_Prompt | String | Accepts multiple inputs. The Workday ID of the resolution details. You can specify more than 1 resolutionDetails query parameter. |
Resolution_Prompt | String | Accepts multiple inputs. The Workday ID of the resolution of the request. You can specify more than 1 resolution query parameter. |
WorkdayObjectValue_Prompt | String | Accepts multiple inputs. The Workday ID of the business object associated with the request. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
AdditionalWorktags_Prompt | Boolean | No description available |
AllStandaloneTypes_Prompt | Boolean | No description available |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
Company_Prompt | String | The Workday ID of the company. |
Currency_Prompt | String | The Workday ID of the currency. |
ExistingWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
ItemDescription_Prompt | String | The description of an item. |
ItemSpendCategory_Prompt | String | No description available |
ProcurementItem_Prompt | String | No description available |
ReqTypeBillOnly_Prompt | Boolean | If true, retrieves requisition types that are bill only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeConsignment_Prompt | Boolean | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeInvReplenishment_Prompt | Boolean | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeJustInTime_Prompt | Boolean | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
ReqTypeParReplenishment_Prompt | Boolean | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, , reqTypeSupplierContract. |
ReqTypeShowAllTypes_Prompt | Boolean | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
ReqTypeSupplierContract_Prompt | Boolean | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. The reqType parameters are: reqTypeBillOnly, reqTypeInvReplenishment, reqTypeJustInTime, reqTypeParReplenishment, reqTypeConsignment, reqTypeSupplierContract. |
Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005 |
RequisitionDate_Prompt | Date | The requisition date using the yyyy-mm-dd format. |
RequisitionLine_Prompt | String | The Workday ID of the requisition line. |
RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (e.g. Inventory Replenishment and Bill Only). |
Requisition_Prompt | String | The Workday ID of the requisition. |
ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract. |
SelectedWorktags_Prompt | String | Accepts multiple inputs. The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
Supplier_Prompt | String | The Workday ID of the resource provider. |
TypesWithoutService_Prompt | Boolean | No description available |
WorktagType_Prompt | String | No description available |
Reads purchaseOrders entries from the Requisitions table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Requisitions_Id [KEY] | String | The Wordkay ID of the Requisitions that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DocumentStatus_Descriptor | String | Supported for: SELECT. A description of the instance |
DocumentStatus_Href | String | Supported for: SELECT. A link to the instance |
DocumentStatus_Id | String | Supported for: SELECT. wid / id / reference id |
Href | String | Supported for: SELECT. A link to the instance |
PoDocumentDate | Datetime | Supported for: SELECT. The date for the purchase order. |
PoNumber | String | Supported for: SELECT. The document number for the purchase order. |
ExternalSourceableId_Prompt | String | No description available |
ExternalSystemId_Prompt | String | No description available |
FromDate_Prompt | Date | Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
Requester_Prompt | String | Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
RequisitionType_Prompt | String | Accepts multiple inputs. Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
SubmittedByPerson_Prompt | String | Filters the requisitions by the Person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
SubmittedBySupplier_Prompt | String | Accepts multiple inputs. Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
SubmittedBy_Prompt | String | Filters the requisitions by the Worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
ToDate_Prompt | Date | Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Retrieves the goods and service line details of a requisition template.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Company_Descriptor | String | Supported for: SELECT. A description of the instance |
Company_Href | String | Supported for: SELECT. A link to the instance |
Company_Id | String | Supported for: SELECT. wid / id / reference id |
CreatedOnDate | Datetime | Supported for: SELECT. The document date of the requisition template. |
Currency_Descriptor | String | Supported for: SELECT. A description of the instance |
Currency_Href | String | Supported for: SELECT. A link to the instance |
Currency_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
LineCount | Decimal | Supported for: SELECT. The number of lines on the requisition template. |
Name | String | Supported for: SELECT. The name of the requisition template. |
OwnedByCurrentUser | Bool | Supported for: SELECT. True when the processing worker also owns the requisition template. Workers can create either shared or private templates. |
Owner_Descriptor | String | Supported for: SELECT. A description of the instance |
Owner_Href | String | Supported for: SELECT. A link to the instance |
Owner_Id | String | Supported for: SELECT. wid / id / reference id |
Reads goodsLines entries from the RequisitionTemplates table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ quantity: Numeric /* The Quantity specified for the Requisition Line distribution line split. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] percent: Numeric /* The Percentage specified for the Requisition Line distribution line split. */ amount: Currency /* The amount on the Requisition line split. This value displays in the same currency of the Requisition. */ memo: Text /* The memo for a Requisition Line split on the requisition or purchase order. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
RequisitionTemplates_Id [KEY] | String | The Wordkay ID of the RequisitionTemplates that contains this |
DeliverTo_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliverTo_Href | String | Supported for: SELECT. A link to the instance |
DeliverTo_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount of the goods line on the requisition. Doesn't include the extended amounts of tax-only invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount of the goods line on the requisition. Doesn't include the extended amounts of tax-only invoices. |
FulfillmentSource_Descriptor | String | Supported for: SELECT. A description of the instance |
FulfillmentSource_Href | String | Supported for: SELECT. A link to the instance |
FulfillmentSource_Id | String | Supported for: SELECT. wid / id / reference id |
ItemDescription | String | Supported for: SELECT. The description for the item of the goods line on the requisition. |
ItemIdentifiers_Aggregate | String | Supported for: SELECT. A JSON aggregate. The alternate item identifiers associated with the inventory item on the goods line of the requisition. |
ItemName_Descriptor | String | Supported for: SELECT. A description of the instance |
ItemName_Href | String | Supported for: SELECT. A link to the instance |
ItemName_Id | String | Supported for: SELECT. wid / id / reference id |
ItemTags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The item tags associated with a delivery run on a goods line. |
Memo | String | Supported for: SELECT. The memo of the goods line on the requisition. |
OrderFromConnection_Descriptor | String | Supported for: SELECT. A description of the instance |
OrderFromConnection_Href | String | Supported for: SELECT. A link to the instance |
OrderFromConnection_Id | String | Supported for: SELECT. wid / id / reference id |
Quantity | Decimal | Supported for: SELECT. The quantity of the item for the goods line on the requisition. |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits of the goods line on the requisition. |
SupplierItemIdentifier | String | Supported for: SELECT. The alphanumeric identifier that a supplier assigns to an item. Each supplier can provide a unique identifier for the item. This identifier differs from the manufacturer identification number. |
Supplier_Aggregate | String | Supported for: SELECT. A JSON aggregate. The supplier or resource provider of the goods line on the requisition. Helps determine the supplier for each line on a purchase order when your order includes multiple suppliers. |
UnitCost_Currency | String | Supported for: SELECT. The unit cost of the goods line on the requisition. |
UnitCost_Value | Decimal | Supported for: SELECT. The unit cost of the goods line on the requisition. |
UnitOfMeasure_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfMeasure_Href | String | Supported for: SELECT. A link to the instance |
UnitOfMeasure_Id | String | Supported for: SELECT. wid / id / reference id |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The accounting worktags that apply to the goods line on the requisition. |
Reads serviceLines entries from the RequisitionTemplates table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ quantity: Numeric /* The Quantity specified for the Requisition Line distribution line split. */ worktags: [{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] percent: Numeric /* The Percentage specified for the Requisition Line distribution line split. */ amount: Currency /* The amount on the Requisition line split. This value displays in the same currency of the Requisition. */ memo: Text /* The memo for a Requisition Line split on the requisition or purchase order. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
RequisitionTemplates_Id [KEY] | String | The Wordkay ID of the RequisitionTemplates that contains this |
DeliverTo_Descriptor | String | Supported for: SELECT. A description of the instance |
DeliverTo_Href | String | Supported for: SELECT. A link to the instance |
DeliverTo_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EndDate | Datetime | Supported for: SELECT. The requested end date of the service line on the requisition. Provided by the user who submits the requisition. Can determine the end of the service contract. |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount of the service line on the requisition. Doesn't include the extended amounts of tax-only invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount of the service line on the requisition. Doesn't include the extended amounts of tax-only invoices. |
FulfillmentSource_Descriptor | String | Supported for: SELECT. A description of the instance |
FulfillmentSource_Href | String | Supported for: SELECT. A link to the instance |
FulfillmentSource_Id | String | Supported for: SELECT. wid / id / reference id |
ItemDescription | String | Supported for: SELECT. The description for the item of the service line on the requisition. |
ItemName_Descriptor | String | Supported for: SELECT. A description of the instance |
ItemName_Href | String | Supported for: SELECT. A link to the instance |
ItemName_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The memo of the service line on the requisition. |
OrderFromConnection_Descriptor | String | Supported for: SELECT. A description of the instance |
OrderFromConnection_Href | String | Supported for: SELECT. A link to the instance |
OrderFromConnection_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
Splits_Aggregate | String | Supported for: SELECT. A JSON aggregate. The line splits of the service line on the requisition. |
StartDate | Datetime | Supported for: SELECT. The requested start date of the service line on the requisition. Provided by the user who submits the requisition. Can determine the start of a service contract. |
Supplier_Aggregate | String | Supported for: SELECT. A JSON aggregate. The supplier or resource provider of the service line on the requisition. Helps determine the supplier for each line on a purchase order when your order includes multiple suppliers. |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The accounting worktags that apply to the service line on the requisition. |
Retrieves a single resource forecast line instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProjectPlanTask_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectPlanTask_Href | String | Supported for: SELECT. A link to the instance |
ProjectPlanTask_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectResource_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectResource_Href | String | Supported for: SELECT. A link to the instance |
ProjectResource_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectRole_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectRole_Href | String | Supported for: SELECT. A link to the instance |
ProjectRole_Id | String | Supported for: SELECT. wid / id / reference id |
ResourcePlanLine_Descriptor | String | Supported for: SELECT. A description of the instance |
ResourcePlanLine_Href | String | Supported for: SELECT. A link to the instance |
ResourcePlanLine_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectResource_Prompt | String | No description available |
ProjectRole_Prompt | String | No description available |
Project_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
Reads excludedWorkers entries from the ResourcePlanLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ResourcePlanLines_Id [KEY] | String | The Wordkay ID of the ResourcePlanLines that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProjectResourcePlan_Prompt | String | No description available |
Project_Prompt | String | No description available |
Reads pendingWorkers entries from the ResourcePlanLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ResourcePlanLines_Id [KEY] | String | The Wordkay ID of the ResourcePlanLines that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProjectResourcePlan_Prompt | String | No description available |
Project_Prompt | String | No description available |
Reads projectResources entries from the ResourcePlanLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ResourcePlanLines_Id [KEY] | String | The Wordkay ID of the ResourcePlanLines that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProjectResourcePlan_Prompt | String | No description available |
Project_Prompt | String | No description available |
Reads requirements entries from the ResourcePlanLines table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ResourcePlanLines_Id [KEY] | String | The Wordkay ID of the ResourcePlanLines that contains this |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Optional | Bool | Supported for: SELECT. The optional status of a requirement. |
Values_Aggregate | String | Supported for: SELECT. A JSON aggregate. Contains the requirement values for the associated category. |
ProjectResourcePlan_Prompt | String | No description available |
Project_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
RequirementCategory_Prompt | String | No description available |
Reads defaultScorecardGoalsResult.performanceScores entries from the ScorecardResults table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ScorecardResults_Id [KEY] | String | The Wordkay ID of the ScorecardResults that contains this |
Achievement | Decimal | Supported for: SELECT. The achievement percentage for the scorecard criteria result. |
GoalID_Id | String | Supported for: SELECT. Id of the instance |
GoalName | String | Supported for: SELECT. The goal name of the scorecard criteria result. |
GoalWeight | Decimal | Supported for: SELECT. The criteria weighted percentage of the scorecard criteria result. |
Reads profileScorecardGoalsResult entries from the ScorecardResults table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ goalID: { /* The criteria for the scorecard criteria result. */ id: Text /* Id of the instance */ } goalName: Text /* The \~goal\~ name of the scorecard criteria result. */ achievement: Numeric /* The achievement percentage for the scorecard criteria result. */ goalWeight: Numeric /* The criteria weighted percentage of the scorecard criteria result. */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
ScorecardResults_Id [KEY] | String | The Wordkay ID of the ScorecardResults that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
EligibiltyRule_Descriptor | String | Supported for: SELECT. A description of the instance |
EligibiltyRule_Href | String | Supported for: SELECT. A link to the instance |
EligibiltyRule_Id | String | Supported for: SELECT. wid / id / reference id |
PerformanceScores_Aggregate | String | Supported for: SELECT. A JSON aggregate. The set of Performance Scores for a Compensation Scorecard. |
WeightedFundingPercent | Decimal | Supported for: SELECT. Calculates the total Weighted Funding Percent for all the scores in the scorecard result set. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
EventStep_Prompt | String | No description available |
Retrieves a student instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
FirstGeneration | Bool | Supported for: SELECT. Indicator for first generation student. |
InternationalStudent | Bool | Supported for: SELECT. True if the student is not a citizen of the United States or one of its territories and is a citizen of another country. |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
MilitaryRelationship | Bool | Supported for: SELECT. Returns students that have a military relationship (e.g. veteran, military spouse) |
Person_Descriptor | String | Supported for: SELECT. A description of the instance |
Person_Href | String | Supported for: SELECT. A link to the instance |
Person_Id | String | Supported for: SELECT. wid / id / reference id |
PreferredName | String | Supported for: SELECT. Returns the fully formatted preferred name for the Student. |
StudentID | String | Supported for: SELECT. The student ID of the student. |
AcademicLevel_Prompt | String | Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only return active students. |
ProgramOfStudy_Prompt | String | Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Retrieves a single student hold instance for the specified student.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
CreatedBy | String | Supported for: SELECT. The user who assigned the hold. |
CreatedOn | Datetime | Supported for: SELECT. Date the Hold was created. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
OverrideEvent_AppliedOn | Datetime | Supported for: SELECT. The Date the Hold Override was placed. |
OverrideEvent_CreatedBy | String | Supported for: SELECT. The person who applied the override. |
OverrideEvent_EndDate | Datetime | Supported for: SELECT. The date the override ends. |
OverrideEvent_Id | String | Supported for: SELECT. Id of the instance |
OverrideEvent_StartDate | Datetime | Supported for: SELECT. The date the override starts. |
Reason_Description | String | Supported for: SELECT. The description of the hold reason. |
Reason_Descriptor | String | Supported for: SELECT. A preview of the instance |
Reason_Id | String | Supported for: SELECT. Id of the instance |
Reason_ResolutionInstructions | String | Supported for: SELECT. The resolution instructions defined for this hold reason. |
RemovedOn | Datetime | Supported for: SELECT. Date when the Hold will be removed from the Student. |
HoldType_Prompt | String | Accepts multiple inputs. Filter for holds matching these hold types. |
Reason_Prompt | String | Filter for holds matching this hold reason. |
ShowInactive_Prompt | Boolean | Parameter that will include inactive holds along with the active ones. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads overrideEvent.holdTypes entries from the StudentsHolds table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
StudentsHolds_Id [KEY] | String | The Wordkay ID of the StudentsHolds that contains this |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
HoldType_Prompt | String | Accepts multiple inputs. Filter for holds matching these hold types. |
Reason_Prompt | String | Filter for holds matching this hold reason. |
ShowInactive_Prompt | Boolean | Parameter that will include inactive holds along with the active ones. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads typeContexts entries from the StudentsHolds table
Name | Type | Description |
StudentsHolds_Id | String | The Wordkay ID of the StudentsHolds that contains this |
Students_Id | String | The Workday ID of the Students that owns this |
AcademicPeriod_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicPeriod_Href | String | Supported for: SELECT. A link to the instance |
AcademicPeriod_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicRecord_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicRecord_Href | String | Supported for: SELECT. A link to the instance |
AcademicRecord_Id | String | Supported for: SELECT. wid / id / reference id |
FederalSchoolCodeRuleSet_Descriptor | String | Supported for: SELECT. A description of the instance |
FederalSchoolCodeRuleSet_Href | String | Supported for: SELECT. A link to the instance |
FederalSchoolCodeRuleSet_Id | String | Supported for: SELECT. wid / id / reference id |
FinancialAidAwardYear_Descriptor | String | Supported for: SELECT. A description of the instance |
FinancialAidAwardYear_Href | String | Supported for: SELECT. A link to the instance |
FinancialAidAwardYear_Id | String | Supported for: SELECT. wid / id / reference id |
HoldType_Descriptor | String | Supported for: SELECT. A preview of the instance |
HoldType_Id | String | Supported for: SELECT. Id of the instance |
Institution_Descriptor | String | Supported for: SELECT. A description of the instance |
Institution_Href | String | Supported for: SELECT. A link to the instance |
Institution_Id | String | Supported for: SELECT. wid / id / reference id |
HoldType_Prompt | String | Accepts multiple inputs. Filter for holds matching these hold types. |
Reason_Prompt | String | Filter for holds matching this hold reason. |
ShowInactive_Prompt | Boolean | Parameter that will include inactive holds along with the active ones. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Retrieves an immigration event for the specified student.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
Application_Descriptor | String | Supported for: SELECT. A description of the instance |
Application_Href | String | Supported for: SELECT. A link to the instance |
Application_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ImmigrationData_ActiveSevisId | String | Supported for: SELECT. The current active SEVIS ID for the student immigration data. |
ImmigrationData_ActiveVisaType_Descriptor | String | Supported for: SELECT. A description of the instance |
ImmigrationData_ActiveVisaType_Href | String | Supported for: SELECT. A link to the instance |
ImmigrationData_ActiveVisaType_Id | String | Supported for: SELECT. wid / id / reference id |
ImmigrationData_Descriptor | String | Supported for: SELECT. A preview of the instance |
ImmigrationData_Id | String | Supported for: SELECT. Id of the instance |
ImmigrationData_IssuingInstitution_Descriptor | String | Supported for: SELECT. A description of the instance |
ImmigrationData_IssuingInstitution_Href | String | Supported for: SELECT. A link to the instance |
ImmigrationData_IssuingInstitution_Id | String | Supported for: SELECT. wid / id / reference id |
Status | String | Supported for: SELECT. The status of the immigration event. |
Institution_Prompt | String | No description available |
Status_Prompt | String | No description available |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads dependentImmigrationData entries from the StudentsImmigrationEvents table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
StudentsImmigrationEvents_Id [KEY] | String | The Wordkay ID of the StudentsImmigrationEvents that contains this |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
CountryOfBirth_Descriptor | String | Supported for: SELECT. A description of the instance |
CountryOfBirth_Href | String | Supported for: SELECT. A link to the instance |
CountryOfBirth_Id | String | Supported for: SELECT. wid / id / reference id |
CountryOfCitizenship_Descriptor | String | Supported for: SELECT. A description of the instance |
CountryOfCitizenship_Href | String | Supported for: SELECT. A link to the instance |
CountryOfCitizenship_Id | String | Supported for: SELECT. wid / id / reference id |
DateOfBirth | Datetime | Supported for: SELECT. The student dependent�s date of birth. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
FirstName | String | Supported for: SELECT. The first name of the student�s dependent. |
ImmigrationStatus_Descriptor | String | Supported for: SELECT. A description of the instance |
ImmigrationStatus_Href | String | Supported for: SELECT. A link to the instance |
ImmigrationStatus_Id | String | Supported for: SELECT. wid / id / reference id |
LastName | String | Supported for: SELECT. The last name of the student�s dependent. |
MiddleName | String | Supported for: SELECT. The middle name of the student�s dependent. |
RelationshipToStudent_Descriptor | String | Supported for: SELECT. A description of the instance |
RelationshipToStudent_Href | String | Supported for: SELECT. A link to the instance |
RelationshipToStudent_Id | String | Supported for: SELECT. wid / id / reference id |
SevisExpirationDate | Datetime | Supported for: SELECT. The expiration date of the SEVIS ID for the student�s dependent. |
SevisId | String | Supported for: SELECT. The SEVIS ID of the student�s dependent. |
SevisIssueDate | Datetime | Supported for: SELECT. The issue date of the SEVIS ID for the student�s dependent. |
Institution_Prompt | String | No description available |
Status_Prompt | String | No description available |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads primaryStudentRecord entries from the Students table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Students_Id [KEY] | String | The Wordkay ID of the Students that contains this |
AcademicLevel_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicLevel_Href | String | Supported for: SELECT. A link to the instance |
AcademicLevel_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicUnit_Descriptor | String | Supported for: SELECT. A description of the instance |
AcademicUnit_Href | String | Supported for: SELECT. A link to the instance |
AcademicUnit_Id | String | Supported for: SELECT. wid / id / reference id |
ClassStanding_Descriptor | String | Supported for: SELECT. A description of the instance |
ClassStanding_Href | String | Supported for: SELECT. A link to the instance |
ClassStanding_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ProgramOfStudy_Descriptor | String | Supported for: SELECT. A description of the instance |
ProgramOfStudy_Href | String | Supported for: SELECT. A link to the instance |
ProgramOfStudy_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
AcademicLevel_Prompt | String | Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only return active students. |
ProgramOfStudy_Prompt | String | Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Retrieves residence information for the specified student.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
Declaration | Datetime | Supported for: SELECT. The date on which this student declared residency. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Detail_Descriptor | String | Supported for: SELECT. A description of the instance |
Detail_Href | String | Supported for: SELECT. A link to the instance |
Detail_Id | String | Supported for: SELECT. wid / id / reference id |
Effective | Datetime | Supported for: SELECT. The date on which this residency status became (or will become) effective. |
EffectiveAcademicPeriod_Descriptor | String | Supported for: SELECT. A description of the instance |
EffectiveAcademicPeriod_Href | String | Supported for: SELECT. A link to the instance |
EffectiveAcademicPeriod_Id | String | Supported for: SELECT. wid / id / reference id |
Reason_Descriptor | String | Supported for: SELECT. A description of the instance |
Reason_Href | String | Supported for: SELECT. A link to the instance |
Reason_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institutions. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads documents entries from the StudentsResidencies table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
StudentsResidencies_Id [KEY] | String | The Wordkay ID of the StudentsResidencies that contains this |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institutions. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads events entries from the StudentsResidencies table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
StudentsResidencies_Id [KEY] | String | The Wordkay ID of the StudentsResidencies that contains this |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institutions. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Reads institutionalAcademicUnits entries from the StudentsResidencies table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
StudentsResidencies_Id [KEY] | String | The Wordkay ID of the StudentsResidencies that contains this |
Students_Id [KEY] | String | The Workday ID of the Students that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
InstitutionalAcademicUnit_Prompt | String | Accepts multiple inputs. The Institutions. |
AcademicLevel_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. No description available |
AcademicUnit_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. Derived Academic Units. |
ActiveOnly_Prompt | Boolean | Only used when a Students_Id filter is not provided. Only return active students. |
ProgramOfStudy_Prompt | String | Only used when a Students_Id filter is not provided. Accepts multiple inputs. For students who haven't matriculated, the program of study they either applied to or have been admitted to. For matriculated students, the primary program of study from their reporting record. |
Search_Prompt | String | Only used when a Students_Id filter is not provided. A fuzzy search string that matches student IDs and names. Example: search=bri%20book returns the student Brian Booker. |
Retrieves a supervisory organization instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Code | String | Supported for: SELECT. The organization id for the organization. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
Manager_Descriptor | String | Supported for: SELECT. A description of the instance |
Manager_Href | String | Supported for: SELECT. A link to the instance |
Manager_Id | String | Supported for: SELECT. wid / id / reference id |
Name | String | Supported for: SELECT. The organization name for the organization. |
Workers | String | Supported for: SELECT. Contains the workers in the organization. |
Retrieves a single member instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupervisoryOrganizations_Id [KEY] | String | The Workday ID of the SupervisoryOrganizations that owns this |
BusinessTitle | String | Supported for: SELECT. The business title for the position. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Id | String | Supported for: SELECT. Id of the instance |
JobType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Id | String | Supported for: SELECT. Id of the instance |
NextPayPeriodStartDate | Datetime | Supported for: SELECT. The next pay period start date for the job. |
SupervisoryOrganization_Descriptor | String | Supported for: SELECT. A preview of the instance |
SupervisoryOrganization_Id | String | Supported for: SELECT. Id of the instance |
Worker_Descriptor | String | Supported for: SELECT. A preview of the instance |
Worker_Id | String | Supported for: SELECT. Id of the instance |
Retrieves a single organization chart instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupervisoryOrganizations_Id [KEY] | String | The Workday ID of the SupervisoryOrganizations that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Superior_Code | String | Supported for: SELECT. The organization id for the organization. |
Superior_Descriptor | String | Supported for: SELECT. A preview of the instance |
Superior_Id | String | Supported for: SELECT. Id of the instance |
Superior_Inactive | Bool | Supported for: SELECT. Indicates whether the organization is inactive |
Superior_Name | String | Supported for: SELECT. Returns the name of the organization as of the processing effective moment |
Reads subordinates entries from the SupervisoryOrganizationsOrgChart table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupervisoryOrganizationsOrgChart_Id [KEY] | String | The Wordkay ID of the SupervisoryOrganizationsOrgChart that contains this |
SupervisoryOrganizations_Id [KEY] | String | The Workday ID of the SupervisoryOrganizations that owns this |
Code | String | Supported for: SELECT. The organization id for the organization. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. Indicates whether the organization is inactive |
Managers_Aggregate | String | Supported for: SELECT. A JSON aggregate. The manager(s) for the supervisory organization. |
Name | String | Supported for: SELECT. Returns the name of the organization as of the processing effective moment |
Reads superior.managers entries from the SupervisoryOrganizationsOrgChart table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupervisoryOrganizationsOrgChart_Id [KEY] | String | The Wordkay ID of the SupervisoryOrganizationsOrgChart that contains this |
SupervisoryOrganizations_Id [KEY] | String | The Workday ID of the SupervisoryOrganizations that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Retrieves a worker instance for a specific supervisory organization.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupervisoryOrganizations_Id [KEY] | String | The Workday ID of the SupervisoryOrganizations that owns this |
BusinessTitle | String | Supported for: SELECT. The business title for the worker's primary position. If no business title is defined for a position, the position title is returned back. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
IsManager | Bool | Supported for: SELECT. Identifies if the worker has a manager role. |
PrimarySupervisoryOrganization_Descriptor | String | Supported for: SELECT. A description of the instance |
PrimarySupervisoryOrganization_Href | String | Supported for: SELECT. A link to the instance |
PrimarySupervisoryOrganization_Id | String | Supported for: SELECT. wid / id / reference id |
PrimaryWorkEmail | String | Supported for: SELECT. The primary work email address for the worker. |
PrimaryWorkPhone | String | Supported for: SELECT. The primary work phone number for the worker including the area code and country code. |
Retrieves a supplier contract.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AllowAllSuppliers | Bool | Supported for: SELECT. True if the Allow All Suppliers option is enabled for a multisupplier type contract. |
AutomaticallyRenew | Bool | Supported for: SELECT. Returns true if the supplier contract is automatically renewed. |
BillToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
BillToAddress_Href | String | Supported for: SELECT. A link to the instance |
BillToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
BillToContactDetail | String | Supported for: SELECT. The bill-to contact that populates on purchase orders for installments of this supplier contract. |
Buyer_Descriptor | String | Supported for: SELECT. A description of the instance |
Buyer_Href | String | Supported for: SELECT. A link to the instance |
Buyer_Id | String | Supported for: SELECT. wid / id / reference id |
CatalogDiscountPercent | Decimal | Supported for: SELECT. Catalog Discount Percent applied to all Catalog Items on the Supplier Contract. The discounted Unit Cost will not be used if there is a Contract Line for the Item, since the Unit Cost on the Contract Line will be used. |
CompanyOrHierarchy_Descriptor | String | Supported for: SELECT. A preview of the instance |
CompanyOrHierarchy_Id | String | Supported for: SELECT. Id of the instance |
ContractReferenceNumber | String | Supported for: SELECT. The reference number that identifies the supplier contract. |
ContractSpecialist_Descriptor | String | Supported for: SELECT. A description of the instance |
ContractSpecialist_Href | String | Supported for: SELECT. A link to the instance |
ContractSpecialist_Id | String | Supported for: SELECT. wid / id / reference id |
ContractType_Descriptor | String | Supported for: SELECT. A preview of the instance |
ContractType_Id | String | Supported for: SELECT. Id of the instance |
Currency_Descriptor | String | Supported for: SELECT. A description of the instance |
Currency_Href | String | Supported for: SELECT. A link to the instance |
Currency_Id | String | Supported for: SELECT. wid / id / reference id |
DefaultOrderFromConnection_Descriptor | String | Supported for: SELECT. A description of the instance |
DefaultOrderFromConnection_Href | String | Supported for: SELECT. A link to the instance |
DefaultOrderFromConnection_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DocumentLink | String | Supported for: SELECT. The link to the external document that the supplier contract refers to. The supplier contract may stem from an external system and this link allows to access the contract to that external system. |
EndDate | Datetime | Supported for: SELECT. The end date of the supplier contract. |
ExternalReferenceID | String | Supported for: SELECT. The external identifier that's associated with a Workday requisition, supplier, supplier contract, or supplier invoice. |
ExternalSystemReference_Descriptor | String | Supported for: SELECT. A description of the instance |
ExternalSystemReference_Href | String | Supported for: SELECT. A link to the instance |
ExternalSystemReference_Id | String | Supported for: SELECT. wid / id / reference id |
FromSupplierList | Bool | Supported for: SELECT. Returns true if Supplier List option is enabled for a Multi-Supplier Contract. |
GpoReference | String | Supported for: SELECT. The Group Purchase Organization (GPO) contract reference of the supplier contract. |
InvoicedPOAmount_Currency | String | Supported for: SELECT. The Total Amount from Supplier Invoices attached to Purchase Orders. Invoices that are canceled or denied are not included. Will return zero if the amount is negative. The currency is the currency of the Supplier Contract. |
InvoicedPOAmount_Value | Decimal | Supported for: SELECT. The Total Amount from Supplier Invoices attached to Purchase Orders. Invoices that are canceled or denied are not included. Will return zero if the amount is negative. The currency is the currency of the Supplier Contract. |
MarkupPercent | Decimal | Supported for: SELECT. The markup percent applied to the unit cost of supplier items associated to the supplier contract. |
Name | String | Supported for: SELECT. The contract name for the supplier contract. |
NonPOInvoiceAmount_Currency | String | Supported for: SELECT. The total amount on invoices that aren't associated to purchase orders, in the currency of the supplier contract. Workday doesn't include canceled invoices, denied invoices, and lease-type contract invoice installments marked as Accounted. This report field returns zero when the total amount is negative. |
NonPOInvoiceAmount_Value | Decimal | Supported for: SELECT. The total amount on invoices that aren't associated to purchase orders, in the currency of the supplier contract. Workday doesn't include canceled invoices, denied invoices, and lease-type contract invoice installments marked as Accounted. This report field returns zero when the total amount is negative. |
NoticePeriod | Decimal | Supported for: SELECT. The number of days/months prior to supplier contract expiration that a notice is delivered. |
NoticePeriodFrequency_Descriptor | String | Supported for: SELECT. A description of the instance |
NoticePeriodFrequency_Href | String | Supported for: SELECT. A link to the instance |
NoticePeriodFrequency_Id | String | Supported for: SELECT. wid / id / reference id |
Number | String | Supported for: SELECT. The automatically generated supplier contract number. |
OnHold | Bool | Supported for: SELECT. True if the transaction document is on hold. You can put customer contracts, supplier invoices, inventory pick lists and other types of documents on hold. |
OriginalTotalAmount_Currency | String | Supported for: SELECT. The original total contract amount in the currency of the supplier contract. |
OriginalTotalAmount_Value | Decimal | Supported for: SELECT. The original total contract amount in the currency of the supplier contract. |
OverridePaymentType_Descriptor | String | Supported for: SELECT. A description of the instance |
OverridePaymentType_Href | String | Supported for: SELECT. A link to the instance |
OverridePaymentType_Id | String | Supported for: SELECT. wid / id / reference id |
Overview | String | Supported for: SELECT. The description or overview of the supplier contract. |
PaymentTerms_Descriptor | String | Supported for: SELECT. A description of the instance |
PaymentTerms_Href | String | Supported for: SELECT. A link to the instance |
PaymentTerms_Id | String | Supported for: SELECT. wid / id / reference id |
PaymentType_Descriptor | String | Supported for: SELECT. A description of the instance |
PaymentType_Href | String | Supported for: SELECT. A link to the instance |
PaymentType_Id | String | Supported for: SELECT. wid / id / reference id |
PurchaseOrderAmount_Currency | String | Supported for: SELECT. The Total Amount from Purchase Orders associated with the contract, either by contract line or header level reference. Orders that are canceled or denied are not included. The currency is the currency of the Supplier Contract. Landed costs are included. |
PurchaseOrderAmount_Value | Decimal | Supported for: SELECT. The Total Amount from Purchase Orders associated with the contract, either by contract line or header level reference. Orders that are canceled or denied are not included. The currency is the currency of the Supplier Contract. Landed costs are included. |
PurchaseOrderDefaultCompany_Descriptor | String | Supported for: SELECT. A preview of the instance |
PurchaseOrderDefaultCompany_Id | String | Supported for: SELECT. Id of the instance |
PurchaseOrderIssueOption_Descriptor | String | Supported for: SELECT. A description of the instance |
PurchaseOrderIssueOption_Href | String | Supported for: SELECT. A link to the instance |
PurchaseOrderIssueOption_Id | String | Supported for: SELECT. wid / id / reference id |
ReceiptAmount_Currency | String | Supported for: SELECT. The total received amount for the supplier contract in the contract currency. Workday excludes draft and in progress receipts when the option is selected for the company�s procurement options. Receipts from Purchase Orders are not included, nor are canceled or denied Receipts. |
ReceiptAmount_Value | Decimal | Supported for: SELECT. The total received amount for the supplier contract in the contract currency. Workday excludes draft and in progress receipts when the option is selected for the company�s procurement options. Receipts from Purchase Orders are not included, nor are canceled or denied Receipts. |
RenewalTerm | Decimal | Supported for: SELECT. The number of days/months/years the supplier contract is renewed for. |
RenewalTermFrequency_Descriptor | String | Supported for: SELECT. A description of the instance |
RenewalTermFrequency_Href | String | Supported for: SELECT. A link to the instance |
RenewalTermFrequency_Id | String | Supported for: SELECT. wid / id / reference id |
SendExpiryNotification | Bool | Supported for: SELECT. Returns true if the supplier contract is included in expiry supplier contract notifications |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContactDetail | String | Supported for: SELECT. The ship-to contact that populates on purchase orders for installments of this supplier contract. |
SignedDate | Datetime | Supported for: SELECT. The date the supplier contract was signed. This date is optional and doesn't affect the execution of the supplier contract. |
StartDate | Datetime | Supported for: SELECT. The date the supplier contract begins and is executable. The contract is valid and executable when the start date is on or before the date of the spend transaction. Example: When the purchase order date predates the contract start date, the contracted price of an item isn't applicable and the spend amount won't be recorded against the contract. |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
SupplierForSupplierInvoice_Descriptor | String | Supported for: SELECT. A description of the instance |
SupplierForSupplierInvoice_Href | String | Supported for: SELECT. A link to the instance |
SupplierForSupplierInvoice_Id | String | Supported for: SELECT. wid / id / reference id |
SupplierInvoiceDefaultCompany_Descriptor | String | Supported for: SELECT. A preview of the instance |
SupplierInvoiceDefaultCompany_Id | String | Supported for: SELECT. Id of the instance |
SupplierInvoiceReferenceNumber | String | Supported for: SELECT. The supplier invoice reference number on the supplier contract. |
Supplier_Descriptor | String | Supported for: SELECT. A description of the instance |
Supplier_Href | String | Supported for: SELECT. A link to the instance |
Supplier_Id | String | Supported for: SELECT. wid / id / reference id |
TotalAmount_Currency | String | Supported for: SELECT. The total contract amount of a supplier contract. This must be equal to, or greater than, the line extended amount. |
TotalAmount_Value | Decimal | Supported for: SELECT. The total contract amount of a supplier contract. This must be equal to, or greater than, the line extended amount. |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Reads catalogs entries from the SupplierContracts table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierContracts_Id [KEY] | String | The Wordkay ID of the SupplierContracts that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Reads chargeControls entries from the SupplierContracts table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierContracts_Id [KEY] | String | The Wordkay ID of the SupplierContracts that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
MaximumAmount_Currency | String | Supported for: SELECT. The maximum charge control amount of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. |
MaximumAmount_Value | Decimal | Supported for: SELECT. The maximum charge control amount of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. |
MinimumAmount_Currency | String | Supported for: SELECT. The minimum charge control amount of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. |
MinimumAmount_Value | Decimal | Supported for: SELECT. The minimum charge control amount of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Reads multiParticipants entries from the SupplierContracts table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierContracts_Id [KEY] | String | The Wordkay ID of the SupplierContracts that contains this |
Company_Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. True if the entry on Participant List for a Multi-Participant Contract is inactive. |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Reads multiSuppliers entries from the SupplierContracts table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierContracts_Id [KEY] | String | The Wordkay ID of the SupplierContracts that contains this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Inactive | Bool | Supported for: SELECT. Returns true if the entry on Supplier List for Multi-Supplier Contract is inactive. |
MarkupPercent | Decimal | Supported for: SELECT. The markup percent applied to the unit cost of supplier items associated to the supplier. |
Supplier_Descriptor | String | Supported for: SELECT. A description of the instance |
Supplier_Href | String | Supported for: SELECT. A link to the instance |
Supplier_Id | String | Supported for: SELECT. wid / id / reference id |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Reads serviceLines entries from the SupplierContracts table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ minimumAmount: Currency /* The \~minimum charge control amount\~ of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. */ maximumAmount: Currency /* The \~maximum charge control amount\~ of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ worktagType: { /* The worktag type. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierContracts_Id [KEY] | String | The Wordkay ID of the SupplierContracts that contains this |
ChargeControls_Aggregate | String | Supported for: SELECT. A JSON aggregate. The charge control rules applied to the transaction or transaction line. |
CompanyForInvoice_Descriptor | String | Supported for: SELECT. A preview of the instance |
CompanyForInvoice_Id | String | Supported for: SELECT. Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DoNotAutoRenew | Bool | Supported for: SELECT. True if the supplier contract line is marked as Do Not Auto Renew. The line checkbox is only editable when the supplier contract type allows Renewal Terms. |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. |
Item_Descriptor | String | Supported for: SELECT. A description of the instance |
Item_Href | String | Supported for: SELECT. A link to the instance |
Item_Id | String | Supported for: SELECT. wid / id / reference id |
LineDescription | String | Supported for: SELECT. The line item description for the document line. |
LineEndDate | Datetime | Supported for: SELECT. The end date of this Supplier Contract Line. |
LineIsCanceled | Bool | Supported for: SELECT. True if this Supplier Contract Line is canceled. Canceled contract lines can't be ordered, received, or invoiced. |
LineNumber | String | Supported for: SELECT. The line number of this Supplier Contract Line. |
LineOnHold | Bool | Supported for: SELECT. True if the supplier contract line is On Hold. You can't add On Hold lines to purchase orders, supplier invoices, receipts, or installments. Lines already associated with downstream documents can't be marked as On Hold. |
LineStartDate | Datetime | Supported for: SELECT. The start date of the Supplier Contract Line. |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The memo on the document line. |
RenewalAmount_Currency | String | Supported for: SELECT. The amount to be renewed for this Supplier Contract Line. When supplier contracts are auto-renewed, the renewal amount automatically persists on the renewed supplier contract line. |
RenewalAmount_Value | Decimal | Supported for: SELECT. The amount to be renewed for this Supplier Contract Line. When supplier contracts are auto-renewed, the renewal amount automatically persists on the renewed supplier contract line. |
Retention | Bool | Supported for: SELECT. Returns true if the Retention check box is selected on the line. |
ShipToAddress_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToAddress_Href | String | Supported for: SELECT. A link to the instance |
ShipToAddress_Id | String | Supported for: SELECT. wid / id / reference id |
ShipToContact_Descriptor | String | Supported for: SELECT. A description of the instance |
ShipToContact_Href | String | Supported for: SELECT. A link to the instance |
ShipToContact_Id | String | Supported for: SELECT. wid / id / reference id |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
TaxApplicability_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxApplicability_Href | String | Supported for: SELECT. A link to the instance |
TaxApplicability_Id | String | Supported for: SELECT. wid / id / reference id |
TaxCode_Descriptor | String | Supported for: SELECT. A description of the instance |
TaxCode_Href | String | Supported for: SELECT. A link to the instance |
TaxCode_Id | String | Supported for: SELECT. wid / id / reference id |
TaxRecoverabilities_Aggregate | String | Supported for: SELECT. A JSON aggregate. Tax Recoverabilities on a Taxable Document Line. |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. All worktags for the related business object. |
CompanyOrHierarchy_Prompt | String | Accepts multiple inputs. Filters the contracts by company or company hierarchy. Specify the Workday ID of the company or company hierarchy. |
ContractSpecialist_Prompt | String | Filters the contracts by the supplier contract specialist. Specify the Workday ID or reference ID of the specialist on the contract. |
ContractType_Prompt | String | Accepts multiple inputs. Filters the contracts by type. Specify the Workday ID of the contract type. |
EndDateOnOrAfter_Prompt | Date | Filters the contracts with an end date on or after the specified date. Use the yyyy-mm-dd format. |
EndDateOnOrBefore_Prompt | Date | Filters the contracts with an end date on or before the specified date. Use the yyyy-mm-dd format. |
ExternalSystemReference_Prompt | String | Accepts multiple inputs. Filters the contracts with the external system reference ID. |
OnHold_Prompt | Boolean | Filters the contracts that are on hold. |
StartDateOnOrAfter_Prompt | Date | Filters the contracts with a start date on or after the specified date. Use the yyyy-mm-dd format. |
StartDateOnOrBefore_Prompt | Date | Filters the contracts with a start date on or before the specified date. Use the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. Filters the contracts by status. Specify the Workday ID of the status. |
Supplier_Prompt | String | Accepts multiple inputs. Filters the contracts by the supplier. Specify the Workday ID of the supplier. |
Retrieves a single supplier invoice line instance.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierInvoiceRequests_Id [KEY] | String | The Workday ID of the SupplierInvoiceRequests that owns this |
Billable | Bool | Supported for: SELECT. True if a supplier invoice request line or line split is billable. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
ExtendedAmount_Currency | String | Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. |
ExtendedAmount_Value | Decimal | Supported for: SELECT. The extended amount for the document line. Excludes Extended Amounts on Tax Only Invoices. |
InternalMemo | String | Supported for: SELECT. The internal line memo for the supplier invoice request line. |
ItemDescription | String | Supported for: SELECT. The description of the item on the document line. This is a text-only value. |
Item_Descriptor | String | Supported for: SELECT. A description of the instance |
Item_Href | String | Supported for: SELECT. A link to the instance |
Item_Id | String | Supported for: SELECT. wid / id / reference id |
Memo | String | Supported for: SELECT. The memo on the document line. |
Quantity | Decimal | Supported for: SELECT. The quantity on the transaction line. This value can have 20 integer places, is precise to 2 decimal places, and can be negative. |
SpendCategory_Descriptor | String | Supported for: SELECT. A description of the instance |
SpendCategory_Href | String | Supported for: SELECT. A link to the instance |
SpendCategory_Id | String | Supported for: SELECT. wid / id / reference id |
SplitBy_Descriptor | String | Supported for: SELECT. A description of the instance |
SplitBy_Href | String | Supported for: SELECT. A link to the instance |
SplitBy_Id | String | Supported for: SELECT. wid / id / reference id |
Type | String | Supported for: SELECT. The line type of the supplier invoice request. |
UnitCost_Currency | String | Supported for: SELECT. The unit cost for the document line. |
UnitCost_Value | Decimal | Supported for: SELECT. The unit cost for the document line. |
UnitOfMeasure_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfMeasure_Href | String | Supported for: SELECT. A link to the instance |
UnitOfMeasure_Id | String | Supported for: SELECT. wid / id / reference id |
Company_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Reads itemIdentifiers entries from the SupplierInvoiceRequestsLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierInvoiceRequestsLines_Id [KEY] | String | The Wordkay ID of the SupplierInvoiceRequestsLines that contains this |
SupplierInvoiceRequests_Id [KEY] | String | The Workday ID of the SupplierInvoiceRequests that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Reads itemTags entries from the SupplierInvoiceRequestsLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierInvoiceRequestsLines_Id [KEY] | String | The Wordkay ID of the SupplierInvoiceRequestsLines that contains this |
SupplierInvoiceRequests_Id [KEY] | String | The Workday ID of the SupplierInvoiceRequests that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Reads splits entries from the SupplierInvoiceRequestsLines table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierInvoiceRequestsLines_Id [KEY] | String | The Wordkay ID of the SupplierInvoiceRequestsLines that contains this |
SupplierInvoiceRequests_Id [KEY] | String | The Workday ID of the SupplierInvoiceRequests that owns this |
Amount_Currency | String | Supported for: SELECT. The amount on the transaction line split. This value displays in the same currency as the business document. |
Amount_Value | Decimal | Supported for: SELECT. The amount on the transaction line split. This value displays in the same currency as the business document. |
Billable | Bool | Supported for: SELECT. True if the supplier invoice request line or line split are billable. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Memo | String | Supported for: SELECT. The memo for a line split |
Percent | Decimal | Supported for: SELECT. The percentage specified for the Business Document Line distribution line split. |
Quantity | Decimal | Supported for: SELECT. The quantity specified for the Business Document Line distribution line split. |
Worktags_Aggregate | String | Supported for: SELECT. A JSON aggregate. The accounting worktags for the line split. |
Company_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Reads worktags entries from the SupplierInvoiceRequestsLines table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
SupplierInvoiceRequestsLines_Id [KEY] | String | The Wordkay ID of the SupplierInvoiceRequestsLines that contains this |
SupplierInvoiceRequests_Id [KEY] | String | The Workday ID of the SupplierInvoiceRequests that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Company_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The company for the Common Financial Dimensions. This is for internal use only on a REST API. |
FromDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The beginning date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is the day from this invoice date. |
FromInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or after which the supplier invoice is created using the MM/DD/YYYY format. |
Requester_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The ID of the worker generating the supplier invoice request. |
Status_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The status of the supplier invoice request. This is for internal use only on a REST API. |
Supplier_Prompt | String | Only used when a SupplierInvoiceRequests_Id filter is not provided. Accepts multiple inputs. The supplier on the business documents. |
ToDueDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The end date of the payment due period for this supplier invoice request. Use the MM/DD/YYYY format. Example: When the payment term is Net 30, the due date value is 30 days from the invoice date. |
ToInvoiceDate_Prompt | Date | Only used when a SupplierInvoiceRequests_Id filter is not provided. The date on or before which the supplier invoice is created using the MM/DD/YYYY format. |
Retrieves system metrics.
Name | Type | Description |
ActiveUserSessions | Decimal | Supported for: SELECT. Count of active user sessions in the system. |
QueuedTasks | Decimal | Supported for: SELECT. The number of queued tasks in the system. |
RunningTasks | Decimal | Supported for: SELECT. Count of running tasks in the system. |
Retrieves a single or a collection of company SUI rates.
Name | Type | Description |
Id [KEY] | String | Unique identifier for company SUI rate. |
ApplicableRate | String | Supported for: SELECT. The applicable rate for the company SUI. |
CompanyInstance_Company | String | Supported for: SELECT. The Reference ID to use for lookups within our Workday Web Services. For supervisory organizations, this is also the Organization_ID. |
CompanyInstance_Descriptor | String | Supported for: SELECT. A preview of the instance |
CompanyInstance_Fein | String | Supported for: SELECT. The FEIN for the US company. |
CompanyInstance_Id | String | Supported for: SELECT. Id of the instance |
Ein | String | Supported for: SELECT. The EIN value for the company SUI rate. |
EinType | String | Supported for: SELECT. The EIN type. Valid values: SUI EIN, STATE EIN, FEIN. |
EndDate | String | Supported for: SELECT. The end date value of the row for company SUI rate. |
Exempt | Bool | Supported for: SELECT. If true, the SUI rate is exempt. |
RateType | String | Supported for: SELECT. The rate type. Valid values: OR for override rate, DR for default rate. |
StartDate | Datetime | Supported for: SELECT. The start date value of the row for company SUI rate. |
StateInstance_Descriptor | String | Supported for: SELECT. A preview of the instance |
StateInstance_Id | String | Supported for: SELECT. Id of the instance |
StateInstance_PayrollStateAuthorityTaxCode | String | Supported for: SELECT. The Payroll Authority Tax Code for a Payroll Tax Authority. |
TaxCode | String | Supported for: SELECT. The payroll tax code. As of v1, the default value is W_SUIER. |
Company_Prompt | String | The company reference ID or WID that represents 1 or more companies. Example: company=comp1andcompany=comp2andcompany=cb550da820584750aae8f807882fa79a |
Effective_Prompt | Date | The effective date for the SUI rate, using the yyyy-mm-dd format. |
PayrollStateAuthorityTaxCode_Prompt | String | The FIPS code or WID that represents 1 or more states. Example: payrollStateAuthorityTaxCode=06andpayrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee0703226andpayrollStateAuthorityTaxCode=48 |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time types for a given worker. |
InOutCodeOnly_Prompt | Boolean | If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event. |
Project_Prompt | String | The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project. |
Worker_Prompt | String | The Workday ID of the worker to look up time types for. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time types for a given worker. |
InOutCodeOnly_Prompt | Boolean | If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event. |
Project_Prompt | String | The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project. |
Worker_Prompt | String | The Workday ID of the worker to look up time types for. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time types for a given worker. |
InOutCodeOnly_Prompt | Boolean | If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event. |
Project_Prompt | String | The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project. |
Worker_Prompt | String | The Workday ID of the worker to look up time types for. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time types for a given worker. |
InOutCodeOnly_Prompt | Boolean | If true, returns only Time Entry Codes of the type In/Out. You must use these types with POST Time Clock Event. |
Project_Prompt | String | The Workday ID of a project, used to filter the projectPlanTasks resource down to project plan tasks from a given project. |
Worker_Prompt | String | The Workday ID of the worker to look up time types for. |
Retrieves a collection of time entry validations.
Name | Type | Description |
CriticalValidations | String | Supported for: SELECT. The critical validation messages separated by the line feed character (hex code in JSON). The validation messages indicate that the requested objects fail the configured critical custom validations. |
WarningValidations | String | Supported for: SELECT. The warning validation messages separated by the line feed character (hex code in JSON). The validation messages indicate that the requested objects fail the configured warning custom validations. |
Date_Prompt | Date | The required date that determines the time entry validations. The method validates the time entries within week or time period of the specified date. |
Worker_Prompt | String | The required Workday ID of the worker who entered the time entries. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time values for a given worker. |
Worker_Prompt | String | The Workday ID of the worker to look up time values for. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Date_Prompt | Date | The effective date to look up time values for a given worker. |
Worker_Prompt | String | The Workday ID of the worker to look up time values for. |
Retrieves a collection of workers and current staffing information.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Person_Email | String | Supported for: SELECT. Returns the public primary work email address for the worker. |
Person_Id | String | Supported for: SELECT. Id of the instance |
Person_Phone | String | Supported for: SELECT. Returns the primary public work phone number for the worker. |
PrimaryJob_BusinessTitle | String | Supported for: SELECT. The business title for the position. |
PrimaryJob_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_Id | String | Supported for: SELECT. Id of the instance |
PrimaryJob_JobProfile_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_JobProfile_Id | String | Supported for: SELECT. Id of the instance |
PrimaryJob_JobType_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_Location_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_Location_Id | String | Supported for: SELECT. Id of the instance |
PrimaryJob_SupervisoryOrganization_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_SupervisoryOrganization_Id | String | Supported for: SELECT. Id of the instance |
PrimaryJob_WorkSpace_Descriptor | String | Supported for: SELECT. A preview of the instance |
PrimaryJob_WorkSpace_Id | String | Supported for: SELECT. Id of the instance |
PrimaryJob_WorkSpace_LocationChain | String | Supported for: SELECT. Location chain including bread crumbs for location. |
WorkerId | String | Supported for: SELECT. The Employee ID or Contingent Worker ID for the worker. |
WorkerType_Descriptor | String | Supported for: SELECT. A description of the instance |
WorkerType_Href | String | Supported for: SELECT. A link to the instance |
WorkerType_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads additionalJobs entries from the Workers table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Wordkay ID of the Workers that contains this |
BusinessTitle | String | Supported for: SELECT. The business title for the position. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Descriptor | String | Supported for: SELECT. A preview of the instance |
JobProfile_Id | String | Supported for: SELECT. Id of the instance |
JobType_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Country_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Descriptor | String | Supported for: SELECT. A preview of the instance |
Location_Id | String | Supported for: SELECT. Id of the instance |
SupervisoryOrganization_Descriptor | String | Supported for: SELECT. A preview of the instance |
SupervisoryOrganization_Id | String | Supported for: SELECT. Id of the instance |
WorkSpace_Descriptor | String | Supported for: SELECT. A preview of the instance |
WorkSpace_Id | String | Supported for: SELECT. Id of the instance |
WorkSpace_LocationChain | String | Supported for: SELECT. Location chain including bread crumbs for location. |
Search_Prompt | String | Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads businessProcessParameters.attachments entries from the WorkersAnytimeFeedbackEvents table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersAnytimeFeedbackEvents_Id [KEY] | String | The Wordkay ID of the WorkersAnytimeFeedbackEvents that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
ContentType_Descriptor | String | Supported for: SELECT. A description of the instance |
ContentType_Href | String | Supported for: SELECT. A link to the instance |
ContentType_Id | String | Supported for: SELECT. wid / id / reference id |
Description | String | Supported for: SELECT. Event attachment description |
FileLength | Decimal | Supported for: SELECT. File length of the attachment |
FileName | String | Supported for: SELECT. File name of the attachment |
UploadDate | Datetime | Supported for: SELECT. Returns Date the Business Process Attachment was updated. |
UploadedBy_Descriptor | String | Supported for: SELECT. A description of the instance |
UploadedBy_Href | String | Supported for: SELECT. A link to the instance |
UploadedBy_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads businessProcessParameters.comments entries from the WorkersAnytimeFeedbackEvents table
Name | Type | Description |
WorkersAnytimeFeedbackEvents_Id | String | The Wordkay ID of the WorkersAnytimeFeedbackEvents that contains this |
Workers_Id | String | The Workday ID of the Workers that owns this |
Comment | String | Supported for: SELECT. Comment |
CommentDate | Datetime | Supported for: SELECT. Gives the moment at which the instance was originally created. |
Person_Descriptor | String | Supported for: SELECT. A description of the instance |
Person_Href | String | Supported for: SELECT. A link to the instance |
Person_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads feedbackAlsoAbout entries from the WorkersAnytimeFeedbackEvents table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersAnytimeFeedbackEvents_Id [KEY] | String | The Wordkay ID of the WorkersAnytimeFeedbackEvents that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads workersToNotify entries from the WorkersAnytimeFeedbackEvents table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersAnytimeFeedbackEvents_Id [KEY] | String | The Wordkay ID of the WorkersAnytimeFeedbackEvents that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a direct report instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
BusinessTitle | String | Supported for: SELECT. The business title for the worker's primary position. If no business title is defined for a position, the position title is returned back. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
IsManager | Bool | Supported for: SELECT. Identifies if the worker has a manager role. |
PrimarySupervisoryOrganization_Descriptor | String | Supported for: SELECT. A description of the instance |
PrimarySupervisoryOrganization_Href | String | Supported for: SELECT. A link to the instance |
PrimarySupervisoryOrganization_Id | String | Supported for: SELECT. wid / id / reference id |
PrimaryWorkEmail | String | Supported for: SELECT. The primary work email address for the worker. |
PrimaryWorkPhone | String | Supported for: SELECT. The primary work phone number for the worker including the area code and country code. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves the eligible absence type for the specified worker.
Name | Type | Description |
Id [KEY] | String | Workday ID |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
AbsenceTypeGroup_Descriptor | String | Supported for: SELECT. A preview of the instance |
AbsenceTypeGroup_DisplayOrder | String | Supported for: SELECT. Absence Type Group display order. |
AbsenceTypeGroup_Id | String | Supported for: SELECT. Id of the instance |
CalculateQuantityBasedOnStartAndEndTime | Bool | Supported for: SELECT. If true, the quantity is based on the start and end times for the time off type. |
Category_Descriptor | String | Supported for: SELECT. A description of the instance |
Category_Href | String | Supported for: SELECT. A link to the instance |
Category_Id | String | Supported for: SELECT. wid / id / reference id |
DailyDefaultQuantity | Decimal | Supported for: SELECT. Daily default quantity |
Descriptor | String | Supported for: SELECT. Descriptor for Coordinated Absence Type |
DisplayStartAndEndTime | Bool | Supported for: SELECT. If true, the time off type has start and end times enabled. |
EntryOption_Descriptor | String | Supported for: SELECT. A description of the instance |
EntryOption_Href | String | Supported for: SELECT. A link to the instance |
EntryOption_Id | String | Supported for: SELECT. wid / id / reference id |
PositionBased | Bool | Supported for: SELECT. If true, the time off type or leave type is position based. |
ReasonRequired | Bool | Supported for: SELECT. If true, the time off type, absence table, or leave type requires a reason. |
StartAndEndTimeRequired | Bool | Supported for: SELECT. If true, the start and end times are required for the time off type. |
UnitOfTime_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfTime_Href | String | Supported for: SELECT. A link to the instance |
UnitOfTime_Id | String | Supported for: SELECT. wid / id / reference id |
Category_Prompt | String | The Workday ID of the absence type category. Valid values: |
Effective_Prompt | Date | The effective date for which eligible absence types need to be returned for the worker. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads absenceReasons entries from the WorkersEligibleAbsenceTypes table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersEligibleAbsenceTypes_Id [KEY] | String | The Wordkay ID of the WorkersEligibleAbsenceTypes that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Category_Prompt | String | The Workday ID of the absence type category. Valid values: |
Effective_Prompt | Date | The effective date for which eligible absence types need to be returned for the worker. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads additionalFields entries from the WorkersEligibleAbsenceTypes table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersEligibleAbsenceTypes_Id [KEY] | String | The Wordkay ID of the WorkersEligibleAbsenceTypes that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Required | Bool | Supported for: SELECT. True if Leave Additional Fields are required. |
Category_Prompt | String | The Workday ID of the absence type category. Valid values: |
Effective_Prompt | Date | The effective date for which eligible absence types need to be returned for the worker. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads position entries from the WorkersEligibleAbsenceTypes table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersEligibleAbsenceTypes_Id [KEY] | String | The Wordkay ID of the WorkersEligibleAbsenceTypes that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Category_Prompt | String | The Workday ID of the absence type category. Valid values: |
Effective_Prompt | Date | The effective date for which eligible absence types need to be returned for the worker. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Get Explicit Skills for Skill Enabled
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
RemoteID | String | Supported for: SELECT. Remote Skill ID for associated Remote Skill Item |
SkillItem_Descriptor | String | Supported for: SELECT. A description of the instance |
SkillItem_Href | String | Supported for: SELECT. A link to the instance |
SkillItem_Id | String | Supported for: SELECT. wid / id / reference id |
SkillSource_Prompt | String | The Workday ID of the skill source. Returns skills associated with the skill source. |
Skill_Prompt | String | Retrieves the skills for the specified skill name. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads skillSources entries from the WorkersExplicitSkills table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersExplicitSkills_Id [KEY] | String | The Wordkay ID of the WorkersExplicitSkills that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
DateCreated | Datetime | Supported for: SELECT. The Creation Date of this Skill Item Source |
Descriptor | String | Supported for: SELECT. A preview of the instance |
SourceType | String | Supported for: SELECT. The Source Type of this Skill Item Source |
SourceTypeID | String | Supported for: SELECT. The Source Type's WID of this Skill Item Source |
SkillSource_Prompt | String | The Workday ID of the skill source. Returns skills associated with the skill source. |
Skill_Prompt | String | Retrieves the skills for the specified skill name. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a single goal instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
CompletedOn | Datetime | Supported for: SELECT. The date when the goal is completed. |
CreatedBy_Descriptor | String | Supported for: SELECT. A description of the instance |
CreatedBy_Href | String | Supported for: SELECT. A link to the instance |
CreatedBy_Id | String | Supported for: SELECT. wid / id / reference id |
Description | String | Supported for: SELECT. The description of the goal. |
DueDate | Datetime | Supported for: SELECT. The date when the goal is due. |
Name | String | Supported for: SELECT. The name of the goal. |
State | String | Supported for: SELECT. The state of the goal. Indicates why the goal is non-editable or why a user needs to take an action to successfully create or update the goal. Possible values: Pending approval, Associated with In Progress Review, Pending archival, Pending restore, Saved for later, and Needs revising. |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
Supports_Descriptor | String | Supported for: SELECT. A description of the instance |
Supports_Href | String | Supported for: SELECT. A link to the instance |
Supports_Id | String | Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | Supported for: SELECT. A description of the instance |
Worker_Href | String | Supported for: SELECT. A link to the instance |
Worker_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads activityStreamableItem entries from the WorkersGoals table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersGoals_Id [KEY] | String | The Wordkay ID of the WorkersGoals that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads associatedReviews entries from the WorkersGoals table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersGoals_Id [KEY] | String | The Wordkay ID of the WorkersGoals that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads category entries from the WorkersGoals table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersGoals_Id [KEY] | String | The Wordkay ID of the WorkersGoals that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Reads relatesTo entries from the WorkersGoals table
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkersGoals_Id [KEY] | String | The Wordkay ID of the WorkersGoals that contains this |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Type | String | Supported for: SELECT. The talent tag type for a goal. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a history instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Due | Datetime | Supported for: SELECT. The date the business process needs to be completed. |
Effective | Datetime | Supported for: SELECT. The date this business process takes effect. |
Href | String | Supported for: SELECT. A link to the instance |
Initiated | Datetime | Supported for: SELECT. The date and time this business process was initiated. |
Initiator_Descriptor | String | Supported for: SELECT. A description of the instance |
Initiator_Href | String | Supported for: SELECT. A link to the instance |
Initiator_Id | String | Supported for: SELECT. wid / id / reference id |
Subject_Descriptor | String | Supported for: SELECT. A description of the instance |
Subject_Href | String | Supported for: SELECT. A link to the instance |
Subject_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves an inbox task instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Assigned | Datetime | Supported for: SELECT. Returns the date when the event record was last updated on. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Due | Datetime | Supported for: SELECT. Returns the due date for this step. |
Href | String | Supported for: SELECT. A link to the instance |
Initiator_Descriptor | String | Supported for: SELECT. A description of the instance |
Initiator_Href | String | Supported for: SELECT. A link to the instance |
Initiator_Id | String | Supported for: SELECT. wid / id / reference id |
OverallProcess_Descriptor | String | Supported for: SELECT. A description of the instance |
OverallProcess_Href | String | Supported for: SELECT. A link to the instance |
OverallProcess_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
StepType_Descriptor | String | Supported for: SELECT. A description of the instance |
StepType_Href | String | Supported for: SELECT. A link to the instance |
StepType_Id | String | Supported for: SELECT. wid / id / reference id |
Subject_Descriptor | String | Supported for: SELECT. A description of the instance |
Subject_Href | String | Supported for: SELECT. A link to the instance |
Subject_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves the leave of absence for the specified worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
ActualLastDayOfLeave | Datetime | Supported for: SELECT. The Actual Last Day Of Work for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_AdoptionNotificationDate | Datetime | Supported for: SELECT. The Adoption Notification Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_AdoptionPlacementDate | Datetime | Supported for: SELECT. The Adoption Placement Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_AgeOfDependent | Decimal | Supported for: SELECT. The Age Of Dependent numerical additional field for the Leave Of Absence. |
AdditionalFields_CaesareanSectionBirth | Bool | Supported for: SELECT. If true, the Leave Of Absence indicates a caesarean section birth, which may impact worker's leave entitlements. |
AdditionalFields_ChildDisabilityIndicator | Bool | Supported for: SELECT. True if Child Disability Indicator is set on the leave event. You can enable it as an additional field when configuring the leave type. Child disability can impact some leave entitlements. |
AdditionalFields_ChildsBirthDate | Datetime | Supported for: SELECT. The Child's Birth Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_ChildsDateOfDeath | Datetime | Supported for: SELECT. The Child's Date Of Death additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_DateBabyArrivedHomeFromHospital | Datetime | Supported for: SELECT. The Date Baby Arrived Home From Hospital additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_DateChildEnteredCountry | Datetime | Supported for: SELECT. The Date Child Entered Country additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_DateOfRecall | Datetime | Supported for: SELECT. The Date Of Recall additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_Dependent_Descriptor | String | Supported for: SELECT. A description of the instance |
AdditionalFields_Dependent_Href | String | Supported for: SELECT. A link to the instance |
AdditionalFields_Dependent_Id | String | Supported for: SELECT. wid / id / reference id |
AdditionalFields_ExpectedDueDate | Datetime | Supported for: SELECT. The Expected Due Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_LastDateForWhichPaid | Datetime | Supported for: SELECT. The Last Date For Which Paid additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_LeaveEntitlementOverride | Decimal | Supported for: SELECT. The Leave Entitlement Override numerical additional field for the Leave Of Absence. |
AdditionalFields_LeavePercentage | Decimal | Supported for: SELECT. The Leave Percentage numerical additional field for the Leave Of Absence. |
AdditionalFields_LocationDuringLeave | String | Supported for: SELECT. The Location During Leave text additional field for the Leave Of Absence. |
AdditionalFields_MultipleChildIndicator | Bool | Supported for: SELECT. If true, the Leave Of Absence indicates multiple children, which may impact worker's leave entitlements. |
AdditionalFields_NumberOfBabiesAdoptedChildren | Decimal | Supported for: SELECT. The Number Of Babies Or Adopted Children numerical additional field for the Leave Of Absence. |
AdditionalFields_NumberOfChildDependents | Decimal | Supported for: SELECT. The Number Of Child Dependents numerical additional field for the Leave Of Absence. |
AdditionalFields_NumberOfPreviousBirths | Decimal | Supported for: SELECT. The Number Of Previous Births numerical additional field for the Leave Of Absence. |
AdditionalFields_NumberOfPreviousMaternityLeaves | Decimal | Supported for: SELECT. The Number Of Previous Maternity Leaves numerical additional field for the Leave Of Absence. |
AdditionalFields_SingleParentIndicator | Bool | Supported for: SELECT. If true, the Leave Of Absence indicates a single parent, which may impact worker's leave entitlements. |
AdditionalFields_SocialSecurityDisabilityCode | String | Supported for: SELECT. The Social Security Disability Code text additional field for the Leave Of Absence. |
AdditionalFields_StillbirthBabyDeceased | Bool | Supported for: SELECT. If true, the Leave Of Absence indicates a stillbirth or baby deceased, which may impact worker's leave entitlements. |
AdditionalFields_StopPaymentDate | Datetime | Supported for: SELECT. The Stop Payment Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_WeekOfConfinement | Datetime | Supported for: SELECT. The Week Of Confinement Date additional field for the Leave Of Absence using the yyyy-mm-dd format. |
AdditionalFields_WorkRelated | Bool | Supported for: SELECT. If true, the Leave Of Absence is work related, which may impact Record Of Employment in Canada. |
BusinessProcessStepStatus | String | Supported for: SELECT. The Business Process Step Status of the Leave Of Absence. |
EstimatedLastDayOfLeave | Datetime | Supported for: SELECT. The Estimated Last Day Of Leave of the Leave Of Absence using the yyyy-mm-dd format. |
FirstDayOfLeave | Datetime | Supported for: SELECT. The First Day Of Leave of the Leave Of Absence using the yyyy-mm-dd format. |
LastDayOfWork | Datetime | Supported for: SELECT. The Last Day Of Work of the Leave Of Absence using the yyyy-mm-dd format. |
LatestLeaveComment | String | Supported for: SELECT. The Latest Leave Comment of the Leave Of Absence. |
LeaveImpactFields_AbsenceAccrualEffect | Bool | Supported for: SELECT. If true, it impacts the worker's absence accrual. |
LeaveImpactFields_BenefitEffect | Bool | Supported for: SELECT. If true, it may require a change to the worker's benefits. |
LeaveImpactFields_ContinuousServiceAccrualEffect | Bool | Supported for: SELECT. If true, it has an impact on the worker's service accrual. It may need a manual change to the worker's service accrual. |
LeaveImpactFields_InactivateWorker | Bool | Supported for: SELECT. If true, the worker on leave will be inactivated in the Workday system. If the leave type is position-based, the worker will not be inactive unless the worker is on leave for all positions with this effect. |
LeaveImpactFields_PayrollEffect | Bool | Supported for: SELECT. If true, the Leave Of Absence event has an effect on payroll. |
LeaveImpactFields_ProfessionalLeaveEffect | Bool | Supported for: SELECT. If true, the Leave Of Absence event has a Professional Leave Effect leave impact field. |
LeaveImpactFields_SabbaticalEffect | Bool | Supported for: SELECT. If true, the Leave Of Absence event has an effect on sabbatical eligibility. It may require a manual change to a worker's sabbatical records. |
LeaveImpactFields_SchedulingEffect | Bool | Supported for: SELECT. True if the leave event is for a leave type that is configured to allow a�worker�to be scheduled to work when placed on leave. |
LeaveImpactFields_StockVestingEffect | Bool | Supported for: SELECT. If true, the Leave Of Absence event has an effect on the worker's stock vesting schedule. It may require a change to the vesting schedule of any stock grants that the worker holds. |
LeaveImpactFields_TalentEffect | Bool | Supported for: SELECT. If true, Workday removes the worker on this type of leave from the Worker prompt of select worker reviews and feedback in talent. |
LeaveImpactFields_TenureEffect | Bool | Supported for: SELECT. If true, the Leave Of Absence event has an effect on tenure eligibility. It may require a manual change to a worker's tenure records. |
LeaveType_Descriptor | String | Supported for: SELECT. A description of the instance |
LeaveType_Href | String | Supported for: SELECT. A link to the instance |
LeaveType_Id | String | Supported for: SELECT. wid / id / reference id |
Position_Descriptor | String | Supported for: SELECT. A description of the instance |
Position_Href | String | Supported for: SELECT. A link to the instance |
Position_Id | String | Supported for: SELECT. wid / id / reference id |
PriorLeaveEvent_Descriptor | String | Supported for: SELECT. A description of the instance |
PriorLeaveEvent_Href | String | Supported for: SELECT. A link to the instance |
PriorLeaveEvent_Id | String | Supported for: SELECT. wid / id / reference id |
Reason_Descriptor | String | Supported for: SELECT. A description of the instance |
Reason_Href | String | Supported for: SELECT. A link to the instance |
Reason_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | Supported for: SELECT. A description of the instance |
Worker_Href | String | Supported for: SELECT. A link to the instance |
Worker_Id | String | Supported for: SELECT. wid / id / reference id |
FromDate_Prompt | Date | The start of a date range filter using the yyyy-mm-dd format. |
LeaveType_Prompt | String | Accepts multiple inputs. The Workday ID of the type of Leave Of Absence. You can specify multiple leaveType query parameters. |
Status_Prompt | String | Accepts multiple inputs. The Workday ID of the status of the Leave Of Absence. The valid statuses are Successfully Completed, In Progress, Canceled, Rescinded, and Process Terminated. To get the Workday ID of a status, call the GET /values/leave/status endpoint. You can specify multiple status query parameters. |
ToDate_Prompt | Date | The end of a date range filter using the yyyy-mm-dd format. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves an organization instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
OrganizationType_Descriptor | String | Supported for: SELECT. A description of the instance |
OrganizationType_Href | String | Supported for: SELECT. A link to the instance |
OrganizationType_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a pay slip instance for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Date | Datetime | Supported for: SELECT. Payment Date |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Gross | Decimal | Supported for: SELECT. Gross Pay for a Payslip |
Href | String | Supported for: SELECT. A link to the instance |
Net | Decimal | Supported for: SELECT. Net Pay for a Payslip |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a period from the period schedule the worker is eligible for.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
CloseTimeEntry | Datetime | Supported for: SELECT. The date and time when the period is closed for time entry. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
LockTimeEntry | Datetime | Supported for: SELECT. The date and time when the period becomes locked out. |
OpenTimeEntry | Datetime | Supported for: SELECT. The date and time when the period is open for time entry. |
PaymentDate | Datetime | Supported for: SELECT. The payment date for periods whose period schedule's usage includes Payroll or Time Tracking without Payroll. |
PeriodEndDate | Datetime | Supported for: SELECT. The end date of the payroll period or the absence subperiod. |
PeriodStartDate | Datetime | Supported for: SELECT. The start date of the payroll period or the absence subperiod. |
UnlockTimeEntry | Datetime | Supported for: SELECT. The date and time when the period is unlocked for time adjustments. |
Date_Prompt | Date | The date on which the worker is eligible, using the yyyy-mm-dd format. If date isn't given it will default to the current Date. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a single service date information instance.
Name | Type | Description |
Workers_Id | String | The Workday ID of the Workers that owns this |
ContinuousServiceDate | Datetime | Supported for: SELECT. Worker service date taking into account breaks in service. |
HireDate | Datetime | Supported for: SELECT. The worker's most recent hire date. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
No description available
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
RemoteID | String | Supported for: SELECT. The remote skill ID of a skill. |
SkillName | String | Supported for: SELECT. The skill name that Workday bases similar skill suggestions on. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a supervisory organization managed by a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Code | String | Supported for: SELECT. The organization id for the organization. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
Manager_Descriptor | String | Supported for: SELECT. A description of the instance |
Manager_Href | String | Supported for: SELECT. A link to the instance |
Manager_Id | String | Supported for: SELECT. wid / id / reference id |
Name | String | Supported for: SELECT. The organization name for the organization. |
Workers | String | Supported for: SELECT. Contains the workers in the organization. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a collection of time off details for the specified worker.
Name | Type | Description |
Workers_Id | String | The Workday ID of the Workers that owns this |
Comment | String | Supported for: SELECT. The comment on the time off entry. |
Date | Datetime | Supported for: SELECT. The Date of the Time Off Entry using the format yyyy-mm-dd. |
Position_Descriptor | String | Supported for: SELECT. A description of the instance |
Position_Href | String | Supported for: SELECT. A link to the instance |
Position_Id | String | Supported for: SELECT. wid / id / reference id |
Quantity | Decimal | Supported for: SELECT. The Quantity of the Time Off Entry in the units specified by the Unit response field. |
Reason_Descriptor | String | Supported for: SELECT. A description of the instance |
Reason_Href | String | Supported for: SELECT. A link to the instance |
Reason_Id | String | Supported for: SELECT. wid / id / reference id |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
TimeOffType_Descriptor | String | Supported for: SELECT. The Time Off Type Name or Absence Table Name for Coordinated Time Off Entry. |
TimeOffType_Id | String | Supported for: SELECT. Id of the instance |
Unit_Descriptor | String | Supported for: SELECT. A description of the instance |
Unit_Href | String | Supported for: SELECT. A link to the instance |
Unit_Id | String | Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | Supported for: SELECT. A description of the instance |
Worker_Href | String | Supported for: SELECT. A link to the instance |
Worker_Id | String | Supported for: SELECT. wid / id / reference id |
FromDate_Prompt | Date | The start of a date range filter using the yyyy-mm-dd format. |
Status_Prompt | String | Accepts multiple inputs. The Workday ID of the time off status. You can specify multiple status query parameters. This method returns the most recent instance of a time off entry based on this query parameter. |
TimeOffType_Prompt | String | Accepts multiple inputs. The Workday ID of the Time Off Type. You can specify multiple timeOffType query parameters. |
ToDate_Prompt | Date | The end of a date range filter using the yyyy-mm-dd format. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a time off entry for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Date | Datetime | Supported for: SELECT. The date requested to be taken for a paid time off request line item. |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Employee_Descriptor | String | Supported for: SELECT. A description of the instance |
Employee_Href | String | Supported for: SELECT. A link to the instance |
Employee_Id | String | Supported for: SELECT. wid / id / reference id |
Href | String | Supported for: SELECT. A link to the instance |
TimeOffRequest_Descriptor | String | Supported for: SELECT. A preview of the instance |
TimeOffRequest_Href | String | Supported for: SELECT. A link to the instance |
TimeOffRequest_Id | String | Supported for: SELECT. Id of the instance |
TimeOffRequest_Status | String | Supported for: SELECT. The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
TimeOff_Descriptor | String | Supported for: SELECT. A preview of the instance |
TimeOff_Href | String | Supported for: SELECT. A link to the instance |
TimeOff_Id | String | Supported for: SELECT. Id of the instance |
TimeOff_Plan_Descriptor | String | Supported for: SELECT. A description of the instance |
TimeOff_Plan_Href | String | Supported for: SELECT. A link to the instance |
TimeOff_Plan_Id | String | Supported for: SELECT. wid / id / reference id |
UnitOfTime_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfTime_Href | String | Supported for: SELECT. A link to the instance |
UnitOfTime_Id | String | Supported for: SELECT. wid / id / reference id |
Units | Decimal | Supported for: SELECT. The units entered for a time off request line item for all status'. Excludes adjustments. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a particular time off plan for a specific worker.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
Workers_Id [KEY] | String | The Workday ID of the Workers that owns this |
Descriptor | String | Supported for: SELECT. A preview of the instance |
Href | String | Supported for: SELECT. A link to the instance |
TimeOffBalance | Decimal | Supported for: SELECT. Returns the time off balance including pending events for the worker and time off plan. This report field should be used within Calculated Fields. |
UnitOfTime_Descriptor | String | Supported for: SELECT. A description of the instance |
UnitOfTime_Href | String | Supported for: SELECT. A link to the instance |
UnitOfTime_Id | String | Supported for: SELECT. wid / id / reference id |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a summary of reported hours for a worker over a period.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ totalNumber: Numeric /* Contains the ordered number of this total calculation. */ quantity: Numeric /* Contains the calculated sum for this total. */ label: Text /* Contains the label for this total calculation. */ }]
Name | Type | Description |
Workers_Id | String | The Workday ID of the Workers that owns this |
CertifyText | String | Supported for: SELECT. Contains legal text the user must agree to in order to certify hours worked. |
PeriodLabel | String | Supported for: SELECT. Contains the summary of the date range and total reported hours of a period. |
SubmitText | String | Supported for: SELECT. Contains legal text the user must agree to in order to submit hours for review. |
Totals_Aggregate | String | Supported for: SELECT. A JSON aggregate. List of all Totals defined in Time Entry Template |
PeriodDate_Prompt | Date | Contains the specified date used to match to a period containing the date. The default is today's date. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
No description available
Name | Type | Description |
Id [KEY] | String | wid / id / reference id |
Descriptor | String | Supported for: SELECT. A description of the instance |
CollectionToken | String | Supported for: SELECT. Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
Workers_Prompt | String | Accepts multiple inputs. No description available |
Retrieves the valid time off dates for the specified worker.
Name | Type | Description |
Workers_Id | String | The Workday ID of the Workers that owns this |
DailyDefaultQuantity | Decimal | Supported for: SELECT. The daily default quantity configured on the Time Off Plan or as an override on the Time Off. |
Date | Datetime | Supported for: SELECT. The dates of the time off entry. |
Unit_Descriptor | String | Supported for: SELECT. A preview of the instance |
Unit_Id | String | Supported for: SELECT. Id of the instance |
Date_Prompt | Date | The dates being requested for which to validate using the yyyy-mm-dd format. |
Position_Prompt | String | The Workday ID of the Position. |
TimeOff_Prompt | String | The Workday ID of the Time Off. |
Search_Prompt | String | Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |
Retrieves a worker time block.
Name | Type | Description |
Id [KEY] | String | Id of the instance |
AllocationPool_Descriptor | String | Supported for: SELECT. A description of the instance |
AllocationPool_Href | String | Supported for: SELECT. A link to the instance |
AllocationPool_Id | String | Supported for: SELECT. wid / id / reference id |
Appropriation_Descriptor | String | Supported for: SELECT. A description of the instance |
Appropriation_Href | String | Supported for: SELECT. A link to the instance |
Appropriation_Id | String | Supported for: SELECT. wid / id / reference id |
BusinessUnit_Descriptor | String | Supported for: SELECT. A description of the instance |
BusinessUnit_Href | String | Supported for: SELECT. A link to the instance |
BusinessUnit_Id | String | Supported for: SELECT. wid / id / reference id |
CalendarDate | Datetime | Supported for: SELECT. The date for a reported time block. |
Comment | String | Supported for: SELECT. The comment associated with the reported time block. |
CostCenter_Descriptor | String | Supported for: SELECT. A description of the instance |
CostCenter_Href | String | Supported for: SELECT. A link to the instance |
CostCenter_Id | String | Supported for: SELECT. wid / id / reference id |
Currency_Descriptor | String | Supported for: SELECT. A description of the instance |
Currency_Href | String | Supported for: SELECT. A link to the instance |
Currency_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization01_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization01_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization01_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization02_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization02_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization02_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization03_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization03_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization03_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization04_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization04_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization04_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization05_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization05_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization05_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization06_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization06_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization06_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization07_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization07_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization07_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization08_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization08_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization08_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization09_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization09_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization09_Id | String | Supported for: SELECT. wid / id / reference id |
CustomOrganization10_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomOrganization10_Href | String | Supported for: SELECT. A link to the instance |
CustomOrganization10_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag01_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag01_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag01_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag02_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag02_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag02_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag03_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag03_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag03_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag04_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag04_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag04_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag05_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag05_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag05_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag06_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag06_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag06_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag07_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag07_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag07_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag08_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag08_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag08_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag09_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag09_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag09_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag10_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag10_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag10_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag11_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag11_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag11_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag12_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag12_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag12_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag13_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag13_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag13_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag14_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag14_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag14_Id | String | Supported for: SELECT. wid / id / reference id |
CustomWorktag15_Descriptor | String | Supported for: SELECT. A description of the instance |
CustomWorktag15_Href | String | Supported for: SELECT. A link to the instance |
CustomWorktag15_Id | String | Supported for: SELECT. wid / id / reference id |
Descriptor | String | Supported for: SELECT. A preview of the instance |
DoNotBill | Bool | Supported for: SELECT. The non-billable flag for a reported time block. |
Fund_Descriptor | String | Supported for: SELECT. A description of the instance |
Fund_Href | String | Supported for: SELECT. A link to the instance |
Fund_Id | String | Supported for: SELECT. wid / id / reference id |
Gift_Descriptor | String | Supported for: SELECT. A description of the instance |
Gift_Href | String | Supported for: SELECT. A link to the instance |
Gift_Id | String | Supported for: SELECT. wid / id / reference id |
Grant_Descriptor | String | Supported for: SELECT. A description of the instance |
Grant_Href | String | Supported for: SELECT. A link to the instance |
Grant_Id | String | Supported for: SELECT. wid / id / reference id |
InTime | Datetime | Supported for: SELECT. The in time for a reported time block. |
InTimeZone_Descriptor | String | Supported for: SELECT. A description of the instance |
InTimeZone_Href | String | Supported for: SELECT. A link to the instance |
InTimeZone_Id | String | Supported for: SELECT. wid / id / reference id |
JobProfile_Descriptor | String | Supported for: SELECT. A description of the instance |
JobProfile_Href | String | Supported for: SELECT. A link to the instance |
JobProfile_Id | String | Supported for: SELECT. wid / id / reference id |
Location_Descriptor | String | Supported for: SELECT. A description of the instance |
Location_Href | String | Supported for: SELECT. A link to the instance |
Location_Id | String | Supported for: SELECT. wid / id / reference id |
OutReason_Descriptor | String | Supported for: SELECT. A description of the instance |
OutReason_Href | String | Supported for: SELECT. A link to the instance |
OutReason_Id | String | Supported for: SELECT. wid / id / reference id |
OutTime | Datetime | Supported for: SELECT. The out time for a reported time block. |
OutTimeZone_Descriptor | String | Supported for: SELECT. A description of the instance |
OutTimeZone_Href | String | Supported for: SELECT. A link to the instance |
OutTimeZone_Id | String | Supported for: SELECT. wid / id / reference id |
OverrideRate | Decimal | Supported for: SELECT. The override rate for a reported time block. |
Position_Descriptor | String | Supported for: SELECT. A description of the instance |
Position_Href | String | Supported for: SELECT. A link to the instance |
Position_Id | String | Supported for: SELECT. wid / id / reference id |
Program_Descriptor | String | Supported for: SELECT. A description of the instance |
Program_Href | String | Supported for: SELECT. A link to the instance |
Program_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectPlanPhase_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectPlanPhase_Href | String | Supported for: SELECT. A link to the instance |
ProjectPlanPhase_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectPlanTask_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectPlanTask_Href | String | Supported for: SELECT. A link to the instance |
ProjectPlanTask_Id | String | Supported for: SELECT. wid / id / reference id |
ProjectRole_Descriptor | String | Supported for: SELECT. A description of the instance |
ProjectRole_Href | String | Supported for: SELECT. A link to the instance |
ProjectRole_Id | String | Supported for: SELECT. wid / id / reference id |
Project_Descriptor | String | Supported for: SELECT. A description of the instance |
Project_Href | String | Supported for: SELECT. A link to the instance |
Project_Id | String | Supported for: SELECT. wid / id / reference id |
Region_Descriptor | String | Supported for: SELECT. A description of the instance |
Region_Href | String | Supported for: SELECT. A link to the instance |
Region_Id | String | Supported for: SELECT. wid / id / reference id |
ReportedQuantity | Decimal | Supported for: SELECT. The hours or units entered for a reported time block. |
Status_Descriptor | String | Supported for: SELECT. A description of the instance |
Status_Href | String | Supported for: SELECT. A link to the instance |
Status_Id | String | Supported for: SELECT. wid / id / reference id |
TimeEntryCode_Descriptor | String | Supported for: SELECT. A description of the instance |
TimeEntryCode_Href | String | Supported for: SELECT. A link to the instance |
TimeEntryCode_Id | String | Supported for: SELECT. wid / id / reference id |
Unit_Descriptor | String | Supported for: SELECT. A description of the instance |
Unit_Href | String | Supported for: SELECT. A link to the instance |
Unit_Id | String | Supported for: SELECT. wid / id / reference id |
Worker_Descriptor | String | Supported for: SELECT. A description of the instance |
Worker_Href | String | Supported for: SELECT. A link to the instance |
Worker_Id | String | Supported for: SELECT. wid / id / reference id |
FromDate_Prompt | Date | The start date of the time block date range, using the yyyy-mm-dd format. |
Phase_Prompt | String | Accepts multiple inputs. The Workday ID of the project plan phase for the time block. |
ProjectPlanTask_Prompt | String | Accepts multiple inputs. The Workday ID of the project plan task for the time block. |
Project_Prompt | String | Accepts multiple inputs. The Workday ID of the project for the time block. |
Status_Prompt | String | Accepts multiple inputs. The Workday ID of the approval status of the worker time block. Valid IDs are: |
ToDate_Prompt | Date | The end date of the time block date range, using the yyyy-mm-dd format. |
Worker_Prompt | String | Accepts multiple inputs. The Workday ID of the worker for the time block. Specify workers that the user has permission to access. |
Reads calculatedTimeDetails entries from the WorkerTimeBlocks table
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Id [KEY] | String | Id of the instance |
WorkerTimeBlocks_Id [KEY] | String | The Wordkay ID of the WorkerTimeBlocks that contains this |
CalculatedDate | Datetime | Supported for: SELECT. The calculated date for a time block. |
CalculatedInTimeZone_Descriptor | String | Supported for: SELECT. A description of the instance |
CalculatedInTimeZone_Href | String | Supported for: SELECT. A link to the instance |
CalculatedInTimeZone_Id | String | Supported for: SELECT. wid / id / reference id |
CalculatedOutTimeZone_Descriptor | String | Supported for: SELECT. A description of the instance |
CalculatedOutTimeZone_Href | String | Supported for: SELECT. A link to the instance |
CalculatedOutTimeZone_Id | String | Supported for: SELECT. wid / id / reference id |
CalculatedQuantity | Decimal | Supported for: SELECT. The calculated hours or units for a time block. |
CalculationTags_Aggregate | String | Supported for: SELECT. A JSON aggregate. Calculation Tags generated by Time Calculations. Blank if not a Calculated Time Block. |
CalendarDate | Datetime | Supported for: SELECT. The calendar date for a time block. |
Currency_Descriptor | String | Supported for: SELECT. A description of the instance |
Currency_Href | String | Supported for: SELECT. A link to the instance |
Currency_Id | String | Supported for: SELECT. wid / id / reference id |
OverrideRate | Decimal | Supported for: SELECT. The calculated override rate for a time block. |
ShiftDate | Datetime | Supported for: SELECT. The shift date for a time block. |
FromDate_Prompt | Date | The start date of the time block date range, using the yyyy-mm-dd format. |
Phase_Prompt | String | Accepts multiple inputs. The Workday ID of the project plan phase for the time block. |
ProjectPlanTask_Prompt | String | Accepts multiple inputs. The Workday ID of the project plan task for the time block. |
Project_Prompt | String | Accepts multiple inputs. The Workday ID of the project for the time block. |
Status_Prompt | String | Accepts multiple inputs. The Workday ID of the approval status of the worker time block. Valid IDs are: |
ToDate_Prompt | Date | The end date of the time block date range, using the yyyy-mm-dd format. |
Worker_Prompt | String | Accepts multiple inputs. The Workday ID of the worker for the time block. Specify workers that the user has permission to access. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Workday.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Workday, along with an indication of whether the procedure succeeded or failed.
Name | Description |
BeginHomeContactInformationChange | Creates a new Home Contact Change business process event for the parent Person. |
BeginJobChange | Initiates a job change request for a specific worker |
BeginOrganizationAssignmentChange | Creates a new change organization assignment event for a specific filled or unfilled position, which returns a new change organization assignment ID. Specify the new ID in subsequent requests that update or get information about the change organization assignment event. |
BeginWorkContactInformationChange | Creates a new Home Contact Change business process event for the parent Person. |
CreateMentorshipForMe | Creates a mentorship for the current processing worker where the user is also the mentee. |
CreateMentorshipForWorker | Creates a mentorship between two workers. |
ElectronicReportingRuns | The Electronic Reporting service enables applications to create information on electronic reporting of customer and supplier invoice documents. |
EventStepsApprove | Approves a business process event step. |
EventStepsDeny | Denies a business process event step. |
EventStepsQuestionnaire | Post an action for a Complete Questionnaire step in a business process. |
EventStepsSendBack | Sends back a business process event step. |
EventStepsToDo | Post an action for a To Do step in a business process. |
ExecuteSOAPOperation | Sends a request to directly invoke a SOAP operation. |
ExpenseEntriesAttachments | Creates new attachments for the existing expense entry. |
ExpenseReportsLines | Creates a collection of expense report lines. |
ExpenseReportsSubmit | No description available |
ImmigrationEventsSubmit | Submits an immigration event. |
MentorshipsClose | Closes the mentorship. |
MentorshipsEdit | Edit the mentorship. |
PhoneValidation | Validates phone number data to ensure it is valid for Workday. |
Programs | Creates a single benefit program instance. |
ProjectsEdit | Creates Project Edit Events and initiates the associated workflow to update the project. |
RequestsClose | Closes a request. |
RequisitionsCancel | Cancels an existing requisition. |
RequisitionsClose | Closes a specified completed requisition. |
RequisitionsRequisitionEvents | Submit Requisition to Business Process |
ResourcePlanLinesEdit | Creates a Resource Plan Line Edit event and initiates the Project Resource Plan Line business process. |
RunBudgetCheck | Creates a budget check for transactions. |
SendMessage | No description available |
SendSupplierInvoiceAttachmentsForScanning | Sends supplier invoice attachments for scanning. |
SubmitHomeContactInformationChange | Submits the specified home contact information change ID. |
SubmitJobChange | Submits the specified change job ID. |
SubmitOrganizationAssignmentChange | Submits the organization assignment change event for the specified ID, and initiates the Change Organization Assignment business process. |
SubmitWorkContactInformationChange | Submits the specified work contact information change ID. |
SupplierInvoiceRequestsSubmit | Submits a single supplier invoice instance. |
ValidateWorktags | Validates worktags. |
WorkersOrganizationAssignmentChanges | Initiates an organization assignment change for a specific worker. |
WorkersRequestOneTimePayment | Request a one-time payment for a worker with the specified ID. |
WorkersRequestTimeOff | Creates a time off request for the specified worker ID and initiates the business process. |
WorkersTimeReviewEvents | Creates a Time Review Event or Time Review Events. |
Creates a new Home Contact Change business process event for the parent Person.
Name | Type | Description |
Worker_Id | String | The ID of the worker to execute this process on |
Descriptor | String | A preview of the instance |
EffectiveDate | Datetime | The date this business process takes effect. |
Href | String | The URL to the related change home contact information resource where this event can be interacted with via REST |
Id | String | Id of the instance |
Name | Type | Description |
HomeContactInformationChange_Id | String | The ID of the change process. Use this ID to update pending change data and submit the change. |
Initiates a job change request for a specific worker
Name | Type | Description |
Worker_Id | String | The ID of the worker to execute this process on |
Date | Datetime | The date this business process takes effect. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Job_Id | String | wid / id / reference id |
Location_Id | String | wid / id / reference id |
Reason_Id | String | wid / id / reference id |
SupervisoryOrganization_Id | String | wid / id / reference id |
Template_Id | String | wid / id / reference id |
Name | Type | Description |
JobChange_Id | String | The ID of the change process. Use this ID to update pending change data and submit the change. |
Creates a new change organization assignment event for a specific filled or unfilled position, which returns a new change organization assignment ID. Specify the new ID in subsequent requests that update or get information about the change organization assignment event.
Name | Type | Description |
Date | Datetime | The effective date of the business process event using the yyyy-mm-dd format. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
MassActionHeader_Id | String | wid / id / reference id |
MassActionWorksheet_Id | String | wid / id / reference id |
Position_Id | String | wid / id / reference id |
Name | Type | Description |
OrganizationAssignmentChange_Id | String | The ID of the change process. Use this ID to update pending change data and submit the change. |
Creates a new Home Contact Change business process event for the parent Person.
Name | Type | Description |
Worker_Id | String | The ID of the worker to execute this process on |
Descriptor | String | A preview of the instance |
EffectiveDate | Datetime | The date this business process takes effect. |
Href | String | The URL to the related change work contact information resource where this event can be interacted with via REST. |
Id | String | Id of the instance |
Name | Type | Description |
WorkContactInformationChange_Id | String | The ID of the change process. Use this ID to update pending change data and submit the change. |
Creates a mentorship for the current processing worker where the user is also the mentee.
Name | Type | Description |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Id | String | Id of the instance |
MentorType_Id | String | wid / id / reference id |
Mentor_Id | String | wid / id / reference id |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
MentorType_Descriptor | String | A description of the instance |
MentorType_Href | String | A link to the instance |
MentorType_Id | String | wid / id / reference id |
Mentor_Descriptor | String | A description of the instance |
Mentor_Href | String | A link to the instance |
Mentor_Id | String | wid / id / reference id |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Creates a mentorship between two workers.
Name | Type | Description |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Id | String | Id of the instance |
Mentee_Id | String | wid / id / reference id |
MentorType_Id | String | wid / id / reference id |
Mentor_Id | String | wid / id / reference id |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Mentee_Descriptor | String | A description of the instance |
Mentee_Href | String | A link to the instance |
Mentee_Id | String | wid / id / reference id |
MentorType_Descriptor | String | A description of the instance |
MentorType_Href | String | A link to the instance |
MentorType_Id | String | wid / id / reference id |
Mentor_Descriptor | String | A description of the instance |
Mentor_Href | String | A link to the instance |
Mentor_Id | String | wid / id / reference id |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
The Electronic Reporting service enables applications to create information on electronic reporting of customer and supplier invoice documents.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ id: Text /* Id of the instance */ }]
Name | Type | Description |
FileName | String | The name of the file created for tax authorities to fulfil reporting requirements. |
Id | String | Id of the instance |
IntegrationEvent | String | integrationEvent |
IntegrationEventEndDate | Datetime | The End Date of the reporting period. |
IntegrationEventStartDate | Datetime | The Start Date of the reporting period. |
InvoiceDocuments_Aggregate | String | A JSON aggregate. The customer or supplier invoice document associated with the electronic reporting file |
Name | Type | Description |
Id | String | Id of the instance |
FileName | String | The name of the file created for tax authorities to fulfil reporting requirements. |
IntegrationEvent | String | integrationEvent |
IntegrationEventEndDate | Datetime | The End Date of the reporting period. |
IntegrationEventStartDate | Datetime | The Start Date of the reporting period. |
InvoiceDocuments_Aggregate | String | A JSON aggregate. The customer or supplier invoice document associated with the electronic reporting file |
Approves a business process event step.
Name | Type | Description |
EventSteps_Id | String | The ID of the resource to execute this process on |
Comment | String | Returns user's comment for Event Record. |
Descriptor | String | A preview of the instance |
EventStatus_Id | String | wid / id / reference id |
Id | String | Id of the instance |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Returns user's comment for Event Record. |
Descriptor | String | A preview of the instance |
EventStatus_Descriptor | String | A description of the instance |
EventStatus_Href | String | A link to the instance |
EventStatus_Id | String | wid / id / reference id |
Denies a business process event step.
Name | Type | Description |
EventSteps_Id | String | The ID of the resource to execute this process on |
Comment | String | Returns user's comment for Event Record. |
Descriptor | String | A preview of the instance |
EventStatus_Id | String | wid / id / reference id |
Id | String | Id of the instance |
StepAction_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Returns user's comment for Event Record. |
Descriptor | String | A preview of the instance |
EventStatus_Descriptor | String | A description of the instance |
EventStatus_Href | String | A link to the instance |
EventStatus_Id | String | wid / id / reference id |
StepAction_Descriptor | String | A description of the instance |
StepAction_Href | String | A link to the instance |
StepAction_Id | String | wid / id / reference id |
Post an action for a Complete Questionnaire step in a business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ questionnaireAttachments: [{ fileName: Text /* File name of the attachment */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } fileLength: Numeric /* File length of the attachment */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] answerMultipleChoices: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] answerNumeric: Numeric /* The answer in a numeric format. */ answerText: Text /* The text answer for a questionnaire. */ answerDate: Date /* The answer in a date format. */ questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
EventSteps_Id | String | The ID of the resource to execute this process on |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
QuestionnaireResponse_Descriptor | String | A preview of the instance |
QuestionnaireResponse_Id | String | Id of the instance |
QuestionnaireResponse_QuestionnaireAnswers_Aggregate | String | A JSON aggregate. The set of answers for a questionnaire. |
QuestionnaireResponse_QuestionnaireTargetContext_Id | String | wid / id / reference id |
QuestionnaireResponse_QuestionnaireTarget_Id | String | wid / id / reference id |
StepAction_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
QuestionnaireResponse_Descriptor | String | A preview of the instance |
QuestionnaireResponse_Id | String | Id of the instance |
QuestionnaireResponse_QuestionnaireAnswers_Aggregate | String | A JSON aggregate. The set of answers for a questionnaire. |
QuestionnaireResponse_QuestionnaireTargetContext_Descriptor | String | A description of the instance |
QuestionnaireResponse_QuestionnaireTargetContext_Href | String | A link to the instance |
QuestionnaireResponse_QuestionnaireTargetContext_Id | String | wid / id / reference id |
QuestionnaireResponse_QuestionnaireTarget_Descriptor | String | A description of the instance |
QuestionnaireResponse_QuestionnaireTarget_Href | String | A link to the instance |
QuestionnaireResponse_QuestionnaireTarget_Id | String | wid / id / reference id |
StepAction_Descriptor | String | A description of the instance |
StepAction_Href | String | A link to the instance |
StepAction_Id | String | wid / id / reference id |
Sends back a business process event step.
Name | Type | Description |
EventSteps_Id | String | The ID of the resource to execute this process on |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Reason | String | Returns user's comment for Event Record. |
Status_Id | String | wid / id / reference id |
To_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
Reason | String | Returns user's comment for Event Record. |
Status_Descriptor | String | A description of the instance |
Status_Href | String | A link to the instance |
Status_Id | String | wid / id / reference id |
To_Descriptor | String | A description of the instance |
To_Href | String | A link to the instance |
To_Id | String | wid / id / reference id |
Post an action for a To Do step in a business process.
Name | Type | Description |
EventSteps_Id | String | The ID of the resource to execute this process on |
Comment | String | Last Comment |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
StepAction_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Last Comment |
Descriptor | String | A preview of the instance |
StepAction_Descriptor | String | A description of the instance |
StepAction_Href | String | A link to the instance |
StepAction_Id | String | wid / id / reference id |
Sends a request to directly invoke a SOAP operation.
Name | Type | Description |
Service | String | The Workday service name. |
Request | String | The XML request to send to the SOAP API. |
Name | Type | Description |
Response | String | The XML content of the body, or NULL if a SOAP error was reported. |
FaultCode | String | The SOAP error code, or NULL if there was no SOAP error response. |
FaultString | String | The SOAP error, or NULL if there was no SOAP error response. |
Creates new attachments for the existing expense entry.
Name | Type | Description |
ExpenseEntries_Id | String | The ID of the resource to execute this process on |
ContentType_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
FileLength | Decimal | File length of the attachment |
FileName | String | File name of the attachment |
Href | String | A link to the instance |
Id | String | Id of the instance |
Name | Type | Description |
Id | String | Id of the instance |
ContentType_Descriptor | String | A description of the instance |
ContentType_Href | String | A link to the instance |
ContentType_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
FileLength | Decimal | File length of the attachment |
FileName | String | File name of the attachment |
Href | String | A link to the instance |
Creates a collection of expense report lines.
Name | Type | Description |
ExpenseReports_Id | String | The ID of the resource to execute this process on |
CreditCardTransaction_Id | String | wid / id / reference id |
Date | Datetime | Date the Expense Report Line was created |
Descriptor | String | A preview of the instance |
ExpenseItem_Id | String | wid / id / reference id |
Id | String | Id of the instance |
Memo | String | Memo for the Expense Report Line |
QuickExpense_Id | String | wid / id / reference id |
TotalAmount_Currency | String | Total amount to be reimbursed to the requestee |
TotalAmount_Value | Decimal | Total amount to be reimbursed to the requestee |
TravelBookingRecord_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
CreditCardTransaction_Descriptor | String | A description of the instance |
CreditCardTransaction_Href | String | A link to the instance |
CreditCardTransaction_Id | String | wid / id / reference id |
Date | Datetime | Date the Expense Report Line was created |
Descriptor | String | A preview of the instance |
ExpenseItem_Descriptor | String | A description of the instance |
ExpenseItem_Href | String | A link to the instance |
ExpenseItem_Id | String | wid / id / reference id |
Memo | String | Memo for the Expense Report Line |
QuickExpense_Descriptor | String | A description of the instance |
QuickExpense_Href | String | A link to the instance |
QuickExpense_Id | String | wid / id / reference id |
TotalAmount_Currency | String | Total amount to be reimbursed to the requestee |
TotalAmount_Value | Decimal | Total amount to be reimbursed to the requestee |
TravelBookingRecord_Descriptor | String | A description of the instance |
TravelBookingRecord_Href | String | A link to the instance |
TravelBookingRecord_Id | String | wid / id / reference id |
No description available
Name | Type | Description |
ExpenseReports_Id | String | The ID of the resource to execute this process on |
Descriptor | String | A preview of the instance |
ExpenseReport_Id | String | wid / id / reference id |
Id | String | Id of the instance |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
ExpenseReport_Descriptor | String | A description of the instance |
ExpenseReport_Href | String | A link to the instance |
ExpenseReport_Id | String | wid / id / reference id |
Submits an immigration event.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ relationshipToStudent: { /* The dependent�s relationship to the student. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } sevisIssueDate: Date /* The issue date of the SEVIS ID for the student�s dependent. */ middleName: Text /* The middle name of the student�s dependent. */ lastName: Text /* The last name of the student�s dependent. */ sevisExpirationDate: Date /* The expiration date of the SEVIS ID for the student�s dependent. */ firstName: Text /* The first name of the student�s dependent. */ countryOfBirth: { /* The \~Country\~ of birth for the student�s dependent. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } sevisId: Text /* The SEVIS ID of the student�s dependent. */ dateOfBirth: Date /* The student dependent�s date of birth. */ countryOfCitizenship: { /* The \~Country\~ of citizenship for the student�s dependent. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } immigrationStatus: { /* The immigration status of the student�s dependent. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
ImmigrationEvents_Id | String | The ID of the resource to execute this process on |
Application_Id | String | wid / id / reference id |
DependentImmigrationData_Aggregate | String | A JSON aggregate. The student dependent immigration data instances for the student immigration data. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
ImmigrationData_ActiveSevisId | String | The current active SEVIS ID for the student immigration data. |
ImmigrationData_ActiveVisaType_Id | String | wid / id / reference id |
ImmigrationData_Descriptor | String | A preview of the instance |
ImmigrationData_Id | String | Id of the instance |
ImmigrationData_IssuingInstitution_Id | String | wid / id / reference id |
Status | String | The status of the immigration event. |
Name | Type | Description |
Id | String | Id of the instance |
Application_Descriptor | String | A description of the instance |
Application_Href | String | A link to the instance |
Application_Id | String | wid / id / reference id |
DependentImmigrationData_Aggregate | String | A JSON aggregate. The student dependent immigration data instances for the student immigration data. |
Descriptor | String | A preview of the instance |
ImmigrationData_ActiveSevisId | String | The current active SEVIS ID for the student immigration data. |
ImmigrationData_ActiveVisaType_Descriptor | String | A description of the instance |
ImmigrationData_ActiveVisaType_Href | String | A link to the instance |
ImmigrationData_ActiveVisaType_Id | String | wid / id / reference id |
ImmigrationData_Descriptor | String | A preview of the instance |
ImmigrationData_Id | String | Id of the instance |
ImmigrationData_IssuingInstitution_Descriptor | String | A description of the instance |
ImmigrationData_IssuingInstitution_Href | String | A link to the instance |
ImmigrationData_IssuingInstitution_Id | String | wid / id / reference id |
Status | String | The status of the immigration event. |
Closes the mentorship.
Name | Type | Description |
Mentorships_Id | String | The ID of the resource to execute this process on |
CloseMentorshipReason_Id | String | wid / id / reference id |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Id | String | Id of the instance |
StartDate | Datetime | The proposed Start date for the mentorship. |
Name | Type | Description |
Id | String | Id of the instance |
CloseMentorshipReason_Descriptor | String | A description of the instance |
CloseMentorshipReason_Href | String | A link to the instance |
CloseMentorshipReason_Id | String | wid / id / reference id |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Edit the mentorship.
Name | Type | Description |
Mentorships_Id | String | The ID of the resource to execute this process on |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Id | String | Id of the instance |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The proposed End date for the mentorship. |
Purpose | String | Returns the proposed purpose for the mentorship. |
StartDate | Datetime | The proposed Start date for the mentorship. |
Validates phone number data to ensure it is valid for Workday.
Name | Type | Description |
CompletePhoneNumber | String | The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | A preview of the instance |
CountryPhoneCode_Country_Id | String | Id of the instance |
CountryPhoneCode_Descriptor | String | A preview of the instance |
CountryPhoneCode_Id | String | Id of the instance |
DeviceType_Descriptor | String | A preview of the instance |
DeviceType_Id | String | Id of the instance |
Name | Type | Description |
CompletePhoneNumber | String | The complete phone number. |
CountryPhoneCode_CountryPhoneCode | String | The phone code for a country. |
CountryPhoneCode_Country_Descriptor | String | A preview of the instance |
CountryPhoneCode_Country_Id | String | Id of the instance |
CountryPhoneCode_Descriptor | String | A preview of the instance |
CountryPhoneCode_Id | String | Id of the instance |
DeviceType_Descriptor | String | A preview of the instance |
DeviceType_Id | String | Id of the instance |
Creates a single benefit program instance.
Name | Type | Description |
AdminNotes | String | Descriptive text from the benefit program partner to Workday administrators about the benefit program. |
Description | String | The text description of the benefit program that the employee sees on the program card. Charater limit: 375 or less. |
EndDate | Datetime | The date when the benefit program ends. Must be after the start date. |
Id | String | Id of the instance |
Image_AlternativeText | String | Specify a description of the image in the Alternative Text field for users of assistive technology. |
Image_ContentType_Id | String | wid / id / reference id |
Image_FileLength | Decimal | length of the file |
Image_FileName | String | Name of the file |
Image_Id | String | Id of the instance |
ProgramPartner_Id | String | wid / id / reference id |
StartDate | Datetime | The date when the benefit program begins. Must be before the end date. |
Title | String | The title of the benefit program card. Character limit: 40 or less. |
Url | String | A external or internal web link to the benefit program that must begin with http or https. |
UrlAlias | String | A text string that masks the URL to simplify the URL, making it shorter and easier to use. |
Name | Type | Description |
Id | String | Id of the instance |
AdminNotes | String | Descriptive text from the benefit program partner to Workday administrators about the benefit program. |
Description | String | The text description of the benefit program that the employee sees on the program card. Charater limit: 375 or less. |
EndDate | Datetime | The date when the benefit program ends. Must be after the start date. |
Image_AlternativeText | String | Specify a description of the image in the Alternative Text field for users of assistive technology. |
Image_ContentType_Descriptor | String | A description of the instance |
Image_ContentType_Href | String | A link to the instance |
Image_ContentType_Id | String | wid / id / reference id |
Image_FileLength | Decimal | length of the file |
Image_FileName | String | Name of the file |
Image_Id | String | Id of the instance |
ProgramPartner_Descriptor | String | A description of the instance |
ProgramPartner_Href | String | A link to the instance |
ProgramPartner_Id | String | wid / id / reference id |
StartDate | Datetime | The date when the benefit program begins. Must be before the end date. |
Title | String | The title of the benefit program card. Character limit: 40 or less. |
Url | String | A external or internal web link to the benefit program that must begin with http or https. |
UrlAlias | String | A text string that masks the URL to simplify the URL, making it shorter and easier to use. |
Creates Project Edit Events and initiates the associated workflow to update the project.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ delayedDate: Date /* The date the delayed step will trigger. */ businessProcessStep: { /* Retired. We retire this report field because it doesn't return all the steps on the business process definition that are associated with the business process event step. A business process event step can be associated with multiple steps from the business process definition if those steps were automatically skipped. Example: Entry conditions to those steps aren't met. We recommend that you use the Steps report field instead. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } businessEventValidation: [{ conditionRule: Text /* The condition rule as a text expression. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] status: { /* The status of this business process step. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } event: { /* Identifies the business process and allows you to drill into the details and access related actions. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } completedByPerson: { /* The person that completed the step as Assignee */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } completedOn: Date /* The date when this step was completed */ due: Date /* Returns the due date for this step. */ creationDate: Date /* The date when the event record was created. */ awaitingPersons: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] comments: [{ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } conmentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ }] descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Projects_Id | String | The ID of the resource to execute this process on |
Billable | Bool | True if the project is billable. |
BusinessEventRecords_Aggregate | String | A JSON aggregate. All event records for the latest Edit Project event. |
Capital | Bool | True if the project is capital. |
Company_Id | String | wid / id / reference id |
Currency_Descriptor | String | A preview of the instance |
Currency_Id | String | Id of the instance |
Customer_Id | String | wid / id / reference id |
Description | String | The description of the project. |
EndDate | Datetime | The approved project end date. |
EstimatedBudget_Currency | String | The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedBudget_Value | Decimal | The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedRevenueSavings_Currency | String | The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
EstimatedRevenueSavings_Value | Decimal | The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
ExternalLink | String | The link to an external site. |
ExternalProjectReference | String | Returns the external project reference. |
Groups_Aggregate | String | A JSON aggregate. Identifies the project groups of a project. Project groups are used to organize projects for worktag prompting. |
Href | String | A link to the instance |
Id | String | Id of the instance |
ImportanceRating_Id | String | wid / id / reference id |
InScope | String | A description of what is considered to be in scope for the project. |
Inactive | Bool | True if the current project or the associated project hierarchy is inactive. |
IncludeProjectIDInName | Bool | Indicates whether to display the ID in the Project name. |
MeasuresOfSuccess | String | A description of what the project will be measured against to determine if it is successful. |
Name | String | The approved project name. |
Objective | String | A description of the desired outcome of the project. |
OutOfScope | String | A description of what is considered to be out of scope for the project. |
Overview | String | Project overview describing additional details about the project |
Owner_Id | String | wid / id / reference id |
PercentComplete | Decimal | The percent complete for the project. |
Priority_Id | String | wid / id / reference id |
ProbabilityOfSuccess | Decimal | The number indicating the probability of project success. |
ProblemStatement | String | A description of the problem to be resolved by the project. |
ProjectDependencies_Aggregate | String | A JSON aggregate. Contains the list of projects defined as dependencies to the project. |
RealizedRevenueSavings_Currency | String | The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RealizedRevenueSavings_Value | Decimal | The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RiskLevel_Id | String | wid / id / reference id |
StartDate | Datetime | Start Date |
Status_Id | String | wid / id / reference id |
SuccessRating_Id | String | wid / id / reference id |
Worktags_Aggregate | String | A JSON aggregate. Worktags |
Name | Type | Description |
Id | String | Id of the instance |
Billable | Bool | True if the project is billable. |
BusinessEventRecords_Aggregate | String | A JSON aggregate. All event records for the latest Edit Project event. |
Capital | Bool | True if the project is capital. |
Company_Descriptor | String | A description of the instance |
Company_Href | String | A link to the instance |
Company_Id | String | wid / id / reference id |
Currency_Descriptor | String | A preview of the instance |
Currency_Id | String | Id of the instance |
Customer_Descriptor | String | A description of the instance |
Customer_Href | String | A link to the instance |
Customer_Id | String | wid / id / reference id |
Description | String | The description of the project. |
EndDate | Datetime | The approved project end date. |
EstimatedBudget_Currency | String | The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedBudget_Value | Decimal | The estimated budget allocated to the project, as defined in the project financials summary. Workday provides the amount in the project currency. |
EstimatedRevenueSavings_Currency | String | The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
EstimatedRevenueSavings_Value | Decimal | The estimated revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
ExternalLink | String | The link to an external site. |
ExternalProjectReference | String | Returns the external project reference. |
Groups_Aggregate | String | A JSON aggregate. Identifies the project groups of a project. Project groups are used to organize projects for worktag prompting. |
Href | String | A link to the instance |
ImportanceRating_Descriptor | String | A description of the instance |
ImportanceRating_Href | String | A link to the instance |
ImportanceRating_Id | String | wid / id / reference id |
InScope | String | A description of what is considered to be in scope for the project. |
Inactive | Bool | True if the current project or the associated project hierarchy is inactive. |
IncludeProjectIDInName | Bool | Indicates whether to display the ID in the Project name. |
MeasuresOfSuccess | String | A description of what the project will be measured against to determine if it is successful. |
Name | String | The approved project name. |
Objective | String | A description of the desired outcome of the project. |
OutOfScope | String | A description of what is considered to be out of scope for the project. |
Overview | String | Project overview describing additional details about the project |
Owner_Descriptor | String | A description of the instance |
Owner_Href | String | A link to the instance |
Owner_Id | String | wid / id / reference id |
PercentComplete | Decimal | The percent complete for the project. |
Priority_Descriptor | String | A description of the instance |
Priority_Href | String | A link to the instance |
Priority_Id | String | wid / id / reference id |
ProbabilityOfSuccess | Decimal | The number indicating the probability of project success. |
ProblemStatement | String | A description of the problem to be resolved by the project. |
ProjectDependencies_Aggregate | String | A JSON aggregate. Contains the list of projects defined as dependencies to the project. |
RealizedRevenueSavings_Currency | String | The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RealizedRevenueSavings_Value | Decimal | The actual revenue (billable project) or savings (non-billable project) gained from the project and expressed in the project currency. |
RiskLevel_Descriptor | String | A description of the instance |
RiskLevel_Href | String | A link to the instance |
RiskLevel_Id | String | wid / id / reference id |
StartDate | Datetime | Start Date |
Status_Descriptor | String | A description of the instance |
Status_Href | String | A link to the instance |
Status_Id | String | wid / id / reference id |
SuccessRating_Descriptor | String | A description of the instance |
SuccessRating_Href | String | A link to the instance |
SuccessRating_Id | String | wid / id / reference id |
TotalSavingsRemaining_Currency | String | The total amount of savings remaining in project currency. |
TotalSavingsRemaining_Value | Decimal | The total amount of savings remaining in project currency. |
Worktags_Aggregate | String | A JSON aggregate. Worktags |
Closes a request.
Name | Type | Description |
Requests_Id | String | The ID of the resource to execute this process on |
Comment | String | Latest Comment for the Request Event of the Request |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
RequestID | String | Request ID |
RequestSubtype_Descriptor | String | A preview of the instance |
RequestSubtype_Id | String | Id of the instance |
ResolutionDetails_Descriptor | String | A preview of the instance |
ResolutionDetails_Id | String | Id of the instance |
Resolution_Id | String | wid / id / reference id |
WorkdayObjectValue_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Comment | String | Latest Comment for the Request Event of the Request |
Descriptor | String | A preview of the instance |
RequestID | String | Request ID |
RequestSubtype_Descriptor | String | A preview of the instance |
RequestSubtype_Id | String | Id of the instance |
ResolutionDetails_Descriptor | String | A preview of the instance |
ResolutionDetails_Id | String | Id of the instance |
Resolution_Descriptor | String | A description of the instance |
Resolution_Href | String | A link to the instance |
Resolution_Id | String | wid / id / reference id |
WorkdayObjectValue_Descriptor | String | A description of the instance |
WorkdayObjectValue_Href | String | A link to the instance |
WorkdayObjectValue_Id | String | wid / id / reference id |
Cancels an existing requisition.
Name | Type | Description |
Requisitions_Id | String | The ID of the resource to execute this process on |
Comments | String | Comments for canceling a requisition. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
ReasonCode_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Comments | String | Comments for canceling a requisition. |
Descriptor | String | A preview of the instance |
ReasonCode_Descriptor | String | A description of the instance |
ReasonCode_Href | String | A link to the instance |
ReasonCode_Id | String | wid / id / reference id |
Closes a specified completed requisition.
Name | Type | Description |
Requisitions_Id | String | The ID of the resource to execute this process on |
Comments | String | The comments provided when closing or canceling a requisition. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
ReasonCode_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Comments | String | The comments provided when closing or canceling a requisition. |
Descriptor | String | A preview of the instance |
ReasonCode_Descriptor | String | A description of the instance |
ReasonCode_Href | String | A link to the instance |
ReasonCode_Id | String | wid / id / reference id |
Submit Requisition to Business Process
Name | Type | Description |
Requisitions_Id | String | The ID of the resource to execute this process on |
AutoComplete | Bool | Yes if the event autocompleted from a web service or by selecting the Enable Autocomplete check box on the business process definition. |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Name | Type | Description |
Id | String | Id of the instance |
AutoComplete | Bool | Yes if the event autocompleted from a web service or by selecting the Enable Autocomplete check box on the business process definition. |
Comment | String | Returns the comment for the last event record done by the processing person, without security filtering. If no comment was entered, the result will be empty. This CRF is for Integration use only. |
Descriptor | String | A preview of the instance |
Creates a Resource Plan Line Edit event and initiates the Project Resource Plan Line business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ delayedDate: Date /* The date the delayed step will trigger. */ businessProcessStep: { /* Retired. We retire this report field because it doesn't return all the steps on the business process definition that are associated with the business process event step. A business process event step can be associated with multiple steps from the business process definition if those steps were automatically skipped. Example: Entry conditions to those steps aren't met. We recommend that you use the Steps report field instead. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } businessEventValidation: [{ conditionRule: Text /* The condition rule as a text expression. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] status: { /* The status of this business process step. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } event: { /* Identifies the business process and allows you to drill into the details and access related actions. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } completedByPerson: { /* The person that completed the step as Assignee */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } completedOn: Date /* The date when this step was completed */ due: Date /* Returns the due date for this step. */ creationDate: Date /* The date when the event record was created. */ awaitingPersons: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] comments: [{ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } conmentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ }] descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
[{ values: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] category: { /* The requirement category for the \~project role\~. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } optional: Boolean /* The optional status of a requirement. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
ResourcePlanLines_Id | String | The ID of the resource to execute this process on |
BookingStatus_Id | String | wid / id / reference id |
BusinessEventRecords_Aggregate | String | A JSON aggregate. project resource plan business event for rest api |
CostRateCurrencyOverride_Id | String | wid / id / reference id |
CostRateOverride_Currency | String | Cost Rate Override |
CostRateOverride_Value | Decimal | Cost Rate Override |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The date the resource plan line ends. |
EstimatedHours | Decimal | The total number of work hours estimated for the role on project resource plan line. |
ExcludedWorkers_Aggregate | String | A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line. |
Id | String | Id of the instance |
JobRequisition_Id | String | wid / id / reference id |
Memo | String | memo |
PercentAllocation | Decimal | The percent allocation of the worker's time on the project in their assigned role for the resource plan line. |
ProjectResources_Aggregate | String | A JSON aggregate. The workers and unnamed resources assigned to the resource plan line. |
Requirements_Aggregate | String | A JSON aggregate. Contains the specific requirements by category for the project role. |
ResourceType_Id | String | wid / id / reference id |
RoleCategory_Id | String | wid / id / reference id |
Role_Id | String | wid / id / reference id |
StartDate | Datetime | The date the resource plan line starts. |
ToBeHired | Bool | Returns true if the resource plan line requires a worker a resource still needs to be hired. |
UnnamedResources | Decimal | The unnamed resource assigned as a placeholder on the resource plan. |
WorkerGroup_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
BookingStatus_Descriptor | String | A description of the instance |
BookingStatus_Href | String | A link to the instance |
BookingStatus_Id | String | wid / id / reference id |
BusinessEventRecords_Aggregate | String | A JSON aggregate. project resource plan business event for rest api |
CostRateCurrencyOverride_Descriptor | String | A description of the instance |
CostRateCurrencyOverride_Href | String | A link to the instance |
CostRateCurrencyOverride_Id | String | wid / id / reference id |
CostRateOverride_Currency | String | Cost Rate Override |
CostRateOverride_Value | Decimal | Cost Rate Override |
Descriptor | String | A preview of the instance |
EndDate | Datetime | The date the resource plan line ends. |
EstimatedHours | Decimal | The total number of work hours estimated for the role on project resource plan line. |
ExcludedWorkers_Aggregate | String | A JSON aggregate. The workers in the selected worker group who are excluded from assignment to the resource plan line. |
JobRequisition_Descriptor | String | A description of the instance |
JobRequisition_Href | String | A link to the instance |
JobRequisition_Id | String | wid / id / reference id |
Memo | String | memo |
PendingWorkers_Aggregate | String | A JSON aggregate. Contains the workers event pending approval to be added to the resource plan line. |
PercentAllocation | Decimal | The percent allocation of the worker's time on the project in their assigned role for the resource plan line. |
ProjectResources_Aggregate | String | A JSON aggregate. The workers and unnamed resources assigned to the resource plan line. |
Requirements_Aggregate | String | A JSON aggregate. Contains the specific requirements by category for the project role. |
ResourceType_Descriptor | String | A description of the instance |
ResourceType_Href | String | A link to the instance |
ResourceType_Id | String | wid / id / reference id |
RoleCategory_Descriptor | String | A description of the instance |
RoleCategory_Href | String | A link to the instance |
RoleCategory_Id | String | wid / id / reference id |
Role_Descriptor | String | A description of the instance |
Role_Href | String | A link to the instance |
Role_Id | String | wid / id / reference id |
StartDate | Datetime | The date the resource plan line starts. |
ToBeHired | Bool | Returns true if the resource plan line requires a worker a resource still needs to be hired. |
UnnamedResources | Decimal | The unnamed resource assigned as a placeholder on the resource plan. |
WorkerGroup_Descriptor | String | A description of the instance |
WorkerGroup_Href | String | A link to the instance |
WorkerGroup_Id | String | wid / id / reference id |
Creates a budget check for transactions.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ transactionAmount: Currency /* The Transaction Amount for the budget check transaction. */ planInformation: [{ spendAmount: Currency /* The Current Spend Amount for the \~plan\~ with budget check enabled. */ ledgerAccountOrLedgerSummary: { /* The Ledger Account or Ledger Account Summary for the \~plan\~ with budget check enabled. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } lineStatus: { /* The budget check status for each \~plan\~ with budget check enabled, for each transaction line. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } planAmount: Currency /* The Current \~Plan\~ Amount from the \~plan\~ with budget check enabled. */ plan: { /* The \~Plan\~ with budget check enabled. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } currency: { /* The company base Currency for the transaction amount. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } accountingWorktagsOrAggregationDimension: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] availableAmount: Currency /* The Available Amount for the \~plan\~ with budget check enabled. */ aggregatedTransactionAmount: Currency /* The Aggregated Transaction Amount for the \~plan\~ line with budget check enabled. */ }] ledgerAccount: { /* The Transaction Ledger Account for the budget check transaction. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } accountingWorktags: [{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] currency: { /* The company base Currency for the budget check transaction. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } bookCode: { /* The Transaction Book Code for the budget check transaction. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } }]
Name | Type | Description |
Company_Descriptor | String | A preview of the instance |
Company_Id | String | Id of the instance |
InflightTransactionDate | Datetime | The transaction Date for the budget check transaction. |
OverallStatus_Descriptor | String | A preview of the instance |
OverallStatus_Id | String | Id of the instance |
TransactionLines_Aggregate | String | A JSON aggregate. The transaction Lines for the Budget Check transaction. |
Name | Type | Description |
Company_Descriptor | String | A preview of the instance |
Company_Id | String | Id of the instance |
InflightTransactionDate | Datetime | The transaction Date for the budget check transaction. |
OverallStatus_Descriptor | String | A preview of the instance |
OverallStatus_Id | String | Id of the instance |
TransactionLines_Aggregate | String | A JSON aggregate. The transaction Lines for the Budget Check transaction. |
No description available
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
CommID_Id | String | wid / id / reference id |
EmailDetail_Body | String | Message content of the email. |
EmailDetail_Name | String | Email Configuration Data container for REST API. |
EmailDetail_ReplyTo | String | Reply To |
EmailDetail_Subject | String | Email subject line. |
MessageTemplate_Id | String | wid / id / reference id |
NotificationType_Id | String | wid / id / reference id |
PushDetail_Id | String | Id of the instance |
PushDetail_Message | String | Message content of a push notification. |
PushDetail_RedirectURL | String | The URL to launch the appropriate mobile app upon acknowledgement. |
Recipients_Contacts_Aggregate | String | A JSON aggregate. Recipients for the Send Message. This CRF supports any instance of type superclass Workday Connect Subscriber, 1$17306. |
SenderOverride_Id | String | wid / id / reference id |
Name | Type | Description |
CommID_Descriptor | String | A description of the instance |
CommID_Href | String | A link to the instance |
CommID_Id | String | wid / id / reference id |
EmailDetail_Body | String | Message content of the email. |
EmailDetail_Name | String | Email Configuration Data container for REST API. |
EmailDetail_ReplyTo | String | Reply To |
EmailDetail_Subject | String | Email subject line. |
MessageTemplate_Descriptor | String | A description of the instance |
MessageTemplate_Href | String | A link to the instance |
MessageTemplate_Id | String | wid / id / reference id |
NotificationType_Descriptor | String | A description of the instance |
NotificationType_Href | String | A link to the instance |
NotificationType_Id | String | wid / id / reference id |
PushDetail_Id | String | Id of the instance |
PushDetail_Message | String | Message content of a push notification. |
PushDetail_RedirectURL | String | The URL to launch the appropriate mobile app upon acknowledgement. |
Recipients_Contacts_Aggregate | String | A JSON aggregate. Recipients for the Send Message. This CRF supports any instance of type superclass Workday Connect Subscriber, 1$17306. |
SenderOverride_Descriptor | String | A description of the instance |
SenderOverride_Href | String | A link to the instance |
SenderOverride_Id | String | wid / id / reference id |
Sends supplier invoice attachments for scanning.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ additionalFields: [{ configurableAttribute: { /* The configurable attribute associated to configurable attribute value */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } attributeValue: Text /* The configurable attribute value */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] company: { /* The company for the reporting transaction. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } workQueueNotes: Rich Text /* The work queue notes assigned to OCR supplier invoice root for processing. */ assignee: { /* The \~worker\~ assigned to ocr supplier invoice root for processing. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } receivedDate: Date /* The date an invoice is received. */ ocrHighPriority: Boolean /* True if the OCR supplier invoice root is high priority. */ attachments: [{ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } fileLength: Numeric /* File length of the attachment. */ fileName: Text /* File name of the attachment. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }] externalSupplierInvoiceSource: { /* The External Supplier Invoice Source assigned to ocr supplier invoice root for processing. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } externalReference: Text /* External Reference for Supplier Invoice */ supplierInvoiceReferenceID: Text /* The Supplier Invoice ID value is used for duplicate checking invoices that come from integrations. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
OcrSupplierInvoices_Aggregate | String | A JSON aggregate. Container for OCR Supplier Invoice Root. |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
OcrSupplierInvoices_Aggregate | String | A JSON aggregate. Container for OCR Supplier Invoice Root. |
Submits the specified home contact information change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | Description |
HomeContactInformationChange_Id | String | The ID of the change process. This value must be the same as the output from the BeginHomeContactInformationChange procedure. |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Name | Type | Description |
BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
Submits the specified change job ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | Description |
JobChange_Id | String | The ID of the change process. This value must be the same as the output from the BeginJobChange procedure. |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Status_Id | String | wid / id / reference id |
Validation | String | Validation message for an action event triggered by a condition. |
Name | Type | Description |
BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
Submits the organization assignment change event for the specified ID, and initiates the Change Organization Assignment business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | Description |
OrganizationAssignmentChange_Id | String | The ID of the change process. This value must be the same as the output from the BeginOrganizationAssignmentChange procedure. |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Name | Type | Description |
BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
Submits the specified work contact information change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ } fileLength: Numeric /* File length of the attachment */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ } id: Text /* Id of the instance */ }]
Name | Type | Description |
WorkContactInformationChange_Id | String | The ID of the change process. This value must be the same as the output from the BeginWorkContactInformationChange procedure. |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Name | Type | Description |
BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
Submits a single supplier invoice instance.
Name | Type | Description |
SupplierInvoiceRequests_Id | String | The ID of the resource to execute this process on |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
Validates worktags.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ worktagWithRestrictedToValues: { /* For REST API responses only. Worktags that are configured with Restricted To values. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } invalidRestrictedToValues: [{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ href: Text /* A link to the instance */ }] }]
[{ invalidWorktagValues: [{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }] worktagWithAllowedValues: { /* For REST API responses only. Worktags that are configured with allowed values. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ missingWorktagTypes: [{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }] worktagWithRequiredWorktags: { /* For REST API responses only. Worktags configured with required worktag types in their related worktags. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ href: Text /* A link to the instance */ }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
[{ id: Text /* Id of the instance */ href: Text /* A link to the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
AllowBuiltInWorktags | String | When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. Example: Supplier in Supplier Invoice. |
InvalidRestrictionsForWorktags_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates invalid restrictions for a worktag configured with Restricted To values. Use the Worktag With Restricted To Values and Invalid Restricted To Values report fields to view the values. |
InvalidWorktagCombinations_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one combination of worktag values aren't allowed with one another. Use the Worktag with Allowed Values and Invalid Worktag Values report fields to view the values. |
MissingRequiredWorktagTypesAfterDefaulting_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as �Required� for the Taggable Configuration is missing in the request and not added by default from related worktags. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values. |
MissingRequiredWorktagTypesForTaggableConfig_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as �Required� for the Taggable Configuration is missing in the request. |
MissingRequiredWorktagTypesForWorktags_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as required in related worktags is missing. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values. |
NonAllowedInactiveWorktagValues_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one inactive worktag was sent in the request that wasn't allowed by the Taggable Configuration. |
NonAllowedWorktagTypesForTaggableConfig_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type sent in the request isn't allowed by the Taggable Configuration. |
OnlyOneProjectOrPhaseOrTaskAllowed | String | When returned in a REST API response, indicates that there is more than one worktag for a Project in the request. Only one worktag type of Project, Project Phase or Project Task is allowed. |
Restrictions_Aggregate | String | A JSON aggregate. For REST API requests only. Values that are validated for worktag types configured with 'Restricted To' values. Example: Company for a cost center configured with Restricted To Companies. |
Status | String | The status in the REST API response that indicates whether the worktags sent in the request have validation errors or not. |
TaggableConfiguration_Id | String | wid / id / reference id |
ValidationTypes_Aggregate | String | A JSON aggregate. For REST API requests only. The validation types to include in the response. If this request parameter is missing or empty, all validation types are included in the response. |
Worktags_Aggregate | String | A JSON aggregate. The worktags sent in a REST API request to be validated based on the configuration in the 'Maintain Worktag Usage' and 'Maintain Related Worktag Usage' tasks. Validations consider required and allowed worktag types, allowed values, and whether inactive values are allowed. |
Name | Type | Description |
AllowBuiltInWorktags | String | When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. Example: Supplier in Supplier Invoice. |
InvalidRestrictionsForWorktags_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates invalid restrictions for a worktag configured with Restricted To values. Use the Worktag With Restricted To Values and Invalid Restricted To Values report fields to view the values. |
InvalidWorktagCombinations_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one combination of worktag values aren't allowed with one another. Use the Worktag with Allowed Values and Invalid Worktag Values report fields to view the values. |
MissingRequiredWorktagTypesAfterDefaulting_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as �Required� for the Taggable Configuration is missing in the request and not added by default from related worktags. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values. |
MissingRequiredWorktagTypesForTaggableConfig_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as �Required� for the Taggable Configuration is missing in the request. |
MissingRequiredWorktagTypesForWorktags_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type configured as required in related worktags is missing. Use the Worktag With Required Worktags and Missing Required Worktag Types report fields to view the values. |
NonAllowedInactiveWorktagValues_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one inactive worktag was sent in the request that wasn't allowed by the Taggable Configuration. |
NonAllowedWorktagTypesForTaggableConfig_Aggregate | String | A JSON aggregate. When returned in a REST API response, indicates that at least one worktag type sent in the request isn't allowed by the Taggable Configuration. |
OnlyOneProjectOrPhaseOrTaskAllowed | String | When returned in a REST API response, indicates that there is more than one worktag for a Project in the request. Only one worktag type of Project, Project Phase or Project Task is allowed. |
Restrictions_Aggregate | String | A JSON aggregate. For REST API requests only. Values that are validated for worktag types configured with 'Restricted To' values. Example: Company for a cost center configured with Restricted To Companies. |
Status | String | The status in the REST API response that indicates whether the worktags sent in the request have validation errors or not. |
TaggableConfiguration_Descriptor | String | A description of the instance |
TaggableConfiguration_Href | String | A link to the instance |
TaggableConfiguration_Id | String | wid / id / reference id |
ValidationTypes_Aggregate | String | A JSON aggregate. For REST API requests only. The validation types to include in the response. If this request parameter is missing or empty, all validation types are included in the response. |
Worktags_Aggregate | String | A JSON aggregate. The worktags sent in a REST API request to be validated based on the configuration in the 'Maintain Worktag Usage' and 'Maintain Related Worktag Usage' tasks. Validations consider required and allowed worktag types, allowed values, and whether inactive values are allowed. |
Initiates an organization assignment change for a specific worker.
Name | Type | Description |
Workers_Id | String | The ID of the resource to execute this process on |
Date | Datetime | The date this business process takes effect. |
Descriptor | String | A preview of the instance |
Id | String | Id of the instance |
Position_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Date | Datetime | The date this business process takes effect. |
Descriptor | String | A preview of the instance |
Position_Descriptor | String | A description of the instance |
Position_Href | String | A link to the instance |
Position_Id | String | wid / id / reference id |
Request a one-time payment for a worker with the specified ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ payrollWorktags: [{ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }] paymentCurrency: { /* The currency for this compensation payment */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } coverageStartDate: Date /* The start date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements. */ paymentAmount: Currency /* Amount of compensation payment */ coverageEndDate: Date /* The end date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements. */ additionalInformation: Text /* Additional information for this compensation payment */ paymentPercent: Numeric /* The actual amount for the \~bonus\~ payment represented as a percentage. The percentage is usually calculated as a percentage of base pay, but on the \~bonus\~ plan setup it is possible to override the calculation basis to calculate as a percentage of a set of compensation elements. */ oneTimePaymentPlan: { /* The one-time payment plan name for this one-time payment. Displays only if the payment is a one-time payment. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } scheduledPaymentDate: Date /* The payment date scheduled for the one-time payment request. */ sendToPayroll: Boolean /* This is true if you selected Send to Payroll on the \~bonus\~ payment, future payment, or one-time payment. If false, Workday Payroll doesn't process the payment. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Workers_Id | String | The ID of the resource to execute this process on |
Descriptor | String | A preview of the instance |
EffectiveDate | Datetime | The date this business process takes effect. |
EmployeeVisibilityDate | Datetime | Returns the date that a compensation change is visible to a worker. |
Id | String | Id of the instance |
OneTimePayments_Aggregate | String | A JSON aggregate. All one-time payments associated with the event. |
Position_Id | String | wid / id / reference id |
Reason_Id | String | wid / id / reference id |
Name | Type | Description |
Id | String | Id of the instance |
Descriptor | String | A preview of the instance |
EffectiveDate | Datetime | The date this business process takes effect. |
EmployeeVisibilityDate | Datetime | Returns the date that a compensation change is visible to a worker. |
OneTimePayments_Aggregate | String | A JSON aggregate. All one-time payments associated with the event. |
Position_Descriptor | String | A description of the instance |
Position_Href | String | A link to the instance |
Position_Id | String | wid / id / reference id |
Reason_Descriptor | String | A description of the instance |
Reason_Href | String | A link to the instance |
Reason_Id | String | wid / id / reference id |
Creates a time off request for the specified worker ID and initiates the business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ description: Text /* Event attachment description */ contentType: { /* Content type of the attachment */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } fileLength: Numeric /* File length of the attachment */ uploadDate: Date /* Returns Date the Business Process Attachment was updated. */ fileName: Text /* File name of the attachment */ uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } category: { /* Returns the category of a Business Process Attachment. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } id: Text /* Id of the instance */ }]
[{ commentDate: Date /* Gives the moment at which the instance was originally created. */ comment: Text /* Comment */ person: { /* Comment made by Person */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } }]
[{ date: Date /* Time Off Entry date */ start: Date /* The start time of the time off entry. */ position: { /* Time Off Entry position. */ id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ } end: Date /* The end time of the time off entry. */ reason: { /* Time Off Entry reason. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } dailyQuantity: Numeric /* Time Off Entry hours */ comment: Text /* The comment on the time off entry. */ timeOffType: { /* Time Off Type for Time Off Entry. */ descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ } descriptor: Text /* A preview of the instance */ id: Text /* Id of the instance */ }]
Name | Type | Description |
Workers_Id | String | The ID of the resource to execute this process on |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
Days_Aggregate | String | A JSON aggregate. Time Off Entries |
Name | Type | Description |
BusinessProcessParameters_Action_Descriptor | String | A description of the instance |
BusinessProcessParameters_Action_Href | String | A link to the instance |
BusinessProcessParameters_Action_Id | String | wid / id / reference id |
BusinessProcessParameters_Attachments_Aggregate | String | A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met. |
BusinessProcessParameters_Comment | String | Returns a null. |
BusinessProcessParameters_Comments_Aggregate | String | A JSON aggregate. Returns the comments for the current business process. |
BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
BusinessProcessParameters_For_Descriptor | String | A description of the instance |
BusinessProcessParameters_For_Href | String | A link to the instance |
BusinessProcessParameters_For_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | A description of the instance |
BusinessProcessParameters_OverallBusinessProcess_Href | String | A link to the instance |
BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
BusinessProcessParameters_TransactionStatus_Descriptor | String | A description of the instance |
BusinessProcessParameters_TransactionStatus_Href | String | A link to the instance |
BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
Days_Aggregate | String | A JSON aggregate. Time Off Entries |
Creates a Time Review Event or Time Review Events.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{ status: { /* Transaction status or workflow state for an event. Example: Successfully Completed, Denied, Terminated */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } project: { /* Contains \~Project\~ for Time Review Event if Independent Events for \~Project\~ is enabled on the Time Entry Template. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } position: { /* Contains Position for Time Review Event if Independent Events for Multiple Jobs is enabled on the Time Entry Template. */ *id: Text /* wid / id / reference id */ descriptor: Text /* A description of the instance */ href: Text /* A link to the instance */ } id: Text /* Id of the instance */ descriptor: Text /* A preview of the instance */ }]
Name | Type | Description |
Workers_Id | String | The ID of the resource to execute this process on |
Comment | String | Contains the BP Comment for Time Review Events. |
Date | Datetime | Contains the user-given date to submit time. Date is used to build the range of Submission based on the user's configuration. |
TimeReviewEvents_Aggregate | String | A JSON aggregate. Contains Time Review Events created in the Submit Time request. |
Name | Type | Description |
Comment | String | Contains the BP Comment for Time Review Events. |
Date | Datetime | Contains the user-given date to submit time. Date is used to build the range of Submission based on the user's configuration. |
TimeReviewEvents_Aggregate | String | A JSON aggregate. Contains Time Review Events created in the Submit Time request. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Workday:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the [CData].[Human_Resources].Workers table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Workers' AND CatalogName='CData' AND SchemaName='Human_Resources'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the [CData].[Human_Resources].Workers table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Workers' AND CatalogName='CData' AND SchemaName='Human_Resources'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:workday:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
ConnectionType | The method to use to connect to Workday. |
AuthScheme | The type of authentication to use when connecting to Workday. |
Tenant | The tenant for the account. |
BaseURL | The base URL for the Workday connection. |
User | The Workday user account used to authenticate. |
Password | The password used to authenticate the user. |
Service | The specific SOAP service or services to retrieve data from. Enter as a comma seperated list. |
UseSplitTables | Whether to split WQL data sources into multiple tables. |
CustomReportURL | The URL Of the report that shows all Reports as a Service (RaaS) reports. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Property | Description |
APIURL | The complete url to the API endpoint to use for making SOAP requests. |
EnforceWQLRowLimit | Determines whether the provider restricts queries to returning only 1 million rows. |
ExpandIDTypes | Whether to expand multiple ID types when they appear in reports. Only has an effect for queries using the Reports as a Service (RaaS) API. |
ExpandMultiValueLimit | The maximum number of output rows that can be expanded from a single input row. |
ExpandMultiValues | Determines if multi-instance fields are expanded into separate rows. |
IncludeChildTableAggregates | For the SOAP API, whether or not to include aggregate columns for child tables. |
IncludeIDInDescriptor | Determines whether the provider includes the ID in descriptor fields. This only applies when ConnectionType is WQL. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MetadataFilters | Specifies what types of fields are ignored by the provider. |
Pagesize | The maximum number of results to return per page from Workday. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SingleEntryTables | Treats the specified SOAP tables as having one entry per row, even if Workday says they are collections. |
SplitSingleValuePrompts | Whether the provider should split lists of prompt values when Workday only allows one. |
TablePageSizes | Allows overriding the default page size when ConnectionType is SOAP. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
WQLDataSourceFilters | Determines what data source filters the provider uses when querying WQL data sources. |
WSDLURL | The URL to the WSDL. Only avaialble for the SOAP API. |
WSDLVersion | The version of the WSDL to use. Only available for the SOAP API. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
ConnectionType | The method to use to connect to Workday. |
AuthScheme | The type of authentication to use when connecting to Workday. |
Tenant | The tenant for the account. |
BaseURL | The base URL for the Workday connection. |
User | The Workday user account used to authenticate. |
Password | The password used to authenticate the user. |
Service | The specific SOAP service or services to retrieve data from. Enter as a comma seperated list. |
UseSplitTables | Whether to split WQL data sources into multiple tables. |
CustomReportURL | The URL Of the report that shows all Reports as a Service (RaaS) reports. |
SSOProperties | Additional properties required to connect to the identity provider in a semicolon-separated list. |
The method to use to connect to Workday.
string
"WQL"
The Cloud supports several ways of connecting to Workday. This option controls which one is used:
The type of authentication to use when connecting to Workday.
string
"Auto"
The available authentication methods depend upon the service you are connecting to:
The following authentication schemes are available when ConnectionType is set to WQL, Reports, or REST:
The following authentication schemes are available when ConnectionType; is set to SOAP:
The tenant for the account.
string
""
The tenant will be used when constructing the URL to use when attempting to retrieve data from Workday. For example:
https://wd3-impl-services1.workday.com/ccx/service/mycompany_gms1/Human_Resources
In this example, "mycompany_gms1" would be the tenant.
The base URL for the Workday connection.
string
""
To obtain the BaseURL, log into Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example:
https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany
In this case the BaseURL is "https://wd3-impl-services1.workday.com".
The Workday user account used to authenticate.
string
""
Together with Password, this field is used to authenticate against the Workday server.
The password used to authenticate the user.
string
""
The User and Password are together used to authenticate with the server.
The specific SOAP service or services to retrieve data from. Enter as a comma seperated list.
string
""
When using the SOAP API, the Cloud exposes SOAP services as separate schemas.
By default the Cloud exposes the most common Workday services.
You can change what services the connection exposes by adding or removing entries from this list:
Absence_Management,Academic_Advising,Academic_Foundation,Admissions,Adoption,Benefits_Administration,Campus_Engagement,Cash_Management,Compensation,Compensation_Review,Dynamic_Document_Generation,Financial_Aid,Financial_Management,Human_Resources,Identity_Management,Integrations,Inventory,Learning,Payroll,Payroll_CAN,Payroll_GBR,Payroll_Interface,Performance_Management,Recruiting,Resource_Management,Revenue_Management,Scheduling,Settlement_Services,Staffing,Student_Core,Student_Finance,Student_Recruiting,Talent,Time_Tracking,Workday_Connect,Workday_Extensibility,Workforce_Planning
The table below lists all the services exposed by the current WSDLVersion and whether or not the Cloud exposes each service by default. If you are using a different WSDLVersion this list may not include all available services. For more information please refer to the Web Services Directory page for your specific WSDLVersion.
Service Name | Included By Default? |
Absence_Management | Yes |
Academic_Advising | Yes |
Academic_Foundation | Yes |
Admissions | Yes |
Adoption | Yes |
Benefits_Administration | Yes |
Campus_Engagement | Yes |
Cash_Management | Yes |
Compensation | Yes |
Compensation_Review | Yes |
Dynamic_Document_Generation | Yes |
External_Integrations | Yes |
Financial_Aid | Yes |
Financial_Management | Yes |
Human_Resources | Yes |
Identity_Management | Yes |
Integrations | Yes |
Interview_Feedback__Do_Not_Use_ | No |
Inventory | Yes |
Learning | Yes |
Moments | No |
Notification | No |
Payroll | Yes |
Payroll_CAN | Yes |
Payroll_FRA | No |
Payroll_GBR | Yes |
Payroll_Interface | Yes |
Performance_Management | Yes |
Professional_Services_Automation | No |
Recruiting | Yes |
Resource_Management | Yes |
Revenue_Management | Yes |
Scheduling | Yes |
Settlement_Services | Yes |
Staffing | Yes |
Student_Core | Yes |
Student_Finance | Yes |
Student_Records | No |
Student_Recruiting | Yes |
Talent | Yes |
Tenant_Data_Translation | No |
Time_Tracking | Yes |
Workday_Connect | Yes |
Workday_Extensibility | Yes |
Workforce_Planning | Yes |
Whether to split WQL data sources into multiple tables.
bool
false
Workday data sources will often have several hundred fields, with some data sources like allWorkers having thousands of fields. Many database and reporting tools do not support tables with this many columns. By default the Cloud exposes the data sources the same way Workday does, so tools with these limitations cannot use larger data sources.
Enabling this option allows the Cloud to be used with these tools. When split tables are enabled, the Cloud creates multiple tables for complex Workday data sources. Each split table contains between 50-100 columns, along with the primary key, last modified timestamp and effective and entry inputs.
JOINs can be used if data is required from columns that are part of different split tables.
SELECT a.academicDegree, b.yearsExperience FROM allWorkers_1 a INNER JOIN allWorkers_60 b ON a.workdayID = b.workdayID
The URL Of the report that shows all Reports as a Service (RaaS) reports.
string
""
Workday does not have a built-in way of finding all the reports which can be used with RaaS. In order to discover these reports automatically, the Cloud uses a custom report that lists all reports enabled for RaaS.
See Fine-Tuning Data Access for instructions on how to create the report and retrieve its URL.
Additional properties required to connect to the identity provider in a semicolon-separated list.
string
""
Additional properties required to connect to the identity provider in a semicolon-separated list.
AzureAD has properties to control what Azure resource is used to authenticate the user. AzureAD SSO uses two applications, the SSO application registered to Workday and a separate OAuth application for the Cloud. The Cloud must know the resource ID of the SSO application so that it can ask that application to authenticate your user.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
The OAuth refresh token for the corresponding OAuth access token.
string
""
The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.
The lifetime in seconds of the OAuth AccessToken.
string
""
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
The Unix epoch timestamp in milliseconds when the current Access Token was created.
string
""
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthJWTCert | The JWT Certificate store. |
OAuthJWTCertType | The type of key store containing the JWT Certificate. |
OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
OAuthJWTIssuer | The issuer of the Java Web Token. |
OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
The JWT Certificate store.
string
""
The name of the certificate store for the client certificate.
The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.
Designations of certificate stores are platform-dependent.
The following are designations of the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
SPC | Software publisher certificates. |
In Java, the certificate store normally is a file containing certificates and optional private keys.
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).
The type of key store containing the JWT Certificate.
string
"PEMKEY_BLOB"
This property can take one of the following values:
USER | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
The password for the OAuth JWT certificate.
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
The subject of the OAuth JWT certificate.
string
"*"
When loading a certificate the subject is used to locate the certificate in the store.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks the first certificate in the certificate store.
The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, [email protected]". Common fields and their meanings are displayed below.
Field | Meaning |
CN | Common Name. This is commonly a host name like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma it must be quoted.
The issuer of the Java Web Token.
string
""
The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
APIURL | The complete url to the API endpoint to use for making SOAP requests. |
EnforceWQLRowLimit | Determines whether the provider restricts queries to returning only 1 million rows. |
ExpandIDTypes | Whether to expand multiple ID types when they appear in reports. Only has an effect for queries using the Reports as a Service (RaaS) API. |
ExpandMultiValueLimit | The maximum number of output rows that can be expanded from a single input row. |
ExpandMultiValues | Determines if multi-instance fields are expanded into separate rows. |
IncludeChildTableAggregates | For the SOAP API, whether or not to include aggregate columns for child tables. |
IncludeIDInDescriptor | Determines whether the provider includes the ID in descriptor fields. This only applies when ConnectionType is WQL. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MetadataFilters | Specifies what types of fields are ignored by the provider. |
Pagesize | The maximum number of results to return per page from Workday. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
SingleEntryTables | Treats the specified SOAP tables as having one entry per row, even if Workday says they are collections. |
SplitSingleValuePrompts | Whether the provider should split lists of prompt values when Workday only allows one. |
TablePageSizes | Allows overriding the default page size when ConnectionType is SOAP. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
WQLDataSourceFilters | Determines what data source filters the provider uses when querying WQL data sources. |
WSDLURL | The URL to the WSDL. Only avaialble for the SOAP API. |
WSDLVersion | The version of the WSDL to use. Only available for the SOAP API. |
The complete url to the API endpoint to use for making SOAP requests.
string
""
Instead of entering the Tenant, Service, and BaseURL individually, the complete API URL may be specified in the following format. For example:
BaseURL/ccx/service/<tenant>/<Service>
For example, this URL is the same as setting Tenant to "mytenant", Service to "Human_Resources", and BaseURL to "https://wd3-impl-services1.workday.com":
https://wd3-impl-services1.workday.com/ccx/service/mytenant/Human_Resources
Alternatively, the Service may be left out, which will enable all services included in the Service property. For example:
https://wd3-impl-services1.workday.com/ccx/service/mytenant
Determines whether the provider restricts queries to returning only 1 million rows.
bool
true
By default the Cloud will add a LIMIT 1000000 to any WQL query it executes. This prevents Workday from raising an error if the query would return too many values.
If you disable this option, the Cloud will not add the LIMIT clause. Any queries that would return more rows than the Workday row limit will instead raise an error.
Whether to expand multiple ID types when they appear in reports. Only has an effect for queries using the Reports as a Service (RaaS) API.
bool
false
Every Workday entity is identified by a WID (a GUID generated by Workday) but some types of entities have other types of identifiers. For example, a Workday country record for the United States would be identified using the "US" country code in addition to its WID.
By default the Cloud collects all these IDs under one column and produce an aggregate.
This is the value of the Country_Reference.ID column for the US record:
<wd:Country_Reference> <wd:ID type="WID">abcdef1234567890</wd:ID> <wd:ID type="Country_Code">US</wd:ID> </wd:Country_Reference>
If this option is enabled, the Cloud instead produces a separate column for each ID type. For the US record:
The maximum number of output rows that can be expanded from a single input row.
int
500
When using ExpandMultiValues, the Cloud can generate multiple output rows for each input row from Workday. Each multi-value column included in the query increases the number of output rows exponentially. For example, if a table has five array columns and has one row has three values for each, then rows are generated in this pattern:
Number of Array Columns Selected | Number of Output Rows |
0 | 1 |
1 | 3 |
2 | 9 |
3 | 27 |
4 | 81 |
5 | 243 |
Realistic queries can output thousands of rows which can be expanded into hundreds of thousands of output rows. Generating these rows reduces the Cloud's performance and can potentially cause the Cloud to run out of memory.
To avoid this, the Cloud counts the number of output rows before actually generating them. If any input row would generate more rows than the ExpandMultiValueLimit, the Cloud reports an error instead. When this happens you should carefully evaluate the query and remove any array columns that are not required. Only increase this limit if there is no way to simplify your query.
Determines if multi-instance fields are expanded into separate rows.
bool
false
The behavior of this option depends upon the service you are connecting to. Please refer to the WQL section for an overview, as the reporting and SOAP sections only cover details specific to those services. Also refer to ExpandMultiValueLimit to understand the performance consequences of enabling this option.
WQL uses multi-value fields to reference multiple rows from another table, such one journal entry referencing multiple journal line items. By default the Cloud displays these as JSON aggregates which must be parsed to get individual values.
workdayID | orderNumber | lineItem |
01234 | 1 | [{"id": "123abc", "descriptor": "..."}, {"id": "234bcd", ...}, {"id": "345cde", ...}] |
56789 | 2 | [{"id": "456def", "descriptor": "..."}, {"id": "567fea", ...}] |
Enabling this option expands each of these multi-value references across multiple rows. The Cloud separates out each aggregate into an ID column and a descriptor column (the same as single-value ID fields). It also generates a new field called workdayIDIndex that counts the number of rows expanded from one WQL row. The workdayID and workdayIDIndex form a composite primary key, instead of the workdayID being the primary key on its own.
workdayID | workdayIDIndex | orderNumber | lineItem.id | lineItem.descriptor |
01234 | 1 | 1 | 123abc | ... |
01234 | 2 | 1 | 234bcd | ... |
01234 | 3 | 1 | 345cde | ... |
56789 | 1 | 2 | 456def | ... |
56789 | 2 | 2 | 567fea | ... |
The Cloud only expands rows that are included in the SELECT clause of the query. If more than one multi-value reference is selected, its values are combined with the other multi-value fields using a CROSS JOIN. This ensures that all combinations are included in the output so they can be used in WHERE or JOIN conditions.
The reporting API behaves similarly to the WQL API, with three main differences:
The first is that two extra columns are added instead of just one. One is called RowIndex and it behaves the same as workdayIDIndex. The other is called RowNumber and it counts the number of original rows from the report. It is included because reports do not have a built-in primary key like WQL data sources do.
The second is that reporting supports the ExpandIDTypes option. By default single-value IDs are treated as multi-value fields and expanded in the same way. This is because even single-value references can have a separate value for each type of ID. If ExpandIDTypes is enabled then each type of ID gets its own column and only multi-value references are expanded across rows.
The third is that the RaaS API supports two main types of reports: advanced reports and other types of reports. The next section explains the differences.
Most types of reports only include fields from their primary business object, with related business objects included using their IDs. Reading a non-advanced report with ExpandMultiValues expands ID values the same way as WQL does.
Advanced reports can include fields from both the primary business object and directly related business objects. Enabling ExpandMultiValues only expands one level of repeated values.
For example, the expenses reports object has the following structure. An advanced report includes fields from both the expense reports themselves as well the related line items and approver:
With ExpandMultiValues the Cloud exposes it as a view with these columns. Notice that Tax_Codes is left as an aggregate containing all ID types, while Approver.Related_Workers.ID is expanded and includes one type per row.
The SOAP API exposes a more complex data model with different types of repeated values:
This property only applies to the first two types because complex repeated structures are always exposed as child tables. The other two types behave similarly to WQL and reporting APIs with a few exceptions:
For the SOAP API, whether or not to include aggregate columns for child tables.
bool
true
By default the Cloud exposes child tables as both XML aggregate columns on their parent table, as well as separate tables. For example, information on parties involved in reported safety incidents is available in two places:
If this option is disabled the aggregate column is not exposed and only the child table is available.
Note that this option does not affect aggregate columns on child tables. The Cloud does not expose second-level child tables, so these aggregates are the only way to access deeply nested data.
Determines whether the provider includes the ID in descriptor fields. This only applies when ConnectionType is WQL.
bool
true
Rows in WQL that reference other rows store data in two parts: an internal Workday ID and a descriptor that is a human-readable name for the row being referenced. For example, a country may have the internal ID 86bc49361cf911ee9f2d00155d17ccfc with the descriptor "Canada".
The Cloud exposes these as two columns, for example, [visaCountry.id] and [visaCountry.descriptor]. This option determines the values of the descriptor column:
The Cloud performs these optimizations when this option is enabled:
SELECT * FROM foreignWorkers WHERE [visaCountry.descriptor] = 'Canada / 86bc49361cf911ee9f2d00155d17ccfc' -- WQL: The ID value is extracted and filtered directly SELECT ... FROM foreignWorkers WHERE visaCountry = '86bc49361cf911ee9f2d00155d17ccfc' SELECT [visaCountry.descriptor], COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.descriptor] -- WQL: The ID value is used for aggregation and combined with the descriptor when reading. SELECT visaCountry, COUNT(*) FROM foreignWorkers GROUP BY visaCountry -- Doing this with IncludeIDInDescriptor=false requires aggregating by the ID and looking up the descriptor -- SELECT t2.descriptor, t1.COUNT FROM (SELECT [visaCountry.id] AS id, COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.id]) t1 -- INNER JOIN foreignWorkers t2 ON t1.id = t2.id
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Specifies what types of fields are ignored by the provider.
string
""
Several types of fields in Workday are slow to read or are common sources of query errors. Excluding these fields at the Cloud level allows for faster and more reliable queries without explicitly excluding these columns for every query. If a field is included in this property, it does not show up in table metadata and it cannot be used in queries.
This property can be set to a comma-separated list containing any combination of the following field types. For example, Calculated,MultiInstance will exclude both calculated and multi-instance fields.
The maximum number of results to return per page from Workday.
int
500
The Pagesize property affects the maximum number of results to return per page from Workday. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
Treats the specified SOAP tables as having one entry per row, even if Workday says they are collections.
string
"Payments"
The Workday SOAP API annotates some operations as returning a collection of data within each value. By default the Cloud exposes these responses using each collection entry as a row, instead of each top-level value being a row. This creates a simpler table by removing elements from the table that may be repeated across multiple rows.
For example, the CommitteeDefinition table is built using this process. Each response value is a Committee_Definition that contains both a reference as well as a Committee_Definition_Data structure. The Cloud table only contains the values from Committee_Definition_Data and leaves off the reference:
However, some Workday SOAP definitions mark data as a collection when only one value is actually allowed. When this happens you can add the table to this connection property. The Cloud will then treat the collection as if it only has one value:
There are three ways to set this property. At the start you should explicitly include the tables you have checked against your Workday data. However, if you find that most of the tables in your workflow are single-entry, you can use the latter two formats:
Whether the provider should split lists of prompt values when Workday only allows one.
bool
false
When a table or view has a prompt, the Cloud normally requires that the query value be compatible with the prompt type.
Prompts that support multiple values can be set using either equals or IN:
SELECT * FROM workersByOrganization WHERE organizationsForWorker_Prompt = '...'; SELECT * FROM workersByOrganization WHERE organizationsForWorker_Prompt IN ('...', '...', '...');
While prompts that support only one value must be set using equals.
The Cloud reports an error if more than one value is given using IN:
-- OK SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = TRUE; -- Fails SELECT * FROM workersByOrganization WHERE includeManagers_Prompt IN (TRUE, FALSE);
When this option is enabled, the Cloud does not report errors when multiple values are given to single value prompts. Instead the Cloud splits the query into individual pieces that Workday can execute, and combines the results client-side. This may lead to duplicate results if the same row appears in two or more of the split queries. To avoid this, make sure to include all of the table's primary key columns in the SELECT clause.
Note that this is noticeably slower than the multi-value prompts that are natively supported by Workday.
Each additional prompt that the Cloud expands requires exponentially more queries to cover all combinations of values:
-- When this is sent to the Cloud SELECT * FROM workersByOrganization WHERE includeManagers_Prompt IN (TRUE, FALSE) AND includeSubordinateOrganizations_Prompt IN (TRUE, FALSE) -- These four queries are executed SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = TRUE AND includeSubordinateOrganizations_Prompt = TRUE; SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = TRUE AND includeSubordinateOrganizations_Prompt = FALSE; SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = FALSE AND includeSubordinateOrganizations_Prompt = TRUE; SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = FALSE AND includeSubordinateOrganizations_Prompt = FALSE;
Allows overriding the default page size when ConnectionType is SOAP.
string
""
By default the Cloud uses a page size of 100 as recommended by Workday. In most cases this offers a good balance between performance and stability.
However, in some situations a different page size is required. You can set the page size for a specific table using the table's name, an equals sign, and the page size. These values can be combined to set page sizes for multiple tables. For example, this setting changes the Workers page size to 10 and the MessageTemplate page size to 250: Workers=10,MessageTemplate=250.
The page size for each table can be any number between 1 and 999 inclusive. The best page size value depends upon the table and the exact data you are querying, and needs to be determined through testing. The following are guidelines for determining how to adjust the page size:
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
Determines what data source filters the provider uses when querying WQL data sources.
string
""
A WQL data source can have one or more data source filters. Each filter has its own set of prompts which determine the rows that are returned from the query. The fields included in each record are the same between filters.
The Cloud exposes one view per data source and determines the filter to use automatically. If the data source does not require a filter then the Cloud view queries the data source directly. Otherwise the Cloud uses the first filter to the data source.
You can set this property to bypass this process for specific data sources. This property accepts a comma-separated list of dataSource=filter values. The data source is the WQL alias of the data source, while the filter is the WQL alias of the filter. These values are displayed on the View Data Source and View Data Source Filter screens respctively.
Note that the data source name is not always the same as the view name. If UseSplitTables is enabled, the Cloud will make multiple views (journalLines_1, journalLines_2, ...) from the same data source (journalLines). All of these split views query the same data source.
For example, this value would make the journalLines view query the journalLinesFind filter, and the projectPortfolio view query the projectPortfolioDefaultFilter filter:
journalLines=journalLinesFind,projectPortfolio=projectPortfolioDefaultFilter
The URL to the WSDL. Only avaialble for the SOAP API.
string
""
As an alternative to entering Service and WSDLVersion, the WSDL URL may be entered directly. For example:
https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v34.1/Human_Resources.wsdl
The version of the WSDL to use. Only available for the SOAP API.
string
"v36.1"
The WSDL Version for Workday changes often. If you would like to use the latest version, the version may be set to a higher value here to match the latest release. Alternatively, set the WSDLURL directly and this property will be ignored.