The CData Sync App provides a straightforward way to continuously pipeline your Workday data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Workday connector can be used from the CData Sync application to pull data from Workday and move it to any of the supported destinations.
The Sync App leverages the Workday API to enable access to Workday.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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.
This page describes:
Note: Because they facilitate authentication to Workday APIs, custom OAuth applications are frequently referred to within this document as custom API Clients.
Note: Be aware that Workday restricts each custom application to a single redirection URI. Therefore, if you have a mix of Desktop and Web users, you will probably need to create more than one custom application.
After the application is created, Workday loads the View API Client page with all the information for the new application. Save the Client ID and Client Secret so they can be used with the OAuthClientId and OAuthClientSecret connection properties.
After the application is created, Workday loads the View API Client page with all the information for the new app. Save the Client ID and Client Secret so they can be used with the OAuthClientId and OAuthClientSecret connection properties.
The following steps register an ISU with the API client you just created.
After the ISU is registered, Workday load sa page showing the Refresh Token for the ISU. Save this value so it can be used with the OAuthRefreshToken property.
To register the certificate in Workday:
Note: If you want to authenticate with OAuthJWT, you need to register an API Client for Integrations has to be registered with a specific ISU. After it is registered you can use the API Client to authenticate. If you do not already have an ISU, you must create one first, as described in Creating an Integration System User (ISU).
Thus, authenticating with Azure Active Directory requires two applications to be configured in your Azure tenant:
After the application is created:
When connecting with ConnectionType set to SOAP, the following properties will determine what tables are exposed:
When connecting with ConnectionType set to Reports, the Sync App supports reading reports that have been exposed through Workday Reports as a Service (RaaS). Workday does not have a built-in way for the Sync App 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 Sync App 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 Sync App 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 Sync App is unable to dynamically determine which modules are available at runtime, but the exposed services can be configured via the Service connection property.
This section details a selection of advanced features of the Workday Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Workday and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App 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 Sync App 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 Sync App exposes each data source using its WQL Alias which is shown on the View Data Source page.
The Sync App exposes two kinds of data sources: Prism data sources and Core data sources. All Prism data sources start with the prefix cds_.
The Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App automatically adds the appropriate subquery SELECT * FROM RequisitionsRequisitionLines
Prompts are also considered when the Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 Sync App 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 |