CData Cloud offers access to Workday across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Workday through CData Cloud.
CData Cloud allows you to standardize and configure connections to Workday as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Workday in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Workday and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Workday through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Workday by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
After you set the parameters for the desired API and have created a custom OAuth and/or Azure AD API client, you are ready to connect.
| 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 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.
This section describes both methods of authentication.
Note: Because they facilitate authentication to Workday APIs, this document frequently refers to custom OAuth applications as custom API Clients.
After you have an API client configured, set the following properties to connect using Workday credentials:
Standard OAuth User
AzureAD User
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 of these clients using the JWT bearer grant type.
After you set the appropriate properties, you are ready to connect.
API Client for Integrations
API Client (JWT)
To use Basic authentication, set these connection parameters:
Other authentication methods are configured the same way as for the WQL and reporting services.
When connecting with ConnectionType set to SOAP, the following properties will determine what tables are exposed:
When connecting with ConnectionType set to Reports, the Cloud supports reading reports that have been exposed through Workday Reports as a Service (RaaS). Workday does not have a built-in way for the Cloud to determine which reports have been exposed via RaaS, so you must create a custom report to use this feature:
After the report is created, you need to add a few columns and filters:
Note that the Current User filter is optional but recommended. It is there to ensure that the Cloud does not surface reports that your account does not have permissions to view. However, if the report has performance issues then the filter can be removed.
The final step is to find the URL associated with the report. This URL is used to set the CustomReportURL connection property.
The permissions used by the Begin and Submit stored procedures (see REST) are configured differently to other REST resources. The permissions for each change resource is determined by its underlying business process. For example, executing BeginOrganizationAssignmentChange triggers the Change Organization Assignments for Worker business process within Workday
If you find that the the Cloud is unable to start a business process, update the processs security policy as follows:
The Cloud discovers reports by accessing the catalog report indicated by the CustomReportURL property. If the output of the catalog report is not valid, the Cloud states that the report "does not list any valid RaaS reports" and fails the connection. There are a few common reasons for this:
While connecting to the SOAP service, you may receive an error stating "Invalid Request". This is a server-side Workday error. It often indicates that your user account has not been granted the permissions required to either connect via the API, or to obtain the specific information you have requested.
The tables and columns are retrieved from a publicly available service that requires no authentication, so this error may appear while either testing the connection, or when trying to retrieve data after metadata has been obtained.
While connecting, you may receive an error stating "Processing error occurred. The task submitted is not authorized".
This is a server-side error Workday error. This error typically indicates that your Workday account does not have the necessary module activated to access the table or Service you are attempting to connect to.
Ensure the correct module is activated if you receive this error. The Cloud is unable to dynamically determine which modules are available at runtime, but the exposed services can be configured via the Service connection property.
These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the Workday Cloud.
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
| Scope | Description |
| System | List views and columns. Required for read access. |
| Tenant Non-Configurable | Access and execute reports as a service. |
| Workday Owned Scope | Include items or components owned and managed by Workday. Required for read access. |
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
| Domain | Always Required | Description |
| <Base URL> | TRUE | The base URL of your Workday REST API Endpoint, as specified in the BaseURL connection property. |
| community.workday.com | FALSE | The base URL for the Workday SOAP API. Required if using SOAP for your ConnectionType. |
| <CustomReportURL> | FALSE | The URL of your report catalog. Required if using Reports for your ConnectionType. |
| login.microsoft.com | FALSE | The base URL for AzureAD SSO. Required if using AzureAD as your AuthScheme |
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud models Workday data as an easy-to-use SQL database with tables, views, and stored procedures.
The Cloud exposes four data models, which you select in ConnectionType:
Note: For performance reasons, you should use WQL instead of SOAP in most situations. WQL generally is much more performant because it supports server-side filtering and aggregation.
Many WQL data sources, reports, REST endpoints, and SOAP services have prompts that affect what rows Workday reports. The Cloud exposes these prompts as input columns that have the _Prompt suffix. Most prompts accept only a single value, but prompts that accept multiple values can be set with IN or equals:
SELECT * FROM [Account Balance Data]
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'
Other filters may be included with prompts. These do not affect the way Workday generates the report, but the Cloud removes non-matching rows from the response:
SELECT * FROM [Account Balance Data]
/* Prompts */
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'
/* Other filters */
AND Department = 'Sales and Marketing'
AND Account_Type = 'LIABILITY'
The Cloud's SOAP data model includes other types of input columns that are not found on other data models. They allow you to control other aspects of the SOAP request. Like prompt columns, each type of input has its own suffix to distinguish it from other inputs.
Normally the Cloud matches a request reference to its data field. When this happens the Cloud exposes only the data field and translates filters on the data field into request reference parameters. However, if the Cloud cannot match a request reference to a data field, it instead adds a separate column with a _RequestRef suffix.
Normally the Cloud determines the response groups automatically. Either the response group is hardcoded (see IgnoreHardcodedIncludes), or the Cloud calculates response groups based on the table and columns in the query. This process does not always given correct results because the Workday API does not explicitly report what fields each include and exclude affects. The Cloud has to guess based on the names of the response groups.
Setting response groups manually is useful for tables with response groups that do not follow the usual pattern. You should make sure that queries return the expected data when you provide response groups manually. Providing a single response group input will disable all hardcoded and automatically determined groups for the table you are querying. Incorrect response groups can return too little data, or reduce read performance by returning too much data.
Sometimes this is not possible because the prompt contains complex repeated values that must appear together. For these cases the Cloud supports aggregate prompts provided as XML. The XML must have a root element called Rows, which contains child elements that match the criteria field. The criteria field itself has a different structure depending upon the specific table and prompt you are using. Refer to the Workday SOAP documentation for full definitions of each criteria type.
For example, the Workers table in the Human Resources schema has a prompt called Eligibility_Criteria_Data_Prompt. Workday documents the Eligibility_Criteria_Data structure as having three values: a single field, an optional effective date, and an optional entry timestamp. The following query provides two of these eligibility criteria values:
SELECT * FROM Human_Resources.Workers WHERE Eligibility_Criteria_Data_Prompt =
'<Row>
<Eligibility_Criteria_Data>
<Field_Reference Descriptor="field a">
<ID type="WID">abc123</ID>
</Field_Reference>
<As_Of_Effective_Date>2024-05-28</As_Of_Effective_Date>
</Eligibility_Criteria_Data>
<Eligibility_Criteria_Data>
<Field_Reference Descriptor="field b">
<ID type="WID">def456</ID>
</Field_Reference>
<As_Of_Entry_DateTime>2024-05-28T14:27:42-05:00</As_Of_Entry_DateTime>
</Eligibility_Criteria_Data>
</Row>'
Note the following differences between the XML you provide here and what Workday natively accepts:
When ConnectionType is set to WQL, the schema exposes Workday data sources as read-only views using the Workday Query Language (WQL) service. The Views section contains examples of read-only SQL tables that might be available. All the data sources used by these views are part of core Workday and the HCM module. To get a complete list of these data sources, run the Data Sources standard report in Workday.
Common views include:
| Table | 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 shows 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. |
| classes | Provides detailed information about all academic classes, including attributes such as class names, codes, associated academic periods, instructional formats, and the academic units offering them. Useful for analyzing course offerings, managing academic schedules, and integrating class data with other student or faculty records in Workday. |
| 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. |
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 | Unique identifier for the class of the compensation plan instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the compensation plan instance. | |
| cf_CompensationPlanEqualToHourly | Bool | Indicates whether the compensation plan is categorized as an hourly wage plan (True/False). | |
| cf_FrequencyForCompensationPlan_id | String | Unique identifier for the frequency of the compensation plan (e.g., weekly, bi-weekly, monthly). | |
| cf_FrequencyForCompensationPlan_descriptor | String | Descriptive name for the frequency of the compensation plan. | |
| cf_CompensationPlanEqualToAllowance | Bool | Indicates whether the compensation plan includes allowances (True/False). | |
| cf_CompensationPlanEqualToBonus | Bool | Indicates whether the compensation plan includes bonuses (True/False). | |
| cf_CompensationPlanTypeEqualToMerit | Bool | Indicates whether the compensation plan is classified as a merit-based plan (True/False). | |
| cf_CompensationPlanEqualToCommission | Bool | Indicates whether the compensation plan includes commission-based payments (True/False). | |
| cf_CompensationPlanEqualToStock | Bool | Indicates whether the compensation plan includes stock-based compensation (True/False). | |
| cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Indicates whether the compensation plan is structured as a salary plan, defined by unit, period, or a fixed salary (True/False). | |
| compensationPlanName | String | The official name assigned to the compensation plan. | |
| description | String | A general description of the compensation plan. | |
| compensationPlanDefaults_id | String | Unique identifier for the default settings associated with the compensation plan. | |
| compensationPlanDefaults_descriptor | String | Human-readable description of the default settings for the compensation plan. | |
| compensationPlanProcessHistory | String | Records and tracks historical changes made to the compensation plan. | |
| compensationPackages | String | Lists the different compensation packages associated with the plan. | |
| eligibilityRules | String | Defines the rules that determine employee eligibility for the compensation plan. | |
| compensationPlan_id | String | Unique identifier for the specific compensation plan. | |
| compensationPlan_descriptor | String | Descriptive label for the compensation plan. | |
| positionsInCompensationPlan | String | Lists the job positions that fall under this compensation plan. | |
| employeesInCompensationPlan | String | Lists employees enrolled in this compensation plan. | |
| calculationType_id | String | Unique identifier for the calculation method used in the compensation plan. | |
| calculationType_descriptor | String | Descriptive label for the calculation method applied to the compensation plan. | |
| calculation_id | String | Unique identifier for the specific calculation associated with the compensation plan. | |
| calculation_descriptor | String | Descriptive label for the specific calculation applied within the compensation plan. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the compensation plan. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the compensation plan's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the compensation plan entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the compensation plan entry was recorded. |
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 | Unique identifier for the class of the compensation plan instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the compensation plan instance. | |
| cf_CompensationPlanEqualToHourly | Bool | Indicates whether the compensation plan is categorized as an hourly wage plan (True/False). | |
| cf_FrequencyForCompensationPlan_id | String | Unique identifier for the frequency of the compensation plan (e.g., weekly, bi-weekly, monthly). | |
| cf_FrequencyForCompensationPlan_descriptor | String | Descriptive name for the frequency of the compensation plan. | |
| cf_CompensationPlanEqualToAllowance | Bool | Indicates whether the compensation plan includes allowances (True/False). | |
| cf_CompensationPlanEqualToBonus | Bool | Indicates whether the compensation plan includes bonuses (True/False). | |
| cf_CompensationPlanTypeEqualToMerit | Bool | Indicates whether the compensation plan is classified as a merit-based plan (True/False). | |
| cf_CompensationPlanEqualToCommission | Bool | Indicates whether the compensation plan includes commission-based payments (True/False). | |
| cf_CompensationPlanEqualToStock | Bool | Indicates whether the compensation plan includes stock-based compensation (True/False). | |
| cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Indicates whether the compensation plan is structured as a salary plan, defined by unit, period, or a fixed salary (True/False). | |
| compensationPlanName | String | The official name assigned to the compensation plan. | |
| description | String | A general description of the compensation plan. | |
| compensationPlanDefaults_id | String | Unique identifier for the default settings associated with the compensation plan. | |
| compensationPlanDefaults_descriptor | String | Human-readable description of the default settings for the compensation plan. | |
| compensationPlanProcessHistory | String | Records and tracks historical changes made to the compensation plan. | |
| compensationPackages | String | Lists the different compensation packages associated with the plan. | |
| eligibilityRules | String | Defines the rules that determine employee eligibility for the compensation plan. | |
| compensationPlan_id | String | Unique identifier for the specific compensation plan. | |
| compensationPlan_descriptor | String | Descriptive label for the compensation plan. | |
| positionsInCompensationPlan | String | Lists the job positions that fall under this compensation plan. | |
| employeesInCompensationPlan | String | Lists employees enrolled in this compensation plan. | |
| calculationType_id | String | Unique identifier for the calculation method used in the compensation plan. | |
| calculationType_descriptor | String | Descriptive label for the calculation method applied to the compensation plan. | |
| calculation_id | String | Unique identifier for the specific calculation associated with the compensation plan. | |
| calculation_descriptor | String | Descriptive label for the specific calculation applied within the compensation plan. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the compensation plan. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the compensation plan's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the compensation plan entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the compensation plan entry was recorded. |
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 | Unique identifier for the class of the compensation plan instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the compensation plan instance. | |
| cf_CompensationPlanEqualToHourly | Bool | Indicates whether the compensation plan is categorized as an hourly wage plan (True/False). | |
| cf_FrequencyForCompensationPlan_id | String | Unique identifier for the frequency of the compensation plan (e.g., weekly, bi-weekly, monthly). | |
| cf_FrequencyForCompensationPlan_descriptor | String | Descriptive name for the frequency of the compensation plan. | |
| cf_CompensationPlanEqualToAllowance | Bool | Indicates whether the compensation plan includes allowances (True/False). | |
| cf_CompensationPlanEqualToBonus | Bool | Indicates whether the compensation plan includes bonuses (True/False). | |
| cf_CompensationPlanTypeEqualToMerit | Bool | Indicates whether the compensation plan is classified as a merit-based plan (True/False). | |
| cf_CompensationPlanEqualToCommission | Bool | Indicates whether the compensation plan includes commission-based payments (True/False). | |
| cf_CompensationPlanEqualToStock | Bool | Indicates whether the compensation plan includes stock-based compensation (True/False). | |
| cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Indicates whether the compensation plan is structured as a salary plan, defined by unit, period, or a fixed salary (True/False). | |
| compensationPlanName | String | The official name assigned to the compensation plan. | |
| description | String | A general description of the compensation plan. | |
| compensationPlanDefaults_id | String | Unique identifier for the default settings associated with the compensation plan. | |
| compensationPlanDefaults_descriptor | String | Human-readable description of the default settings for the compensation plan. | |
| compensationPlanProcessHistory | String | Records and tracks historical changes made to the compensation plan. | |
| compensationPackages | String | Lists the different compensation packages associated with the plan. | |
| eligibilityRules | String | Defines the rules that determine employee eligibility for the compensation plan. | |
| compensationPlan_id | String | Unique identifier for the specific compensation plan. | |
| compensationPlan_descriptor | String | Descriptive label for the compensation plan. | |
| positionsInCompensationPlan | String | Lists the job positions that fall under this compensation plan. | |
| employeesInCompensationPlan | String | Lists employees enrolled in this compensation plan. | |
| workdayID | String | Unique identifier assigned to the compensation plan within the Workday system. | |
| referenceID1 | String | Reference identifier used to track the compensation plan in external systems. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the compensation plan. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the compensation plan's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the compensation plan entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the compensation plan entry was recorded. |
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 | Unique identifier for the class of the compensation rule assignment instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the compensation rule assignment instance. | |
| positionsAndPositionGroupsSelectedByCompensationRule | String | Lists the positions and position groups that are selected by the compensation rule. | |
| compensationRuleName | String | The official name assigned to the compensation rule. | |
| compensationRuleAssignment_id | String | Unique identifier for the compensation rule assignment. | |
| compensationRuleAssignment_descriptor | String | Descriptive label for the compensation rule assignment. | |
| compensationComponents | String | Lists the compensation components associated with this rule assignment. | |
| employeesSelectedByCompensationRule | String | Lists employees selected by the compensation rule. | |
| compensationGradeProfiles | String | Lists the compensation grade profiles associated with this rule assignment. | |
| compensationGrades | String | Lists the compensation grades applicable to this rule assignment. | |
| compensationPlans | String | Lists the compensation plans covered by this rule assignment. | |
| compensationPackages | String | Lists the compensation packages included in this rule assignment. | |
| workdayID | String | Unique identifier assigned to the compensation rule assignment within the Workday system. | |
| compensationEligibilityRule_id | String | Unique identifier for the compensation eligibility rule. | |
| compensationEligibilityRule_descriptor | String | Descriptive label for the compensation eligibility rule. | |
| referenceID | String | Reference identifier used to track the compensation rule assignment in external systems. | |
| createdMoment | Date | Timestamp indicating when the compensation rule assignment was created. | |
| lastFunctionallyUpdated | Date | Date when the compensation rule assignment was last functionally updated. | |
| currentOMSVersion_id | String | Unique identifier for the current version of the OMS (Order Management System) linked to this compensation rule assignment. | |
| currentOMSVersion_descriptor | String | Descriptive label for the current version of the OMS associated with this compensation rule assignment. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the compensation rule assignment. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the compensation rule assignment's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the compensation rule assignment entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the compensation rule assignment entry was recorded. |
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 | Lists the educational degrees typically associated with this job profile. | |
| cf_CompensationSurvey | String | Indicates whether this job profile is included in a compensation survey. | |
| cf_JobEvaluationScore | String | Score assigned to the job profile based on evaluation metrics. | |
| classOfInstance1_id | String | Unique identifier for the class of the job profile instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the job profile instance. | |
| cf_countriesWherePayRateTypeEqualToSalaried | String | Lists the countries where the job profile follows a salaried pay rate type. | |
| cf_countriesWherePayRateTypeEqualToHourly | String | Lists the countries where the job profile follows an hourly pay rate type. | |
| cf_CompensationGroup_id | String | Unique identifier for the compensation group associated with the job profile. | |
| cf_CompensationGroup_descriptor | String | Descriptive label for the compensation group linked to this job profile. | |
| jobProfileName | String | The official name assigned to the job profile. | |
| jobFamilyGroupAndFamily | String | Lists all job families and groups associated with this job profile. | |
| jobProfileSummary | String | A brief summary describing the job profile. | |
| jobProfile_id | String | Unique identifier for the job profile. | |
| jobProfile_descriptor | String | Descriptive label for the job profile. | |
| jobClassifications | String | Lists the job classifications applicable to this job profile. | |
| managementLevel_id | String | Unique identifier for the management level associated with this job profile. | |
| managementLevel_descriptor | String | Descriptive label for the management level. | |
| ID | String | General identifier used for tracking the job profile. | |
| compensationGradesImpactedByRules | String | Lists the compensation grades affected by rules for this job profile. | |
| jobExempt | Bool | Indicates whether this job profile is exempt from overtime regulations (True/False). | |
| averagePay_Amount_value | Decimal | The average pay amount associated with this job profile. | |
| averagePay_Amount_currency | String | The currency in which the average pay amount is measured. | |
| employeeCount | Int | The total number of employees assigned to this job profile. | |
| highestPay_Amount_value | Decimal | The highest pay amount recorded for this job profile. | |
| highestPay_Amount_currency | String | The currency in which the highest pay amount is measured. | |
| lowestPay_Amount_value | Decimal | The lowest pay amount recorded for this job profile. | |
| lowestPay_Amount_currency | String | The currency in which the lowest pay amount is measured. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the job profile. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the job profile's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the job profile entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the job profile entry was recorded. |
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 | Unique identifier for the class of the compensation plan instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the compensation plan instance. | |
| cf_CompensationPlanEqualToHourly | Bool | Indicates whether the compensation plan is categorized as an hourly wage plan (True/False). | |
| cf_FrequencyForCompensationPlan_id | String | Unique identifier for the frequency of the compensation plan (e.g., weekly, bi-weekly, monthly). | |
| cf_FrequencyForCompensationPlan_descriptor | String | Descriptive name for the frequency of the compensation plan. | |
| cf_CompensationPlanEqualToAllowance | Bool | Indicates whether the compensation plan includes allowances (True/False). | |
| cf_CompensationPlanEqualToBonus | Bool | Indicates whether the compensation plan includes bonuses (True/False). | |
| cf_CompensationPlanTypeEqualToMerit | Bool | Indicates whether the compensation plan is classified as a merit-based plan (True/False). | |
| cf_CompensationPlanEqualToCommission | Bool | Indicates whether the compensation plan includes commission-based payments (True/False). | |
| cf_CompensationPlanEqualToStock | Bool | Indicates whether the compensation plan includes stock-based compensation (True/False). | |
| cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary | Bool | Indicates whether the compensation plan is structured as a salary plan, defined by unit, period, or a fixed salary (True/False). | |
| compensationPlanName | String | The official name assigned to the compensation plan. | |
| description | String | A general description of the compensation plan. | |
| compensationPlanDefaults_id | String | Unique identifier for the default settings associated with the compensation plan. | |
| compensationPlanDefaults_descriptor | String | Human-readable description of the default settings for the compensation plan. | |
| compensationPlanProcessHistory | String | Records and tracks historical changes made to the compensation plan. | |
| compensationPackages | String | Lists the different compensation packages associated with the plan. | |
| eligibilityRules | String | Defines the rules that determine employee eligibility for the compensation plan. | |
| compensationPlan_id | String | Unique identifier for the specific compensation plan. | |
| compensationPlan_descriptor | String | Descriptive label for the compensation plan. | |
| positionsInCompensationPlan | String | Lists the job positions that fall under this compensation plan. | |
| employeesInCompensationPlan | String | Lists employees enrolled in this compensation plan. | |
| workdayID | String | Unique identifier assigned to the compensation plan within the Workday system. | |
| referenceID1 | String | Reference identifier used to track the compensation plan in external systems. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the compensation plan. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the compensation plan's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the compensation plan entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the compensation plan entry was recorded. |
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 | Unique identifier for the supervisory organization hierarchy. | |
| cf_SupervisoryOrganizationHierarchy_descriptor | String | Descriptive label for the supervisory organization hierarchy. | |
| cf_EarliestHireDate_Quarter | String | The earliest hire date categorized by quarter. | |
| cf_MonthsFromEarliestHireDate | Int | Number of months that have passed since the earliest hire date. | |
| cf_TimeToFill1 | Int | Number of days required to fill an open position. | |
| cf_OpenPositionCountAtEndOfLastQuarter | Int | Total number of open positions at the end of the last quarter. | |
| cf_ExecutiveGroup1_id | String | Unique identifier for the executive group. | |
| cf_ExecutiveGroup1_descriptor | String | Descriptive label for the executive group. | |
| cf_AnnualPositionBurdenInUSD1_value | Decimal | Annual cost associated with a position, expressed in USD. | |
| cf_AnnualPositionBurdenInUSD1_currency | String | Currency used for the annual position burden amount. | |
| cf_DaysFromEarliestHireDate | Int | Number of days that have passed since the earliest hire date. | |
| cf_NumberOfMonthsPositionUnfilled | Int | Number of months a position has remained unfilled. | |
| cf_PositionCount_Frozen | Int | Number of positions that are currently frozen. | |
| cf_AnnualPositionBurdenInUSDOpenPositionsOnly_value | Decimal | Annual position burden in USD for open positions only. | |
| cf_AnnualPositionBurdenInUSDOpenPositionsOnly_currency | String | Currency used for the annual position burden of open positions. | |
| cf_IsPositionOpenAndEarliestHireDateCurrent | Bool | Indicates whether the position is open and the earliest hire date is current (True/False). | |
| cf_EarliestHireDate9Months1 | Date | Earliest hire date plus nine months. | |
| cf_CompensationRangeMidpointInUSD_value | Decimal | Midpoint value of the compensation range, expressed in USD. | |
| cf_CompensationRangeMidpointInUSD_currency | String | Currency used for the compensation range midpoint. | |
| cf_EarliestHireDate6Months1 | Date | Earliest hire date plus six months. | |
| cf_OpenPositionCount_GAndA | Int | Total number of open positions in General and Administrative (G and A) departments. | |
| cf_TimeInPositionRange_id | String | Unique identifier for the time in position range. | |
| cf_TimeInPositionRange_descriptor | String | Descriptive label for the time in position range. | |
| cf_IsInGAndA | Bool | Indicates whether the position falls under General and Administrative (G and A) (True/False). | |
| cf_AvailableYearQuarter | String | The year and quarter when the position became available. | |
| cf_EarliestHireDate3Months1 | Date | Earliest hire date plus three months. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the open position. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the open position's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the open position entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the open position entry was recorded. |
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 | Unique identifier for the class of the pre-hire instance. | |
| classOfInstance1_descriptor | String | Human-readable label for the class of the pre-hire instance. | |
| cf_WorkerCountryISOCodeOnExpensePayee | String | ISO country code associated with the pre-hire's expense payee information. | |
| pre_Hire_id | String | Unique identifier for the pre-hire record. | |
| pre_Hire_descriptor | String | Descriptive label for the pre-hire record. | |
| source_id | String | Unique identifier for the source from which the pre-hire originated. | |
| source_descriptor | String | Descriptive label for the source of the pre-hire. | |
| referredBy | String | The individual or entity that referred the pre-hire. | |
| pre_HirePools | String | Lists the pools or groups that the pre-hire is associated with. | |
| datePre_HireAddedToSystem | Date | The date when the pre-hire record was added to the system. | |
| notEligibleForHireComment | String | Comment explaining why the pre-hire is not eligible for hire. | |
| comment | String | General comments related to the pre-hire. | |
| resume | String | Stores the resume or CV associated with the pre-hire. | |
| pre_HireConsideration | String | Additional considerations relevant to the pre-hire process. | |
| availableForHire | Bool | Indicates whether the pre-hire is currently available for hire (True/False). | |
| roleName | String | The role assigned to the pre-hire within the organization. | |
| email_Primary | String | Primary email address of the pre-hire. | |
| phone_Primary | String | Primary phone number of the pre-hire. | |
| organizationRoleAssignments | String | Lists the organization roles assigned to the pre-hire. | |
| integrationIdentifier | String | Unique identifier used for integration purposes. | |
| organizationRoles | String | Roles assigned to the pre-hire within the organization. | |
| externalIDForSystemID | String | External system ID associated with the pre-hire record. | |
| raceEthnicity_id | String | Unique identifier for the race/ethnicity classification of the pre-hire. | |
| raceEthnicity_descriptor | String | Descriptive label for the race/ethnicity classification. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the pre-hire. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the pre-hire's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the pre-hire entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the pre-hire entry was recorded. |
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 | Used for multi-instance unit testing purposes. | |
| cf_ClickableAddedRoleAssignments | String | Lists role assignments that have been added and can be clicked for more details. | |
| cf_ClickableRemovedRoleAssignments | String | Lists role assignments that have been removed and can be clicked for more details. | |
| cf_SecurityGroupsWithAccessToSettlePayments_Payroll | String | Security groups that have access to settle payroll payments. | |
| cf_SecurityGroupsWithAccessToInputEditOrProcessPayroll | String | Security groups with access to input, edit, or process payroll data. | |
| cf_SecurityGroupsWithAccessToRefundCustomers | String | Security groups that have access to issue refunds to customers. | |
| cf_SecurityGroupsWithAccessToCreateModifyCustomers | String | Security groups that can create or modify customer records. | |
| cf_ReportsAndTasks_View | String | Lists reports and tasks that users have permission to view. | |
| cf_SecurityGroupsWithAccessToCreateModifySuppliers | String | Security groups that can create or modify supplier records. | |
| cf_ReportsAndTasks_Modify | String | Lists reports and tasks that users have permission to modify. | |
| cf_SecurityGroupsWithAccessToCreateEditSupplierInvoices | String | Security groups that have access to create or edit supplier invoices. | |
| cf_BusinessProcessPolicy_Approve | String | Indicates whether the business process policy includes approval permissions. | |
| cf_BusinessProcessPolicy_Cancel | String | Indicates whether the business process policy includes cancellation permissions. | |
| cf_SecurityGroupsWithAccessToSettlePayments_Suppliers | String | Security groups that have access to settle supplier payments. | |
| cf_BusinessProcessPolicy_Rescind | String | Indicates whether the business process policy includes rescind permissions. | |
| cf_SecurityGroupsWithAccessToCreateModifyExpenseReports | String | Security groups that have access to create or modify expense reports. | |
| cf_BusinessProcessPolicy_Initiate | String | Indicates whether the business process policy includes initiation permissions. | |
| cf_SecurityGroupsWithAccessToSettlePayments_Expenses | String | Security groups that have access to settle expense payments. | |
| cf_BusinessProcessPolicy_View | String | Indicates whether the business process policy includes viewing permissions. | |
| cf_BusinessProcessPolicy_ViewCompleted | String | Indicates whether the business process policy includes permissions to view completed processes. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the Workday account. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the Workday account's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the Workday account entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the Workday account entry was recorded. |
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 | Annualized pay rate for contract workers, expressed as a numerical value. | |
| cf_ContractPayRateAnnualized_currency | String | Currency in which the contract pay rate annualized value is measured. | |
| cf_NumberOfTerminations | Int | Total number of terminations recorded for the worker. | |
| cf_DisciplinaryActions_Completed | String | List of completed disciplinary actions for the worker. | |
| cf_RetirementEligibility_id | String | Unique identifier for the worker's retirement eligibility classification. | |
| cf_RetirementEligibility_descriptor | String | Descriptive label for the worker's retirement eligibility classification. | |
| cf_LocationSiteHierarchyLevel2_id | String | Unique identifier for the Level 2 location site hierarchy. | |
| cf_LocationSiteHierarchyLevel2_descriptor | String | Descriptive label for the Level 2 location site hierarchy. | |
| cf_TotalBasePayAnnualizedInCAD_Amount_value | Decimal | Total base pay annualized in CAD, expressed as a numerical value. | |
| cf_TotalBasePayAnnualizedInCAD_Amount_currency | String | Currency in which the total base pay annualized in CAD is measured. | |
| cf_TotalBasePayHourly_Amount_value | Decimal | Total base pay on an hourly basis, expressed as a numerical value. | |
| cf_TotalBasePayHourly_Amount_currency | String | Currency in which the total base pay hourly amount is measured. | |
| cf_PrimaryAddressHomeStateText | String | Text representation of the worker's primary home state address. | |
| cf_NumberOfHires | Int | Total number of hires associated with this worker record. | |
| cf_SpendAuthorizationsNotInUseByActiveExpenseReports | String | List of spend authorizations that are not in use by active expense reports. | |
| cf_FormatPercentOfExpenseReportsWithWarningValidations | String | Formatted percentage of expense reports that include warning validations. | |
| cf_LegalName_LastNameUppercase | String | Worker's legal last name formatted in uppercase. | |
| cf_Apparel | String | Apparel-related details associated with the worker. | |
| cf_TopLevelSupervisoryOrganizationGMS_id | String | Unique identifier for the worker's top-level supervisory organization in the GMS. | |
| cf_TopLevelSupervisoryOrganizationGMS_descriptor | String | Descriptive label for the worker's top-level supervisory organization in the GMS. | |
| cf_HireDate90Days | Date | Hire date plus 90 days. | |
| cf_TotalBasePayAnnualizedInEUR_Amount_value | Decimal | Total base pay annualized in EUR, expressed as a numerical value. | |
| cf_TotalBasePayAnnualizedInEUR_Amount_currency | String | Currency in which the total base pay annualized in EUR is measured. | |
| cf_TotalBasePayMonthly_Amount_value | Decimal | Total base pay on a monthly basis, expressed as a numerical value. | |
| cf_TotalBasePayMonthly_Amount_currency | String | Currency in which the total base pay monthly amount is measured. | |
| cf_PerformanceImprovementPlans_InProgressOrCompleted | String | List of performance improvement plans that are either in progress or completed. | |
| cf_ExternalPayrollActualHoursWorkedInLast12Months | Int | Total actual hours worked in external payroll during the last 12 months. | |
| cf_PreferredName_LastNameUppercase | String | Worker's preferred last name formatted in uppercase. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the worker record. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the worker record's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the worker record entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the worker record entry was recorded. |
Returns all classes accessible by the current user
| Name | Type | References | Description |
| class1_id | String | Unique identifier for the class. | |
| class1_descriptor | String | Descriptive label for the class. | |
| classOfInstance1_id | String | Unique identifier for the instance's associated class. | |
| classOfInstance1_descriptor | String | Descriptive label for the instance's associated class. | |
| superclasses | String | List of superclasses to which this class belongs. | |
| instanceSet1_id | String | Unique identifier for the set of instances within this class. | |
| instanceSet1_descriptor | String | Descriptive label for the set of instances within this class. | |
| name1 | String | Name assigned to the class. | |
| metadata | Bool | Indicates whether the class contains metadata (True/False). | |
| countClassReportFieldForClass | Int | Total number of report fields associated with this class. | |
| totalInstancesOfClassIncludingSubclasses | Int | Total number of instances of this class, including those in subclasses. | |
| comment | String | General comment or additional information about the class. | |
| classReportFieldsForClassAndSuperClasses | String | List of report fields available for this class and its superclasses. | |
| DEPRECATED | Bool | Indicates whether this class has been deprecated (True/False). | |
| translatableDataForClassOrSupersOrSubs | String | List of translatable data associated with this class, its superclasses, or its subclasses. | |
| securityGroups1 | String | Security groups associated with this class. | |
| iManSetupDataClass_id | String | Unique identifier for the iMan setup data class. | |
| iManSetupDataClass_descriptor | String | Descriptive label for the iMan setup data class. | |
| setupDataClass_id | String | Unique identifier for the setup data class. | |
| setupDataClass_descriptor | String | Descriptive label for the setup data class. | |
| workdayID | String | Unique identifier assigned to the class within Workday. | |
| businessObjectName | String | Name of the business object associated with this class. | |
| customerAccessibleReportFields | String | List of report fields accessible to customers for this class. | |
| customerAccessibleDataSources | String | List of data sources accessible to customers for this class. | |
| secured_id | String | Unique identifier for the security classification of the class. | |
| secured_descriptor | String | Descriptive label for the security classification of the class. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the class. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the class's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the class entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the class entry was recorded. |
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.
The Workday Cloud requires filtering on organizations_Prompt in order to perform the query.
For example:
SELECT * FROM organizationsIManage WHERE organizations_Prompt = '1fcf0b79747a43d1a4de334e0c214b1b';
| Name | Type | References | Description |
| cf_BusinessUnitManager_id | String | Unique identifier for the business unit manager. | |
| cf_BusinessUnitManager_descriptor | String | Descriptive label for the business unit manager. | |
| cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of employee terminations, including subordinate organizations. | |
| cf_CompanyCostingManager_id | String | Unique identifier for the company costing manager. | |
| cf_CompanyCostingManager_descriptor | String | Descriptive label for the company costing manager. | |
| cf_CostCenterManager_id | String | Unique identifier for the cost center manager. | |
| cf_CostCenterManager_descriptor | String | Descriptive label for the cost center manager. | |
| cf_ManagerCount_IncludingSubordinateOrganizations | Int | Total number of managers, including those in subordinate organizations. | |
| cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the beginning of the period, including subordinate organizations. | |
| cf_RegionCostingManager_id | String | Unique identifier for the regional costing manager. | |
| cf_RegionCostingManager_descriptor | String | Descriptive label for the regional costing manager. | |
| cf_MidYearReviewPercentCompleteRange_id | String | Unique identifier for the range of completion for mid-year reviews. | |
| cf_MidYearReviewPercentCompleteRange_descriptor | String | Descriptive label for the range of completion for mid-year reviews. | |
| cf_EmployeeVoluntaryTerminationsCount | Int | Total number of voluntary terminations by employees. | |
| cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the end of the period, including subordinate organizations. | |
| cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of voluntary terminations by employees, including subordinate organizations. | |
| cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Total number of contingent workers at the end of the period, including subordinate organizations. | |
| cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average number of employees, including those in subordinate organizations. | |
| cf_SupervisoryOrganizationHierarchy_id | String | Unique identifier for the supervisory organization hierarchy. | |
| cf_SupervisoryOrganizationHierarchy_descriptor | String | Descriptive label for the supervisory organization hierarchy. | |
| cf_BeginningContingentWorkerCountInclSubOrgs | Int | Total number of contingent workers at the beginning of the period, including subordinate organizations. | |
| cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover percentage of employees, including subordinate organizations. | |
| cf_OrgHierarchy_id | String | Unique identifier for the organizational hierarchy. | |
| cf_OrgHierarchy_descriptor | String | Descriptive label for the organizational hierarchy. | |
| cf_EmployeeToManagerRatio | Int | Ratio of employees to managers within the organization. | |
| cf_TopPerformerEmployeeCount | Int | Total number of employees classified as top performers. | |
| cf_BeginningEmployeeCount | Int | Total number of employees at the beginning of the period. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the organization record. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the organization record's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the organization record entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the organization record entry was recorded. |
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.
The Workday Cloud requires filtering on compensationEligibilityRule_Prompt in order to perform the query.
For example:
SELECT * FROM positionsValidForCompensationSelectionRule WHERE compensationEligibilityRule_Prompt = '1fcf0b79747a43d1a4de334e0c214b1b';
| Name | Type | References | Description |
| cf_SupervisoryOrganizationHierarchy_id | String | Unique identifier for the supervisory organization hierarchy. | |
| cf_SupervisoryOrganizationHierarchy_descriptor | String | Descriptive label for the supervisory organization hierarchy. | |
| cf_TimeInPositionRange_id | String | Unique identifier for the time in position range. | |
| cf_TimeInPositionRange_descriptor | String | Descriptive label for the time in position range. | |
| cf_PositionsFrozen | Int | Total number of frozen positions. | |
| cf_QuarterAvailable | String | Quarter in which the position is available. | |
| cf_PositionText | String | Descriptive text associated with the position. | |
| cf_AnnualPositionBurdenInUSD_value | Decimal | Total annual burden cost of the position, expressed in USD. | |
| cf_AnnualPositionBurdenInUSD_currency | String | Currency in which the annual position burden is measured. | |
| cf_NumberOfMonthsUnfilledRange_id | String | Unique identifier for the range of months a position has been unfilled. | |
| cf_NumberOfMonthsUnfilledRange_descriptor | String | Descriptive label for the range of months a position has been unfilled. | |
| cf_EarliestHireDate9Months | Date | Earliest hire date plus nine months. | |
| cf_TimeInPosition_Days | Int | Number of days the position has been occupied. | |
| cf_AnnualEmployeeBurdenInUSD_value | Decimal | Total annual burden cost of an employee in this position, expressed in USD. | |
| cf_AnnualEmployeeBurdenInUSD_currency | String | Currency in which the annual employee burden is measured. | |
| cf_DefaultCompensationRangeMidpointInUSD_value | Decimal | Midpoint of the default compensation range, expressed in USD. | |
| cf_DefaultCompensationRangeMidpointInUSD_currency | String | Currency in which the default compensation range midpoint is measured. | |
| cf_EarliestHireDate6Months | Date | Earliest hire date plus six months. | |
| cf_AnnualContingentWorkerBurdenInUSD_value | Decimal | Total annual burden cost of a contingent worker, expressed in USD. | |
| cf_AnnualContingentWorkerBurdenInUSD_currency | String | Currency in which the annual contingent worker burden is measured. | |
| cf_EarliestHireDate3Months | Date | Earliest hire date plus three months. | |
| cf_MyOrganizations_id | String | Unique identifier for the associated organization. | |
| cf_MyOrganizations_descriptor | String | Descriptive label for the associated organization. | |
| cf_PositionCount_AllStatuses | Int | Total number of positions across all statuses. | |
| cf_AnnualCompensationPayWithBurdenInUSD_value | Decimal | Annual compensation or pay including burden costs, expressed in USD. | |
| cf_AnnualCompensationPayWithBurdenInUSD_currency | String | Currency in which the annual compensation with burden is measured. | |
| cf_Worker_id | String | Unique identifier for the worker assigned to the position. | |
| cf_Worker_descriptor | String | Descriptive label for the worker assigned to the position. | |
| cf_AnnualCompensationPayInUSD_value | Decimal | Total annual compensation or pay, expressed in USD. | |
| cf_AnnualCompensationPayInUSD_currency | String | Currency in which the annual compensation or pay is measured. | |
| cf_WorkerType_id | String | Unique identifier for the worker type classification. | |
| cf_WorkerType_descriptor | String | Descriptive label for the worker type classification. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the position. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the position's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the position entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the position entry was recorded. |
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 | Unique identifier for the business unit manager. | |
| cf_BusinessUnitManager_descriptor | String | Descriptive label for the business unit manager. | |
| cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of employee terminations, including subordinate organizations. | |
| cf_CompanyCostingManager_id | String | Unique identifier for the company costing manager. | |
| cf_CompanyCostingManager_descriptor | String | Descriptive label for the company costing manager. | |
| cf_CostCenterManager_id | String | Unique identifier for the cost center manager. | |
| cf_CostCenterManager_descriptor | String | Descriptive label for the cost center manager. | |
| cf_ManagerCount_IncludingSubordinateOrganizations | Int | Total number of managers, including those in subordinate organizations. | |
| cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the beginning of the period, including subordinate organizations. | |
| cf_RegionCostingManager_id | String | Unique identifier for the regional costing manager. | |
| cf_RegionCostingManager_descriptor | String | Descriptive label for the regional costing manager. | |
| cf_MidYearReviewPercentCompleteRange_id | String | Unique identifier for the range of completion for mid-year reviews. | |
| cf_MidYearReviewPercentCompleteRange_descriptor | String | Descriptive label for the range of completion for mid-year reviews. | |
| cf_EmployeeVoluntaryTerminationsCount | Int | Total number of voluntary terminations by employees. | |
| cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the end of the period, including subordinate organizations. | |
| cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of voluntary terminations by employees, including subordinate organizations. | |
| cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Total number of contingent workers at the end of the period, including subordinate organizations. | |
| cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average number of employees, including those in subordinate organizations. | |
| cf_SupervisoryOrganizationHierarchy_id | String | Unique identifier for the supervisory organization hierarchy. | |
| cf_SupervisoryOrganizationHierarchy_descriptor | String | Descriptive label for the supervisory organization hierarchy. | |
| cf_BeginningContingentWorkerCountInclSubOrgs | Int | Total number of contingent workers at the beginning of the period, including subordinate organizations. | |
| cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover percentage of employees, including subordinate organizations. | |
| cf_OrgHierarchy_id | String | Unique identifier for the organizational hierarchy. | |
| cf_OrgHierarchy_descriptor | String | Descriptive label for the organizational hierarchy. | |
| cf_EmployeeToManagerRatio | Int | Ratio of employees to managers within the organization. | |
| cf_TopPerformerEmployeeCount | Int | Total number of employees classified as top performers. | |
| cf_BeginningEmployeeCount | Int | Total number of employees at the beginning of the period. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the organization record. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the organization record's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the organization record entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the organization record entry was recorded. |
Accesses the Organization as its primary object. The Organization object returns one row per organization.
The Workday Cloud requires filtering on organization_Prompt in order to perform the query.
For example:
SELECT * FROM topLevelOrganizationsAndSubordinates WHERE organization_Prompt = '1fcf0b79747a43d1a4de334e0c214b1b';
| Name | Type | References | Description |
| cf_BusinessUnitManager_id | String | Unique identifier for the business unit manager. | |
| cf_BusinessUnitManager_descriptor | String | Descriptive label for the business unit manager. | |
| cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of employee terminations, including subordinate organizations. | |
| cf_CompanyCostingManager_id | String | Unique identifier for the company costing manager. | |
| cf_CompanyCostingManager_descriptor | String | Descriptive label for the company costing manager. | |
| cf_CostCenterManager_id | String | Unique identifier for the cost center manager. | |
| cf_CostCenterManager_descriptor | String | Descriptive label for the cost center manager. | |
| cf_ManagerCount_IncludingSubordinateOrganizations | Int | Total number of managers, including those in subordinate organizations. | |
| cf_BeginningEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the beginning of the period, including subordinate organizations. | |
| cf_RegionCostingManager_id | String | Unique identifier for the regional costing manager. | |
| cf_RegionCostingManager_descriptor | String | Descriptive label for the regional costing manager. | |
| cf_MidYearReviewPercentCompleteRange_id | String | Unique identifier for the range of completion for mid-year reviews. | |
| cf_MidYearReviewPercentCompleteRange_descriptor | String | Descriptive label for the range of completion for mid-year reviews. | |
| cf_EmployeeVoluntaryTerminationsCount | Int | Total number of voluntary terminations by employees. | |
| cf_EndingEmployeeCount_IncludingSubordinateOrganizations | Int | Total number of employees at the end of the period, including subordinate organizations. | |
| cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations | Int | Total number of voluntary terminations by employees, including subordinate organizations. | |
| cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations | Int | Total number of contingent workers at the end of the period, including subordinate organizations. | |
| cf_AverageHeadcount_IncludingSubordinateOrganizations | Int | Average number of employees, including those in subordinate organizations. | |
| cf_SupervisoryOrganizationHierarchy_id | String | Unique identifier for the supervisory organization hierarchy. | |
| cf_SupervisoryOrganizationHierarchy_descriptor | String | Descriptive label for the supervisory organization hierarchy. | |
| cf_BeginningContingentWorkerCountInclSubOrgs | Int | Total number of contingent workers at the beginning of the period, including subordinate organizations. | |
| cf_TurnoverPercent_IncludingSubordinateOrganizations | Int | Turnover percentage of employees, including subordinate organizations. | |
| cf_OrgHierarchy_id | String | Unique identifier for the organizational hierarchy. | |
| cf_OrgHierarchy_descriptor | String | Descriptive label for the organizational hierarchy. | |
| cf_EmployeeToManagerRatio | Int | Ratio of employees to managers within the organization. | |
| cf_TopPerformerEmployeeCount | Int | Total number of employees classified as top performers. | |
| cf_BeginningEmployeeCount | Int | Total number of employees at the beginning of the period. | |
| effectiveAsOfDate | Date | A pseudo-column used to filter data based on the effective date of the organization record. | |
| effectiveAsOfMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of the organization record's effectiveness. | |
| entryDate | Date | A pseudo-column used to filter data based on the date the organization record entry was recorded. | |
| entryMoment | Datetime | A pseudo-column used to filter data based on the exact timestamp of when the organization record entry was recorded. |
When ConnectionType is set to WQL, the Cloud models Workday data sources as views. To get a complete list of these data sources, run the Data Sources standard report in Workday. The Cloud exposes each data source using its WQL Alias, which is shown on the View Data Source page.
The Cloud exposes two kinds of data sources:
The Cloud does not list all the data sources defined within Workday. It only exposes data sources that are accessible to the authenticating user. For example, if the authenticating user has only HR roles, they may view data sources containing employee records, but not data sources about financial assets.
The Cloud only supports one data source filter per data source. When the unfiltered version of the data source is available, it picks the first filter when a filter is required. For further information, see WQLDataSourceFilters.
To work around this limitation, use UseSplitTables to split each data source into multiple views with fewer columns.
When ConnectionType is set to REST, the Cloud models Workday information as an easy-to-use SQL database with tables and views.
The Tables section, which details standard SQL tables, and the Views section, which lists read-only SQL tables, contain samples of what you might have access to in your Workday account.
Common tables include:
| Table | Description |
| Workers | Retrieves detailed worker records, including employment history, job assignments, and organizational roles. |
| Jobs | Retrieves detailed job positions within the organization, including job titles, descriptions, and classifications. |
| JobProfiles | Defines the attributes and requirements of various job roles, such as necessary skills and qualifications. |
| Organizations | Represents the company's organizational structure, including departments, divisions, and teams. |
| SupervisoryOrganizations | Specifies reporting hierarchies and management relationships within the organization. |
| PayGroups | Stores and retrieves structured data related to payroll groups, including identification, eligibility rules, and payment processing settings. |
| PayrollInputs | Captures and manages individual payroll input records, including employee-specific earnings, deductions, and adjustments for payroll processing. |
| TimeClockEvents | Retrieves a collection of time clock entries for a worker within a specified date range, capturing punch-in/out details and timestamps. |
| JobChangesAdministrative | Tracks administrative updates to a worker's job details, such as employment status changes, worker type adjustments, or organizational assignment shifts. |
| JobChangesJobProfile | Captures changes to an employee’s job profile, including updates to the role's classification, responsibilities, or title. |
| Projects | Stores information about various projects, allowing retrieval of project metadata, statuses, and associated attributes for organizational planning and execution. |
| Requisitions | Manages purchase requisitions, tracking details such as requested items, approvers, and statuses. |
| ExpenseReports | Contains detailed records of employee-submitted expense reports, including submission status, approval workflow, and reimbursement amounts. |
| ExpenseEntries | Stores individual expense line items within an expense report, detailing transaction-specific information like expense type, date, amount, and associated project or cost center. |
| EffectiveChanges | Maintains a log of all effective-dated changes applied to worker or organizational data, such as job changes, compensation adjustments, or transfers. |
| Scorecards | Represents structured templates used to assess employee performance, often containing goals, competencies, and evaluation criteria. |
| Payments | Records and retrieves customer invoice payment transactions, including amounts, payment methods, and processing statuses. |
| SupplierInvoiceRequests | Stores supplier invoice requests, including approval and payment details. |
| Cases | Maintains a record of cases that a user has access to view. Supports issue tracking, employee relations cases, IT service requests, and customer support interactions. |
| Requests | Contains user-initiated requests for business processes such as time off, job changes, or compensation updates. Acts as a centralized repository for pending, approved, or denied requests, providing visibility and control over employee-driven actions. |
The Cloud models the data in Workday as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| AdHocProjectTimeTransactions | Records ad hoc project-time transactions. This table allows tracking of manually entered work hours for project-based assignments, workforce planning, payroll processing, and cost allocation. |
| Attachments | Manages file attachments that are associated with cases. This table enables users to upload supporting documents, images, or records during case creation for compliance, auditing, and issue resolution. |
| Audiences | Get Audience |
| AudiencesCampaignCategory | Reads /campaignCategory entries from the Audiences table. |
| AudiencesConnectTypes | Reads /connectTypes entries from the Audiences table. |
| AudiencesExcludesWorkers | Reads /excludesWorkers entries from the Audiences table. |
| AudiencesIncludesWorkers | Reads /includesWorkers entries from the Audiences table. |
| BillableTransactions | Contains detailed records of billable transactions. This table captures information such as transaction amounts, associated accounts, billing periods, and customer details for financial processing and revenue tracking. |
| Cases | Maintains a record of cases that a user has access to view.This table supports issue tracking, employee relations cases, IT service requests, and customer support interactions. |
| CasesTimeline | Contains a chronological history of case-related events, comments, and interactions. This table supports auditability, collaboration, and case resolution tracking. |
| CasesTimelineAttachments | Manages file attachments that are linked to case timelines. This table ensures that supporting documents, evidence, and references are available for audit trails and case validation. |
| Definitions | Stores metadata definitions for custom objects within Workday, detailing their attributes, structure, and relationships. This table provides foundational information for managing custom object schemas. |
| DefinitionsConditionRules | Contains predefined condition rules associated with custom object definitions. These rules dictate how data should be validated or processed within a custom object framework. |
| DefinitionsFields | Defines individual fields within custom objects, outlining their properties, data types, and relationships. This table serves as a reference for understanding the structure of custom objects. |
| DefinitionsFieldsAuthorizedUsages | Tracks authorized usages for fields within custom object definitions. This ensures that fields are utilized in accordance with predefined security and access policies. |
| DefinitionsFieldsCategories | Categorizes fields within custom object definitions, helping users organize and classify data attributes based on functional groupings or business needs. |
| DefinitionsFieldsDisplayOptions | Stores display preferences and UI rendering configurations for fields in custom object definitions. This table dictates how fields appear in Workday interfaces. |
| DefinitionsFieldsPrompts | Contains prompt settings for fields within custom objects, providing context-sensitive guidance to users when entering or selecting data. |
| DefinitionsFieldsValidations | Defines validation rules for fields in custom objects, ensuring data integrity by enforcing constraints such as format checks, value ranges, and mandatory requirements. |
| DefinitionsValidations | Stores validation rules applicable to custom object definitions, governing how data is verified and ensuring compliance with business rules. |
| EffectiveChanges | Tracks effective change data related to organizations and workers, providing insights into historical and upcoming changes in employment, organizational structure, and worker attributes. |
| EffectiveChangesRequestCriteriaOrganizations | Defines organization-based filtering criteria for effective change data, allowing users to query modifications related to specific organizational entities. |
| EffectiveChangesRequestCriteriaResponseFilterAdditionalNameTypes | Specifies additional name types to be included in response filtering when querying effective change data, ensuring comprehensive retrieval of name-related updates. |
| EffectiveChangesRequestCriteriaResponseFilterOrganizationRoles | Stores role-based filtering criteria for effective change data, ensuring that changes affecting specific organizational roles are retrieved accurately. |
| EffectiveChangesRequestCriteriaResponseFilterOrganizationTypes | Defines filters based on organization types for refining effective change queries, enabling users to segment data retrieval according to business units, departments, or other classifications. |
| EffectiveChangesRequestCriteriaResponseFilterPaymentElectionRules | Maintains filtering rules for payment elections in the effective change dataset, ensuring that financial and compensation-related modifications are accurately captured. |
| EffectiveChangesRequestCriteriaWorkerOverrides | Stores override criteria for workers in effective change queries, allowing exceptions or special conditions to be applied when retrieving worker-related changes. |
| EffectiveChangesResponseDataDocuments | Contains response data documents generated from effective change queries, providing structured outputs for reporting, auditing, and compliance purposes. |
| EventDrivenIntegrationVendorResponse | Manages vendor response data within an event-driven integration process, ensuring seamless updates after third-party payroll processing is completed. |
| EventDrivenIntegrationVendorResponseErrorMessageSetErrors | Stores error messages related to vendor responses in event-driven integrations, aiding in troubleshooting and process optimization. |
| ExpenseEntries | Stores individual Quick Expense entries, detailing cost, category, and payment information for employee reimbursements and financial reporting. |
| ExpenseEntriesAttachments | Retrieves attachment records linked to expense entries, providing access to receipts, invoices, and other supporting documents submitted with expenses. |
| ExpenseReports | Stores and retrieves structured data for expense reports, including employee submissions, approval status, total amounts, and attached supporting documentation. |
| ExternalCreators | Maintains records of external contacts involved in Workday cases, storing details such as name, contact information, and case association. |
| FieldTypes | Defines custom field types that can be used across different Workday objects, enabling organizations to extend standard data structures. |
| FieldTypesListInfoValues | Contains metadata and structural information about lists used within FieldTypes, supporting data consistency and validation. |
| FieldTypesListValues | Stores actual values for custom lists defined in FieldTypes, providing selectable options for custom fields and configurations. |
| GiveRequestedFeedbackEvents | Tracks feedback request events initiated within the system, recording responses and associated feedback details about employees. |
| GiveRequestedFeedbackEventsBusinessProcessParametersAttachments | Links attachments submitted as part of business process parameters related to feedback request events, ensuring supporting documents are available for review. |
| GiveRequestedFeedbackEventsFeedbackComments | Holds detailed comments provided as feedback for employees, offering qualitative insights into performance and professional growth. |
| HomeContactInformationChangesAddresses | Tracks address changes staged for update in an employee's home contact details, reflecting modifications pending approval. |
| HomeContactInformationChangesEmailAddresses | Maintains a record of email address changes in employee contact information, ensuring updated communication channels. |
| HomeContactInformationChangesInstantMessengers | Captures updates to instant messaging details within employee contact information, ensuring real-time communication availability. |
| HomeContactInformationChangesPhoneNumbers | Logs updates to employee phone numbers within the home contact details, ensuring current contact records are maintained. |
| HomeContactInformationChangesWebAddresses | Stores pending changes to web addresses within employee contact details, supporting profile updates and digital presence tracking. |
| InterviewsFeedback | Stores feedback provided by interviewers on candidate performance, helping in decision-making for hiring processes. |
| JobChangesAdministrative | Provides administrative options related to a specific job change, including approval workflows and policy adherence. |
| JobChangesBusinessTitle | Retrieves the updated business title associated with a specific job change, reflecting new roles or responsibilities. |
| JobChangesComment | Returns comments or notes associated with a specific job change, providing additional context on the update. |
| JobChangesContract | Retrieves contract-related details for a job change, including modifications to employment agreements or terms. |
| JobChangesJobClassification | Retrieves job classification details for a specific job change, ensuring accurate categorization based on organizational standards. |
| JobChangesJobProfile | Retrieves a job profile for a given job change, providing role-specific details such as responsibilities and required skills. |
| JobChangesLocation | Returns location-related details associated with a job change, ensuring proper worksite assignments and compliance. |
| JobChangesMoveTeam | Retrieves team movement details related to a job change, supporting internal team transfers and reassignments. |
| JobChangesOpening | Retrieves details on open job positions associated with a job change, helping manage job transfers and internal mobility. |
| JobChangesPosition | Retrieves position details for a given job change, ensuring updates align with organizational structure and reporting lines. |
| JobChangesStartDetails | Retrieves start date and other onboarding-related details for a specific job change. |
| MessageTemplates | Retrieves predefined message templates used for notifications and communications related to HR and job processes. |
| OrganizationAssignmentChangesBusinessUnit | Retrieves business unit details associated with organization assignment changes. |
| OrganizationAssignmentChangesComment | Retrieves comment details related to an organization assignment change, providing additional context. |
| OrganizationAssignmentChangesCompany | Retrieves company details linked to an organization assignment change, ensuring correct entity alignment. |
| OrganizationAssignmentChangesCostCenter | Retrieves cost center information associated with an organization assignment change, supporting financial tracking. |
| OrganizationAssignmentChangesCosting | Retrieves costing organization details related to an organization assignment change, ensuring accurate cost allocation. |
| OrganizationAssignmentChangesCustomOrganizations | Retrieves custom organization details linked to an organization assignment change, allowing for specialized tracking. |
| OrganizationAssignmentChangesRegion | Retrieves region details associated with an organization assignment change, ensuring correct geographical placement. |
| OrganizationAssignmentChangesStartDetails | Retrieves start date and onboarding details for an organization assignment change. |
| PayGroupsPeriods | Supports a collection of payroll periods associated with a specific Payroll Interface pay group ID, facilitating accurate period-based payroll calculations. |
| Payments | Records and retrieves customer invoice payment transactions, including amounts, payment methods, and processing statuses. |
| PaymentsRemittanceDetails | Stores detailed breakdowns of remittance lines associated with customer invoice payments, ensuring complete financial reconciliation. |
| PayrollInputs | Captures and manages individual payroll input records, including employee-specific earnings, deductions, and adjustments for payroll processing. |
| PayrollInputsInputDetails | Stores detailed breakdowns of payroll input records, including itemized earnings, deductions, and tax components applied to each payroll entry. |
| PayrollInputsRunCategories | Organizes and categorizes payroll input records by run category, enabling precise payroll runs based on defined processing rules. |
| PayrollInputsWorktags | Links payroll input records with relevant worktags to ensure proper accounting and reporting of payroll expenses. |
| PlanPhases | Stores and retrieves details about specific phases within a project plan, tracking key milestones and timelines for effective project management. |
| PlanTasks | Maintains a collection of tasks within a project plan, including assignments, deadlines, and dependencies for a given project or project phase. |
| Projects | Stores information about various projects, allowing retrieval of project metadata, statuses, and associated attributes for organizational planning and execution. |
| ProjectsBusinessEventRecords | Maintains records of business events linked to projects, such as approvals, status updates, and key decision points, for auditing and tracking purposes. |
| ProjectsGroups | Stores group associations within projects, enabling retrieval of information about team structures, project roles, and collaborations. |
| ProjectsOptionalHierarchies | Captures optional hierarchical structures within projects, allowing flexible organization and classification of project elements. |
| ProjectsProjectDependencies | Tracks dependencies between different projects, providing insight into interrelated project timelines and potential scheduling conflicts. |
| ProjectsWorktags | Stores worktags associated with projects, helping in financial tracking, categorization, and reporting based on project-specific IDs. |
| Prospects | Manages and stores information about prospective candidates for recruitment, allowing for the creation and tracking of potential hires within the system. |
| ProspectsCandidatePools | Associates prospects with candidate pools, facilitating segmentation of potential hires based on skill sets, experience, or job roles. |
| ProspectsCandidateTags | Stores tags linked to prospects, enabling categorization based on skills, experience, or recruitment status. |
| ProspectsEducations | Retrieves educational background details for a specific prospect, providing insights into qualifications and academic history. |
| ProspectsExperiences | Stores and retrieves work experience details of prospects, allowing recruiters to assess career history and job suitability. |
| ProspectsLanguages | Captures language proficiency information for prospects, supporting multilingual hiring and candidate assessment. |
| ProspectsLanguagesAbilities | Links language abilities to a prospect’s language records, detailing their proficiency levels and specific linguistic skills. |
| ProspectsResumeAttachments | Stores and retrieves resume attachments uploaded by prospects, ensuring easy access to applicant documentation. |
| ProspectsSkills | Captures and retrieves details on skills possessed by prospects, assisting recruiters in identifying suitable candidates based on expertise. |
| Requests | Retrieves details for a specific request using its unique ID. |
| RequestsQuestionnaireResponsesQuestionnaireAnswers | Contains answers submitted for questionnaire responses associated with specific requests. |
| Requisitions | Manages purchase requisitions, tracking details such as requested items, approvers, and statuses. |
| RequisitionsAttachments | Stores metadata and file content for attachments linked to requisitions. |
| RequisitionsRequisitionLines | Manages line items within requisitions, including requested quantities and pricing. |
| RequisitionsRequisitionLinesWorktags | Stores worktag values associated with requisition line items. |
| RequisitionsWorktags | Links worktags to requisitions at a header level for tracking and cost allocation. |
| ResourceForecastLinesAllocations | Manages specific allocations within resource forecast lines. |
| ResourcePlanLines | Stores individual resource planning line items, detailing resource allocation. |
| ResourcePlanLinesExcludedWorkers | Tracks workers who are excluded from specific resource plans. |
| ResourcePlanLinesRequirements | Defines specific resource requirements within a resource plan. |
| ScorecardResults | Stores and retrieves scorecard evaluations used for performance tracking. |
| ScorecardResultsDefaultScorecardGoalsResultPerformanceScores | Retrieves performance scores from default scorecard goal evaluations. |
| ScorecardResultsProfileScorecardGoalsResult | Retrieves profile-based scorecard goal results for performance analysis. |
| Scorecards | Manages compensation scorecard data for performance-based evaluations. |
| ScorecardsDefaultScorecardGoals | Stores default scorecard goals for use in performance assessments. |
| ScorecardsScorecardProfiles | Links scorecards to profiles for tracking and managing performance results. |
| StudentsPayments | Stores student payment transactions and billing information. |
| SupplierInvoiceRequests | Stores supplier invoice requests, including approval and payment details. |
| SupplierInvoiceRequestsAttachments | Manages attachments linked to supplier invoice requests. |
| TaskResources | Retrieves a collection of task resources, including metadata and dependencies associated with tasks within Workday. |
| TaskResourcesProjectResources | Fetches project resource data linked to tasks, enabling project tracking and resource allocation analysis. |
| TaxRates | Retrieves a single or a collection of State Unemployment Insurance (SUI) tax rates configured for different company entities. |
| TimeClockEvents | Retrieves a collection of time clock entries for a worker within a specified date range, capturing punch-in/out details and timestamps. |
| WorkContactInformationChangesAddresses | Represents address updates pending approval as part of a worker's contact information change process. |
| WorkContactInformationChangesEmailAddresses | Retrieves all email address changes staged for update as part of a Workday business process. |
| WorkContactInformationChangesInstantMessengers | Captures pending updates to a worker’s instant messaging details within the Workday system. |
| WorkContactInformationChangesPhoneNumbers | Records phone number changes for a worker before they are officially updated in Workday. |
| WorkContactInformationChangesWebAddresses | Tracks updates to a worker's web address details, such as personal or professional websites, awaiting approval. |
| WorkersAnytimeFeedbackEvents | Retrieves feedback events given to or about a worker, including manager and peer reviews. |
| WorkersAnytimeFeedbackEventsBusinessProcessParametersAttachments | Fetches attachments associated with business process events related to anytime feedback. |
| WorkersAnytimeFeedbackEventsFeedbackAlsoAbout | Lists additional workers referenced in a feedback event, providing context on multi-person evaluations. |
| WorkersAnytimeFeedbackEventsWorkersToNotify | Lists workers notified about a specific feedback event, including managers and HR personnel. |
| WorkersBusinessTitleChanges | Retrieves historical and pending changes to a worker’s business title, tracking career progression. |
| WorkersCheckIns | Retrieves detailed information on a worker’s check-in records, including topics discussed and feedback received. |
| WorkersCheckInsAssociatedTopics | Lists topics associated with check-in meetings, providing insights into recurring themes in discussions. |
| WorkersCheckInsCheckInAttachments | Fetches attachments related to worker check-ins, such as documents or notes shared during a session. |
| WorkersCheckInTopics | Retrieves a collection of discussion topics covered in worker check-ins, aiding in performance management. |
| WorkersCheckInTopicsAssociatedCheckIns | Lists check-in sessions that reference a specific topic, useful for tracking recurring discussions over time. |
| WorkersCheckInTopicsCheckInTopicAttachments | Fetches files or supporting materials attached to check-in topics for enhanced documentation. |
| WorkersDevelopmentItems | Retrieves development items for a worker, including skill-building tasks and career advancement plans. |
| WorkersExplicitSkills | Retrieves explicitly recorded skills for a worker that are tracked and maintained as part of their professional profile in Workday. |
| WorkersExplicitSkillsSkillSources | Fetches sources of explicit skills, such as self-reported skills, manager endorsements, or third-party assessments, providing context for skill validation. |
| WorkersExternalSkillLevel | Retrieves externally acquired skill levels for a worker from third-party systems, certifications, or external assessments. |
| WorkersRequestedFeedbackOnSelfEvents | Retrieves instances where a worker has requested feedback on their own performance from colleagues, managers, or peers. |
| WorkersRequestedFeedbackOnSelfEventsBusinessProcessParametersAttachments | Fetches attachments linked to feedback requests initiated by a worker, such as self-evaluations or supporting documents. |
| WorkersRequestedFeedbackOnSelfEventsFeedbackQuestions | Lists questions included in a worker’s self-requested feedback, enabling structured evaluation. |
| WorkersRequestedFeedbackOnSelfEventsFeedbackResponders | Retrieves details on who has responded to a worker's self-requested feedback and their responses. |
| WorkersRequestedFeedbackOnWorkerEvents | Retrieves feedback requests initiated by managers or peers regarding a specific worker. |
| WorkersRequestedFeedbackOnWorkerEventsBusinessProcessParametersAttachments | Fetches attachments related to feedback requests initiated by managers or peers for a worker. |
| WorkersRequestedFeedbackOnWorkerEventsFeedbackQuestions | Lists evaluation questions used in peer or manager-initiated feedback for a worker. |
| WorkersRequestedFeedbackOnWorkerEventsFeedbackResponders | Retrieves a list of individuals who provided feedback in response to a manager or peer request regarding a worker. |
| WorkersSkillItems | Lists skill items associated with a worker, including validated competencies and self-reported skills. |
Records ad hoc project-time transactions. This table allows tracking of manually entered work hours for project-based assignments, workforce planning, payroll processing, and cost allocation.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the ad hoc project time transaction instance. This Id ensures that each time entry is distinctly tracked and managed within the system. |
| BillingStatus_Descriptor | String | False |
A human-readable summary of the billing status for the ad hoc project time transaction. This summary provides context on whether the transaction is billable, non-billable, or pending. |
| BillingStatus_Href | String | False |
A direct link to the billing status instance associated with this ad hoc project time transaction. This link provides programmatic access to retrieve detailed billing information. |
| BillingStatus_Id | String | False |
The unique Id for the billing status associated with this ad hoc project time transaction. This Id ensures accurate classification of the transaction's billing state. |
| Descriptor | String | False |
A human-readable summary of the ad hoc project time transaction instance. This summary provides quick reference details about the transaction. |
| Hours | Decimal | False |
The total number of hours logged for the ad hoc project time transaction. This value represents the time spent on a project that is recorded outside standard time-tracking workflows. |
| Href | String | False |
A direct link to the ad hoc project time transaction instance. This link provides programmatic access to retrieve detailed information about the transaction. |
| IncludeCost | Bool | False |
Indicates whether costs are calculated for the ad hoc project time transaction. A value of 'true' ensures that labor costs are included in financial reporting. |
| Memo | String | False |
The memo or description entered for the ad hoc project time transaction. This value provides additional context about the purpose or details of the recorded time. |
| ProjectRole_Descriptor | String | False |
A human-readable summary of the project role associated with the ad hoc project time transaction. This summary provides insight into the worker's role within the project. |
| ProjectRole_Href | String | False |
A direct link to the project role instance associated with this ad hoc project time transaction. This link provides programmatic access to retrieve role-specific details. |
| ProjectRole_Id | String | False |
The unique Id for the project role linked to this ad hoc project time transaction. This Id ensures that roles are correctly associated with recorded time. |
| Project_Descriptor | String | False |
A human-readable summary of the project associated with the ad hoc project time transaction. This summary provides context about the project to which the time entry applies. |
| Project_Href | String | False |
A direct link to the project instance associated with this ad hoc project time transaction. This link provides programmatic access to retrieve detailed project information. |
| Project_Id | String | False |
The unique Id for the project linked to this ad hoc project time transaction. This Id ensures that recorded time is accurately associated with the correct project. |
| RateToBill_Currency | String | False |
The currency type for the actual rate at which the ad hoc project time transaction is billed. This value specifies the currency in which billing occurs. |
| RateToBill_Value | Decimal | False |
The actual rate at which the ad hoc project time transaction is billed. This value represents the financial charge applied per hour worked on the project. |
| StandardCostRate_Currency | String | False |
The currency type for the hourly standard cost rate applied to the ad hoc project time transaction. This value specifies the cost calculation currency. |
| StandardCostRate_Value | Decimal | False |
The hourly standard cost rate for hours logged on the ad hoc project time transaction. This value represents the baseline cost applied to the recorded time. |
| Task_Descriptor | String | False |
A human-readable summary of the task associated with the ad hoc project time transaction. This summary provides context about the specific task to which the recorded time applies. |
| Task_Href | String | False |
A direct link to the task instance associated with this ad hoc project time transaction. This link provides programmatic access to retrieve task-specific details. |
| Task_Id | String | False |
The unique Id for the task linked to this ad hoc project time transaction. This Id ensures that recorded time is accurately assigned to the correct task. |
| TransactionDate | Datetime | False |
The date of the ad hoc project time transaction, formatted as YYYY-MM-DD. This date indicates when the time entry was recorded. |
| Worker_Descriptor | String | False |
A human-readable summary of the worker associated with the ad hoc project time transaction. This summary provides context about the individual who logged the time. |
| Worker_Href | String | False |
A direct link to the worker instance associated with this ad hoc project time transaction. This link provides programmatic access to retrieve worker details. |
| Worker_Id | String | False |
The unique Id for the worker linked to this ad hoc project time transaction. This Id ensures that time entries are accurately attributed to the correct individual. |
| ProjectOrProjectHierarchy_Prompt | String | False |
The unique Id or reference Id of a project or project hierarchy. This value can be retrieved using GET /projects and ensures accurate project selection for time tracking. |
Manages file attachments that are associated with cases. This table enables users to upload supporting documents, images, or records during case creation for compliance, auditing, and issue resolution.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM Attachments WHERE Id = 'f8e80f38f2af100009b00e67c49b12f2';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the attachment instance. This Id ensures that each attachment is distinctly tracked and managed within the system. |
| ContentType_Descriptor | String | False |
A human-readable summary of the content type associated with the attachment. This summary provides insight into the type of file, such as document, image, or PDF. |
| ContentType_Href | String | False |
A direct link to the content type instance associated with the attachment. This link provides programmatic access to retrieve details about the file type classification. |
| ContentType_Id | String | False |
The unique Id for the content type associated with the attachment. This Id ensures accurate classification and processing of file attachments within the system. |
| FileLength | Decimal | False |
The total file size of the attachment in bytes. This value helps track storage usage and enforce file size limits. |
| FileName | String | False |
The name of the file attached to the record. This value provides a recognizable label for the file within the system. |
Get Audience
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
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 |
| AudienceType_Descriptor | String | False |
A description of the instance |
| AudienceType_Href | String | False |
A link to the instance |
| AudienceType_Id | String | False |
wid / id / reference id |
| CampaignCategory_Aggregate | String | False |
The campaign categories that this audience is limited to be used for. |
| ConnectTypes_Aggregate | String | False |
The connect types that this audience is able to be used for. |
| CreationDate | String | False |
The date when the audience was created |
| Creator | String | False |
Full name of the user who created the audience |
| Description | String | False |
A more detailed description of the audience. |
| ExcludesWorkers_Aggregate | String | False |
list of workers to be excluded from the audience |
| Inactive | Bool | False |
Indicates if the audience is inactive and is not available for use. |
| IncludesWorkers_Aggregate | String | False |
List of workers to be included in the audience |
| LastUpdatedBy | String | False |
The name of the person who last updated the Connect Audience (Framework). |
| LastUpdatedTime | String | False |
The time (converted to user's local time zone) at which the audience was last updated. |
| Membership_Descriptor | String | False |
A description of the instance |
| Membership_Href | String | False |
A link to the instance |
| Membership_Id | String | False |
wid / id / reference id |
| Name | String | False |
Name |
| WqlQuery | String | False |
Serialized JSON object of an audience used for UI rendering in Audience Builder. |
| WqlQueryString | String | False |
The WQL query text string of an audience |
| AudienceType_Prompt | String | False | |
| CampaignCategory_Prompt | String | False | |
| ConnectTypes_Prompt | String | False | |
| IncludeInactive_Prompt | Bool | False | |
| Name_Prompt | String | False |
Reads /campaignCategory entries from the Audiences table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Id of the instance |
| Audiences_Id [KEY] | String | False |
The Workday ID of the Audiences that contains this. |
| Descriptor | String | False |
A preview of the instance |
| AudienceType_Prompt | String | False | |
| CampaignCategory_Prompt | String | False | |
| ConnectTypes_Prompt | String | False | |
| IncludeInactive_Prompt | Bool | False | |
| Name_Prompt | String | False |
Reads /connectTypes entries from the Audiences table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Id of the instance |
| Audiences_Id [KEY] | String | False |
The Workday ID of the Audiences that contains this. |
| Descriptor | String | False |
A preview of the instance |
| AudienceType_Prompt | String | False | |
| CampaignCategory_Prompt | String | False | |
| ConnectTypes_Prompt | String | False | |
| IncludeInactive_Prompt | Bool | False | |
| Name_Prompt | String | False |
Reads /excludesWorkers entries from the Audiences table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Id of the instance |
| Audiences_Id [KEY] | String | False |
The Workday ID of the Audiences that contains this. |
| Descriptor | String | False |
A preview of the instance |
| AudienceType_Prompt | String | False | |
| CampaignCategory_Prompt | String | False | |
| ConnectTypes_Prompt | String | False | |
| IncludeInactive_Prompt | Bool | False | |
| Name_Prompt | String | False |
Reads /includesWorkers entries from the Audiences table.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Id of the instance |
| Audiences_Id [KEY] | String | False |
The Workday ID of the Audiences that contains this. |
| Descriptor | String | False |
A preview of the instance |
| AudienceType_Prompt | String | False | |
| CampaignCategory_Prompt | String | False | |
| ConnectTypes_Prompt | String | False | |
| IncludeInactive_Prompt | Bool | False | |
| Name_Prompt | String | False |
Contains detailed records of billable transactions. This table captures information such as transaction amounts, associated accounts, billing periods, and customer details for financial processing and revenue tracking.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the billable transaction instance. This Id ensures that each transaction is distinctly tracked and associated with the correct billing process. |
| AdjustmentCount | Decimal | False |
The total count of billing rate applications for this billable transaction. This count reflects the number of times the transaction has been adjusted due to rate modifications or other billing updates. |
| AdjustmentReason_Descriptor | String | False |
A human-readable summary of the reason for the adjustment applied to the billable transaction. This summary provides context on why the adjustment was necessary, such as corrections or rate changes. |
| AdjustmentReason_Href | String | False |
A direct link to the adjustment reason instance. This link provides programmatic access to retrieve details about the reason for the adjustment. |
| AdjustmentReason_Id | String | False |
The unique Id for the adjustment reason associated with this billable transaction. This Id ensures proper tracking of billing changes and their justifications. |
| AmountToBill_Currency | String | False |
The currency type for the amount to be billed for this billable transaction. This value specifies the currency in which the customer is invoiced, excluding applicable taxes. |
| AmountToBill_Value | Decimal | False |
The total amount to be billed for this billable transaction. This value reflects the charge before taxes and adjustments are applied. |
| BillableAmount_Currency | String | False |
The currency type for the original amount to be billed to the customer. This value ensures that billing transactions are accurately represented in the correct monetary unit. |
| BillableAmount_Value | Decimal | False |
The original amount to be billed to the customer before adjustments or tax-only invoices are applied. This value represents the base charge for the transaction. |
| BillableHours | Decimal | False |
The total number of hours originally designated as billable for this transaction. This value reflects the time worked before adjustments or approvals. |
| BillableRate_Currency | String | False |
The currency type for the billable rate applied to this transaction. This value ensures that billing rates are properly recorded in the correct monetary unit. |
| BillableRate_Value | Decimal | False |
The original rate applied for the billable transaction before adjustments. This value represents the agreed-upon rate per hour or unit of service. |
| BillingStatus_Descriptor | String | False |
A human-readable summary of the billing status for this transaction. This summary provides insight into whether the transaction is pending, billed, or requires further processing. |
| BillingStatus_Href | String | False |
A direct link to the billing status instance. This link provides programmatic access to retrieve additional details about the current billing status. |
| BillingStatus_Id | String | False |
The unique Id for the billing status associated with this transaction. This Id ensures accurate tracking of billing progress and updates. |
| Category_Descriptor | String | False |
A human-readable summary of the category assigned to this billable transaction. This summary classifies the transaction based on its type, such as labor, expenses, or service fees. |
| Category_Href | String | False |
A direct link to the category instance associated with this billable transaction. This link provides programmatic access to retrieve category-specific details. |
| Category_Id | String | False |
The unique Id for the category assigned to this billable transaction. This Id ensures proper classification for billing and reporting purposes. |
| Customer_Descriptor | String | False |
A human-readable summary of the customer associated with this billable transaction. This summary identifies the client or entity responsible for payment. |
| Customer_Href | String | False |
A direct link to the customer instance associated with this billable transaction. This link provides programmatic access to retrieve customer-specific details. |
| Customer_Id | String | False |
The unique Id for the customer associated with this billable transaction. This Id ensures accurate assignment of transactions to the appropriate client. |
| Descriptor | String | False |
A human-readable summary of the billable transaction instance. This summary provides a quick reference to identify key details about the transaction. |
| ExpenseDescriptor_Descriptor | String | False |
A human-readable summary of the expense associated with this billable transaction. This summary provides context on reimbursable or chargeable expenses. |
| ExpenseDescriptor_Href | String | False |
A direct link to the expense descriptor instance. This link provides programmatic access to retrieve additional details about the associated expense. |
| ExpenseDescriptor_Id | String | False |
The unique Id for the expense descriptor linked to this billable transaction. This Id ensures that expenses are accurately recorded and assigned. |
| HoursToBill | Decimal | False |
The actual number of hours available for billing in this transaction. This value represents the billable hours after adjustments or exclusions. |
| Href | String | False |
A direct link to the billable transaction instance. This link provides programmatic access to retrieve details about the specific transaction. |
| InvoiceDescription | String | False |
A detailed description of the supplier invoice line item, expense report line item, or usage-based transaction. This description provides clarity for invoicing and reporting purposes. |
| Memo | String | False |
The memo associated with this project billable transaction. This note may include additional details or context about the transaction. |
| PreviouslyInvoiced | Bool | False |
Indicates whether the billable transaction has been previously invoiced. A value of 'true' signifies that the transaction has already been included in an invoice. |
| ProjectRole_Descriptor | String | False |
A human-readable summary of the project role associated with this billable transaction. This summary provides context on the role or responsibility linked to the transaction. |
| ProjectRole_Href | String | False |
A direct link to the project role instance. This link provides programmatic access to retrieve details about the role involved in the transaction. |
| ProjectRole_Id | String | False |
The unique Id for the project role linked to this billable transaction. This Id ensures that labor costs are correctly assigned based on the worker’s role. |
| ProjectTask_Descriptor | String | False |
A human-readable summary of the project task associated with the billable transaction. This summary provides insight into the specific task that incurred the billable cost. |
| ProjectTask_Href | String | False |
A direct link to the project task instance. This link provides programmatic access to retrieve additional details about the task. |
| ProjectTask_Id | String | False |
The unique Id for the project task associated with the billable transaction. This Id ensures that labor or expenses are correctly assigned to the appropriate task within the project. |
| Project_Descriptor | String | False |
A human-readable summary of the project associated with the billable transaction. This summary helps identify the overarching project to which the transaction belongs. |
| Project_Href | String | False |
A direct link to the project instance. This link provides programmatic access to retrieve additional details about the project. |
| Project_Id | String | False |
The unique Id for the project associated with the billable transaction. This Id ensures that the transaction is correctly linked to the appropriate project. |
| RateToBill_Currency | String | False |
The currency type for the actual rate at which the billable transaction is billed. This value ensures the rate is accurately recorded in the correct monetary unit. |
| RateToBill_Value | Decimal | False |
The actual rate that is applied for billing the transaction. This value represents the agreed-upon charge per unit of service or labor. |
| ReasonForChange | String | False |
The reason for the rate change applied to the billable transaction. This explanation helps track adjustments due to contract modifications, approvals, or billing corrections. |
| ResourceProvider_Descriptor | String | False |
A human-readable summary of the resource provider associated with the billable transaction. This summary identifies the entity responsible for supplying the resource or service. |
| ResourceProvider_Href | String | False |
A direct link to the resource provider instance. This link provides programmatic access to retrieve additional details about the resource provider. |
| ResourceProvider_Id | String | False |
The unique Id for the resource provider associated with the billable transaction. This Id ensures that the correct provider is attributed to the transaction. |
| RevenueStatus_Descriptor | String | False |
A human-readable summary of the revenue status of the billable transaction. This summary indicates whether the revenue has been recognized, deferred, or is in another status. |
| RevenueStatus_Href | String | False |
A direct link to the revenue status instance. This link provides programmatic access to retrieve additional details about the revenue recognition status. |
| RevenueStatus_Id | String | False |
The unique Id for the revenue status associated with the billable transaction. This Id ensures accurate tracking of revenue recognition for billing purposes. |
| TransactionDate | Datetime | False |
The date on which the billable transaction occurred. This date is used for financial tracking, reporting, and reconciliation purposes. |
| TransactionSource_Descriptor | String | False |
A human-readable summary of the transaction source for the billable transaction. This summary indicates the origin of the transaction, such as time entry, expense, or adjustment. |
| TransactionSource_Href | String | False |
A direct link to the transaction source instance. This link provides programmatic access to retrieve additional details about the transaction source. |
| TransactionSource_Id | String | False |
The unique Id for the transaction source associated with the billable transaction. This Id ensures accurate attribution of transactions to their respective sources. |
| Worker_Descriptor | String | False |
A human-readable summary of the worker associated with the billable transaction. This summary helps identify the individual responsible for the work or service being billed. |
| Worker_Href | String | False |
A direct link to the worker instance. This link provides programmatic access to retrieve additional details about the worker involved in the transaction. |
| Worker_Id | String | False |
The unique Id for the worker associated with the billable transaction. This Id ensures that labor costs are accurately attributed to the correct employee. |
| ZeroAmountToBill | Bool | False |
Indicates whether the billable transaction has a zero rate. A value of 'true' signifies that no charge is applied for this transaction. |
| BillingStatus_Prompt | String | False |
Filters the billable transactions by status. This field requires the Workday Id of the billing status. Multiple status query parameters can be specified to refine the results. |
| Customer_Prompt | String | False |
Filters the billable transactions by customer. This field requires the Workday Id of the customer associated with the project for the billable transaction. To retrieve a valid Id, call GET /customers in the Customer Accounts REST service. |
| FromDate_Prompt | Date | False |
Filters the billable transactions to include only those with a transaction date on or after the specified date. This filter uses the YYYY-MM-DD format to define the starting range. |
| Phase_Prompt | String | False |
Filters the billable transactions by project phase. This field requires the Workday Id of the project phase associated with the billable transaction for the time entry. To retrieve a valid Id, call GET /planPhases in the Projects REST service. |
| Project_Prompt | String | False |
Filters the billable transactions by project. This field requires the Workday Id of the project associated with the billable transactions. To retrieve a valid Id, call GET /projects in the Projects REST service. |
| SpendCategory_Prompt | String | False |
Filters the billable transactions by spend category. This field requires the Workday Id of the spend category associated with the billable transaction related to the expense report line. |
| Task_Prompt | String | False |
Filters the billable transactions by project task. This field requires the Workday Id of the project task associated with the billable transaction for the time entry. To retrieve a valid Id, call GET /planTasks in the Projects REST service. |
| TimeCode_Prompt | String | False |
Filters the billable transactions by time code. This field requires the Workday Id of the time code associated with the billable transaction for the time entry. |
| ToDate_Prompt | Date | False |
Filters the billable transactions to include only those with a transaction date on or before the specified date. This filter uses the YYYY-MM-DD format to define the ending range. |
| TransactionSource_Prompt | String | False |
Filters the billable transactions by transaction source. This field requires the Workday Id of the transaction source to refine the results. |
| Worker_Prompt | String | False |
Filters the billable transactions by worker. This field requires the Workday Id of the worker associated with the billable transaction. To retrieve a valid Id, call GET /workers in the Staffing service. |
Maintains a record of cases that a user has access to view.This table supports issue tracking, employee relations cases, IT service requests, and customer support interactions.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* \~Case\~ Attachment ID. */
}]
[{
answerDate: Date /* The answer in a date format. */
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. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
questionnaireAttachments: [{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the case instance. This Id allows for distinct tracking, retrieval, and management of cases within the system. |
| AboutWorker_Id | String | False |
The unique Id for the worker that the case is about. This Id ensures that all case-related activities and updates are correctly linked to the designated worker. |
| About_Descriptor | String | False |
A human-readable summary of the case subject. This summary provides a brief but clear reference to the individual or entity involved in the case. |
| About_Id | String | False |
The unique Id for the case subject. This Id ensures consistency in system records and supports case tracking and reporting. |
| About_Person_Descriptor | String | False |
A human-readable summary of the person that the case is about. This summary provides additional clarity by displaying key identifying details of the individual. |
| About_Person_Href | String | False |
A direct link to the instance of the person associated with the case. This link enables programmatic access to fetch detailed information about the individual involved. |
| About_Person_Id | String | False |
The unique Id for the person that the case is about. This Id ensures that system queries and reports accurately reference the correct individual. |
| Assignee_Descriptor | String | False |
A human-readable summary of the case assignee. This summary helps users quickly identify the person or team responsible for managing the case. |
| Assignee_Id | String | False |
The unique Id for the assignee of the case. This Id ensures proper assignment, delegation, and resolution tracking. |
| Assignee_Person_Descriptor | String | False |
A human-readable summary of the assignee responsible for managing the case. This descriptor includes essential details to help users recognize the assigned worker. |
| Assignee_Person_Href | String | False |
A direct link to the assignee's instance. This link provides an easy way to navigate to the assignee’s profile or additional case-related information. |
| Assignee_Person_Id | String | False |
The unique Id for the assignee of the case. This Id ensures that cases are correctly routed to the responsible worker for action. |
| Attachments_Aggregate | String | False |
A collection of attachments added during case creation. These files can include supporting documents, images, or other relevant materials for case resolution. |
| By_Descriptor | String | False |
A human-readable summary of the person who created the case. This summary provides insight into the requestor's identity for better case tracking. |
| By_ExternalCreator_Email | String | False |
The email address of the external case creator. This contact information facilitates communication and case follow-ups with external submitters. |
| By_ExternalCreator_Id | String | False |
The unique Id for the external case creator. This Id helps track cases that originate from individuals outside the organization. |
| By_ExternalCreator_Name | String | False |
The name of the external case creator, often appended with 'External' or a note indicating a purged record. This naming convention helps differentiate external requests from internal ones. |
| By_Id | String | False |
The unique Id for the individual who created the case. This Id ensures precise tracking of case ownership and history. |
| By_Worker_Descriptor | String | False |
A human-readable summary of the worker who created the case. This descriptor aids in recognizing the case initiator without needing additional lookups. |
| By_Worker_Id | String | False |
The unique Id for the worker who initiated the case. This Id supports tracking and reporting on cases created by employees. |
| By_Worker_Person_Descriptor | String | False |
A human-readable summary of the worker who created the case. This descriptor provides useful context about the requestor’s role or position. |
| By_Worker_Person_Href | String | False |
A direct link to the instance of the worker who created the case. This link enables seamless navigation to the requestor’s profile. |
| By_Worker_Person_Id | String | False |
The unique Id for the worker who created the case. This Id ensures that employee-initiated cases are correctly assigned and managed. |
| CaseID | String | False |
The unique Id assigned to the case. This Id is crucial for case tracking, auditing, and referencing within the system. |
| CaseLink | String | False |
A direct link to view the case in Workday. This Uniform Resource Locator (URL) allows users to access full case details and take necessary actions. |
| CaseReopenDetails_CaseReopenDueDate | String | False |
The deadline for reopening the case. This date sets the last possible day when a worker can request a case review or reactivation. |
| CaseReopenDetails_CaseReopenStatus | Bool | False |
Indicates whether the case can be reopened by the worker. A value of 'true' means the worker still has the option to request further action. |
| CaseType_Id | String | False |
The unique Id for the case type. This Id categorizes the case based on its nature, such as HR, IT, or compliance-related issues. |
| Confidential | Bool | False |
Indicates whether the case is marked as confidential. A value of 'true' ensures that access is limited to authorized personnel only. |
| ContextInstance_Id | String | False |
wid / id / reference id |
| CreationDate | Datetime | False |
The date and time when the case was created. This timestamp serves as a historical record and helps track response and resolution times. |
| DetailedMessage | String | False |
The detailed description of the case. This field captures all relevant information, including the issue, request, or inquiry details. |
| ElementContent_Id | String | False |
wid / id / reference id |
| ForExternalCreator_Id | String | False |
The unique Id for the external creator associated with the case. This Id distinguishes cases initiated by external individuals or organizations. |
| ForWorker_Id | String | False |
The unique Id for the worker for whom the case was created. This Id ensures that the case is accurately assigned to the correct employee. |
| For_Descriptor | String | False |
A human-readable summary of the worker or external creator for whom the case was created. This descriptor provides an at-a-glance reference for users handling the case. |
| For_ExternalCreator_Email | String | False |
The email address of the external creator associated with the case. This contact information allows for follow-ups and communications regarding the case. |
| For_ExternalCreator_Id | String | False |
The unique Id for the external creator associated with the case. This Id links the case back to its originating party. |
| For_ExternalCreator_Name | String | False |
The name of the external creator, often including 'External' in parentheses or a note indicating a purged record. This naming convention differentiates external cases from internal ones. |
| For_Id | String | False |
The unique Id for the worker or external creator associated with the case. This Id ensures precise case tracking and accountability. |
| For_Worker_Descriptor | String | False |
A human-readable summary of the worker for whom the case was created. This descriptor provides additional insight into the recipient’s role or involvement in the case. |
| For_Worker_Id | String | False |
The unique Id for the worker for whom the case was created. This Id helps link the case to the appropriate individual for tracking and resolution. |
| For_Worker_Person_Descriptor | String | False |
A human-readable summary of the worker for whom the case was created. This descriptor provides a brief but informative overview of the worker involved. |
| For_Worker_Person_Href | String | False |
A direct link to the worker’s instance. This link allows for quick navigation to detailed information about the worker associated with the case. |
| For_Worker_Person_Id | String | False |
The unique Id for the worker associated with the case. This Id ensures that cases are assigned correctly and consistently. |
| FormattedCreationDate | String | False |
The formatted creation date of the case, including the year, month, day, hour, and minute. This format ensures consistency with the processing user's locale and timezone. |
| QuestionnaireHolder_Id | String | False |
The unique Id for the questionnaire holder associated with the case. This Id ensures that the questionnaire responses remain linked to the correct case. |
| QuestionnaireResponses_Descriptor | String | False |
A human-readable summary of the questionnaire responses for the case. This descriptor provides a high-level view of the responses collected. |
| QuestionnaireResponses_Id | String | False |
The unique Id for the questionnaire responses associated with the case. This Id is used to track and manage responses within the system. |
| QuestionnaireResponses_QuestionnaireAnswers_Aggregate | String | False |
A collection of all answers submitted in response to a questionnaire. These responses provide critical information for case evaluation and resolution. |
| QuestionnaireResponses_QuestionnaireTargetContext_Id | String | False |
The unique Id for the context in which the questionnaire was targeted. This Id helps determine the scope and relevance of the collected responses. |
| QuestionnaireResponses_QuestionnaireTarget_Id | String | False |
The unique Id for the specific questionnaire target. This Id ensures that responses are properly associated with the intended questionnaire. |
| SatisfactionSurvey_Active | Bool | False |
Indicates whether the case has an active satisfaction survey. A value of 'true' means that feedback can still be provided by the user. |
| SatisfactionSurvey_Directive | String | False |
The directive text displayed in the case satisfaction survey. This text offers guidance on how the survey should be completed. |
| SatisfactionSurvey_Results_Comment | String | False |
The comment provided in response to the case satisfaction survey. This feedback allows users to elaborate on their experience with the case. |
| SatisfactionSurvey_Results_FormattedCreationDate | String | False |
The formatted creation date of the case satisfaction survey response, including the year, month, day, hour, and minute. This format ensures clarity for reporting and analysis. |
| SatisfactionSurvey_Results_Id | String | False |
The unique Id for the case satisfaction survey response. This Id links feedback to the appropriate case record. |
| SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Descriptor | String | False |
A human-readable summary of the questionnaire associated with the case satisfaction survey response. This descriptor provides insight into the survey's purpose and content. |
| SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Href | String | False |
A direct link to the questionnaire instance associated with the case satisfaction survey response. This link facilitates easy access to survey details. |
| SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Id | String | False |
The unique Id for the questionnaire associated with the case satisfaction survey response. This Id ensures that feedback is recorded under the correct questionnaire. |
| SatisfactionSurvey_Results_Score_Description | String | False |
A description of the case satisfaction survey response score. This description helps interpret the numerical rating given by the respondent. |
| SatisfactionSurvey_Results_Score_Number | Decimal | False |
The numeric score given in response to the case satisfaction survey. This score quantifies user satisfaction with the resolution of the case. |
| SatisfactionSurvey_Task | String | False |
Indicates whether the satisfaction survey has been dismissed. A value of 'true' means that the user has chosen not to complete the survey. |
| ServiceTeam_Descriptor | String | False |
A human-readable summary of the service team handling the case. This descriptor provides details about the team responsible for resolving the issue. |
| ServiceTeam_Href | String | False |
A direct link to the service team instance. This link enables users to retrieve additional information about the assigned service team. |
| ServiceTeam_Id | String | False |
The unique Id for the service team responsible for the case. This Id ensures accurate case assignment within the system. |
| Source_Id | String | False |
The unique Id for the source of the case. This Id identifies where the case originated, such as from a user, system, or external entity. |
| Status_Descriptor | String | False |
A human-readable summary of the current status of the case. This descriptor provides insight into whether the case is open, resolved, or pending action. |
| Status_Id | String | False |
The unique Id for the status of the case. This Id ensures that the system correctly tracks changes in the case’s status. |
| Title | String | False |
The title of the case. This title serves as a brief summary of the issue or request that the case addresses. |
| Type_Confidential | Bool | False |
Indicates whether the case type is confidential. A value of 'true' restricts access to authorized users only. |
| Type_Description | String | False |
A description of the case type. This description provides additional context about the nature or category of the case. |
| Type_Id | String | False |
The unique Id for the case type. This Id categorizes the case based on its purpose or classification. |
| Type_Inactive | Bool | False |
Indicates whether the case type is inactive. A value of 'true' means that this case type is no longer actively used. |
| Type_Name | String | False |
The display Id for the case type. This name represents the case type in a user-friendly format. |
| Type_ServiceCategory_Description | String | False |
A description of the service category associated with the case type. This description provides details about the type of service the case falls under. |
| Type_ServiceCategory_Id | String | False |
The unique Id for the service category associated with the case type. This Id ensures proper classification of service types. |
| Type_ServiceCategory_Name | String | False |
The name of the service category associated with the case type. This name represents the category of service in a way that is easy to understand. |
| UiTask_Id | String | False |
wid / id / reference id |
| Desc_Prompt | Bool | False |
Indicates whether results should be sorted in descending order. A value of 'true' ensures that the most recent cases appear first. |
| MyCases_Prompt | Bool | False |
Retrieves cases that are owned by the processing user. This filter helps users see only the cases assigned to them. |
| OpenCases_Prompt | Bool | False |
Retrieves open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on recent case activity. |
| Sort_Prompt | String | False |
Determines the field used for sorting case results. The default sorting field is 'creationDate'. Currently, only sorting by 'creationDate' is supported. |
Contains a chronological history of case-related events, comments, and interactions. This table supports auditability, collaboration, and case resolution tracking.
The Workday Cloud requires filtering on Cases_Id in order to perform the query.
For example:
SELECT * FROM CasesTimeline WHERE Cases_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* \~Case\~ Attachment ID. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the case timeline item. This Id ensures that each timeline entry is distinctly tracked within the case history. |
| Cases_Id [KEY] | String | False |
The Workday Id of the case that owns this timeline entry. This Id associates the timeline event with its corresponding case. |
| Attachments_Aggregate | String | False |
A collection of attachments linked to the timeline item. These attachments can include supporting documents, images, or additional details related to the case event. |
| Comment_Content | String | False |
The comment added to the case in rich text format. This field supports formatted text, including styling and embedded links. |
| Comment_TextBody | String | False |
The comment added to the case in plain text format. This version of the comment removes any formatting or rich text elements. |
| CreationDate | Datetime | False |
The date and time when the case timeline item was created. This timestamp provides an audit trail for case-related activities. |
| Description | String | False |
A detailed message included in the case creation timeline entry. This field captures the original message provided by the case creator. |
| FormattedCreationDate | String | False |
The creation date of the timeline item formatted with year, month, day, hour, and minute. The format adapts to the processing user’s locale and timezone settings. |
| Guidance_KbArticle_Descriptor | String | False |
A human-readable summary of the knowledge base article linked to this case timeline item. This summary provides quick context on the related guidance document. |
| Guidance_KbArticle_Id | String | False |
The unique Id for the knowledge base article linked to the case. This Id ensures that the correct article is referenced. |
| Guidance_UiTask_Descriptor | String | False |
A human-readable summary of the UI task linked to the timeline item. This summary helps users understand the purpose of the associated action. |
| Guidance_UiTask_Id | String | False |
The unique Id for the UI task related to the timeline item. This Id ensures accurate tracking of tasks associated with the case. |
| Guidance_UiTask_Url | String | False |
A direct Uniform Resource Locator (URL) to the UI task associated with this case timeline entry. This link enables users to quickly access the relevant task in Workday. |
| QuestionnaireResponse_Questionnaire_Descriptor | String | False |
A human-readable summary of the questionnaire response associated with this case. This summary provides insight into the survey or feedback collected. |
| QuestionnaireResponse_Questionnaire_Href | String | False |
A direct link to the questionnaire response instance. This link allows programmatic access to retrieve response details. |
| QuestionnaireResponse_Questionnaire_Id | String | False |
The unique Id for the questionnaire response linked to the case. This Id ensures proper association of the survey data. |
| SubmittedBy_Descriptor | String | False |
A human-readable summary of the person who submitted the timeline entry. This summary provides context on who contributed to the case history. |
| SubmittedBy_ExternalCreator_Email | String | False |
The email address of the external creator who submitted the case timeline item. This contact detail helps track externally initiated case updates. |
| SubmittedBy_ExternalCreator_Id | String | False |
The unique Id for the external creator of the timeline item. This Id ensures accurate tracking of contributions from external users. |
| SubmittedBy_ExternalCreator_Name | String | False |
The name of the external creator, with 'External' in parentheses or a note indicating a purged record. This field identifies case updates submitted by external sources. |
| SubmittedBy_Id | String | False |
The unique Id for the person who submitted the timeline entry. This Id ensures proper tracking of contributions to the case. |
| SubmittedBy_Worker_Descriptor | String | False |
A human-readable summary of the worker who submitted the timeline entry. This summary provides insight into the employee contributing to the case record. |
| SubmittedBy_Worker_Id | String | False |
The unique Id for the worker who submitted the case timeline item. This Id links the timeline entry to the responsible employee. |
| SubmittedBy_Worker_Person_Descriptor | String | False |
A human-readable summary of the worker associated with the case submission. This summary provides additional context about the case participant. |
| SubmittedBy_Worker_Person_Href | String | False |
A direct link to the worker’s instance. This link allows programmatic retrieval of details about the employee who submitted the timeline item. |
| SubmittedBy_Worker_Person_Id | String | False |
The unique Id for the worker linked to the case submission. This Id ensures the correct employee is referenced in case history. |
| Type_Descriptor | String | False |
A human-readable summary of the type of case timeline entry. This summary provides context on the nature of the recorded event. |
| Type_Id | String | False |
The unique Id for the type of case timeline entry. This Id categorizes the timeline event for reporting and tracking purposes. |
| Desc_Prompt | Bool | False |
If the value is 'true', the query sorts the results in descending order. This setting ensures the most recent case timeline entries appear first. |
| MyCases_Prompt | Bool | False |
Retrieves case timeline entries for cases owned by the processing user. This filter ensures only relevant case history records are displayed. |
| OpenCases_Prompt | Bool | False |
Retrieves timeline entries for open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on active or recently closed cases. |
| Sort_Prompt | String | False |
Specifies the field used to sort query results. The default sorting field is creationDate, ensuring timeline events are displayed chronologically. |
Manages file attachments that are linked to case timelines. This table ensures that supporting documents, evidence, and references are available for audit trails and case validation.
The Workday Cloud requires filtering on Cases_Id in order to perform the query.
For example:
SELECT * FROM CasesTimelineAttachments WHERE Cases_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier (Id) for the case timeline attachment. This Id ensures that each attachment is distinctly tracked and referenced within the system. |
| CasesTimeline_Id [KEY] | String | False |
The Workday Id of the case timeline entry that contains this attachment. This Id links the attachment to a specific timeline event for contextual reference. |
| Cases_Id [KEY] | String | False |
The Workday Id of the case that owns this attachment. This Id ensures that the attachment is associated with the correct case record. |
| Comment | String | False |
The comment associated with the questionnaire attachment. This field can contain additional details or context provided by the user at the time of attachment. |
| FileName | String | False |
The name of the attached file. This field allows users to identify the attachment without opening it. |
| Href | String | False |
A direct link to access the attached file instance. This Uniform Resource Locator (URL) provides programmatic access to retrieve the file. |
| Desc_Prompt | Bool | False |
If set to 'true', the query sorts results in descending order. This setting ensures that the most recently uploaded attachments appear first. |
| MyCases_Prompt | Bool | False |
Retrieves case timeline attachments for cases owned by the processing user. This filter ensures that only relevant attachments are included in the results. |
| OpenCases_Prompt | Bool | False |
Retrieves attachments for open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on active or recently closed cases. |
| Sort_Prompt | String | False |
Specifies the field used to sort query results. The default sorting field is creationDate, ensuring attachments are displayed in chronological order. |
Stores metadata definitions for custom objects within Workday, detailing their attributes, structure, and relationships. This table provides foundational information for managing custom object schemas.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
*alias: Text /* The web service alias of the custom field. */
*authorizedUsages: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
*categories: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
descriptor: Text /* A preview of the instance */
displayOptions: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
draft: Boolean /* If true, the custom field is not activated yet and it is saved as a draft. */
*fieldType: { /* The field type of the custom field. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
href: Text /* A link to the instance */
id: Text /* Id of the instance */
inactive: Boolean /* If true, the custom field should no longer be used. */
*name: Text /* The name of the custom field on the business object. */
order: Text /* The order of the custom field. */
prompts: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
validations: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the custom object instance, used for internal and external references. |
| Active | Bool | False |
Indicates whether the custom object definition is currently active or still in a draft state. |
| Alias | String | False |
The web service alias of the custom object, used for API interactions. |
| BusinessObjectFilter_Descriptor | String | False |
Provides a brief description of the business object filter applied to this instance. |
| BusinessObjectFilter_Href | String | False |
URL link to the business object filter instance, enabling direct access. |
| BusinessObjectFilter_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the business object filter. |
| BusinessObject_Descriptor | String | False |
Description of the related business object, offering contextual information. |
| BusinessObject_Href | String | False |
URL link to the related business object instance for easy navigation. |
| BusinessObject_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the related business object. |
| Descriptor | String | False |
A brief preview or summary of the custom object instance. |
| DisplayValue_Id | String | False |
Unique identifier (WID, Id, or reference Id) representing the display value of the object. |
| Domains_Aggregate | String | False |
Lists the Security Domains that control access to this custom object, separated by commas with 1 space after each comma. |
| Fields_Aggregate | String | False |
Lists all custom fields associated with the custom object, separated by commas with 1 space after each comma. |
| HelpText | String | False |
Text that provides guidance or context for using the custom object within the application. |
| HideOnView | Bool | False |
If true, the field is hidden from view when it is unpopulated. |
| Href | String | False |
URL link to the custom object instance for direct access. |
| MultiInstance | Bool | False |
If true, the custom object allows multiple instances to be associated with the extended business object. |
| Name | String | False |
The name of the custom object, typically used for display and identification. |
| ReferenceId_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the reference Id associated with this instance. |
| UiVisibilityRule_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the UI visibility rule that controls the display of this object. |
Contains predefined condition rules associated with custom object definitions. These rules dictate how data should be validated or processed within a custom object framework.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
and: Boolean /* If true, the condition item uses an AND operator. */
closeParentheses: Boolean /* If true, the condition item has close parentheses. */
openParentheses: Boolean /* If true, the condition item has open parentheses. */
or: Boolean /* If true, the condition item uses an OR operator. */
*order: Text /* The order of the condition item. */
*relationalOperator: Text /* The name for the condition item relational operator. */
*sourceField: { /* The source used by the external field. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
targetBoolean: Boolean /* The target boolean used to compare against the source field. */
targetDate: Date /* The target date used to compare against the condition item source field. */
targetField: { /* The target external field. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
targetInstances: [{
descriptor: Text /* The instance descriptor. */
id: Text /* The Workday ID of the given object. */
}]
targetNumber: Numeric /* The target number used to compare against the condition item source field. */
targetText: Text /* The target text used to compare against the condition item source field. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the condition rule instance. |
| Definitions_Id [KEY] | String | False |
The Workday identifier (WID) that identifies the Definitions object to which this condition rule belongs. |
| Comment | String | False |
User-provided comment that explains the purpose or context of the condition rule. |
| ConditionItems_Aggregate | String | False |
List of condition items that make up the rule, separated by commas with a space after each comma. |
| ConditionRuleId | String | False |
Reference Id used to look up related elements, such as 'Organization_ID' for supervisory organizations. |
| Descriptor | String | False |
Text preview summarizing key information about the condition rule instance. |
| Href | String | False |
URL link to the condition rule instance within the Workday system. |
| RuleDescription | String | False |
Detailed description of the condition rule as provided by the user, specifying its logic or intended use. |
Defines individual fields within custom objects, outlining their properties, data types, and relationships. This table serves as a reference for understanding the structure of custom objects.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance of the custom field. |
| Definitions_Id [KEY] | String | False |
The Workday identifier (WID) of the Definitions object that owns this custom field. |
| Alias | String | False |
The web service alias used to reference the custom field in integrations and reports. |
| AuthorizedUsages_Aggregate | String | False |
Specifies the application areas where the custom field is intended to be used, such as reporting, business processes, or integrations. |
| Categories_Aggregate | String | False |
Lists one or more categories associated with the custom field, used for organizing and filtering fields. |
| Descriptor | String | False |
A text preview that provides a human-readable summary of the instance. |
| DisplayOptions_Aggregate | String | False |
Lists one or more display options configured for the custom field, such as formatting or visibility settings. |
| Draft | Bool | False |
Indicates whether the custom field is saved as a draft. If 'true', the field is not yet active. |
| FieldType_Descriptor | String | False |
A brief description of the custom field type, such as text, number, or date. |
| FieldType_Href | String | False |
A URL link to the Workday reference page for the custom field type. |
| FieldType_Id | String | False |
The unique identifier of the custom field type, which may be a WID, standard Id, or reference Id. |
| Href | String | False |
A URL link to the Workday reference page for this custom field. |
| Inactive | Bool | False |
Indicates whether the custom field is inactive. If 'true', the field should no longer be used. |
| Name | String | False |
The name of the custom field as displayed on the associated business object. |
| Order | String | False |
Specifies the display order of the custom field when shown in forms, reports, or business processes. |
| Prompts_Aggregate | String | False |
Lists the prompt Ids associated with this custom field, used to capture user input or selections. |
| Validations_Aggregate | String | False |
Lists one or more custom field validations applied to ensure data accuracy and compliance with business rules. |
Tracks authorized usages for fields within custom object definitions. This ensures that fields are utilized in accordance with predefined security and access policies.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the current instance, typically used for internal tracking and referencing. |
| DefinitionsFields_Id [KEY] | String | False |
The Workday identifier (WID) of the associated DefinitionsFields record, establishing the relationship between the current instance and its parent DefinitionsFields. |
| Definitions_Id [KEY] | String | False |
The WID of the related Definitions record, indicating the owning Definitions entity that governs this instance. |
| Descriptor | String | False |
A concise summary or label that provides a quick reference to the instance's content or purpose. |
| Href | String | False |
A URL link that provides direct access to the instance within the Workday system, enabling navigation or API interaction. |
Categorizes fields within custom object definitions, helping users organize and classify data attributes based on functional groupings or business needs.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the current instance, typically used as a primary key. |
| DefinitionsFields_Id [KEY] | String | False |
The specific Workday identifier of the DefinitionsFields that this record is associated with. |
| Definitions_Id [KEY] | String | False |
The specific Workday identifier of the Definitions that owns or references this record. |
| Descriptor | String | False |
A brief textual preview that summarizes the instance for quick identification. |
| Href | String | False |
A URL or hyperlink pointing to the detailed instance, allowing direct access within Workday. |
Stores display preferences and UI rendering configurations for fields in custom object definitions. This table dictates how fields appear in Workday interfaces.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for the instance, used to distinguish it from other records. |
| DefinitionsFields_Id [KEY] | String | False |
The Workday identifier (WID) associated with the DefinitionsFields object that includes this instance, enabling reference within related datasets. |
| Definitions_Id [KEY] | String | False |
The WID associated with the parent Definitions object that owns this instance, supporting hierarchical relationships. |
| Descriptor | String | False |
A brief, human-readable summary of the instance, typically used for display purposes in user interfaces. |
| Href | String | False |
A URL linking to the instance, providing direct access to its details in external systems or web-based interfaces. |
Contains prompt settings for fields within custom objects, providing context-sensitive guidance to users when entering or selecting data.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the current instance, used to reference this record in Workday. |
| DefinitionsFields_Id [KEY] | String | False |
The unique Workday identifier (WID) of the DefinitionsFields that this instance belongs to, establishing its parent-child relationship. |
| Definitions_Id [KEY] | String | False |
The unique WID of the Definitions that owns this record, linking it to the broader definition structure. |
| Descriptor | String | False |
A brief summary or label that provides a quick preview of the instance, typically used in search results and reports. |
| Href | String | False |
A URL that links to the detailed view of this instance within the Workday interface, allowing for direct access. |
Defines validation rules for fields in custom objects, ensuring data integrity by enforcing constraints such as format checks, value ranges, and mandatory requirements.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the current instance, used to reference this record in Workday. |
| DefinitionsFields_Id [KEY] | String | False |
The unique Workday identifier (WID) of the DefinitionsFields that this instance belongs to, establishing its parent-child relationship. |
| Definitions_Id [KEY] | String | False |
The unique WID of the Definitions that owns this record, linking it to the broader definition structure. |
| Descriptor | String | False |
A brief summary or label that provides a quick preview of the instance, typically used in search results and reports. |
| Href | String | False |
A URL that links to the detailed view of this instance within the Workday interface, allowing for direct access. |
Stores validation rules applicable to custom object definitions, governing how data is verified and ensuring compliance with business rules.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the validation instance. |
| Definitions_Id [KEY] | String | False |
The Workday identifier (WID) that uniquely identifies the Definitions object that owns this validation. |
| Alias | String | False |
The shorthand or alternate name used to reference the custom object validation. |
| ConditionRule_Descriptor | String | False |
A brief description of the condition rule that determines when the validation triggers. |
| ConditionRule_Href | String | False |
A URL link to the detailed information of the condition rule in Workday. |
| ConditionRule_Id | String | False |
Identifier of the condition rule, which can be a WID, standard Id, or reference Id. |
| CustomField_Descriptor | String | False |
A brief description of the custom field associated with this validation. |
| CustomField_Href | String | False |
A URL link to the detailed information of the custom field in Workday. |
| CustomField_Id | String | False |
Identifier of the custom field, which can be a WID, standard Id, or reference Id. |
| Descriptor | String | False |
A preview or brief summary of the validation instance. |
| Href | String | False |
A URL link to the detailed information of the validation instance in Workday. |
| MessageText | String | False |
The message that is displayed to the user when the validation is triggered. |
| Name | String | False |
The name assigned to the validation for identification purposes. |
| OnlyOnOk | Bool | False |
If true, this validation only executes when the user clicks the OK button to submit the data. Otherwise, it triggers as the user enters data into the custom object. |
| SeverityLevel_Descriptor | String | False |
A brief description of the severity level of the validation. |
| SeverityLevel_Href | String | False |
A URL link to detailed information about the severity level in Workday. |
| SeverityLevel_Id | String | False |
Identifier of the severity level, which can be a WID, standard Id, or reference Id. |
Tracks effective change data related to organizations and workers, providing insights into historical and upcoming changes in employment, organizational structure, and worker attributes.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM EffectiveChanges WHERE Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
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 */
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 */
id: Text /* Id of the instance */
}]
[{
entryMomentFromOverride: Date /* Entry Moment override for the \~Worker\~. */
id: Text /* The \~worker\~ to override. */
}]
[{
id: Text /* Id of the instance */
}]
[{
documentId: Text /* Document ID for document. Can be used in conjunction with Blobitory API to retrieve the document. */
documentTags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
fileName: Text /* File name for document. */
organization: { /* Organization for document. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the instance, used to reference specific records. |
| RequestCriteria_AllEffective | Bool | False |
Defaults to 'false'. Set to true to include all effective changes within the specified date range. If 'false', only incremental changes made within the entry range are returned. |
| RequestCriteria_EffectiveFrom | Datetime | False |
The start date for retrieving changes based on their effective date. |
| RequestCriteria_EffectiveTo | Datetime | False |
The end date for retrieving changes based on their effective date. |
| RequestCriteria_EntryMomentFrom | Datetime | False |
The start date for retrieving changes based on the date they were entered into the system. |
| RequestCriteria_EntryMomentTo | Datetime | False |
The end date for retrieving changes based on the date they were entered into the system. |
| RequestCriteria_ExcludeWorkers | Bool | False |
Set to true to exclude workers specified in the 'workers' request parameter from the output. By default, the parameter is inclusive. |
| RequestCriteria_ExtendedAllEffectiveTo | Datetime | False |
The upper limit for an optional extended range of effective changes. |
| RequestCriteria_Fields_FieldSetVersion | String | False |
Specifies the version of fields for which changes are requested. |
| RequestCriteria_Fields_OnlyInclude_Aggregate | String | False |
A comma-separated list of specific fields to include in the response, with 1 space after each comma. |
| RequestCriteria_ForceRerun | Bool | False |
Set to true to generate a new request, even if the parameters match a previous request. Use only if the previous request is complete or has failed. |
| RequestCriteria_IncludeRequestCriteriaInResponse | Bool | False |
Defaults to false. Set to true to include the original request parameters in the response. |
| RequestCriteria_Organizations_Aggregate | String | False |
Specifies organizations relevant to the external data request, such as pay groups. |
| RequestCriteria_ResponseFilter_AdditionalNameTypes_Aggregate | String | False |
A comma-separated list of additional name types to filter and include in the output, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Descriptor | String | False |
A description of the instance |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Href | String | False |
A link to the instance |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Id | String | False |
wid / id / reference id |
| RequestCriteria_ResponseFilter_CountryNameFormat | String | False |
Specifies the format in which country names should be returned. |
| RequestCriteria_ResponseFilter_CountryRegionNameFormat | String | False |
Specifies the format in which country region names should be returned. |
| RequestCriteria_ResponseFilter_ExcludeAdditionalJobs | Bool | False |
Set to true to exclude additional job data from the response. |
| RequestCriteria_ResponseFilter_FullSnapshot | Bool | False |
Set to true to include all workers within the request, regardless of whether they have changes to report. |
| RequestCriteria_ResponseFilter_IncludeEndedContracts | Bool | False |
Set to true to include data related to ended contracts in the output. |
| RequestCriteria_ResponseFilter_OrganizationRoles_Aggregate | String | False |
A comma-separated list of organization roles to include in the Position data section, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_OrganizationTypes_Aggregate | String | False |
A comma-separated list of organization types to filter and include in the output, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_PaymentElectionRules_Aggregate | String | False |
A comma-separated list of payment election rules used to filter payment election data, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_ReportPostTermCompensation | Bool | False |
Set to true to include post-termination compensation changes in the output. |
| RequestCriteria_SchemaOnly | Bool | False |
Set to true to return only the schema file. Set to false to return both the schema file and other output files. Use this option to identify available API fields and map them to external vendor fields as needed. |
| RequestCriteria_WorkerOverrides_Aggregate | String | False |
A comma-separated list of worker overrides relevant to the data request, with 1 space after each comma. |
| RequestCriteria_Workers_Aggregate | String | False |
A comma-separated list of workers relevant to the data request, with 1 space after each comma. |
| ResponseData_Documents_Aggregate | String | False |
Comma-separated IDs of documents containing data produced using the request parameters. Use the Blobitory REST API to retrieve the documents, with 1 space after each comma. |
| ResponseData_Status_Descriptor | String | False |
Descriptive status message providing additional context about the instance. |
| ResponseData_Status_Href | String | False |
URL link to access the instance. |
| ResponseData_Status_Id | String | False |
Unique identifier of the instance, which can be a Workday identifier (WID), Id, or reference Id. |
Defines organization-based filtering criteria for effective change data, allowing users to query modifications related to specific organizational entities.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaOrganizations WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the organization instance within the EffectiveChanges request. Used to track specific entities. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday identifier (WID) associated with the EffectiveChanges event that includes this organization. This Id links the organization to its related changes. |
| Descriptor | String | False |
A short, human-readable preview or summary of the organization instance, typically used for display in user interfaces. |
Specifies additional name types to be included in response filtering when querying effective change data, ensuring comprehensive retrieval of name-related updates.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaResponseFilterAdditionalNameTypes WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance, typically used to reference specific records within Workday. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday system-generated ID for the EffectiveChanges object that contains this record, used for tracking and referencing changes. |
| Descriptor | String | False |
A brief textual preview that provides context or summary information about the instance for easier identification. |
Stores role-based filtering criteria for effective change data, ensuring that changes affecting specific organizational roles are retrieved accurately.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaResponseFilterOrganizationRoles WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance, used to reference specific records within the system. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday identifier (WID) of the EffectiveChanges object that this record is associated with, enabling linkage between related data. |
| Descriptor | String | False |
A brief, human-readable summary or label that provides context about the instance for quick identification. |
Defines filters based on organization types for refining effective change queries, enabling users to segment data retrieval according to business units, departments, or other classifications.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaResponseFilterOrganizationType WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the organization type instance, used for reference and tracking. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday-specific identifier of the EffectiveChanges record that this organization type is associated with. |
| Descriptor | String | False |
A brief summary or label that provides a human-readable preview of the organization type instance. |
Maintains filtering rules for payment elections in the effective change dataset, ensuring that financial and compensation-related modifications are accurately captured.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaResponseFilterPaymentElectionRules WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance, used to reference this record within the system. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday identifier (WID) associated with the EffectiveChanges record that this element is part of. This Id is used to link the record to related data. |
| Descriptor | String | False |
A brief summary or label that provides a quick overview of the instance, often used for display purposes. |
Stores override criteria for workers in effective change queries, allowing exceptions or special conditions to be applied when retrieving worker-related changes.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesRequestCriteriaWorkerOverrides WHERE Effectivechanges_Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier of the worker whose data is being overridden. Use this to specify the target worker. |
| EffectiveChanges_Id [KEY] | String | False |
The Workday identifier (WID) of the EffectiveChanges record associated with the override. This connects the override to a specific change event. |
| EntryMomentFromOverride | Datetime | False |
The adjusted entry moment for the worker, representing the date and time when the override takes effect. |
Contains response data documents generated from effective change queries, providing structured outputs for reporting, auditing, and compliance purposes.
The Workday Cloud requires filtering on Effectivechanges_Id in order to perform the query.
For example:
SELECT * FROM EffectiveChangesResponseDataDocuments WHERE Effectivechanges_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
| EffectiveChanges_Id | String | False |
The unique Workday identifier (WID) of the EffectiveChanges record that contains this document. Use this Id to reference the specific record. |
| DocumentId | String | False |
The unique identifier of the document. Use this Id with the Blobitory API to retrieve the document content. |
| DocumentTags_Aggregate | String | False |
A list of tags associated with the document, providing metadata for categorization and search. Each tag is separated by a comma with 1 space after each comma. |
| FileName | String | False |
The name of the document file, including its extension. This name is typically user-assigned or system-generated. |
| Organization_Descriptor | String | False |
A textual preview or short description of the organization instance associated with the document. |
| Organization_Id | String | False |
The unique identifier of the organization instance linked to this document. This Id is used for referencing the specific organization. |
Manages vendor response data within an event-driven integration process, ensuring seamless updates after third-party payroll processing is completed.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM EventDrivenIntegrationVendorResponse WHERE Id = '12345'
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
diagnosis: Text /* An explanation for the root cause of the error. */
functionalArea: Text /* The functional area that was impacted by the error reported. Examples: Position, Compensation, Personal data. */
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. */
}]
groupName: Text /* The group category holding the data being provided by the third-party payroll system. Examples: Allowance, Address. */
groupValue: Text /* The specific name of the type of data being provided by the third-party payroll system. Examples: Car Allowance, Home Address. */
}]
messageCategory: Text /* The category for where the error occurred. Examples: Worker Data, Organization, Supervisory, Staffing. */
messageNumber: Text /* An integer number identifying the error reported. */
procedure: Text /* The steps to fix the error. */
recordType: Text /* The type of error being recorded. Examples: Data error, Configuration error. */
*severity: { /* The Workday ID or reference ID of the severity level for the error message. The reference ID uses the referenceIdType=sampleRefId format. Examples: CRITICAL, ERROR, WARNING, INFO. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
*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. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique Workday identifier (WID) required for the Event-Driven Integration. Workday provides this identifier to the third-party payroll vendor during the initial file delivery, ensuring accurate tracking and processing of worker data. |
| ErrorMessageSet_Errors_Aggregate | String | False |
A structured dataset that contains detailed payroll messages and exceptions returned by the payroll vendor. These messages relate to worker changes sent via the Event-Driven Integration, allowing users to identify and address specific issues. |
| OverallStatus_Descriptor | String | False |
A human-readable description of the current status of the integration instance, providing context on the state or outcome of the process. |
| OverallStatus_Href | String | False |
A URL link that directs users to the specific integration instance within Workday, enabling quick access for review and troubleshooting. |
| OverallStatus_Id | String | False |
The unique identifier associated with the integration instance, which can be a WID, internal Id, or reference I, used for tracking and referencing within the system. |
| Relaunchable | Bool | False |
Indicates whether users can resend worker changes to the payroll vendor after correcting errors. If true, the 'Resend to Payroll' button is available on the 'Review Event-Driven Integration for Third-Party Payroll' step. If false, resubmitting changes is disabled because errors cannot be resolved by user actions. |
| SetLsrd | Bool | False |
Specifies whether Workday updates the Last Successful Run Date (LSRD) for the worker. If true, only changes made after the Event-Driven Integration are included in the next batch PECI integration. If false, the original data is resent during the next transmission through either the event-driven integration or the Payroll Effective Change Interface integration. |
| SkipReview | Bool | False |
Determines whether the 'Review Event-Driven Integration for Third-Party Payroll' step is displayed on the 'Maintain Local Payroll Data' task. If true, this review step is bypassed, streamlining the process. If false, users must review the integration before proceeding. |
| SkipReviewReason | String | False |
Provides the reason why users should or should not complete the 'Maintain Local Payroll Data' step after the 'Review Event-Driven Integration for Third-Party Payroll' step. This field is applicable when the Hire business process is configured with these steps in sequence, offering guidance for accurate payroll data maintenance. |
Stores error messages related to vendor responses in event-driven integrations, aiding in troubleshooting and process optimization.
The Workday Cloud requires filtering on EventDrivenIntegrationVendorResponse_Id in order to perform the query.
For example:
SELECT * FROM EventDrivenIntegrationVendorResponseErrorMessageSetErrors WHERE EventDrivenIntegrationVendorResponse_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
groupData: [{
name: Text /* The name of the reported field attribute. Examples: Amount, Currency, Status. */
value: Text /* The value of the reported field attribute. Examples: 2000, USD, Active. */
}]
groupName: Text /* The group category holding the data being provided by the third-party payroll system. Examples: Allowance, Address. */
groupValue: Text /* The specific name of the type of data being provided by the third-party payroll system. Examples: Car Allowance, Home Address. */
}]
| Name | Type | ReadOnly | Description |
| EventDrivenIntegrationVendorResponse_Id | String | False |
The unique Workday identifier (WID) that identifies the specific EventDrivenIntegrationVendorResponse containing this error message. |
| Diagnosis | String | False |
A detailed explanation of the root cause of the error to aid in troubleshooting. |
| FunctionalArea | String | False |
The specific functional area within Workday that was impacted by the reported error includes examples such as Position, Compensation, and Personal data. |
| Group_Aggregate | String | False |
A collection of additional data that provides supplementary context to the main error being reported. |
| MessageCategory | String | False |
The category indicating where the error occurred within the system. Examples: Worker Data, Organization, Supervisory, Staffing. |
| MessageNumber | String | False |
A unique integer identifier that distinguishes the specific error instance. |
| Procedure | String | False |
The recommended steps or actions required to resolve the reported error. |
| RecordType | String | False |
The classification of the error based on its nature. Examples: Data error, Configuration error. |
| Severity_Descriptor | String | False |
A textual description that conveys the severity level of the error instance. |
| Severity_Href | String | False |
A hyperlink directing to the specific instance or documentation for further details. |
| Severity_Id | String | False |
The unique identifier (WID, Id, or reference Id) associated with the severity of the error. |
| VendorErrorMessage | String | False |
A detailed error message from the third-party payroll system explaining what went wrong during the processing of worker changes sent via Event-Diven Integration. |
| Who | String | False |
The individuals, roles, or teams responsible for addressing and resolving the reported error. |
Stores individual Quick Expense entries, detailing cost, category, and payment information for employee reimbursements and financial reporting.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the expense entry instance. |
| Amount_Currency | String | False |
Currency code representing the currency of the expense entry amount, for example, United States Dollar (USD), Euro (EUR), British Pound Sterling (GBP). |
| Amount_Value | Decimal | False |
Monetary value of the expense entry, expressed in the specified currency. |
| Attachments_Aggregate | String | False |
Aggregate reference for attachments related to Optical Character Recognition (OCR), exposed via the Entries REST operation. |
| Date | Datetime | False |
Date when the expense entry was recorded. |
| Descriptor | String | False |
A brief textual preview or summary of the expense entry instance. |
| EntryType_Descriptor | String | False |
Descriptive label for the type of expense entry (for example, Travel, Meals, Lodging). |
| EntryType_Href | String | False |
URL reference linking to the detailed information for the expense entry type. |
| EntryType_Id | String | False |
Unique identifier (WID, Id, or reference Id) associated with the expense entry type. |
| ExpenseEntryStatus_Descriptor | String | False |
Descriptive label for the current status of the expense entry (for example, Submitted, Approved, Rejected). |
| ExpenseEntryStatus_Href | String | False |
URL reference linking to detailed information for the expense entry status. |
| ExpenseEntryStatus_Id | String | False |
Unique identifier (WID, Id, or reference Id) associated with the expense entry status. |
| ExpenseItem_Descriptor | String | False |
Descriptive label for the expense item category (for example, Airfare, Taxi, Hotel). |
| ExpenseItem_Href | String | False |
URL reference linking to detailed information for the expense item category. |
| ExpenseItem_Id | String | False |
Unique identifier (WID, Id, or reference Id) associated with the expense item category. |
| HasOCRReceipt | Bool | False |
Boolean value indicating whether the expense entry includes an image captured using OCR. |
| Href | String | False |
URL reference linking to the detailed expense entry instance. |
| Image_Id | String | False |
Unique identifier (WID, Id, or reference Id) associated with the attached receipt image. |
| Memo | String | False |
Additional notes or comments entered for the expense entry. |
| Merchant | String | False |
Name of the merchant or vendor associated with the expense transaction. |
| ScanStatus_Descriptor | String | False |
Descriptive label indicating the scan status of the OCR receipt (for example, Processed, Failed, Pending). |
| ScanStatus_Href | String | False |
URL reference linking to detailed information about the scan status. |
| ScanStatus_Id | String | False |
Unique identifier (WID, Id, or reference Id) associated with the scan status. |
| EntryType_Prompt | String | False |
Prompt text displayed when selecting an expense entry type. |
| ExpenseEntryStatus_Prompt | String | False |
Prompt text displayed when selecting the status of an expense entry. |
| FromDate_Prompt | Date | False |
Prompt text indicating the starting date range for filtering expense entries. |
| ToDate_Prompt | Date | False |
Prompt text indicating the ending date range for filtering expense entries. |
Retrieves attachment records linked to expense entries, providing access to receipts, invoices, and other supporting documents submitted with expenses.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the attachment instance. |
| ExpenseEntries_Id [KEY] | String | False |
The Workday identifier (WID) of the ExpenseEntries record that this attachment belongs to. |
| ContentType_Descriptor | String | False |
A human-readable description of the file type or content category of the attachment. |
| ContentType_Href | String | False |
A URL link to the file type or content category reference in Workday. |
| ContentType_Id | String | False |
The unique identifier (WID, Id, or reference Id) of the file type or content category. |
| Descriptor | String | False |
A brief preview or summary of the attachment's content. |
| FileLength | Decimal | False |
The size of the attachment file in bytes. |
| FileName | String | False |
The name of the attachment file, including its file extension. |
| Href | String | False |
A URL link to download or access the attachment in Workday. |
| EntryType_Prompt | String | False |
The type of expense entry associated with the attachment, shown as a prompt or label. |
| ExpenseEntryStatus_Prompt | String | False |
The current status of the associated expense entry, shown as a prompt or label. |
| FromDate_Prompt | Date | False |
The start date of the period related to the expense entry, shown as a prompt or label. |
| ToDate_Prompt | Date | False |
The end date of the period related to the expense entry, shown as a prompt or label. |
Stores and retrieves structured data for expense reports, including employee submissions, approval status, total amounts, and attached supporting documentation.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the expense report instance. |
| Company_Id | String | False |
Workday identifier (WID), external Id, or reference Id for the company associated with the expense report. |
| CreationDate | Datetime | False |
Date when the expense report was created, formatted for use with the REST API. |
| Descriptor | String | False |
A brief summary or preview of the expense report instance. |
| ExpenseReportMemo | String | False |
Memo or note associated with the expense report, formatted for use with the REST API. |
| ExpenseReportStatus_Descriptor | String | False |
A textual description of the current status of the expense report. |
| ExpenseReportStatus_Href | String | False |
URL link to the detailed status of the expense report instance. |
| ExpenseReportStatus_Id | String | False |
WID, external Id, or reference Id for the status of the expense report. |
| Href | String | False |
URL link to the detailed information of the expense report instance. |
| Payee_Id | String | False |
WID, external Id, or reference Id for the payee associated with the expense report. |
| TotalAmount_Currency | String | False |
Currency code representing the currency used for the total amount of the expense report, for example, United States Dollar (USD), Euro (EUR), British Pound Sterling (GBP). |
| TotalAmount_Value | Decimal | False |
Total monetary value of the expense report, expressed in the specified currency. |
| Worktag_Descriptor | String | False |
A brief summary or preview of the associated worktag. |
| Worktag_Id | String | False |
Unique identifier for the associated worktag. |
| ExpenseReportMemo_Prompt | String | False |
Prompt text that guides users to enter a memo for the expense report. |
| ExpenseReportStatus_Prompt | String | False |
Prompt text that guides users to select or enter the status of the expense report. |
| FromDate_Prompt | Date | False |
Prompt text that guides users to enter the start date for filtering expense reports. |
| ToDate_Prompt | Date | False |
Prompt text that guides users to enter the end date for filtering expense reports. |
Maintains records of external contacts involved in Workday cases, storing details such as name, contact information, and case association.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the external case contact instance. |
| Blocked | Bool | False |
Indicates whether the external contact is blocked. Blocked contacts are not permitted to create cases. |
| String | False |
Primary email address associated with the external case contact. | |
| Name | String | False |
Full name of the external case contact. |
| Email_Prompt | String | False |
Email address used to identify the external case contact when creating or managing cases. |
| HideBlockedCreators_Prompt | Bool | False |
If true, the response excludes external contacts who are blocked from creating cases. |
Defines custom field types that can be used across different Workday objects, enabling organizations to extend standard data structures.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
alias: Text /* The web service alias of the custom list value. */
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
inactive: Boolean /* If true, the custom list value is not active and should not be used. */
name: Text /* The name of a custom list value. */
order: Text /* The order of the custom list value. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the custom field type instance. |
| Alias | String | False |
The web service alias used to reference the custom field type in integrations and APIs. |
| CurrencyInfo_Max | Decimal | False |
Maximum allowable value for a custom currency field, defined in decimal format. |
| CurrencyInfo_Min | Decimal | False |
Minimum allowable value for a custom currency field, defined in decimal format. |
| CurrencyInfo_Precision | Decimal | False |
Number of decimal places allowed for a custom currency field. |
| DecimalInfo_Max | Decimal | False |
Maximum allowable value for a custom decimal field. |
| DecimalInfo_Min | Decimal | False |
Minimum allowable value for a custom decimal field. |
| DecimalInfo_Precision | Decimal | False |
Number of decimal places allowed for a custom decimal field. |
| Descriptor | String | False |
A text summary or preview of the custom field type instance. |
| FieldType_Descriptor | String | False |
A detailed description of the custom field type instance. |
| FieldType_Id | String | False |
Unique identifier for the type of custom field. |
| Href | String | False |
A hyperlink that provides direct access to the custom field type instance. |
| Inactive | Bool | False |
Indicates whether the custom field type is inactive. If true, the field type should not be used. |
| IntegerInfo_Max | Decimal | False |
Maximum allowable value for a custom integer field. |
| IntegerInfo_Min | Decimal | False |
Minimum allowable value for a custom integer field. |
| ListInfo_Values_Aggregate | String | False |
A list of all available custom list values, presented as an array. Each value is separated by a comma, followed by a space. |
| Name | String | False |
The display name assigned to the custom field type. |
| ParagraphInfo_MaxLength | Decimal | False |
Maximum number of characters allowed in a custom paragraph text field. |
| TextInfo_MaxLength | Decimal | False |
Maximum number of characters allowed in a custom text field. |
| FieldType_Prompt | String | False |
A prompt or label displayed to users when interacting with the custom field type. |
Contains metadata and structural information about lists used within FieldTypes, supporting data consistency and validation.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance of the custom list value. |
| FieldTypes_Id [KEY] | String | False |
Unique Workday identifier (WID) that references the FieldTypes object associated with this list value. |
| Alias | String | False |
Web service alias used to reference the custom list value in integrations and API calls. |
| Descriptor | String | False |
Short preview or summary of the custom list value, often used for display purposes. |
| Href | String | False |
URL link that provides direct access to the specific instance of the custom list value. |
| Inactive | Bool | False |
Indicates whether the custom list value is inactive. If true, the value is unavailable for selection or use. |
| Name | String | False |
Display name of the custom list value as shown in the Workday interface. |
| Order | String | False |
Numeric or alphanumeric value that determines the display order of the custom list value within its list. |
| FieldType_Prompt | String | False |
Prompt text that guides users when selecting a value from the custom list. |
Stores actual values for custom lists defined in FieldTypes, providing selectable options for custom fields and configurations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance of the custom list value. |
| FieldTypes_Id [KEY] | String | False |
The Workday identifier (WID) of the FieldTypes table that owns this custom list value, used to establish the relationship between the list value and its parent FieldTypes. |
| Alias | String | False |
The web service alias assigned to the custom list value, used to reference the value in integrations and API calls. |
| Descriptor | String | False |
A brief preview or summary of the custom list value, typically used for display purposes. |
| Href | String | False |
A URL link to access the instance of the custom list value within Workday. |
| Inactive | Bool | False |
Indicates whether the custom list value is inactive. If true, the value is unavailable for selection and should not be used. |
| Name | String | False |
The display name of the custom list value, shown in user interfaces and reports. |
| Order | String | False |
Specifies the display order of the custom list value relative to other values in the list. Lower numbers appear first. |
| FieldType_Prompt | String | False |
The prompt or label associated with the field type, providing guidance on expected input or selection. |
Tracks feedback request events initiated within the system, recording responses and associated feedback details about employees.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the feedback event instance. |
| AboutWorker_Descriptor | String | False |
Text description of the worker who is the subject of the feedback. |
| AboutWorker_Href | String | False |
URL link to the worker's profile or related information. |
| AboutWorker_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the worker who is the subject of the feedback. |
| BusinessProcessParameters_Action_Descriptor | String | False |
Description of the action performed within the business process. |
| BusinessProcessParameters_Action_Href | String | False |
URL link to detailed information about the action performed. |
| BusinessProcessParameters_Action_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the action performed. |
| BusinessProcessParameters_Comment | String | False |
Additional comments associated with the business process. Returns null if no comments are provided. |
| BusinessProcessParameters_CriticalValidations | String | False |
Validation message indicating critical issues triggered by specific conditions during the action event. |
| BusinessProcessParameters_For_Descriptor | String | False |
Description of the target entity for which the action was performed. |
| BusinessProcessParameters_For_Href | String | False |
URL link to detailed information about the target entity. |
| BusinessProcessParameters_For_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the target entity. |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | False |
Summary description of the overall business process. |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | False |
URL link to detailed information about the overall business process. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the overall business process. |
| BusinessProcessParameters_OverallStatus | String | False |
The current status of the business process includes categories such as Successfully Completed, Denied, or Terminated. |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | False |
Description of the transaction's status within the business process. |
| BusinessProcessParameters_TransactionStatus_Href | String | False |
URL link to detailed information about the transaction's status. |
| BusinessProcessParameters_TransactionStatus_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the transaction's status. |
| BusinessProcessParameters_WarningValidations | String | False |
Warning message indicating non-critical issues triggered by specific conditions during the action event. |
| Descriptor | String | False |
Brief preview or summary of the feedback event instance. |
| DisplayNameofResponder | Bool | False |
True if the feedback provider's name is hidden from the feedback recipient. |
| DueDate | Datetime | False |
Deadline date by which the feedback process needs to be completed. |
| ExpirationDate | Datetime | False |
Date when the feedback request expires and can no longer be fulfilled. |
| FeedbackConfidential | Bool | False |
Yes if the feedback is confidential between the feedback provider and the manager. The employee who is the subject of the feedback does not have access to confidential feedback. |
| FeedbackCreationDate | Datetime | False |
Date and time when the feedback event was created. |
| FeedbackGivenDate | Datetime | False |
Date and time when the feedback was provided by the feedback provider. |
| FeedbackPrivate | Bool | False |
Yes if the feedback is private between the feedback provider and the worker, meaning it is not shared with others. |
| RequestedBy_Descriptor | String | False |
Description of the person or entity that requested the feedback. |
| RequestedBy_Href | String | False |
URL link to detailed information about the person or entity that requested the feedback. |
| RequestedBy_Id | String | False |
Unique identifier (WID, Id, or reference Id) of the person or entity that requested the feedback. |
Links attachments submitted as part of business process parameters related to feedback request events, ensuring supporting documents are available for review.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the feedback attachment instance. |
| GiveRequestedFeedbackEvents_Id [KEY] | String | False |
The Workday identifier (WID) of the GiveRequestedFeedbackEvents process that contains this attachment. |
| Category_Descriptor | String | False |
A descriptive label indicating the category of the attachment. |
| Category_Href | String | False |
A URL link to the category resource of the attachment. |
| Category_Id | String | False |
Unique identifier or reference Id associated with the attachment category, including WID, Id, or reference Id. |
| ContentType_Descriptor | String | False |
A descriptive label indicating the file type of the attachment. |
| ContentType_Href | String | False |
A URL link to the content type resource of the attachment. |
| ContentType_Id | String | False |
Unique identifier or reference Id associated with the content type, including WID, Id, or reference Id. |
| Description | String | False |
A brief description of the attachment, providing context for its content. |
| FileLength | Decimal | False |
The size of the attachment file, measured in bytes. |
| FileName | String | False |
The name of the attachment file, including its extension. |
| UploadDate | Datetime | False |
The date and time when the attachment was uploaded as part of the business process. |
| UploadedBy_Descriptor | String | False |
A descriptive label indicating the user who uploaded the attachment. |
| UploadedBy_Href | String | False |
A URL link to the user profile or resource of the individual who uploaded the attachment. |
| UploadedBy_Id | String | False |
Unique identifier or reference Id associated with the uploader, including WID, Id, or reference Id. |
Holds detailed comments provided as feedback for employees, offering qualitative insights into performance and professional growth.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the feedback event instance. |
| GiveRequestedFeedbackEvents_Id [KEY] | String | False |
The Workday identifier (WID) of the GiveRequestedFeedbackEvents instance that this feedback belongs to. |
| DateAnswer | Datetime | False |
The date provided as an answer for a feedback question of type Date. |
| Descriptor | String | False |
A brief preview or summary of the feedback event instance. |
| FeedbackDeclineReason | String | False |
The reason provided by the responder for declining to give feedback on a specific question. |
| FeedbackDeclined | Bool | False |
Indicates True if the responder chose not to provide feedback for a specific question; otherwise, False. |
| FeedbackQuestion_Descriptor | String | False |
A brief description of the feedback question. |
| FeedbackQuestion_Href | String | False |
A URL linking to the detailed feedback question instance. |
| FeedbackQuestion_Id | String | False |
The WID, standard Id, or reference Id of the feedback question. |
| MultipleChoiceAnswers_Aggregate | String | False |
The selected answers from a multiple-choice feedback question, listed as comma-separated values with 1 space after each comma. |
| NumericAnswer | Decimal | False |
The numeric value provided as an answer for a feedback question of type Number. |
| PossibleMultipleChoiceAnswers_Aggregate | String | False |
All possible answer options for a multiple-choice feedback question, listed as comma-separated values with 1 space after each comma. |
| QuestionType_Descriptor | String | False |
A brief description of the question type, such as Text, Date, Number, or Multiple Choice. |
| QuestionType_Href | String | False |
A URL linking to the question type instance for more details. |
| QuestionType_Id | String | False |
The WID, standard Id, or reference Id of the question type. |
| RelatesTo_Aggregate | String | False |
A list of talent tags related to the feedback question or response, separated by commas with 1 space after each comma. |
| Response | String | False |
The textual feedback provided by the responder for the feedback question. |
Tracks address changes staged for update in an employee's home contact details, reflecting modifications pending approval.
The Workday Cloud requires filtering on HomeContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM HomeContactInformationChangesAddresses WHERE HomeContactInformationChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier of the address record instance. |
| HomeContactInformationChange_Id [KEY] | String | False |
Unique identifier of the home contact information change process. Must be specified in all queries to ensure accurate results. |
| AddressLine1 | String | False |
Primary address line, typically containing the street name and number. |
| AddressLine1Local | String | False |
Primary address line in the local language or format. |
| AddressLine2 | String | False |
Secondary address line, often used for apartment, suite, or building information. |
| AddressLine2Local | String | False |
Secondary address line in the local language or format. |
| AddressLine3 | String | False |
Additional address line for extended location details. |
| AddressLine3Local | String | False |
Additional address line in the local language or format. |
| AddressLine4 | String | False |
Additional address line, commonly used for complex addresses or rural routes. |
| AddressLine4Local | String | False |
Additional address line in the local language or format. |
| AddressLine5 | String | False |
Additional address line for further location specificity. |
| AddressLine5Local | String | False |
Additional address line in the local language or format. |
| AddressLine6 | String | False |
Additional address line for large or multi-structure locations. |
| AddressLine6Local | String | False |
Additional address line in the local language or format. |
| AddressLine7 | String | False |
Additional address line for extended address details. |
| AddressLine7Local | String | False |
Additional address line in the local language or format. |
| AddressLine8 | String | False |
Additional address line for special location instructions. |
| AddressLine8Local | String | False |
Additional address line in the local language or format. |
| AddressLine9 | String | False |
Additional address line for complex location descriptions. |
| AddressLine9Local | String | False |
Additional address line in the local language or format. |
| City | String | False |
The name of the city. |
| CityLocal | String | False |
Name of the city in the local language or format. |
| CitySubdivision1 | String | False |
First-level subdivision within the city, such as a district or borough. |
| CitySubdivision1Local | String | False |
First-level city subdivision in the local language or format. |
| CitySubdivision2 | String | False |
Second-level subdivision within the city, such as a neighborhood or zone. |
| CitySubdivision2Local | String | False |
Second-level city subdivision in the local language or format. |
| CountryCity_Descriptor | String | False |
Text description providing a preview of the country and city. |
| CountryCity_Id | String | False |
Unique identifier for the combination of country and city. |
| CountryRegion_Descriptor | String | False |
Text description providing a preview of the country and region. |
| CountryRegion_Id | String | False |
Unique identifier for the combination of country and region. |
| Country_Descriptor | String | False |
Text description providing a preview of the country. |
| Country_Id | String | False |
Unique identifier for the country. |
| Effective | Datetime | False |
Date when the home contact information change takes effect. |
| NumberDaysWFH | Decimal | False |
Number of days per week the individual works from home. |
| PostalCode | String | False |
Postal or ZIP code used for mail delivery. |
| RegionSubdivision1 | String | False |
First-level administrative region subdivision, such as a state or province. |
| RegionSubdivision1Local | String | False |
First-level region subdivision in the local language or format. |
| RegionSubdivision2 | String | False |
Second-level administrative region subdivision, such as a county or district. |
| Usage_Comment | String | False |
Description or comments related to the usage of the communication method. |
| Usage_Primary | Bool | False |
Indicates whether this address is the primary contact location. |
| Usage_Public | Bool | False |
Indicates whether this address is visible to the public. |
| Usage_UsageType_Descriptor | String | False |
Text description of the usage type, such as home, work, or mailing. |
| Usage_UsageType_Id | String | False |
Unique identifier for the usage type. |
| Usage_UsedFor_Aggregate | String | False |
List of purposes this address is used for, with values separated by commas and a space after each comma. |
| PrimaryOnly_Prompt | Bool | False |
Boolean value indicating if only the primary address should be returned. |
| UsedFor_Prompt | String | False |
Specifies the context or purpose for which the address is used. |
Maintains a record of email address changes in employee contact information, ensuring updated communication channels.
The Workday Cloud requires filtering on HomeContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM HomeContactInformationChangesEmailAddresses WHERE HomeContactInformationChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier for the email address record within the system. |
| HomeContactInformationChange_Id [KEY] | String | False |
Unique identifier of the home contact information change process. This value is required for all queries. |
| Descriptor | String | False |
A brief summary or preview of the email address record, typically used for display purposes. |
| EmailAddress | String | False |
The full email address associated with the contact information record. |
| Usage_Comment | String | False |
A brief note explaining the context or purpose of the specified communication method. |
| Usage_Primary | Bool | False |
Indicates whether this email address is designated as the primary contact method. True means it is the primary email. |
| Usage_Public | Bool | False |
Indicates whether this email address is publicly accessible. True means the email address is public; if false or no result is returned, the address is private. |
| Usage_UsageType_Id | String | False |
Unique identifier representing the type of usage for this email address, such as home or work. |
| Usage_UsedFor_Aggregate | String | False |
Specifies the usage behaviors for the email address, including mailing, billing, shipping, etc. Values are comma-separated with a space after each comma. |
| PrimaryOnly_Prompt | Bool | False |
When true, the query returns only the Ids of email addresses designated as primary. |
| PublicOnly_Prompt | Bool | False |
When true, the query returns only the Ids of email addresses that are publicly accessible. |
| UsageType_Prompt | String | False |
Specifies the usage type for filtering results, such as home or work. Only applicable if the service allows access to multiple usage types through the same endpoint. |
| UsedFor_Prompt | String | False |
Specifies the intended usage behavior for filtering results, such as mailing, billing, or shipping. Values are comma-separated with a space after each comma. |
Captures updates to instant messaging details within employee contact information, ensuring real-time communication availability.
The Workday Cloud requires filtering on HomeContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM HomeContactInformationChangesInstantMessengers WHERE HomeContactInformationChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier of the instant messenger record. |
| HomeContactInformationChange_Id [KEY] | String | False |
Identifier of the home contact information change process. This value is required in all queries. |
| Type_Descriptor | String | False |
A brief preview or label of the instant messenger record for display purposes. |
| Type_Id | String | False |
Unique identifier of the type associated with the instant messenger record. |
| Usage_Comment | String | False |
Descriptive note explaining the purpose or context of the communication method. |
| Usage_Primary | Bool | False |
Indicates whether the communication method is designated as the primary method (true or false). |
| Usage_Public | Bool | False |
Indicates whether the communication method is public (true or false). If false or no value is returned, the communication method is private. |
| Usage_UsageType_Id | String | False |
Unique identifier of the usage type associated with the communication method. |
| Usage_UsedFor_Aggregate | String | False |
List of usage behaviors for the communication method, including mailing, billing, shipping, etc. Values are separated by commas with a space after each comma. |
| UserName | String | False |
The username associated with the instant messenger account. |
| PrimaryOnly_Prompt | Bool | False |
If true, only the usernames of the person's primary instant messenger accounts are returned. |
| PublicOnly_Prompt | Bool | False |
If true, only the usernames of the person's public instant messenger accounts are returned. |
| UsageType_Prompt | String | False |
Specifies the usage type, such as home or work. This value is used only if the service allows access to multiple usage types from the same endpoint. |
| UsedFor_Prompt | String | False |
This values specifies the usage behavior, such as mailing, billing, or shipping. |
Logs updates to employee phone numbers within the home contact details, ensuring current contact records are maintained.
The Workday Cloud requires filtering on HomeContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM HomeContactInformationChangesPhoneNumbers WHERE HomeContactInformationChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier of the phone number entry within the change process. |
| HomeContactInformationChange_Id [KEY] | String | False |
Identifier for the home contact information change process, required in all queries to link the phone number to the process. |
| CompletePhoneNumber | String | False |
Full phone number including country code, area code, and local number. |
| CountryPhoneCode_CountryPhoneCode | String | False |
International dialing code assigned to a specific country, such as +1 for the United States. |
| CountryPhoneCode_Country_Descriptor | String | False |
Brief textual representation of the country associated with the phone code, useful for display purposes. |
| CountryPhoneCode_Country_Id | String | False |
Unique identifier for the country associated with the phone code. |
| CountryPhoneCode_Descriptor | String | False |
Short textual description of the country phone code instance, often used in user interfaces. |
| CountryPhoneCode_Id | String | False |
Unique identifier for the country phone code instance. |
| Descriptor | String | False |
General textual preview of the phone number instance, often used for display or selection. |
| DeviceType_Descriptor | String | False |
Textual description of the phone device type, such as mobile, landline, or VoIP. |
| DeviceType_Id | String | False |
Unique identifier for the phone device type. |
| Extension | String | False |
Telephone extension used for internal dialing within an organization. |
| Usage_Comment | String | False |
Additional information or notes related to the phone number’s communication usage. |
| Usage_Primary | Bool | False |
True if the phone number is designated as the primary contact method for the person. |
| Usage_Public | Bool | False |
True if the phone number is publicly available. If false or not returned, the phone number is private. |
| Usage_UsageType_Id | String | False |
Unique identifier for the communication usage type, such as home, work, or mobile. |
| Usage_UsedFor_Aggregate | String | False |
List of communication purposes associated with the phone number, such as mailing, billing, shipping, etc. Values are comma-separated with a space after each comma. |
| PrimaryOnly_Prompt | Bool | False |
If true, limits results to only the primary phone numbers associated with the person. |
| PublicOnly_Prompt | Bool | False |
If true, limits results to only phone numbers designated as public. |
| UsageType_Prompt | String | False |
Specifies the usage type of the phone number, such as home, work, or mobile. Only used if the service allows multiple usage types from the same endpoint. |
| UsedFor_Prompt | String | False |
Defines the communication behavior of the phone number, such as mailing, billing, or shipping. Values should be comma-separated with a space after each comma. |
Stores pending changes to web addresses within employee contact details, supporting profile updates and digital presence tracking.
The Workday Cloud requires filtering on HomeContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM HomeContactInformationChangesWebAddresses WHERE HomeContactInformationChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier of the web address instance. |
| HomeContactInformationChange_Id [KEY] | String | False |
Identifier of the home contact information change process. Must be provided in all queries. |
| Url | String | False |
The full URL for the web address, including protocol (for example, https://). |
| Usage_Comment | String | False |
A brief note describing the purpose or context of the communication method. |
| Usage_Primary | Bool | False |
True if this communication method is designated as primary for the person. |
| Usage_Public | Bool | False |
True if this communication method is visible to the public. If false or no results are returned, the method is private. |
| Usage_UsageType_Id | String | False |
Unique identifier for the usage type, specifying the context in which the communication method is used. |
| Usage_UsedFor_Aggregate | String | False |
List of usage behaviors for the communication method, including mailing, billing, shipping, etc. Each value is separated by a comma and a space. |
| PrimaryOnly_Prompt | Bool | False |
If true, returns only the identifiers of the person's primary web addresses. |
| PublicOnly_Prompt | Bool | False |
If true, returns only the identifiers of the person's public web addresses. |
| UsageType_Prompt | String | False |
Specifies the type of usage, such as home or work. Only applicable if the service allows access to multiple usage types through the same endpoint. |
| UsedFor_Prompt | String | False |
Specifies the intended usage behavior, such as mailing, billing, or shipping. |
Stores feedback provided by interviewers on candidate performance, helping in decision-making for hiring processes.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the feedback instance. |
| Interviews_Id [KEY] | String | False |
The Workday identifier (WID) of the interview associated with this feedback. |
| Comment | String | False |
Comments provided by the interviewer, including overall impressions and competency-specific feedback. |
| DateSubmitted | Datetime | False |
The date and time when the feedback was submitted. |
| Descriptor | String | False |
A brief textual preview that represents the feedback instance. |
| OverallRating_Descriptor | String | False |
A brief textual preview summarizing the interview's overall rating. |
| OverallRating_Id | String | False |
Unique identifier for the overall rating associated with the feedback. |
| InterviewStatus_Prompt | String | False |
All applicable interview statuses for an interview event include Scheduled, Completed, Canceled, Rescheduled, and No Show. |
Provides administrative options related to a specific job change, including approval workflows and policy adherence.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesAdministrative WHERE JobChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment changes. |
| AssignmentType_Descriptor | String | False |
A concise, user-friendly description of the assignment type, helping users understand the nature of the worker's assignment. |
| AssignmentType_Href | String | False |
A direct Uniform Resource Locator (URL) to the assignment type record in Workday, allowing quick reference or updates. |
| AssignmentType_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the assignment type, used for system tracking and integrations. |
| CompanyInsiderTypes_Aggregate | String | False |
Lists new company insider classifications assigned to the worker as of the effective date, ensuring compliance with regulatory requirements. |
| DefaultWeeklyHours | Decimal | False |
The updated standard number of weekly work hours assigned to the worker, reflecting new employment terms. |
| EndEmploymentDate | Datetime | False |
The revised employment end date for the worker, updated based on contractual changes or terminations. |
| ExpectedAssignmentEndDate | Datetime | False |
The expected end date for the worker’s assignment, recorded in the relevant business process for workforce planning. |
| FirstDayOfWork | Datetime | False |
The worker’s official first day of employment, recorded in hiring and job change transactions for accurate employment history. |
| Fte | Decimal | False |
The worker’s Full-Time Equivalent (FTE), calculated as scheduled weekly hours divided by the standard weekly hours, determining workload percentage. |
| NotifyBy | Datetime | False |
The date by which the worker should be informed about a termination event, ensuring timely notification and compliance. |
| PaidFte | Decimal | False |
The proportion of a full-time workload the worker is paid for, as of the effective date, reflecting compensation adjustments. |
| PayRateType_Descriptor | String | False |
A brief, human-readable description of the worker’s pay rate type, clarifying the basis for salary calculations. |
| PayRateType_Href | String | False |
A direct URL to the pay rate type record in Workday, allowing users to access or modify pay rate details. |
| PayRateType_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the pay rate type for system reference and reporting. |
| PositionWorkerType_Descriptor | String | False |
A descriptive label for the worker type associated with the position, helping distinguish employment categories. |
| PositionWorkerType_Href | String | False |
A direct URL to the position worker type record in Workday for quick reference and modifications. |
| PositionWorkerType_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the position worker type, ensuring accurate classification. |
| SpecifyPaidFte | Bool | False |
Indicates whether a specific paid FTE value has been set for the worker, controlling payroll calculations. |
| SpecifyWorkingFte | Bool | False |
Indicates whether a specific working FTE value has been set for the worker, affecting scheduling and reporting. |
| TimeType_Descriptor | String | False |
A user-friendly label describing the time type associated with the worker’s role, helping categorize work schedules. |
| TimeType_Href | String | False |
A direct URL to the time type record in Workday, allowing for easy access and updates. |
| TimeType_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the time type for tracking and system use. |
| WorkStudy_Descriptor | String | False |
A descriptive label for the work-study program the worker is enrolled in, helping categorize employment programs. |
| WorkStudy_Href | String | False |
A direct URL to the work-study record in Workday, enabling users to access and manage program details. |
| WorkStudy_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the work-study program, ensuring proper tracking. |
| WorkersCompensationCodeOverride_Descriptor | String | False |
A brief, human-readable description of the worker’s compensation code override, clarifying changes to standard classifications. |
| WorkersCompensationCodeOverride_Href | String | False |
A direct URL to the worker’s compensation code override record in Workday, allowing for modifications and verification. |
| WorkersCompensationCodeOverride_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the worker’s compensation code override for system tracking. |
| WorkingFte | Decimal | False |
The proportion of a full-time workload the worker is scheduled to work as of the effective date, affecting work-hour calculations and benefits. |
Retrieves the updated business title associated with a specific job change, reflecting new roles or responsibilities.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesBusinessTitle WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| BusinessTitle | String | False |
The worker’s updated business title as of the effective date. If no custom business title is assigned, this field defaults to the job title or job profile name, ensuring alignment with company standards. |
Returns comments or notes associated with a specific job change, providing additional context on the update.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesComment WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| Comment | String | False |
A remark or explanation provided during the job change process before submission. This field allows users to document the rationale or important details related to the change for better tracking and review. |
Retrieves contract-related details for a job change, including modifications to employment agreements or terms.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesContract WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| AssignmentDetails | String | False |
The updated details of the contract assignment for the contingent worker as of the effective date, ensuring accurate record-keeping. |
| ContractEndDate | Datetime | False |
The official end date of the contingent worker's contract, recorded as part of the job change process for proper workforce planning. |
| ContractPayRate_Currency | String | False |
The currency in which the new contract pay rate is specified for the contingent worker, ensuring consistency in compensation records. |
| ContractPayRate_Value | Decimal | False |
The revised contract pay rate for the contingent worker as of the effective date, reflecting any salary updates or renegotiations. |
| Currency_Descriptor | String | False |
A user-friendly label describing the currency in which the contract pay rate is denominated, helping users interpret payment details. |
| Currency_Href | String | False |
A direct Uniform Resource Locator (URL) to the currency record in Workday, allowing quick reference and verification of currency details. |
| Currency_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the currency, used for system tracking and financial reporting. |
| Frequency_Descriptor | String | False |
A brief, user-friendly description of the pay frequency associated with the contingent worker’s contract, clarifying payroll intervals. |
| Frequency_Href | String | False |
A direct URL to the pay frequency record in Workday, enabling easy access and updates. |
| Frequency_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the pay frequency, ensuring proper classification within payroll systems. |
| PurchaseOrder_Descriptor | String | False |
A concise, human-readable summary of the purchase order linked to the contract, providing context for procurement and payments. |
| PurchaseOrder_Href | String | False |
A direct URL to the purchase order record in Workday, allowing users to access and review contract-related procurement details. |
| PurchaseOrder_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the purchase order, ensuring accurate tracking of contract-related transactions. |
Retrieves job classification details for a specific job change, ensuring accurate categorization based on organizational standards.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesJobClassification WHERE JobChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| AdditionalJobClassifications_Aggregate | String | False |
A list of additional job classifications proposed as part of the staffing event, ensuring proper categorization of the worker’s role within the organization. |
Retrieves a job profile for a given job change, providing role-specific details such as responsibilities and required skills.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesJobProfile WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| JobProfile_Descriptor | String | False |
A brief, user-friendly description of the job profile, providing insight into the worker’s responsibilities and role within the organization. |
| JobProfile_Href | String | False |
A direct URL linking to the job profile instance in Workday, allowing quick access to detailed job profile information. |
| JobProfile_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job profile, ensuring accurate tracking of job roles. |
| JobTitle | String | False |
The updated job title assigned to the worker as of the effective date, reflecting any changes in role or position. |
Returns location-related details associated with a job change, ensuring proper worksite assignments and compliance.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesLocation WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| Location_Descriptor | String | False |
A brief, user-friendly description of the new work location, providing clarity on where the worker will be based. |
| Location_Href | String | False |
A direct URL linking to the work location instance in Workday, enabling quick access to location details. |
| Location_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the work location, ensuring accurate tracking of workplace assignments. |
| ScheduledHours | Decimal | False |
The updated scheduled weekly work hours for the worker as of the effective date, reflecting any changes in work schedule. |
| WorkShift_Descriptor | String | False |
A brief, user-friendly description of the assigned work shift, specifying details such as morning, night, or rotating shifts. |
| WorkShift_Href | String | False |
A direct URL linking to the work shift instance in Workday, allowing easy reference to shift details. |
| WorkShift_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the work shift, ensuring accurate shift tracking. |
| WorkSpace_Descriptor | String | False |
A brief, user-friendly description of the workspace, detailing assigned office spaces, desks, or remote work areas. |
| WorkSpace_Href | String | False |
A direct URL linking to the workspace instance in Workday, providing easy access to workspace details. |
| WorkSpace_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the workspace, ensuring accurate tracking of assigned work areas. |
Retrieves team movement details related to a job change, supporting internal team transfers and reassignments.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesMoveTeam WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| MoveTeam | Bool | False |
Indicates whether the teams reporting to the manager were moved along with them during the job change event ('true' or 'false'). |
Retrieves details on open job positions associated with a job change, helping manage job transfers and internal mobility.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesOpening WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job opening instance, ensuring accurate tracking of job vacancies. |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| Descriptor | String | False |
A brief, user-friendly summary of the job opening, providing essential details about the position. |
| HeadcountOption_Descriptor | String | False |
A brief, user-friendly description of the headcount option, specifying how the position fits within the organization's staffing plan. |
| HeadcountOption_Href | String | False |
A direct URL linking to the headcount option instance in Workday, allowing easy access to staffing configurations. |
| HeadcountOption_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the headcount option, ensuring precise workforce planning. |
| OpeningAvailableForOverlap | Bool | False |
Indicates whether the job opening allows overlap between the departing and incoming employees ('true' or 'false'), helping manage smooth transitions. |
Retrieves position details for a given job change, ensuring updates align with organizational structure and reporting lines.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesPosition WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the position instance, ensuring accurate job tracking. |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| AvailableForOverlap | Bool | False |
Indicates whether the position allows job overlap between the departing and incoming employees ('true' or 'false'), supporting smooth transitions. |
| ClosePosition | Bool | False |
Indicates whether the position is being closed as part of the job change process ('true' or 'false'), marking the position as inactive. |
| CreatePosition | Bool | False |
Indicates whether a new position is being created as part of the job change process ('true' or 'false'), enabling workforce expansion. |
| Descriptor | String | False |
A brief, user-friendly summary of the position instance, providing essential details about the job role. |
| JobRequisition_Descriptor | String | False |
A brief, user-friendly description of the job requisition, outlining hiring needs and associated job postings. |
| JobRequisition_Href | String | False |
A direct URL linking to the job requisition instance in Workday, allowing quick access to requisition details. |
| JobRequisition_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job requisition, ensuring accurate tracking of hiring processes. |
| Position_Descriptor | String | False |
A brief, user-friendly description of the position, clarifying job responsibilities and organizational placement. |
| Position_Href | String | False |
A direct URL linking to the position instance in Workday, providing quick access to job details. |
| Position_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the position, ensuring accurate tracking within workforce management. |
Retrieves start date and other onboarding-related details for a specific job change.
The Workday Cloud requires filtering on JobChange_Id in order to perform the query.
For example:
SELECT * FROM JobChangesStartDetails WHERE JobChange_Id = '1234';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job change start details instance, ensuring accurate tracking. |
| JobChange_Id [KEY] | String | False |
A system-generated unique identifier for the job change process, required in all queries to track employment modifications. |
| Date | Datetime | False |
The date when this job change takes effect, defining the official transition timeline. |
| Descriptor | String | False |
A brief, user-friendly summary of the job change instance, providing context for the employment modification. |
| Job_Descriptor | String | False |
A concise description of the job associated with this change, offering insight into the worker’s new or updated role. |
| Job_Href | String | False |
A direct URL linking to the job instance in Workday, enabling quick access to job details. |
| Job_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job, ensuring accurate tracking within workforce management. |
| Location_Descriptor | String | False |
A brief, user-friendly description of the new work location, clarifying where the worker will be based. |
| Location_Href | String | False |
A direct URL linking to the work location instance in Workday, providing easy reference. |
| Location_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the work location, ensuring accurate workplace tracking. |
| Reason_Descriptor | String | False |
A brief, user-friendly description of the reason for this job change, clarifying the purpose behind the modification. |
| Reason_Href | String | False |
A direct URL linking to the job change reason instance in Workday, allowing quick reference to the rationale. |
| Reason_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job change reason, ensuring consistent documentation. |
| SupervisoryOrganization_Descriptor | String | False |
A brief, user-friendly description of the supervisory organization associated with the job change. |
| SupervisoryOrganization_Href | String | False |
A direct URL linking to the supervisory organization instance in Workday, enabling easy access to organizational details. |
| SupervisoryOrganization_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the supervisory organization, ensuring accurate workforce structuring. |
| Template_Descriptor | String | False |
A brief, user-friendly description of the job change template, outlining the structured transition process. |
| Template_Href | String | False |
A direct URL linking to the job change template instance in Workday, providing easy reference. |
| Template_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the job change template, ensuring standardized employment transitions. |
| UseNextPayPeriod | Bool | False |
Indicates whether the job change will take effect in the next pay period ('true' or 'false'), helping align changes with payroll schedules. |
| Worker_Descriptor | String | False |
A brief, user-friendly description of the worker associated with this job change, typically displaying their name. |
| Worker_Href | String | False |
A direct URL linking to the worker instance in Workday, allowing quick access to worker details. |
| Worker_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the worker, ensuring accurate employment tracking. |
Retrieves predefined message templates used for notifications and communications related to HR and job processes.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the message template instance, ensuring proper tracking and usage. |
| CreatedBy_Descriptor | String | False |
A user-friendly description of the user who created this message template, providing insight into template ownership. |
| CreatedBy_Href | String | False |
A direct URL linking to the creator's profile in Workday, allowing quick access to their information. |
| CreatedBy_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the user who created this message template, enabling tracking of content origin. |
| CreatedOn | Datetime | False |
The exact date and time when this message template was originally created, helping to audit messaging history. |
| Descriptor | String | False |
A user-friendly summary of the message template, describing its intended purpose or content. |
| EmailDetail_Body | String | False |
The full body content of the email message stored in this template, used when generating automated communications. |
| EmailDetail_Name | String | False |
The name assigned to the email configuration container for use in REST API integrations, ensuring correct API calls. |
| EmailDetail_ReplyTo | String | False |
The designated email address for receiving replies to messages sent using this template, ensuring proper communication routing. |
| EmailDetail_Subject | String | False |
The subject line of the email message in this template, helping recipients understand the email’s purpose at a glance. |
| Inactive | Bool | False |
Indicates whether the message template is currently inactive ('true' or 'false'), allowing filtering of outdated templates. |
| LastUpdated | Datetime | False |
The exact date and time when this message template was last updated, ensuring version control and tracking of modifications. |
| LastUpdatedBy_Descriptor | String | False |
A user-friendly description of the user who last modified this template, providing insight into recent changes. |
| LastUpdatedBy_Href | String | False |
A direct URL linking to the profile of the user who last updated this template, allowing verification of modifications. |
| LastUpdatedBy_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the user who last updated this template, ensuring accountability for changes. |
| Name | String | False |
The name assigned to the message template, allowing users to quickly identify its purpose. |
| NotificationType_Descriptor | String | False |
A user-friendly description of the notification type associated with this template, such as system alerts, email notifications, or mobile push messages. |
| NotificationType_Href | String | False |
A direct URL linking to the notification type instance in Workday, enabling easy access to notification settings. |
| NotificationType_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the notification type, ensuring accurate classification of messages. |
| PushDetail_Id | String | False |
A unique identifier for the push notification configuration instance, linking the template to mobile alert settings. |
| PushDetail_Message | String | False |
The content of the message used for push notifications, displayed when users receive mobile alerts. |
| PushDetail_RedirectURL | String | False |
The URL used to launch the relevant mobile app when a user acknowledges the push notification, enabling seamless navigation. |
| ReferenceID | String | False |
A reference ID used for lookups within Workday Web Services. For supervisory organizations, this also serves as the 'Organization ID.' |
| UsageCount | Decimal | False |
The total number of instances using this message template, tracking its frequency and relevance. |
| Inactive_Prompt | Bool | False |
A filter to include only inactive message templates ('true' or 'false'), allowing users to refine search results. |
| Name_Prompt | String | False |
A filter allowing users to search for message templates by name, streamlining retrieval. |
| NotificationType_Prompt | String | False |
A filter to refine search results by notification type, ensuring users can locate templates based on their intended communication method. |
Retrieves business unit details associated with organization assignment changes.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesBusinessUnit WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for all queries to track assignment modifications. |
| BusinessUnit_Descriptor | String | False |
A user-friendly description of the business unit associated with the assignment change, providing insight into the specific division, department, or entity impacted. |
| BusinessUnit_Href | String | False |
A direct URL linking to the business unit instance in Workday, allowing users to access detailed information about the unit involved in the assignment change. |
| BusinessUnit_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the business unit associated with the assignment change, ensuring accurate tracking of structural adjustments. |
Retrieves comment details related to an organization assignment change, providing additional context.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesComment WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for all queries to track changes in organizational structure. |
| Comment | String | False |
A comment or note entered during the organization assignment change process, typically used to provide context, reasoning, or additional details before submission. |
Retrieves company details linked to an organization assignment change, ensuring correct entity alignment.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesCompany WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for all queries to track modifications in company assignments. |
| Company_Descriptor | String | False |
A user-friendly description of the company associated with the assignment change, providing details about the corporate entity affected by the update. |
| Company_Href | String | False |
A direct URL linking to the company instance in Workday, allowing users to access detailed information about the company involved in the assignment change. |
| Company_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the company associated with the assignment change, ensuring accurate tracking and reporting of organizational changes. |
Retrieves cost center information associated with an organization assignment change, supporting financial tracking.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesCostCenter WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for all queries to track modifications in cost center assignments. |
| CostCenter_Descriptor | String | False |
A user-friendly description of the cost center associated with the assignment change, providing details on financial allocation and budget ownership. |
| CostCenter_Href | String | False |
A direct URL linking to the cost center instance in Workday, allowing users to access detailed financial and organizational information about the cost center involved in the assignment change. |
| CostCenter_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the cost center associated with the assignment change, ensuring accurate tracking of financial allocations and cost distributions. |
Retrieves costing organization details related to an organization assignment change, ensuring accurate cost allocation.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesCosting WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for tracking modifications in costing assignments. |
| Fund_Descriptor | String | False |
A user-friendly description of the fund associated with the assignment change, providing insight into the specific financial resource being allocated. |
| Fund_Href | String | False |
A direct URL linking to the fund instance in Workday, enabling users to access detailed financial information related to the fund. |
| Fund_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the fund associated with the assignment change, ensuring accurate financial tracking. |
| Gift_Descriptor | String | False |
A user-friendly description of the gift associated with the assignment change, indicating any allocated philanthropic contributions or endowments. |
| Gift_Href | String | False |
A direct URL linking to the gift instance in Workday, providing access to donation records and related financial details. |
| Gift_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the gift associated with the assignment change, ensuring traceability of financial contributions. |
| Grant_Descriptor | String | False |
A user-friendly description of the grant associated with the assignment change, outlining externally or internally funded financial allocations. |
| Grant_Href | String | False |
A direct URL linking to the grant instance in Workday, allowing users to access information on grant funding sources and allocations. |
| Grant_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the grant associated with the assignment change, enabling structured financial tracking. |
| Program_Descriptor | String | False |
A user-friendly description of the program associated with the assignment change, providing details about the specific initiative or financial category. |
| Program_Href | String | False |
A direct URL linking to the program instance in Workday, allowing users to navigate to relevant financial program details. |
| Program_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the program associated with the assignment change, ensuring accurate classification and financial reporting. |
Retrieves custom organization details linked to an organization assignment change, allowing for specialized tracking.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesCustomOrganizations WHERE OrganizationAssignmentChange_Id = '12345';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
organizationType: { /* Includes these organization types: Company, Cost Center, Custom orgs, Location Hierarchy, Matrix, Pay Group, Region, Retiree, Supervisory. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for tracking modifications in custom organizational assignments. |
| CustomOrganizations_Aggregate | String | False |
A list of new custom organizations assigned to the worker as of the effective date, reflecting updates in group memberships, specialized teams, or other custom-defined organizational structures. |
Retrieves region details associated with an organization assignment change, ensuring correct geographical placement.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesRegion WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for tracking regional modifications. |
| Region_Descriptor | String | False |
A user-friendly description of the region associated with the assignment change, providing insights into its geographic scope, administrative function, or jurisdiction. |
| Region_Href | String | False |
A direct URL linking to the region instance in Workday, allowing users to navigate to detailed information about the assigned region. |
| Region_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the region associated with the assignment change, ensuring accurate classification and tracking of geographic assignments. |
Retrieves start date and onboarding details for an organization assignment change.
The Workday Cloud requires filtering on OrganizationAssignmentChange_Id in order to perform the query.
For example:
SELECT * FROM OrganizationAssignmentChangesStartDetails WHERE OrganizationAssignmentChange_Id = '12345';
| Name | Type | ReadOnly | Description |
| OrganizationAssignmentChange_Id [KEY] | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the organization assignment change process, required for tracking workforce modifications. |
| Date | Datetime | False |
The date when the organization assignment change takes effect, marking the official transition point for the reassignment. |
| Position_Descriptor | String | False |
A user-friendly description of the position associated with the assignment change, providing insights into job role, function, or department. |
| Position_Href | String | False |
A direct URL linking to the position instance in Workday, allowing users to navigate to detailed job-related information. |
| Position_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the position associated with the assignment change, ensuring accurate classification and tracking. |
| SupervisoryOrganization_Descriptor | String | False |
A user-friendly description of the supervisory organization associated with the assignment change, indicating the management structure governing the role. |
| SupervisoryOrganization_Href | String | False |
A direct URL linking to the supervisory organization instance in Workday, allowing users to access organizational details. |
| SupervisoryOrganization_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the supervisory organization, ensuring proper tracking within the organizational hierarchy. |
| Worker_Descriptor | String | False |
A user-friendly description of the worker affected by the assignment change, providing insight into their role and placement within the organization. |
| Worker_Href | String | False |
A direct URL linking to the worker instance in Workday, allowing access to the employee’s profile and related details. |
| Worker_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the worker affected by the assignment change, ensuring accuracy in personnel tracking. |
Supports a collection of payroll periods associated with a specific Payroll Interface pay group ID, facilitating accurate period-based payroll calculations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique ID for the payroll period record. This value is system-generated and should be used to reference specific pay periods within Workday. |
| PayGroups_Id [KEY] | String | False |
The unique Workday ID (WID) for the pay group associated with this payroll period. This ID links payroll periods to specific pay groups, ensuring accurate payroll processing. |
| PeriodEndDate | Datetime | False |
The final date of the payroll period, representing the last day for which employees receive compensation. This date determines payroll cutoff and reporting timelines. |
| PeriodIsEarliestOpen | Bool | False |
Indicates whether this payroll period is the earliest available open period for payroll processing. If true, this is the earliest unpaid or unprocessed payroll period. |
| PeriodStartDate | Datetime | False |
The first date of the payroll period, marking the beginning of the pay cycle. This date is used for payroll calculations and reporting purposes. |
| Status | String | False |
The current status of the payroll period, such as 'Open,' 'Closed,' or 'Processing.' This value determines whether payroll actions can be performed within the specified period. |
| PeriodEndDate_Prompt | Date | False |
Specifies the end date of the payroll period in YYYY-MM-DD format for querying purposes. This parameter should not be used in conjunction with the showMostRecentOnly query parameter. |
| ShowMostRecentOnly_Prompt | Bool | False |
Determines whether to return only the five most recent pay periods. If set to true, the query retrieves the five most recent periods instead of filtering by a specific period end date. |
| Country_Prompt | String | False |
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. |
Records and retrieves customer invoice payment transactions, including amounts, payment methods, and processing statuses.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM Payments WHERE Id = '12345';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique ID for each customer payment transaction, maintaining data integrity, ensuring that every payment record can be distinctly referenced within the system. |
| Amount_Currency | String | False |
The currency in which the customer payment was made, represented as an International Organization for Standardization (ISO) currency code. |
| Amount_Value | Decimal | False |
The total value of the customer payment in the transaction currency, reflecting the exact amount paid by the customer. |
| Company_Id | String | False |
The unique ID for the company associated with the payment, which can be a Workday ID (WID), a reference ID, or an internal system ID. |
| Date | Datetime | False |
The timestamp indicating when the customer payment was completed, which is formatted as a date-time value. |
| Descriptor | String | False |
A brief summary or preview of the customer payment instance, often used for display purposes. |
| Memo | String | False |
Additional notes or details associated with the customer payment, often provided for reference or reconciliation. |
| ReadyToAutoApply | Bool | False |
Indicates whether the customer payment is eligible for automatic application to outstanding invoices or cash sales. |
| Reference | String | False |
A unique reference number is assigned to settled customer payments but is empty if the status is 'In Progress' or the payment method is check or Electronic Funds Transfer (EFT). |
| RemitFromCustomer_Id | String | False |
The unique ID for the customer who remitted the payment, represented as a WID, a reference ID, or an internal system ID. |
| TransactionNumber | String | False |
The official transaction number associated with the customer payment, used for tracking and reporting. |
| Type_Id | String | False |
An ID specifying the type of payment transaction, represented as a WID, a reference ID, or an internal system ID. |
Stores detailed breakdowns of remittance lines associated with customer invoice payments, ensuring complete financial reconciliation.
The Workday Cloud requires filtering on Payments_Id in order to perform the query.
For example:
SELECT * FROM PaymentsRemittanceDetails WHERE Payments_Id = '12345' AND Id = '54321';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for a payment remittance record is a system-generated or externally provided value that differentiates individual records. |
| Payments_Id [KEY] | String | False |
The system-generated unique Workday ID (WID) for the payment transaction associated with this remittance detail. |
| AmountToPay_Currency | String | False |
The currency in which the payment amount is specified, as defined on the customer payment invoice line. |
| AmountToPay_Value | Decimal | False |
The total amount to be paid, as specified on the customer payment invoice line, in the designated currency. |
| BillToCustomer_Id | String | False |
The unique identifier (for example, WID) or reference ID) for the customer being billed for this payment. |
| Invoice_Id | String | False |
The unique identifier (for example, WID, or reference ID) for the invoice associated with this payment remittance detail. |
Captures and manages individual payroll input records, including employee-specific earnings, deductions, and adjustments for payroll processing.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
type: { /* The related calculation type for the input line. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
name: Text /* The alternate ID of the related calculation for the pay component and pay component related calculation. */
}
value: Numeric /* The value for the input line. */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the payroll input instance, used to track and reference specific records. |
| Adjustment | Bool | False |
Indicates whether the payroll input is an adjustment. If the value is 'true,' it modifies an existing entry rather than replacing it. |
| Comment | String | False |
A textual comment providing additional details or context about this specific payroll input. |
| Currency_Descriptor | String | False |
A textual representation of the currency associated with this payroll input, typically the currency name or code. |
| Currency_Href | String | False |
A direct URL reference to the currency instance in Workday, allowing navigation to more details about the currency. |
| Currency_Id | String | False |
The unique identifier for the currency associated with the payroll input, which can be a Workday ID (WID), a reference ID, or another system-generated ID. |
| Descriptor | String | False |
A brief textual preview summarizing key details of the payroll input record for easy identification. |
| EndDate | Datetime | False |
The final date on which this payroll input remains applicable. After this date, the input is no longer valid. |
| FieldEditability | String | False |
Specifies which fields in the payroll input request can be modified. Possible values can be all (full edit access), none (read-only), and end date only (only the end date can be changed). |
| InputDetails_Aggregate | String | False |
Comprehensive details related to the payroll input, including metadata, references, or other key attributes. |
| Ongoing | Bool | False |
Indicates whether the payroll input is continuous. If the value is 'true,' the input remains active indefinitely until explicitly ended. |
| PayComponent_Code | String | False |
The code assigned to the pay component associated with this payroll input, used for categorization and processing. |
| PayComponent_Descriptor | String | False |
A brief textual description providing context or details about the associated pay component. |
| PayComponent_Id | String | False |
The unique identifier of the pay component related to this payroll input, used for system tracking and reference. |
| Position_Descriptor | String | False |
A descriptive label or summary identifying the position related to this payroll input. |
| Position_Href | String | False |
A direct URL reference to the position instance in Workday, allowing quick access to position details. |
| Position_Id | String | False |
The unique identifier for the position associated with this payroll input, which can be a WID, a reference ID, or another system-generated ID. |
| RunCategories_Aggregate | String | False |
Specifies the run category assigned to this payroll input, determining how and when it is processed within payroll cycles. |
| StartDate | Datetime | False |
The initial date from which this payroll input becomes effective. Inputs before this date are not considered. |
| Worker_Descriptor | String | False |
A summary or preview identifying the worker associated with this payroll input, typically including the worker’s name. |
| Worker_Id | String | False |
The unique identifier of the worker to whom this payroll input applies, used for tracking and processing. |
| Worktags_Aggregate | String | False |
A collection of worktags linked to this payroll input, which help categorize and track expenses, projects, or other financial allocations. |
| EndDate_Prompt | Date | False |
A filter parameter that retrieves payroll inputs that are active on or before this specified end date. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | False |
The WID of the pay component associated with the payroll input. |
| StartDate_Prompt | Date | False |
A filter parameter that retrieves payroll inputs that are active on or after this specified start date. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | False |
The WID of the worker associated with the payroll input. This can be retrieved using GET /workers in the Staffing service. |
Stores detailed breakdowns of payroll input records, including itemized earnings, deductions, and tax components applied to each payroll entry.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this payroll input detail links records, tracks changes, and ensures data consistency in payroll processing. |
| PayrollInputs_Id [KEY] | String | False |
The generated Workday ID (WID) for the parent PayrollInputs record that this entry belongs to. |
| Type_Descriptor | String | False |
A human-readable description providing an overview of the type of payroll input associated with this record. |
| Type_Id | String | False |
The unique identifier representing the specific type of payroll input within the system. |
| Type_Name | String | False |
An alternate identifier that corresponds to the related pay component or its associated calculation, used for payroll processing. |
| Value | Decimal | False |
The numeric value assigned to this payroll input detail, typically representing an amount, rate, or percentage. |
| EndDate_Prompt | Date | False |
Specifies the cutoff date for payroll inputs. Only inputs active on or before this date will be returned. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | False |
The generated WID for the pay component linked to this payroll input. |
| StartDate_Prompt | Date | False |
Specifies the starting date for filtering payroll inputs. Only payroll inputs that are active on or after this date will be returned. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | False |
The generated WID for the worker associated with this payroll input. This ID can be retrieved from the Staffing service API at GET /workers. |
Organizes and categorizes payroll input records by run category, enabling precise payroll runs based on defined processing rules.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the payroll input run category instance, used to track and reference this specific entry within the system. |
| PayrollInputs_Id [KEY] | String | False |
The Workday ID (WID) for the associated PayrollInputs record that this run category is linked to, ensuring proper data relationships. |
| Descriptor | String | False |
A brief textual representation of this payroll input run category instance, often used in UI displays and reports. |
| EndDate_Prompt | Date | False |
Specifies the cutoff date for payroll inputs included in this category. Only payroll inputs that are active on or before this date will be considered. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | False |
The WID of the pay component associated with the payroll input. This filter can be used for payroll inputs by specific pay components. |
| StartDate_Prompt | Date | False |
Defines the beginning of the time period for filtering payroll inputs. Only inputs active on or after this date will be included. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | False |
The WID of the worker associated with this payroll input. This field can be used to retrieve payroll inputs for a specific worker. |
Links payroll input records with relevant worktags to ensure proper accounting and reporting of payroll expenses.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this payroll input worktag instance within Workday. |
| PayrollInputs_Id [KEY] | String | False |
The system-generated unique Workday ID (WID) for the Payroll Inputs record to which this worktag belongs. |
| Descriptor | String | False |
A brief summary or preview of this payroll input worktag instance, providing a readable identifier. |
| EndDate_Prompt | Date | False |
The final date for filtering payroll inputs, ensuring only payroll inputs active on or before this date are included. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | False |
The WID for the pay component associated with this payroll input. This ID can be retrieved from GET /values/payrollInputsGroup/payComponents. |
| StartDate_Prompt | Date | False |
The initial date for filtering payroll inputs, ensuring only payroll inputs active on or after this date are included. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | False |
The WID for the worker associated with this payroll input. This ID can be retrieved using GET /workers from the staffing service. |
Stores and retrieves details about specific phases within a project plan, tracking key milestones and timelines for effective project management.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the project plan phase instance within Workday. |
| ChildrenCount | Decimal | False |
Total number of child phases or tasks directly associated with the current project plan phase. |
| Deletable | Bool | False |
Indicates whether the project plan phase can be removed from the system. If the value is 'true,' the phase can be deleted. |
| Description | String | False |
Detailed description of the specific phase within the project plan, providing insight into its purpose and function. |
| Descriptor | String | False |
A textual summary or label used to quickly identify the project plan phase instance. |
| Editable | Bool | False |
Indicates whether modifications can be made to the project plan phase. If the value is 'true,' the phase can be edited. |
| HasChildren | Bool | False |
Specifies whether the project plan phase contains any subordinate phases or tasks. If the value is 'true,' at least one child element exists. |
| LevelNumber | Decimal | False |
Represents the hierarchical level of the phase within the project plan structure, where higher numbers indicate deeper nesting. |
| Order | String | False |
Determines the sequence in which the phase appears within the project plan. Used for organizing and displaying phases in the correct order. |
| ParentPhase_Descriptor | String | False |
Textual representation of the parent phase, providing an overview or title of the higher-level phase. |
| ParentPhase_Href | String | False |
A direct URL reference to the parent phase instance within Workday, facilitating navigation to related records. |
| ParentPhase_Id | String | False |
The unique identifier (for example, WID, ID, or reference ID) for the parent phase, establishing its relationship with the current phase. |
| Phase_Descriptor | String | False |
A descriptive label or summary for the current phase, aiding in identification within the project plan. |
| Phase_Href | String | False |
A direct URL reference to the current phase instance, allowing easy access to its details within Workday. |
| Phase_Id | String | False |
The unique identifier (for example, WID, ID, or reference ID) for the current phase, used for referencing within the Workday system. |
| Project_Descriptor | String | False |
A textual summary of the project to which the phase belongs, providing a high-level view of its context. |
| Project_Href | String | False |
A direct URL reference to the associated project instance, allowing for quick access to project details. |
| Project_Id | String | False |
The unique identifier (for example, WID, ID, or reference ID) for the project containing the phase, enabling linkage between phases and their parent project. |
| SequenceNumber | String | False |
Specifies the sequential ordering of the project plan phase, ensuring consistency in project execution. |
| FilterBy_Prompt | String | False |
Accepts either a Project Plan Phase or Project Plan Task WID, used to filter results based on the specified filter condition. |
| FilterCondition_Prompt | String | False |
Works with the FilterBy field to determine which instances to include or exclude in the GET response. This accepts values such as 'Is' and 'Not Equal to' (case-insensitive). |
| Parent_Prompt | String | False |
Indicates the reference or prompt used for filtering project plan phases by their parent instance. |
| Project_Prompt | String | False |
Indicates the reference or prompt used for filtering project plan phases by their associated project. |
| TopLevelPhase_Prompt | Bool | False |
Specifies whether the current phase is a top-level phase within the project plan hierarchy. If the value is 'true,' the phase has no parent. |
Maintains a collection of tasks within a project plan, including assignments, deadlines, and dependencies for a given project or project phase.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the project plan task instance, used for reference and tracking. |
| BillableTask | Bool | False |
Indicates whether the project plan task is billable. If the value is 'false,' the time recorded against this task will not be billed to a client. |
| Closed | Bool | False |
Specifies whether the project plan task is closed. Closed tasks are locked from any further modifications, including time entry. |
| CustomTaskName | String | False |
The user-defined name of the project task, allowing customization for better identification and organization within the project plan. |
| Deletable | Bool | False |
Indicates if the project plan task can be removed. Tasks marked as non-deletable must remain in the plan. |
| Descriptor | String | False |
A textual summary or brief preview of the project plan task instance, used for quick reference. |
| Editable | Bool | False |
Determines whether the project task can be modified. If the value is 'false,' the users cannot make changes to the task details. |
| EndDate | Datetime | False |
The scheduled completion date of the project task, defining when the task should be finalized. |
| Memo | String | False |
Additional notes or comments related to the project plan task, providing context, updates, or relevant details. |
| Milestone | Bool | False |
Indicates whether the task represents a significant milestone within the project plan. Milestones signify key achievements or phases. |
| Order | String | False |
Defines the sequence in which the project tasks appear within the plan, ensuring a structured workflow. |
| PercentComplete | Decimal | False |
Represents the progress of the task as a percentage, indicating how much of the work has been completed. |
| Phase_Descriptor | String | False |
A textual description of the associated project phase, summarizing its purpose and key details. |
| Phase_Href | String | False |
A direct URL reference to the associated project phase instance, enabling navigation to detailed information. |
| Phase_Id | String | False |
Unique identifier (WID, ID, or reference ID) for the project phase, used for linking related records. |
| StartDate | Datetime | False |
The scheduled start date of the project task, marking when work is expected to begin. |
| TaskResourceCount | Decimal | False |
The total number of resources assigned to the project task, reflecting workload distribution. |
| Task_Descriptor | String | False |
A textual description of the project task, providing insight into its purpose and details. |
| Task_Href | String | False |
A direct URL reference to the project task instance, allowing access to detailed task information. |
| Task_Id | String | False |
Unique identifier (WID, ID, or reference ID) for the project task, facilitating reference and linkage. |
| Utilization | Bool | False |
Indicates whether the project task is factored into utilization calculations, affecting resource management and reporting. |
| FilterBy_Prompt | String | False |
Accepts both Project Plan Phase or Project Plan Task WID, used to refine query results. |
| FilterCondition_Prompt | String | False |
Defines criteria for filtering tasks or phases in a project plan, specifying whether to include or exclude certain Workday IDs (WIDs). |
| PlanPhase_Prompt | String | False |
Defines the project phase within which the task is categorized, helping to structure project planning. |
| Project_Prompt | String | False |
Specifies the associated project for which the task is being managed, ensuring proper task allocation and reporting. |
Stores information about various projects, allowing retrieval of project metadata, statuses, and associated attributes for organizational planning and execution.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
awaitingPersons: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
businessEventValidation: [{
conditionRule: Text /* The condition rule as a text expression. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
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. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
comments: [{
comment: Text /* Comment */
conmentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
completedByPerson: { /* The person that completed the step as Assignee */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
completedOn: Date /* The date when this step was completed */
creationDate: Date /* The date when the event record was created. */
delayedDate: Date /* The date the delayed step will trigger. */
descriptor: Text /* A preview of the instance */
due: Date /* Returns the due date for this step. */
event: { /* The business process associated with the project you're editing. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
status: { /* The status of this business process step. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for the project instance within the system. Used to reference the project in various Workday transactions. |
| Billable | Bool | False |
Indicates whether the project is billable. When set to True, the project is expected to generate revenue through client invoicing or internal chargebacks. |
| BusinessEventRecords_Aggregate | String | False |
Represents the aggregated record of business events related to the project, such as approvals, modifications, and financial adjustments, which are tracked within Workday. |
| Capital | Bool | False |
Indicates whether the project is a capital project. Capital projects involve significant financial investment, typically in infrastructure, equipment, or long-term assets. |
| Company_Descriptor | String | False |
A textual representation of the company associated with the project, providing a user-friendly reference for reporting and selection. |
| Company_Href | String | False |
A URL link to the company entity within Workday, enabling quick navigation to company details from the project record. |
| Company_Id | String | False |
A unique identifier, either the Workday ID (WID) or reference ID, for the company associated with the project. This is used for system-level integration and reporting. |
| Currency_Descriptor | String | False |
A human-readable description of the currency in which the project transactions are denominated, such as 'US Dollar' or 'Euro'. |
| Currency_Id | String | False |
A system-generated identifier for the currency associated with the project, ensuring financial consistency in transactions. |
| Customer_Descriptor | String | False |
A descriptive label representing the customer linked to the project, typically used in billing and reporting. |
| Customer_Href | String | False |
A URL link to the customer's record within Workday, allowing users to quickly access customer details. |
| Customer_Id | String | False |
A unique identifier (WID, reference ID) for the customer associated with the project, ensuring accurate tracking of customer-related transactions. |
| Description | String | False |
A detailed narrative explaining the purpose, scope, and key details of the project, often used for documentation and reporting. |
| Descriptor | String | False |
A brief summary of the project instance, often used for quick reference within Workday dashboards and reports. |
| EndDate | Datetime | False |
The scheduled completion date of the project, signifying when all planned work should be finalized. |
| EstimatedBudget_Currency | String | False |
The currency in which the estimated project budget is calculated, ensuring consistency in financial tracking. |
| EstimatedBudget_Value | Decimal | False |
The total estimated budget allocated to the project, as recorded in the project financials summary, expressed in the designated project currency. |
| EstimatedRevenueSavings_Currency | String | False |
The currency in which the estimated revenue (for billable projects) or savings (for non-billable projects) is calculated. |
| EstimatedRevenueSavings_Value | Decimal | False |
The projected revenue or cost savings expected from the project, based on financial forecasts and business case analysis. |
| ExternalLink | String | False |
A hyperlink to an external system, document, or resource relevant to the project, such as a client portal or project management tool. |
| ExternalProjectReference | String | False |
An identifier or reference code used by external systems to link to this project, facilitating integration between Workday and other project management platforms. |
| Groups_Aggregate | String | False |
A collection of project groups associated with this project. Project groups are used to classify projects for organizational or financial tracking. |
| Href | String | False |
A hyperlink to the project record within Workday, enabling direct navigation for users reviewing project details. |
| ImportanceRating_Descriptor | String | False |
A descriptive label indicating the significance of the project, typically used in prioritization and decision-making. |
| ImportanceRating_Href | String | False |
A URL link to the importance rating definition in Workday, allowing for quick reference to rating criteria. |
| ImportanceRating_Id | String | False |
A unique identifier for the importance rating assigned to the project, used for reporting and sorting projects by priority. |
| InScope | String | False |
A detailed description of tasks, deliverables, and activities that are explicitly included within the project's scope. Helps define project boundaries. |
| Inactive | Bool | False |
Indicates whether the project is currently inactive. When set to True, no further financial or operational actions can be performed on this project. |
| IncludeProjectIDInName | Bool | False |
Determines whether the project ID should be automatically included in the project name for easier identification. |
| MeasuresOfSuccess | String | False |
Specific criteria used to evaluate the success of the project, such as key performance indicators (KPIs), milestones achieved, or financial performance. |
| Name | String | False |
The official, approved name of the project, used for reporting, budgeting, and communication. |
| Objective | String | False |
A clear and concise statement of the project’s goals and intended outcomes, providing guidance to stakeholders and team members. |
| OptionalHierarchies_Aggregate | String | False |
A collection of optional project hierarchies to which this project belongs, providing flexibility in organizational structure. |
| OutOfScope | String | False |
A detailed description of tasks, deliverables, and activities that are explicitly excluded from the project's scope, helping manage stakeholder expectations. |
| Overview | String | False |
A high-level summary of the project, including key objectives, stakeholders, and critical details to provide context to team members. |
| Owner_Descriptor | String | False |
A human-readable label representing the project owner, often a manager or lead responsible for overseeing project execution. |
| Owner_Href | String | False |
A URL link referencing the specific project owner instance within the system. This link allows navigation to the detailed record of the project owner. |
| Owner_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the project owner, ensuring proper linkage to related records. |
| PercentComplete | Decimal | False |
The percentage of work completed for the project, represented as a decimal value. This field helps track progress towards project completion. |
| PrimaryHierarchy_Descriptor | String | False |
A descriptive name or label for the primary hierarchy associated with this project, providing context about its placement within the organization's structure. |
| PrimaryHierarchy_Href | String | False |
A URL link pointing to the specific instance of the primary hierarchy related to the project, allowing users to access detailed hierarchy information. |
| PrimaryHierarchy_Id | String | False |
A unique identifier (WID, ID, or reference ID) associated with the primary hierarchy of the project, used for tracking and data integrity. |
| Priority_Descriptor | String | False |
A text-based description of the priority level assigned to the project, such as High, Medium, or Low, indicating its relative importance. |
| Priority_Href | String | False |
A URL link referencing the specific priority instance for the project, providing additional details about its classification. |
| Priority_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the priority level of the project, ensuring proper categorization. |
| ProbabilityOfSuccess | Decimal | False |
A numeric value representing the likelihood of project success, typically expressed as a decimal percentage based on risk assessment and historical data. |
| ProblemStatement | String | False |
A detailed statement outlining the problem or challenge that the project aims to resolve, providing context for stakeholders. |
| ProjectDependencies_Aggregate | String | False |
A list of dependencies that the project relies on, including other projects, resources, or key milestones that must be met for successful execution. |
| ProjectID | String | False |
A unique alphanumeric identifier assigned to the project, used for tracking and reference purposes. |
| ProjectState_Descriptor | String | False |
A text description of the project's current state, such as In Progress, Completed, or On Hold, providing insights into its lifecycle stage. |
| ProjectState_Href | String | False |
A URL link directing users to the specific instance of the project state, enabling access to more details about its status. |
| ProjectState_Id | String | False |
A unique identifier (WID, ID, or reference ID) assigned to the project's state, ensuring consistency in tracking and reporting. |
| RealizedRevenueSavings_Currency | String | False |
The currency in which the project's realized revenue (for billable projects) or cost savings (for non-billable projects) is expressed, ensuring clarity in financial reports. |
| RealizedRevenueSavings_Value | Decimal | False |
The actual amount of revenue earned (for billable projects) or savings achieved (for non-billable projects), represented in the project’s designated currency. |
| RiskLevel_Descriptor | String | False |
A descriptive label indicating the risk level associated with the project, such as Low, Medium, or High, based on project complexity and uncertainty. |
| RiskLevel_Href | String | False |
A URL link referencing the specific risk level instance, allowing users to review additional risk-related details. |
| RiskLevel_Id | String | False |
A unique identifier (WID, ID, or reference ID) associated with the project's risk level, ensuring accurate classification. |
| StartDate | Datetime | False |
The official start date of the approved project, determining when work on the project is scheduled to begin. |
| Status_Descriptor | String | False |
A text-based description of the project's current status, providing a clear indication of its progress, such as Active, On Hold, or Completed. |
| Status_Href | String | False |
A URL link pointing to the specific instance of the project's status, allowing users to view more detailed status information. |
| Status_Id | String | False |
A unique identifier (WID, ID, or reference ID) associated with the project status, ensuring accurate tracking in reports and dashboards. |
| SuccessRating_Descriptor | String | False |
A description of the project's overall success rating, based on predefined criteria such as performance metrics and stakeholder satisfaction. |
| SuccessRating_Href | String | False |
A URL link directing users to the success rating instance, enabling further analysis of the project's outcomes. |
| SuccessRating_Id | String | False |
A unique identifier (WID, ID, or reference ID) associated with the project's success rating, facilitating structured reporting. |
| TotalSavingsRemaining_Currency | String | False |
The currency in which the remaining projected savings for the project are expressed, ensuring financial clarity and consistency. |
| TotalSavingsRemaining_Value | Decimal | False |
The total estimated amount of cost savings still available for the project, represented in the project’s designated currency. |
| Worktags_Aggregate | String | False |
A collection of keywords or tags assigned to the project to categorize financial transactions, such as Cost, Organization, or Funding Source, enhancing tracking and reporting. |
Maintains records of business events linked to projects, such as approvals, status updates, and key decision points, for auditing and tracking purposes.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
conditionRule: Text /* The condition rule as a text expression. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
comment: Text /* Comment */
conmentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this business event record instance within Workday. |
| Projects_Id [KEY] | String | False |
The system-generated unique Workday ID (WID) for the project that this business event is associated with. |
| AwaitingPersons_Aggregate | String | False |
A list of individuals who are required to take action on this business event before it can proceed to the next step. |
| BusinessEventValidation_Aggregate | String | False |
A collection of validation errors or warnings that were triggered when processing this business event, indicating potential issues that need to be resolved. |
| BusinessProcessStep_Descriptor | String | False |
A textual representation that describes the specific step within the business process workflow for this event. |
| BusinessProcessStep_Href | String | False |
A direct URL link to access the details of this business process step in Workday. |
| BusinessProcessStep_Id | String | False |
The unique identifier (WID, id, or reference ID) assigned to this specific business process step. |
| Comments_Aggregate | String | False |
A collection of user-submitted comments associated with this business process event step, providing additional context or details. |
| CompletedByPerson_Descriptor | String | False |
A text-based description of the individual who completed this business process step. |
| CompletedByPerson_Href | String | False |
A direct URL link to access the profile or details of the person who completed this step. |
| CompletedByPerson_Id | String | False |
The unique identifier (WID, id, or reference ID) assigned to the person who completed this step. |
| CompletedOn | Datetime | False |
The exact date and time when this business process step was marked as completed in Workday. |
| CreationDate | Datetime | False |
The timestamp indicating when this business event record was originally created in the Workday system. |
| DelayedDate | Datetime | False |
The scheduled date and time when a delayed step in the business process workflow will be executed. |
| Descriptor | String | False |
A brief textual preview summarizing key details of this business event record instance. |
| Due | Datetime | False |
The deadline or due date by which this business process step must be completed to stay on track. |
| Event_Descriptor | String | False |
A descriptive label providing context about the specific business event associated with this record. |
| Event_Href | String | False |
A direct URL link to access detailed information about this business event instance. |
| Event_Id | String | False |
The unique identifier (WID, id, or reference ID) assigned to this specific business event in Workday. |
| Status_Descriptor | String | False |
A text-based summary of the current status of this business event within the workflow. |
| Status_Href | String | False |
A direct URL link to access more details about the current status of this business event. |
| Status_Id | String | False |
The unique identifier (WID, id, or reference ID) assigned to the status of this business event. |
Stores group associations within projects, enabling retrieval of information about team structures, project roles, and collaborations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this specific instance within the ProjectsGroups table. This value is used as the primary key to distinguish each record uniquely. |
| Projects_Id [KEY] | String | False |
The unique Workday ID (WID) that links this record to a corresponding entry in the Projects table. This establishes a relationship between the project and its associated group. |
| Descriptor | String | False |
A human-readable representation of this instance, typically used for display purposes. This can include a concatenation of key attributes to provide a quick preview of the record's details. |
Captures optional hierarchical structures within projects, allowing flexible organization and classification of project elements.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this specific instance of the ProjectsOptionalHierarchies table. This ID is system-generated and serves as a primary key. |
| Projects_Id [KEY] | String | False |
The assigned unique Workday ID (WID) for the associated Project. This links the record to a specific project within the Workday system, ensuring proper hierarchy mapping. |
| Descriptor | String | False |
A human-readable summary or preview of this instance, providing a brief but informative representation of the project hierarchy. |
Tracks dependencies between different projects, providing insight into interrelated project timelines and potential scheduling conflicts.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for each project dependency record, ensuring that each entry in the dataset can be distinctly referenced. |
| Projects_Id [KEY] | String | False |
The unique Workday ID (WID) for the project that contains this dependency. This links the dependency to its parent project. |
| Descriptor | String | False |
A brief, human-readable representation of this project dependency instance, providing a preview or summary of its key attributes. |
Stores worktags associated with projects, helping in financial tracking, categorization, and reporting based on project-specific IDs.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the specific instance of this table entry, typically a system-generated value, used to reference this record within the database. |
| Projects_Id [KEY] | String | False |
The specific Workday ID (WID) associated with a Project. This ID is used to track and manage project-related data within the Workday system. |
| Descriptor | String | False |
A brief textual representation of this record, often used for display purposes. This might include a concatenation of key attributes that provide a quick overview of the instance. |
Manages and stores information about prospective candidates for recruitment, allowing for the creation and tracking of potential hires within the system.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM Prospects WHERE Id = 'c1d030d96f4c900144b4d0bd8d470000';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A system-generated unique identifier assigned to each candidate record, used to track the candidate throughout the recruitment and hiring process. |
| CandidatePools_Aggregate | String | False |
A list of candidate pools that the candidate is actively part of. These pools help categorize candidates based on hiring needs. |
| CandidateTags_Aggregate | String | False |
A collection of tags assigned to the candidate, often used to facilitate searching and filtering based on skills, experience, or other attributes. |
| Candidate_Descriptor | String | False |
A brief, human-readable representation of the candidate's record, typically used for display purposes in user interfaces or reports. |
| Candidate_Email | String | False |
The email address associated with the candidate, used for communication and identification in the recruitment process. |
| Candidate_Id | String | False |
A unique identifier assigned to the candidate within the system, used to track their application and recruitment progress. |
| Candidate_Name_Country_Descriptor | String | False |
A descriptive label providing a human-readable format of the country associated with the candidate's name, typically used for reporting and selection interfaces. |
| Candidate_Name_Country_Id | String | False |
A unique identifier representing the country associated with the candidate's name, used for reference and categorization. |
| Candidate_Name_Descriptor | String | False |
A human-readable display of the candidate’s full name, formatted for ease of identification in reports and application tracking. |
| Candidate_Name_FirstName | String | False |
The given name of the candidate, used in formal records and communications throughout the hiring process. |
| Candidate_Name_FirstNameLocal | String | False |
The candidate's first name displayed in the local script, applicable in regions where non-Latin scripts are used. |
| Candidate_Name_FirstNameLocal2 | String | False |
An additional local script version of the candidate's first name, relevant for countries with multiple non-Latin scripts. |
| Candidate_Name_FullName | String | False |
The complete name of the candidate as officially recorded. This is used primarily in regions where a full name is a recognized component. |
| Candidate_Name_Hereditary_Descriptor | String | False |
A descriptive label for the hereditary name component, if applicable. |
| Candidate_Name_Hereditary_Id | String | False |
A unique identifier assigned to the candidate's name instance within the Workday system. This hereditary ID ensures consistency across different processes. |
| Candidate_Name_Id | String | False |
A system-generated unique identifier assigned to each candidate's name record. This ID ensures that every candidate's name entry is distinct and can be referenced across the system. |
| Candidate_Name_LastName | String | False |
The last name or surname of the candidate, used for identification and record-keeping. This value is typically derived from the candidate's submitted personal information. |
| Candidate_Name_LastNameLocal | String | False |
The candidate's last name in local script, applicable in regions where non-Latin scripts are used. |
| Candidate_Name_LastNameLocal2 | String | False |
A secondary local script version of the candidate's last name, relevant for countries with multiple non-Latin scripts. |
| Candidate_Name_MiddleName | String | False |
The middle name of the candidate, which is useful for distinguishing individuals with common first and last names. |
| Candidate_Name_MiddleNameLocal | String | False |
The candidate's middle name in local script, applicable in regions where non-Latin scripts are used. |
| Candidate_Name_Salutation_Descriptor | String | False |
A readable label for the salutation associated with the candidate’s name (for example, Mr., Ms., Dr.). |
| Candidate_Name_Salutation_Id | String | False |
The unique identifier for the salutation or title (for example, Mr., Ms., Dr.) associated with the candidate's name and ensures proper addressing. |
| Candidate_Name_SecondaryLastName | String | False |
The secondary family name of the candidate, typically used in cultures where multiple last names are common. This can represent a maternal surname in some naming conventions. |
| Candidate_Name_SecondaryLocal | String | False |
The secondary family name of the candidate written in the local script, ensuring accurate representation of names in native languages. |
| Candidate_Name_Social_Descriptor | String | False |
A text preview or summary of the candidate's name as it appears in social or public settings, often used for display purposes in reports and dashboards. |
| Candidate_Name_Social_Id | String | False |
A system-generated unique identifier for tracking the candidate's social name entry in Workday. This ID links the candidate's name to relevant records. |
| Candidate_Name_TertiaryLastName | String | False |
The tertiary family name of the candidate, used in cultures where three-part surnames are common. This ensures accurate representation of the candidate's full legal name. |
| Candidate_Name_Title_Descriptor | String | False |
A text preview of the candidate's professional or academic title, such as 'Dr.', 'Prof.', or 'Sir', used in communications and official documentation. |
| Candidate_Name_Title_Id | String | False |
A unique system-generated identifier for the candidate's title, ensuring proper classification and retrieval of title-related information. |
| Candidate_Phone_CountryPhoneCode_Descriptor | String | False |
A textual description of the country phone code associated with the candidate's phone number, such as 'United States (+1)' or 'United Kingdom (+44)'. |
| Candidate_Phone_CountryPhoneCode_Href | String | False |
A hyperlink reference to additional details about the country phone code, potentially linking to country-specific communication guidelines. |
| Candidate_Phone_CountryPhoneCode_Id | String | False |
A system-generated identifier representing the country phone code, such as 'US-1' or 'IN-91', ensuring standardized international dialing information. |
| Candidate_Phone_Descriptor | String | False |
A text summary of the candidate's primary phone number, often used for quick reference in reports or user interfaces. |
| Candidate_Phone_DeviceType_Descriptor | String | False |
A description of the type of phone device the candidate is using, such as 'Mobile', 'Home', 'Work', or 'Fax', which helps categorize communication preferences. |
| Candidate_Phone_DeviceType_Href | String | False |
A hyperlink reference providing more information about the device type, potentially linking to system configurations or usage policies. |
| Candidate_Phone_DeviceType_Id | String | False |
A system-generated identifier for the phone device type, ensuring proper classification of the candidate's contact details. |
| Candidate_Phone_Extension | String | False |
The extension number associated with the candidate's phone line, typically used in office phone systems to route calls efficiently. |
| Candidate_Phone_Id | String | False |
A unique identifier for the candidate's phone record, linking it to other contact information in the system. |
| Candidate_Phone_PhoneNumber | String | False |
The candidate's full primary phone number, including country and area codes where applicable. Used for direct communication with the candidate. |
| ContactConsent | Bool | False |
Indicates whether the candidate has given explicit consent to be contacted by recruiters or hiring teams. A value of 'true' means the candidate has opted in for communications. |
| Descriptor | String | False |
A textual summary or preview of the record, typically used for quick reference in user interfaces and reports. |
| Href | String | False |
A hyperlink reference to additional details about the current record, allowing users to navigate to related information. |
| Level_Descriptor | String | False |
A descriptive label indicating the hierarchical level of the candidate, such as 'Entry Level', 'Mid-Level', or 'Senior', categorizing the candidate's experience. |
| Level_Href | String | False |
A hyperlink reference providing additional details about the candidate's level, potentially linking to job level guidelines. |
| Level_Id | String | False |
A unique identifier for the candidate's level, ensuring accurate classification and retrieval of experience-related information. |
| ReferredBy_Descriptor | String | False |
A textual description of the individual or organization that referred the candidate, such as 'Employee Referral' or 'External Agency'. |
| ReferredBy_Href | String | False |
A hyperlink reference to details about the referrer, linking to additional information about referral programs. |
| ReferredBy_Id | String | False |
A unique identifier for the referring individual or organization, ensuring accurate tracking of referrals. |
| Source_Descriptor | String | False |
A description of the source from which the candidate application originated, such as 'Job Board', 'Recruiter', or 'Direct Application'. |
| Source_Href | String | False |
A hyperlink reference providing more details about the candidate's source, allowing users to analyze recruiting effectiveness. |
| Source_Id | String | False |
A unique identifier for the source, ensuring proper categorization and reporting of recruitment channels. |
| Status_Descriptor | String | False |
A descriptive label indicating the candidate's current application status, such as 'Applied', 'Interviewing', or 'Hired'. |
| Status_Href | String | False |
A hyperlink reference to details about the candidate's status, allowing users to track progress in the hiring process. |
| Status_Id | String | False |
A unique identifier for the candidate's status, ensuring accurate reporting and workflow processing. |
| Type_Descriptor | String | False |
A description of the candidate's classification within the system, such as 'Internal Applicant', 'External Applicant', or 'Employee Transfer'. |
| Type_Href | String | False |
A hyperlink reference providing more details about the candidate type, linking to relevant hiring policies or classifications. |
| Type_Id | String | False |
A unique identifier for the candidate type, ensuring proper categorization and processing in recruitment workflows. |
Associates prospects with candidate pools, facilitating segmentation of potential hires based on skill sets, experience, or job roles.
The Workday Cloud retrieves the first 5 rows from the ProspectsCandidatePools table without applying any filters.
For example:
SELECT * FROM ProspectsCandidatePools Limit 5;
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the instance, used as the primary key to distinguish each record. |
| Prospects_Id [KEY] | String | False |
The specific Workday ID (WID) for the Prospects entity that contains this candidate pool entry. This is used to establish relationships between candidates and their associated pools. |
| Descriptor | String | False |
A brief textual representation or summary of the instance, typically used for display purposes in Workday interfaces. |
Stores tags linked to prospects, enabling categorization based on skills, experience, or recruitment status.
The Workday Cloud retrieves the first 5 rows from the ProspectsCandidateTags table without applying any filters.
For example:
SELECT * FROM ProspectsCandidateTags Limit 5;
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this candidate tag entry, used to track individual tags associated with prospects. |
| Prospects_Id [KEY] | String | False |
The system-generated Workday ID (WID) that links this tag to a specific prospect record. |
| Descriptor | String | False |
A brief, human-readable representation of the candidate tag, often used in User Inteface (UI) displays or reports. |
Retrieves educational background details for a specific prospect, providing insights into qualifications and academic history.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsEducations WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this specific educational record within Workday. |
| Prospects_Id [KEY] | String | False |
The unique Workday ID (WID) for the prospect associated with this educational record. |
| Degree_Descriptor | String | False |
A textual representation of the academic degree earned or pursued, such as 'Bachelor of Science in Computer Science' or 'Master of Business Administration.' |
| Degree_Href | String | False |
A URL or link directing to the Workday reference for the specific academic degree. |
| Degree_Id | String | False |
A system-generated WID, ID, or external reference ID, used to uniquely identify the academic degree. |
| FieldOfStudy_Descriptor | String | False |
A descriptive label specifying the candidate's field of study, such as 'Electrical Engineering' or 'Finance and Accounting.' |
| FieldOfStudy_Href | String | False |
A URL or Workday reference link pointing to the specific field of study details. |
| FieldOfStudy_Id | String | False |
A WID, system-generated ID, or external reference ID, used to uniquely identify the field of study. |
| FirstYearAttended | Datetime | False |
The earliest recorded year in which the candidate started attending this educational institution, formatted as a date-time value. |
| GradeAverage | String | False |
The candidate's academic performance indicator, which can include a GPA (for example, 3.8/4.0), letter grade, or percentage score, based on the institution’s grading system. |
| LastYearAttended | Datetime | False |
The most recent recorded year in which the candidate attended this educational institution, formatted as a date-time value. |
| SchoolName | String | False |
The official name of the educational institution where the candidate studied or is currently studying. |
Stores and retrieves work experience details of prospects, allowing recruiters to assess career history and job suitability.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsExperiences WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this specific work experience entry, assigned automatically. |
| Prospects_Id [KEY] | String | False |
The unique Workday ID (WID) associated with the prospect to whom this work experience belongs. |
| CompanyName | String | False |
The full name of the company where the candidate was employed, as entered in their job history. |
| CurrentlyWorkHere | Bool | False |
Indicates whether the candidate is still employed at this company. If the value is 'true,' the employment is ongoing. |
| Description | String | False |
A detailed summary of the candidate's responsibilities, achievements, and contributions during their tenure at this company. |
| EndMonth | Decimal | False |
Represents the numerical month (1-12) when the candidate's employment at this company ended. |
| EndYear | Datetime | False |
The four-digit year in which the candidate's employment at this company concluded. |
| Location | String | False |
The geographic location of the company where the candidate was employed, which can include city and state. |
| StartMonth | Decimal | False |
Represents the numerical month (1-12) when the candidate began working at this company. |
| StartYear | Datetime | False |
The four-digit year in which the candidate's employment at this company commenced. |
| Title | String | False |
The job title or position held by the candidate at this company, reflecting their role and responsibilities. |
Captures language proficiency information for prospects, supporting multilingual hiring and candidate assessment.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsLanguages WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
abilityType: { /* The type of language ability. See the configured types in the Maintain Language Ability Types. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
proficiency: { /* The proficiency for a specific language ability. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for this specific language entry, which distinguishes it from other entries in the table. |
| Prospects_Id [KEY] | String | False |
The system-generated Workday ID (WID) that links this language skill record to a specific prospect. |
| Abilities_Aggregate | String | False |
A collection of skills and proficiencies demonstrated by the prospect in the specified language, including speaking, writing, reading, and comprehension. |
| Language_Descriptor | String | False |
A textual representation of the language, such as its name, classification, or additional metadata that helps describe the entry. |
| Language_Href | String | False |
A direct URL or reference link to the Workday instance of this language record, allowing quick access within the system. |
| Language_Id | String | False |
A unique identifier for the language within Workday, which can be a WID, reference ID, or another system-generated ID. |
| Native | Bool | False |
Indicates whether this language is the prospect’s native language. If the value is 'true,' the individual considers this their primary language. |
Links language abilities to a prospect’s language records, detailing their proficiency levels and specific linguistic skills.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsLanguagesAbilities WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
A unique identifier for this language ability record within Workday. This ID is system-generated and serves as a primary key. |
| ProspectsLanguages_Id [KEY] | String | False |
The unique Workday ID (WID) for the ProspectsLanguages entity that groups multiple language ability records for a prospect. |
| Prospects_Id [KEY] | String | False |
The unique WID for the prospect to whom this language ability record belongs. This links the language ability to a specific individual in the system. |
| AbilityType_Descriptor | String | False |
A textual representation of the language ability type, such as 'Speaking,' 'Reading,' or 'Writing,' providing human-readable context for the record. |
| AbilityType_Href | String | False |
A URL reference pointing to the Workday API endpoint where details about this specific language ability type can be retrieved. |
| AbilityType_Id | String | False |
A system-generated identifier that uniquely represents the language ability type within Workday. This could be a WID, a reference ID, or an external system ID. |
| Proficiency_Descriptor | String | False |
A textual description of the proficiency level associated with this language ability, such as 'Beginner,' 'Intermediate,' or 'Fluent,' providing a human-readable representation. |
| Proficiency_Href | String | False |
A URL reference pointing to the Workday API endpoint where details about this specific proficiency level can be retrieved. |
| Proficiency_Id | String | False |
A system-generated identifier that uniquely represents the proficiency level in Workday. This could be WID, a reference ID, or an external system ID. |
Stores and retrieves resume attachments uploaded by prospects, ensuring easy access to applicant documentation.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsResumeAttachments WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the resume attachment instance. This value is system-generated and ensures each attachment is uniquely recognized within the database. |
| Prospects_Id [KEY] | String | False |
The Workday ID (WID) associated with the prospect who owns this resume attachment. This ID links the attachment to a specific candidate profile within Workday. |
| ContentType_Id | String | False |
The unique identifier or reference ID associated with the content type of the attached file. This helps categorize the file format for processing and display purposes. |
| Descriptor | String | False |
A brief textual representation or preview of the resume attachment, often used to provide a summary or key details about the document contents. |
| FileExtension | String | False |
The file format extension of the uploaded resume attachment, such as .pdf, .docx, or .txt. This determines how the file can be opened and processed. |
| FileLength | Decimal | False |
The total size of the resume attachment in bytes. This value ensures compliance with system limitations and helps manage storage efficiently. |
| FileName | String | False |
The original name of the uploaded resume file, including its extension. This name is typically provided by the user during upload and can help identify the file's contents. |
Captures and retrieves details on skills possessed by prospects, assisting recruiters in identifying suitable candidates based on expertise.
The Workday Cloud requires filtering on Prospects_Id in order to perform the query.
For example:
SELECT * FROM ProspectsSkills WHERE Prospects_Id = 'c1d030d96f4c900144b4d0bd8d470000';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the skill record. This value is automatically generated and serves as the primary key for referencing this specific skill instance. |
| Prospects_Id [KEY] | String | False |
The unique Workday ID (WID) for the prospect associated with this skill. This ID links the skill entry to a specific candidate profile in the Workday system. |
| Name | String | False |
The official name or designation of the skill possessed by the candidate. This value is used to categorize and filter skills when evaluating prospect qualifications. |
Retrieves details for a specific request using its unique ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
answerDate: Date /* The answer in a date format. */
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. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
questionnaireAttachments: [{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the instance, typically a Workday ID or reference ID used to track the record. |
| Comment | String | False |
The most recent comment related to the request event, providing additional context or information. |
| CompletionDate | Datetime | False |
The date when the request was fully completed or resolved. |
| Description | String | False |
A detailed description of the request, offering a clear overview of its purpose and content. |
| Descriptor | String | False |
A brief preview of the instance, typically used for summarizing or referencing the record. |
| Href | String | False |
A URL link to the specific instance, allowing direct access to the record in the system. |
| Initiator_Descriptor | String | False |
A description of the individual who initiated the request or action. |
| Initiator_Href | String | False |
A URL link to the profile or record of the initiator of the request. |
| Initiator_Id | String | False |
The unique identifier for the individual who initiated the request, typically their Workday ID or reference ID. |
| OnBehalfOf_Descriptor | String | False |
A description of the person or entity the request is being made on behalf of. |
| OnBehalfOf_Href | String | False |
A URL link to the profile or record of the person or entity the request is on behalf of. |
| OnBehalfOf_Id | String | False |
The unique identifier for the person or entity the request is being made on behalf of. |
| QuestionnaireResponses_BusinessProcessType_Descriptor | String | False |
A description of the business process type associated with the questionnaire responses. |
| QuestionnaireResponses_BusinessProcessType_Href | String | False |
A link to the business process type instance for the questionnaire responses. |
| QuestionnaireResponses_BusinessProcessType_Id | String | False |
The unique identifier for the business process type tied to the questionnaire responses. |
| QuestionnaireResponses_CreationDate | Datetime | False |
The date when the questionnaire response was created or submitted. |
| QuestionnaireResponses_Descriptor | String | False |
A preview description of the questionnaire response instance. |
| QuestionnaireResponses_Id | String | False |
The unique identifier for the questionnaire response instance. |
| QuestionnaireResponses_QuestionnaireAnswers_Aggregate | String | False |
An aggregate set of answers provided for the questionnaire, summarizing the responses. |
| QuestionnaireResponses_QuestionnaireResponseStatus_Descriptor | String | False |
A description of the current status of the questionnaire response. |
| QuestionnaireResponses_QuestionnaireResponseStatus_Href | String | False |
A link to the status record of the questionnaire response. |
| QuestionnaireResponses_QuestionnaireResponseStatus_Id | String | False |
The unique identifier for the status of the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTargetContext_Descriptor | String | False |
A description of the context or target related to the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTargetContext_Href | String | False |
A link to the context or target record related to the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTargetContext_Id | String | False |
The unique identifier for the context or target associated with the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTarget_Descriptor | String | False |
A description of the specific target or item associated with the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTarget_Href | String | False |
A link to the target or item record related to the questionnaire response. |
| QuestionnaireResponses_QuestionnaireTarget_Id | String | False |
The unique identifier for the target or item associated with the questionnaire response. |
| QuestionnaireResponses_TotalScore | Decimal | False |
The total score of the questionnaire response, calculated as the sum of individual answers' scores. |
| RequestDate | Datetime | False |
The date when the request business process was initially started. |
| RequestEvent_Descriptor | String | False |
A description of the event tied to the request, summarizing the context of the request event. |
| RequestEvent_Href | String | False |
A URL link to the specific event record related to the request. |
| RequestEvent_Id | String | False |
The unique identifier for the request event instance. |
| RequestID | String | False |
A unique identifier for the request, used to track and reference the request within the system. |
| RequestId_2 | String | False |
A secondary identifier for the request, typically based on an ID generator format. |
| RequestType_Descriptor | String | False |
A description of the request type, outlining its nature and categorization. |
| RequestType_Href | String | False |
A URL link to the specific request type record. |
| RequestType_Id | String | False |
The unique identifier for the request type instance. |
| ResolutionDetails_Descriptor | String | False |
A description of the resolution details related to the request, outlining how the request was addressed. |
| ResolutionDetails_Href | String | False |
A link to the resolution details record for the request. |
| ResolutionDetails_Id | String | False |
The unique identifier for the resolution details associated with the request. |
| Resolution_Descriptor | String | False |
A description of the resolution outcome for the request, providing details about the final decision or action taken. |
| Resolution_Href | String | False |
A link to the record that describes the resolution for the request. |
| Resolution_Id | String | False |
The unique identifier for the resolution instance associated with the request. |
| Status_Descriptor | String | False |
A description of the current status of the request, providing insight into its progress or state. |
| Status_Href | String | False |
A URL link to the status record of the request. |
| Status_Id | String | False |
The unique identifier for the status instance of the request. |
| Subtype_Descriptor | String | False |
A description of the subtype classification of the request, further categorizing its nature. |
| Subtype_Href | String | False |
A link to the subtype record associated with the request. |
| Subtype_Id | String | False |
The unique identifier for the subtype of the request. |
| WorkdayObjectValue_Descriptor | String | False |
A description of the Workday object associated with the request, providing context about the object involved. |
| WorkdayObjectValue_Href | String | False |
A link to the Workday object record tied to the request. |
| WorkdayObjectValue_Id | String | False |
The unique identifier for the Workday object associated with the request. |
| CompletedOnOrAfter_Prompt | Date | False |
A prompt to filter requests completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | False |
A prompt to filter requests completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | False |
A prompt to filter requests initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | False |
A prompt to filter requests initiated on or before the specified date. |
| Initiator_Prompt | String | False |
The Workday ID of the person who initiated the request. This can be used to query for the worker's WID through the /common service. |
| OnBehalfOf_Prompt | String | False |
The Workday ID of the individual the request is being made on behalf of. |
| RequestId_Prompt | String | False |
The unique ID of the request, typically based on an ID generator format. |
| RequestSubtype_Prompt | String | False |
The Workday ID of the request subtype. Multiple requestSubtype parameters can be specified for filtering. |
| RequestType_Prompt | String | False |
The Workday ID of the request type. Multiple requestType parameters can be specified for filtering. |
| ResolutionDetails_Prompt | String | False |
The Workday ID of the resolution details associated with the request. Multiple resolutionDetails parameters can be specified for filtering. |
| Resolution_Prompt | String | False |
The Workday ID of the resolution of the request. Multiple resolution parameters can be specified for filtering. |
| WorkdayObjectValue_Prompt | String | False |
The Workday ID of the business object related to the request, providing context about the object involved in the request. |
Contains answers submitted for questionnaire responses associated with specific requests.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
}]
[{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the instance, typically used as the primary key within the database. |
| Requests_Id [KEY] | String | False |
The Workday ID of the request that contains this specific questionnaire answer. |
| AnswerDate | Datetime | False |
The date when the answer was provided, formatted as a date. |
| AnswerMultipleChoiceOrder | String | False |
The order in which multiple choice answers are presented for a specific question in the questionnaire (used in the REST API). |
| AnswerMutlipleChoice_Descriptor | String | False |
A description of the multiple choice answer instance, providing context about the choice. |
| AnswerMutlipleChoice_Href | String | False |
A link to the detailed instance of the multiple choice answer. |
| AnswerMutlipleChoice_Id | String | False |
The unique Workday ID or reference ID for the multiple choice answer. |
| AnswerNumeric | Decimal | False |
The numeric answer provided for a question, typically used for quantitative responses. |
| AnswerText | String | False |
The textual response provided for a questionnaire item. |
| Branching | Bool | False |
Indicates whether the answer is for a branching question, which affects the flow of the questionnaire. |
| Descriptor | String | False |
A brief preview description of the instance, summarizing its content or purpose. |
| QuestionBody | String | False |
The body or main content of the question, formatted in rich text, explaining what is being asked. |
| QuestionItem_Descriptor | String | False |
A description of the specific question item, providing context or additional information about the question. |
| QuestionItem_Href | String | False |
A link to the specific question item instance for further details. |
| QuestionItem_Id | String | False |
The unique identifier for the question item, typically a Workday ID or reference ID. |
| QuestionOrder | String | False |
The order in which the question item appears in the questionnaire, used for structuring the questionnaire (available via the REST API). |
| QuestionnaireAttachments_Aggregate | String | False |
A list of all attachments related to the questionnaire response, aggregated into a single value. |
| CompletedOnOrAfter_Prompt | Date | False |
A prompt that allows filtering requests completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | False |
A prompt that allows filtering requests completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | False |
A prompt to filter requests initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | False |
A prompt to filter requests initiated on or before the specified date. |
| Initiator_Prompt | String | False |
The Workday ID for the individual who initiated the request. This can be retrieved by querying the /workers endpoint in the /common service. |
| OnBehalfOf_Prompt | String | False |
The Workday ID of the person on behalf of whom the request is being initiated. |
| RequestId_Prompt | String | False |
The ID of the request, typically following an ID generation format for unique identification. |
| RequestSubtype_Prompt | String | False |
The Workday ID of the request subtype. Multiple requestSubtype query parameters can be specified for more specific filtering. |
| RequestType_Prompt | String | False |
The Workday ID of the request type. Multiple requestType query parameters can be specified for filtering requests by type. |
| ResolutionDetails_Prompt | String | False |
The Workday ID of the resolution details for the request. Multiple resolutionDetails query parameters can be specified for filtering. |
| Resolution_Prompt | String | False |
The Workday ID of the resolution associated with the request. Multiple resolution query parameters can be specified for filtering. |
| WorkdayObjectValue_Prompt | String | False |
The Workday ID of the business object related to the request, providing context about the object associated with the request. |
Manages purchase requisitions, tracking details such as requested items, approvers, and statuses.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
commodityCode: { /* The code that identifies the type of goods or service. You can use this field to drill into the commodity code details such as description, level name, or associated spend categories. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
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. */
deliverToLocation: { /* The final location where the goods or services are delivered. Example: an employee's work station or stock room. This field can be configured as a hidden field using the Configure Optional Fields task for the REST API Requisition functional area. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
endDate: Date /* The end date requested for the service on the requisition line. */
id: Text /* Id of the instance */
item: { /* The item for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
itemDescription: Text /* The line item description for the requisition line. */
lineCompany: { /* The company for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
lotSerialInformation: { /* The lot serial information for the requisition line. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
lotNumber: Text /* The lot number for the lot and serial transaction. */
serialNumber: Text /* The lot serial number for the lot and serial transaction. */
}
memo: Text /* The line memo 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. */
orderFromConnection: { /* The order-from supplier connection to use when sourcing this requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
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. */
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. */
rfqRequired: Boolean /* If true, a request for quote is required for the requisition line. */
shipToAddress: { /* The address reference related to the ship-to address of the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
shipToContact: { /* The ship-to contact worker for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
spendCategory: { /* The spend category for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
startDate: Date /* The start date requested for the service on the requisition line. */
supplier: { /* The supplier for the requisition line. This is represented as a worktag object. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
supplierContract: { /* The supplier contract for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
supplierItemIdentifier: Text /* The alphanumeric identifier assigned by a supplier to an item. This can be different from the manufacturer identification number. */
unitCost: Currency /* The unit cost for the requisition line. */
unitOfMeasure: { /* The unit of measure for the requisition line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
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. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
writeInGoods: Boolean /* If true, the requisition line is a goods line with no purchase item, supplier item, or catalog item. */
writeInService: Boolean /* If true, the requisition line is a service line with no purchase item, supplier item, or catalog item. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the instance, typically used as a primary reference ID within the system. |
| AdditionalInformation | String | False |
Details about the requisition that explain why it is being created, such as special accommodations or requirements. |
| Amount_Currency | String | False |
The total amount for the requisition, displayed in the requisition's currency. This includes the sum of requisition lines, taxes, and freight charges. |
| Amount_Value | Decimal | False |
The total value for the requisition, calculated as the sum of all requisition lines, including additional charges like tax and freight, presented as a decimal. |
| Comments | String | False |
Comments regarding the cancellation or closure of a requisition, used for internal record-keeping. |
| Company_Descriptor | String | False |
A brief preview or description of the company associated with the requisition. |
| Company_Id | String | False |
The unique identifier for the company handling the requisition. |
| CriticalCustomValidations | String | False |
A list of critical validation errors that failed during the requisition process. These errors are aggregated at the header level and each message is separated by an HTML encoded line feed. |
| Currency_CurrencySymbol | String | False |
The three-letter ISO currency symbol (for example, USD, EUR) representing the currency used in the requisition. |
| Currency_Descriptor | String | False |
The full name of the currency used in the requisition (for example, US Dollar, Euro). |
| Currency_Id | String | False |
The unique identifier for the currency instance associated with the requisition. |
| DeliverToLocationChain | String | False |
The deliver-to location, including its hierarchy, used to specify where items for the requisition should be delivered. |
| DeliverToLocation_Descriptor | String | False |
A preview or description of the deliver-to location for the requisition. |
| DeliverToLocation_Id | String | False |
The unique identifier for the deliver-to location instance. |
| Descriptor | String | False |
A brief preview or summary description of the instance. |
| ExternalSourceableId | String | False |
The External Sourceable ID used to track the requisition in external systems. |
| ExternalSystemId_Descriptor | String | False |
A description of the external system ID, used for integrating requisition data with other systems. |
| ExternalSystemId_Href | String | False |
A link to the external system ID record for detailed information. |
| ExternalSystemId_Id | String | False |
The unique Workday ID or reference ID for the external system identifier. |
| FormattedAmount | String | False |
The total requisition amount, including the currency symbol. This value respects the user's locale settings for currency formatting. |
| FormattedFreight | String | False |
The freight charges for the requisition, formatted according to the user's locale settings (for example, positive/negative display, grouping, and decimal separators). |
| FormattedOtherCharges | String | False |
The other charges for the requisition, formatted based on the user's locale settings (for example, positive/negative display, grouping, and decimal separators). |
| FormattedShippingAddress | String | False |
The shipping address for the requisition, displayed as a single string where each line is separated by an HTML encoded line feed. |
| FormattedSubtotal | String | False |
The subtotal for the requisition line, formatted according to the user's locale preferences (for example, positive/negative display, grouping, and decimal separators). |
| FreightAmount_Currency | String | False |
The currency used for freight charges applicable to the taxable document in the requisition. |
| FreightAmount_Value | Decimal | False |
The value of the freight charges for the requisition, included in the taxable document calculation. |
| HighPriority | Bool | False |
Indicates whether the requisition is marked as 'High Priority' for expedited processing. |
| Href | String | False |
A link to the specific instance for detailed viewing or further interaction. |
| InternalMemo | String | False |
An internal memo for the requisition, visible only to internal workers and not shared with external parties. |
| InventorySite_Descriptor | String | False |
A description of the inventory site associated with the requisition. |
| InventorySite_Href | String | False |
A link to the inventory site instance for further details. |
| InventorySite_Id | String | False |
The unique identifier for the inventory site instance. |
| MedicalRecordNumber | String | False |
The medical record number associated with the requisition, typically used for healthcare-related requisitions. |
| Memo | String | False |
The memo or note related to the transaction, often used for documentation or reference purposes. |
| OtherCharges_Currency | String | False |
The currency used for other charges applicable to the taxable document in the requisition. |
| OtherCharges_Value | Decimal | False |
The value of other charges for the requisition, which are included in the taxable document calculation. |
| ParLocation_Descriptor | String | False |
A description of the par location associated with the requisition, typically referring to an inventory storage area. |
| ParLocation_Href | String | False |
A link to the par location instance for further details. |
| ParLocation_Id | String | False |
The unique identifier for the par location instance. |
| PatientId | String | False |
The patient ID associated with the requisition, typically used in healthcare requisitions to identify the patient involved. |
| PhysicianId | String | False |
The physician ID associated with the requisition, used to identify the physician involved in the requisition creation. |
| Procedure | String | False |
The medical or operational procedure that the requisition is created to accommodate, such as a surgery or treatment. |
| ProcedureDate | Datetime | False |
The date of the procedure that the requisition is created to accommodate. |
| ProcedureNumber | String | False |
The procedure number associated with the requisition, used to track specific procedures. |
| ReasonCode_Descriptor | String | False |
A description of the reason code used for categorizing the requisition. |
| ReasonCode_Href | String | False |
A link to the reason code instance for detailed information. |
| ReasonCode_Id | String | False |
The unique identifier for the reason code associated with the requisition. |
| Requester_Descriptor | String | False |
A preview or description of the individual who requested the requisition. |
| Requester_Id | String | False |
The unique identifier for the requester of the requisition. |
| Requester_Image_Descriptor | String | False |
A preview or description of the requester's image, typically used for identifying the requester visually. |
| Requester_Image_Href | String | False |
A link to the requester's image. |
| Requester_Image_Id | String | False |
The unique identifier for the requester's image. |
| Requester_Image_Url | String | False |
The relative URL for the requester's image in the UI Server. |
| RequestingEntity_Descriptor | String | False |
A description of the entity requesting the requisition, such as a department or organization. |
| RequestingEntity_Href | String | False |
A link to the requesting entity instance for more details. |
| RequestingEntity_Id | String | False |
The unique identifier for the requesting entity associated with the requisition. |
| RequisitionDate | Datetime | False |
The date when the requisition was created or when the items were requested. |
| RequisitionLines_Aggregate | String | False |
An aggregated list of requisition lines associated with the requisition. These lines may not be returned in a specific order. |
| RequisitionType_Descriptor | String | False |
A preview or description of the requisition type instance. |
| RequisitionType_Id | String | False |
The unique identifier for the requisition type instance. |
| RequisitionType_RequisitionTypeDetails_BillOnly | Bool | False |
Indicates whether the requisition is for billing purposes only, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_Consignment | Bool | False |
Indicates whether the requisition is related to consignment stock, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_HasService | Bool | False |
Indicates whether the requisition type includes a service component, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_Inactive | Bool | False |
Indicates whether the requisition type is marked as inactive, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_InventoryReplenishment | Bool | False |
Indicates whether the requisition type involves inventory replenishment, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_JustInTime | Bool | False |
Indicates whether the requisition type is for just-in-time inventory, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_ParReplenishment | Bool | False |
Indicates whether the requisition type is for par replenishment, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_ProcedureInformation | Bool | False |
Indicates whether the requisition type includes procedure information, based on the Maintain Requisition Types task. |
| RequisitionType_RequisitionTypeDetails_SupplierContractRequest | Bool | False |
Indicates whether the requisition type is for a supplier contract request, based on the Maintain Requisition Types task. |
| ShippingAddress_Descriptor | String | False |
A description of the shipping address associated with the requisition. |
| ShippingAddress_Href | String | False |
A link to the shipping address instance for detailed information. |
| ShippingAddress_Id | String | False |
The unique identifier for the shipping address instance. |
| SourcingBuyer_Descriptor | String | False |
A description of the sourcing buyer associated with the requisition. |
| SourcingBuyer_Href | String | False |
A link to the sourcing buyer instance for further details. |
| SourcingBuyer_Id | String | False |
The unique identifier for the sourcing buyer instance. |
| Status_Descriptor | String | False |
A description of the current status of the requisition, indicating whether it's open, approved, or canceled. |
| Status_Href | String | False |
A link to the status record for the requisition. |
| Status_Id | String | False |
The unique identifier for the requisition status instance. |
| Submitter_Descriptor | String | False |
A description of the person who submitted the requisition. |
| Submitter_Href | String | False |
A link to the submitter's instance for more details. |
| Submitter_Id | String | False |
The unique identifier for the submitter of the requisition. |
| SupplierRepresentative | String | False |
The supplier representative associated with the requisition, who handles communication and transactions related to the requisition. |
| SupplierSalesOrderNumber | String | False |
The supplier's sales order number associated with the requisition, used for tracking and reference. |
| VerifiedBy | String | False |
The individual who verified the procedure related to the requisition. |
| WarningCustomValidations | String | False |
A list of warning validation messages that failed during the requisition process, represented as a string. These warnings may be aggregates at the line level. |
| ExternalSourceableId_Prompt | String | False |
A prompt to filter requisitions by their external sourceable ID. |
| ExternalSystemId_Prompt | String | False |
A prompt to filter requisitions by their external system ID. |
| FromDate_Prompt | Date | False |
Filters requisitions based on the document date, selecting those on or after the specified date (use yyyy-mm-dd format). |
| Requester_Prompt | String | False |
Filters requisitions by the requester. Specify the Workday ID of the worker who requested the requisition. |
| RequisitionType_Prompt | String | False |
Filters requisitions by their type. Specify the Workday ID of the requisition type. Multiple requisitionType query parameters can be used. |
| SubmittedByPerson_Prompt | String | False |
Filters requisitions by the person who submitted them. Specify the Workday ID or reference ID of the person. |
| SubmittedBySupplier_Prompt | String | False |
Filters requisitions by the supplier who submitted them. Specify the Workday ID or reference ID of the supplier. |
| SubmittedBy_Prompt | String | False |
Filters requisitions by the worker who submitted them. Specify the Workday ID or reference ID of the worker. |
| ToDate_Prompt | Date | False |
Filters requisitions based on the document date, selecting those on or before the specified date (use yyyy-mm-dd format). |
Stores metadata and file content for attachments linked to requisitions.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique identifier for the instance, typically used as the primary reference ID within the system. |
| Requisitions_Id [KEY] | String | False |
The Workday ID of the requisition that owns or is associated with this attachment. |
| AttachmentCategory_Descriptor | String | False |
A brief preview or description of the category of the attachment, providing context about its type or usage. |
| AttachmentCategory_Id | String | False |
The unique identifier for the attachment category, used to classify the type of attachment. |
| Comment | String | False |
A comment or note regarding the attachment, providing additional information or context about the attached file. |
| ContentType_Descriptor | String | False |
A description of the content type of the attachment, outlining the nature or format of the file. |
| ContentType_Href | String | False |
A link to the content type instance for further details or reference. |
| ContentType_Id | String | False |
The unique Workday ID or reference ID for the content type associated with the attachment. |
| Descriptor | String | False |
A brief preview or summary description of the attachment instance. |
| External | Bool | False |
Indicates whether the attachment can be viewed by an external supplier once the associated purchase order is issued (true) or not (false). |
| FileLength | Decimal | False |
The size of the attachment file, typically measured in bytes. |
| FileName | String | False |
The name of the file associated with the attachment. |
| Href | String | False |
A link to the specific attachment instance for viewing or further interaction. |
| ExternalSourceableId_Prompt | String | False |
A prompt to filter attachments by their external sourceable ID, which links the attachment to external systems. |
| ExternalSystemId_Prompt | String | False |
A prompt to filter attachments by their external system ID, used for integration with other systems. |
| FromDate_Prompt | Date | False |
Filters requisitions by their document date, selecting those created on or after the specified date (use yyyy-mm-dd format). |
| Requester_Prompt | String | False |
Filters requisitions by the requester. Specify the Workday ID of the worker who initiated the requisition. |
| RequisitionType_Prompt | String | False |
Filters requisitions by their type. Specify the Workday ID of the requisition type. Multiple requisitionType parameters can be used for more specific filtering. |
| SubmittedByPerson_Prompt | String | False |
Filters requisitions by the person who submitted them. Specify the Workday ID or reference ID of the person. |
| SubmittedBySupplier_Prompt | String | False |
Filters requisitions by the supplier who submitted them. Specify the Workday ID or reference ID of the supplier. |
| SubmittedBy_Prompt | String | False |
Filters requisitions by the worker who submitted them. Specify the Workday ID or reference ID of the worker. |
| ToDate_Prompt | Date | False |
Filters requisitions by their document date, selecting those created on or before the specified date (use yyyy-mm-dd format). |
Manages line items within requisitions, including requested quantities and pricing.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the requisition line. |
| Requisitions_Id [KEY] | String | False |
The Workday ID of the requisition to which this line belongs. |
| CatalogItem | Bool | False |
Indicates whether this requisition line is for a catalog item. |
| CommodityCode_Descriptor | String | False |
Description of the commodity code associated with this requisition line. |
| CommodityCode_Href | String | False |
A link to the commodity code instance. |
| CommodityCode_Id | String | False |
The Workday ID or reference ID for the commodity code. |
| CreatedMoment | Datetime | False |
Timestamp indicating when the requisition line was created. |
| CriticalCustomValidations | String | False |
List of critical validation messages that failed, formatted as a single string with HTML line feed delimiters. |
| DeliverToLocation_Descriptor | String | False |
Description of the deliver-to location for this requisition line. |
| DeliverToLocation_Id | String | False |
The Workday ID of the deliver-to location. |
| Descriptor | String | False |
A brief description of the requisition line. |
| EndDate | Datetime | False |
The requested end date for service-based requisition lines. This can be configured as hidden in Workday. |
| ExtendedAmount_Currency | String | False |
Currency of the extended amount for this requisition line. |
| ExtendedAmount_Value | Decimal | False |
Total extended amount for the requisition line, excluding tax-only invoices. |
| FormattedExtendedAmount | String | False |
Formatted total amount including currency symbol, adjusted for user locale settings. |
| FormattedShippingAddress | String | False |
Full shipping address for this requisition line, formatted as a single string with HTML line feed delimiters. |
| FormattedUnitCost | String | False |
Formatted unit cost including currency symbol, adjusted based on user locale settings. |
| Href | String | False |
A link to the requisition line instance in Workday. |
| ItemDescription | String | False |
Detailed description of the item in this requisition line. |
| ItemImage_Descriptor | String | False |
Description of the associated item image. |
| ItemImage_Href | String | False |
A link to the associated item image instance. |
| ItemImage_Id | String | False |
The Workday ID of the associated item image. |
| ItemImage_InternalURL | String | False |
Internal Workday UI Server URL for the item image. |
| ItemRanking | Decimal | False |
Ranking assigned to the item in this requisition line. |
| ItemURL | String | False |
Workday Instance View URL for the procurement item linked to this requisition line. |
| Item_Descriptor | String | False |
A description of the procurement item for this requisition line. |
| Item_Href | String | False |
A link to the procurement item instance. |
| Item_Id | String | False |
The Workday ID or reference ID of the procurement item. |
| LineCompany_Descriptor | String | False |
Description of the company associated with this requisition line. |
| LineCompany_Id | String | False |
The Workday ID of the associated company. |
| LineDeliverToLocationChain | String | False |
Full hierarchy of deliver-to locations for this requisition line. |
| LotSerialInformation_Descriptor | String | False |
A preview of the lot/serial information for this requisition line. |
| LotSerialInformation_Id | String | False |
The Workday ID of the lot/serial information. |
| LotSerialInformation_LotNumber | String | False |
The lot number for the lot and serial transaction. |
| LotSerialInformation_SerialNumber | String | False |
The lot serial number for the lot and serial transaction. |
| Memo | String | False |
Memo field for additional details. Can be hidden using Workday configuration. |
| NoCharge | Bool | False |
Indicates if this is a no-charge requisition line. |
| OrderFromConnection_Descriptor | String | False |
Description of the ordering connection associated with this line. |
| OrderFromConnection_Id | String | False |
The Workday ID of the ordering connection. |
| Quantity | Decimal | False |
Quantity requested in this requisition line. Supports up to 20 integer places and 2 decimal precision. |
| RequestedDeliveryDate | Datetime | False |
The requested delivery date for the item in this requisition line. |
| RfqRequired | Bool | False |
Indicates if a Request for Quote (RFQ) is required. |
| SearchTerm | String | False |
Search term used in Workday's catalog for this item. |
| ServiceRequisitionLine | Bool | False |
Indicates whether this requisition line is for a service. |
| ShipToAddressReference_Descriptor | String | False |
Description of the ship-to address reference. |
| ShipToAddressReference_Href | String | False |
A link to the ship-to address reference instance. |
| ShipToAddressReference_Id | String | False |
The Workday ID of the ship-to address reference. |
| ShipToAddress_Descriptor | String | False |
Description of the ship-to address for this requisition line. |
| ShipToAddress_Href | String | False |
A link to the ship-to address instance. |
| ShipToAddress_Id | String | False |
The Workday ID of the ship-to address. |
| ShipToContact_Descriptor | String | False |
Description of the ship-to contact. |
| ShipToContact_Href | String | False |
A link to the ship-to contact instance. |
| ShipToContact_Id | String | False |
The Workday ID of the ship-to contact. |
| SpendCategory_Descriptor | String | False |
Description of the spend category. |
| SpendCategory_Href | String | False |
A link to the spend category instance. |
| SpendCategory_Id | String | False |
The Workday ID of the spend category. |
| StartDate | Datetime | False |
Requested start date for service requisition lines. |
| SupplierContract_Descriptor | String | False |
Description of the supplier contract associated with this requisition line. |
| SupplierContract_Href | String | False |
A link to the supplier contract instance. |
| SupplierContract_Id | String | False |
The Workday ID of the supplier contract. |
| SupplierItemIdentifier | String | False |
Supplier-assigned identifier for the item in this requisition line. |
| Supplier_Descriptor | String | False |
Description of the supplier for this requisition line. |
| Supplier_Href | String | False |
A link to the supplier instance. |
| Supplier_Id | String | False |
The Workday ID of the supplier. |
| UnitCost_Currency | String | False |
Currency of the unit cost for this requisition line. |
| UnitCost_Value | Decimal | False |
Unit cost for this requisition line. |
| UnitOfMeasure_Descriptor | String | False |
Description of the unit of measure used in this requisition line. |
| UnitOfMeasure_Href | String | False |
A link to the unit of measure instance. |
| UnitOfMeasure_Id | String | False |
The Workday ID of the unit of measure. |
| WarningCustomValidations | String | False |
List of warning messages for custom validations that failed, formatted as a single string with HTML line feed delimiters. |
| WebItem | Bool | False |
Indicates whether this requisition line is for a web item. |
| WebItemImageURL | String | False |
URL of the supplier’s web image for this item. |
| Worktags_Aggregate | String | False |
All worktags assigned to this requisition line. |
| WriteInGoods | Bool | False |
Indicates if this requisition line is a write-in goods line without a predefined purchase item or supplier item. |
| WriteInService | Bool | False |
Indicates if this requisition line is a write-in service line without a predefined purchase item or supplier item. |
| ExternalSourceableId_Prompt | String | False |
External system reference ID for this requisition line. |
| ExternalSystemId_Prompt | String | False |
External system ID associated with this requisition line. |
| FromDate_Prompt | Date | False |
Filters requisitions with a document date on or after the specified date (yyyy-mm-dd format). |
| Requester_Prompt | String | False |
Filters requisitions by requester, using the Workday ID of the worker who created the requisition. |
| RequisitionType_Prompt | String | False |
Filters requisitions by type, specifying the Workday ID of the requisition type (supports multiple values). |
| SubmittedByPerson_Prompt | String | False |
Filters requisitions by the person who submitted them, using their Workday ID or reference ID. |
| SubmittedBySupplier_Prompt | String | False |
Filters requisitions by the supplier who submitted them, using their Workday ID or reference ID (supports multiple values). |
| SubmittedBy_Prompt | String | False |
Filters requisitions by the worker who submitted them, using their Workday ID or reference ID. |
| ToDate_Prompt | Date | False |
Filters requisitions with a document date on or before the specified date (yyyy-mm-dd format). |
Stores worktag values associated with requisition line items.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the requisition line instance. |
| RequisitionsRequisitionLines_Id [KEY] | String | False |
The Workday ID of the requisition line that contains this entry. |
| Requisitions_Id [KEY] | String | False |
The Workday ID of the requisition associated with this requisition line. |
| Descriptor | String | False |
A preview description of the requisition line. |
| Href | String | False |
A direct link to the requisition line instance in Workday. |
| WorktagType_Descriptor | String | False |
A description of the worktag type associated with this requisition line. |
| WorktagType_Href | String | False |
A link to the associated worktag type instance. |
| WorktagType_Id | String | False |
The Workday ID or reference ID of the associated worktag type. |
| ExternalSourceableId_Prompt | String | False |
External system reference ID for requisition lines available for sourcing. |
| ExternalSystemId_Prompt | String | False |
External system reference ID linked to this requisition line. |
| FromDate_Prompt | Date | False |
Filters requisition lines with a document date on or after the specified date (yyyy-mm-dd format). |
| Requester_Prompt | String | False |
Filters requisitions by the requester's Workday ID. |
| RequisitionType_Prompt | String | False |
Filters requisitions by type using the Workday ID of the requisition type (supports multiple values). |
| SubmittedByPerson_Prompt | String | False |
Filters requisitions by the person who submitted them, using their Workday or reference ID. |
| SubmittedBySupplier_Prompt | String | False |
Filters requisitions by the supplier who submitted them, using their Workday or reference ID (supports multiple values). |
| SubmittedBy_Prompt | String | False |
Filters requisitions by the worker who submitted them, using their Workday or reference ID. |
| ToDate_Prompt | Date | False |
Filters requisition lines with a document date on or before the specified date (yyyy-mm-dd format). |
Links worktags to requisitions at a header level for tracking and cost allocation.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the requisition instance. |
| Requisitions_Id [KEY] | String | False |
The Workday ID of the requisition containing this entry. |
| Descriptor | String | False |
A preview description of the requisition. |
| Href | String | False |
A direct link to the requisition instance in Workday. |
| WorktagType_Descriptor | String | False |
A description of the associated worktag type. |
| WorktagType_Href | String | False |
A link to the associated worktag type instance. |
| WorktagType_Id | String | False |
The Workday ID or reference ID of the associated worktag type. |
| ExternalSourceableId_Prompt | String | False |
External system reference ID for requisitions available for sourcing. |
| ExternalSystemId_Prompt | String | False |
External system reference ID associated with the requisition. |
| FromDate_Prompt | Date | False |
Filters requisitions with a document date on or after the specified date (yyyy-mm-dd format). |
| Requester_Prompt | String | False |
Filters requisitions based on the requester’s Workday ID. |
| RequisitionType_Prompt | String | False |
Filters requisitions by type using the Workday ID of the requisition type (multiple values allowed). |
| SubmittedByPerson_Prompt | String | False |
Filters requisitions by the person who submitted them, using their Workday or reference ID. |
| SubmittedBySupplier_Prompt | String | False |
Filters requisitions by the supplier who submitted them, using their Workday or reference ID (multiple values allowed). |
| SubmittedBy_Prompt | String | False |
Filters requisitions by the worker who submitted them, using their Workday or reference ID. |
| ToDate_Prompt | Date | False |
Filters requisitions with a document date on or before the specified date (yyyy-mm-dd format). |
Manages specific allocations within resource forecast lines.
| 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 |
The date for the forecasted hours. |
| Descriptor | String | False |
A preview of the instance |
| ForecastedHours | Decimal | False |
The number of hours forecasted for the worker on the specified date. |
| ProjectResource_Prompt | String | False |
The Workday ID of the project resource used to filter forecast data for a specific resource. |
| ProjectRole_Prompt | String | False |
The Workday ID of the project role used to filter forecast data by a specific role. |
| Project_Prompt | String | False |
The Workday ID of the project used to filter forecast data for a specific project. |
Stores individual resource planning line items, detailing resource allocation.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
awaitingPersons: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
businessEventValidation: [{
conditionRule: Text /* The condition rule as a text expression. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
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. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
comments: [{
comment: Text /* Comment */
conmentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
completedByPerson: { /* The person that completed the step as Assignee */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
completedOn: Date /* The date when this step was completed */
creationDate: Date /* The date when the event record was created. */
delayedDate: Date /* The date the delayed step will trigger. */
descriptor: Text /* A preview of the instance */
due: Date /* Returns the due date for this step. */
event: { /* The business process associated with the project you're editing. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
status: { /* The status of this business process step. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
category: { /* The requirement category for the \~project role\~. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
optional: Boolean /* The optional status of a requirement. */
values: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique Workday ID for this instance. |
| BookingStatus_Descriptor | String | False |
A description of the booking status for the resource plan line. |
| BookingStatus_Href | String | False |
A link to the instance representing the booking status. |
| BookingStatus_Id | String | False |
The Workday ID for the booking status. |
| BusinessEventRecords_Aggregate | String | False |
Contains the Project Resource Plan Line Event business process records triggered when a resource plan line is created or modified. |
| CostRateCurrencyOverride_Descriptor | String | False |
A description of the currency override for cost rate. |
| CostRateCurrencyOverride_Href | String | False |
A link to the instance representing the currency override for cost rate. |
| CostRateCurrencyOverride_Id | String | False |
The Workday ID for the cost rate currency override. |
| CostRateOverride_Currency | String | False |
The currency associated with the cost rate override. |
| CostRateOverride_Value | Decimal | False |
The hourly cost rate assigned to a worker for project time costing. |
| Descriptor | String | False |
A general preview or description of the resource plan line instance. |
| EndDate | Datetime | False |
The planned end date for the resource plan line. |
| EstimatedHours | Decimal | False |
The total estimated work hours allocated for the project role in this resource plan line. |
| ExcludedWorkers_Aggregate | String | False |
Lists workers from the selected worker group who are excluded from assignment to this resource plan line. |
| JobRequisition_Descriptor | String | False |
A description of the job requisition associated with this resource plan. |
| JobRequisition_Href | String | False |
A link to the job requisition instance. |
| JobRequisition_Id | String | False |
The Workday ID for the job requisition. |
| Memo | String | False |
Additional comments or details related to this resource plan line. |
| PercentAllocation | Decimal | False |
The percentage of the worker's time allocated to this project role. |
| Project_Id | String | False |
The Workday ID for the project associated with this resource plan line. |
| Requirements_Aggregate | String | False |
Lists the specific role requirements categorized for this project. |
| ResourceType_Descriptor | String | False |
A description of the type of resource being assigned. |
| ResourceType_Href | String | False |
A link to the instance representing the resource type. |
| ResourceType_Id | String | False |
The Workday ID for the resource type. |
| RoleCategory_Descriptor | String | False |
A description of the category of the assigned role. |
| RoleCategory_Href | String | False |
A link to the role category instance. |
| RoleCategory_Id | String | False |
The Workday ID for the role category. |
| Role_Descriptor | String | False |
A description of the role being assigned in the resource plan. |
| Role_Href | String | False |
A link to the instance representing the role. |
| Role_Id | String | False |
The Workday ID for the assigned role. |
| StartDate | Datetime | False |
The planned start date for the resource plan line. |
| ToBeHired | Bool | False |
Indicates if a worker is yet to be hired for this resource plan line (true/false). |
| UnnamedResources | Decimal | False |
The number of unnamed resources (placeholders) allocated in the plan. |
| WorkerGroup_Descriptor | String | False |
A description of the worker group associated with this plan. |
| WorkerGroup_Href | String | False |
A link to the instance representing the worker group. |
| WorkerGroup_Id | String | False |
The Workday ID for the worker group. |
| Workers_Aggregate | String | False |
A list of assigned workers in this resource plan line. |
| ProjectResourcePlan_Prompt | String | False |
Reference input for retrieving the relevant project resource plan. |
| Project_Prompt | String | False |
Reference input for retrieving the relevant project. |
Tracks workers who are excluded from specific resource plans.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique Workday ID for this instance. |
| ResourcePlanLines_Id [KEY] | String | False |
The Workday ID of the Resource Plan Lines that contain this instance. |
| Descriptor | String | False |
A general preview or description of the resource plan instance. |
| ProjectResourcePlan_Prompt | String | False |
Reference input for retrieving the associated project resource plan. |
| Project_Prompt | String | False |
Reference input for retrieving the associated project. |
Defines specific resource requirements within a resource plan.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
Unique identifier for this instance, used as a primary key. |
| ResourcePlanLines_Id [KEY] | String | False |
Workday-generated unique ID linking this record to a specific Resource Plan Line. |
| Category_Descriptor | String | False |
Human-readable description of the category for easier identification. |
| Category_Href | String | False |
URL or reference link pointing to the category instance in Workday. |
| Category_Id | String | False |
Unique identifier used to track the category. |
| Descriptor | String | False |
A brief summary of the instance for quick identification. |
| Optional | Bool | False |
Indicates whether the requirement is optional (true) or mandatory (false). |
| Values_Aggregate | String | False |
Aggregated requirement values associated with this category. |
| ProjectResourcePlan_Prompt | String | False |
Reference prompt for selecting a Project Resource Plan within Workday. |
| Project_Prompt | String | False |
Reference prompt for selecting a Project within Workday. |
Stores and retrieves scorecard evaluations used for performance tracking.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| DefaultScorecardGoalsResult_Descriptor | String | False |
A human-readable summary of the default scorecard goals result. |
| DefaultScorecardGoalsResult_EligibiltyRule_Descriptor | String | False |
A description of the eligibility rule applied to the default scorecard goals result. |
| DefaultScorecardGoalsResult_EligibiltyRule_Href | String | False |
A URL or reference link to the eligibility rule instance. |
| DefaultScorecardGoalsResult_EligibiltyRule_Id | String | False |
Unique identifier of the eligibility rule associated with the default scorecard goals result. |
| DefaultScorecardGoalsResult_Id | String | False |
Unique identifier for the default scorecard goals result instance. |
| DefaultScorecardGoalsResult_WeightedFundingPercent | Decimal | False |
Total weighted funding percentage calculated for all scores in the scorecard result set. |
| Descriptor | String | False |
A brief summary of this instance for easy identification. |
| EvaluationDate | Datetime | False |
The date when the scorecard result was evaluated. |
| ScorecardDescription | String | False |
A detailed description of the scorecard. |
| ScorecardID_Id | String | False |
Unique identifier for the scorecard instance. |
| ScorecardName | String | False |
The name of the goal associated with the scorecard criteria result. |
Retrieves performance scores from default scorecard goal evaluations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| ScorecardResults_Id [KEY] | String | False |
Workday-generated unique ID linking this record to a specific Scorecard Results instance. |
| Achievement | Decimal | False |
The percentage of achievement for the scorecard criteria result, representing progress toward the goal. |
| GoalID_Id | String | False |
Unique identifier for the goal instance within the scorecard. |
| GoalName | String | False |
The name of the goal associated with the scorecard criteria result. |
| GoalWeight | Decimal | False |
The weighted percentage assigned to this goal within the scorecard criteria result, determining its impact on the overall score. |
Retrieves profile-based scorecard goal results for performance analysis.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
achievement: Numeric /* The achievement percentage for the scorecard criteria result. */
goalID: { /* The criteria for the scorecard criteria result. */
id: Text /* Id of the instance */
}
goalName: Text /* The \~goal\~ name of the scorecard criteria result. */
goalWeight: Numeric /* The criteria weighted percentage of the scorecard criteria result. */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| ScorecardResults_Id [KEY] | String | False |
Workday-generated unique ID linking this record to a specific Scorecard Results instance. |
| Descriptor | String | False |
A brief, human-readable summary of this instance. |
| EligibiltyRule_Descriptor | String | False |
Description of the eligibility rule applied to the scorecard result. |
| EligibiltyRule_Href | String | False |
URL or reference link to the eligibility rule instance. |
| EligibiltyRule_Id | String | False |
Unique identifier of the eligibility rule associated with this instance. |
| PerformanceScores_Aggregate | String | False |
A collection of performance scores used in a compensation scorecard. |
| WeightedFundingPercent | Decimal | False |
Total weighted funding percentage calculated across all scores in the scorecard result set. |
Manages compensation scorecard data for performance-based evaluations.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
*goalName: Text /* The name of the Compensation Scorecard Goal. */
*goalWeight: Numeric /* The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9] */
id: Text /* Id of the instance */
}]
[{
*eligibilityRule: { /* The name of the Compensation Eligibility Rule assigned to the Compensation Scorecard Profile. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
*profileScorecardGoals: [{
goalDescription: Text /* The description of the Compensation Scorecard Goal */
*goalName: Text /* The name of the Compensation Scorecard Goal. */
*goalWeight: Numeric /* The weight given to the Compensation Scorecard Goal. [90% will be displayed as 0.9] */
id: Text /* Id of the instance */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| DefaultScorecardGoals_Aggregate | String | False |
A collection of goals associated with the Compensation Scorecard. |
| EffectiveDate | Datetime | False |
The date the Compensation Scorecard becomes effective, formatted as YYYY-MM-DD. |
| Inactive | Bool | False |
Indicates whether the scorecard is inactive (true) or active (false). |
| ScorecardDescription | String | False |
A detailed description of the Compensation Scorecard. |
| ScorecardName | String | False |
The name assigned to the Compensation Scorecard. |
| ScorecardProfiles_Aggregate | String | False |
A collection of profiles associated with the Compensation Scorecard. |
| EffectiveDate_Prompt | Date | False |
Reference prompt indicating the effective date of the scorecard task. |
Stores default scorecard goals for use in performance assessments.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| Scorecards_Id [KEY] | String | False |
Workday-generated unique ID linking this record to a specific Compensation Scorecard. |
| GoalDescription | String | False |
A detailed description of the Compensation Scorecard Goal. |
| GoalName | String | False |
The name assigned to the Compensation Scorecard Goal. |
| GoalWeight | Decimal | False |
The weight assigned to the Compensation Scorecard Goal, represented as a decimal (for example, 90% is displayed as 0.9). |
| EffectiveDate_Prompt | Date | False |
Reference prompt indicating the effective date of the scorecard task. |
Links scorecards to profiles for tracking and managing performance results.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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\~. */
goalName: Text /* The name of the Compensation Scorecard \~Goal\~. */
goalWeight: Numeric /* The weight given to the Compensation Scorecard \~Goal\~. [90% will be displayed as 0.9] */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| Scorecards_Id [KEY] | String | False |
Workday-generated unique ID linking this record to a specific Compensation Scorecard. |
| EligibilityRule_Descriptor | String | False |
A human-readable description of the eligibility rule applied to the scorecard. |
| EligibilityRule_Href | String | False |
A URL or reference link to the eligibility rule instance. |
| EligibilityRule_Id | String | False |
Unique identifier of the eligibility rule associated with this instance. |
| ProfileScorecardGoals_Aggregate | String | False |
A collection of goals associated with the Compensation Scorecard. |
| EffectiveDate_Prompt | Date | False |
Reference prompt indicating the effective date of the scorecard task. |
Stores student payment transactions and billing information.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this instance. |
| Students_Id [KEY] | String | False |
Workday-generated unique ID linking this record to the associated student. |
| AcademicPeriod_Descriptor | String | False |
A brief, human-readable summary of the academic period. |
| AcademicPeriod_Id | String | False |
Unique identifier for the academic period instance. |
| Amount_Currency | String | False |
The amount of the customer payment in transaction currency. |
| Amount_Value | Decimal | False |
The monetary value of the customer payment in transaction currency. |
| Descriptor | String | False |
A brief, human-readable summary of the instance. |
| InstitutionalAcademicUnit_Descriptor | String | False |
A brief, human-readable description of the institutional academic unit. |
| InstitutionalAcademicUnit_Id | String | False |
Unique identifier for the institutional academic unit. |
| PaymentDate | Datetime | False |
The transaction date for the reporting transaction. If filtering for expense reports, use the Expense Report Date report field instead. |
| PaymentItem_Descriptor | String | False |
A brief, human-readable summary of the payment item. |
| PaymentItem_Id | String | False |
Unique identifier for the payment item instance. |
| PaymentType_Descriptor | String | False |
A brief, human-readable description of the payment type. |
| PaymentType_Id | String | False |
Unique identifier for the payment type instance. |
| Reason_Descriptor | String | False |
A brief, human-readable summary of the reason for the payment. |
| Reason_Id | String | False |
Unique identifier for the payment reason instance. |
| Reference | String | False |
Reference to a customer payment processed through a settlement run. Blank if the Payment Status is 'In Progress' or the Payment Type is 'Check' or 'ETF.' |
| StudentFinanceTransactionDate | Datetime | False |
The start and end date of the date range filtering payments by the student payment transaction date (format: yyyy-mm-dd). |
| AcademicPeriod_Prompt | String | False |
The academic period associated with this object. If the object is tied to both a starting and ending period, it returns the starting academic period. |
| FromDate_Prompt | Date | False |
Limit student payments to those made on or after this date (format: yyyy-mm-dd). |
| InstitutionalAcademicUnit_Prompt | String | False |
The academic unit, an organizational classification for academic appointments. |
| PaymentItem_Prompt | String | False |
The student payment item associated with the student payment. |
| PaymentReference_Prompt | String | False |
The check number or EFT number associated with the student payment. |
| PaymentType_Prompt | String | False |
The payment type for the reporting transaction. |
| ToDate_Prompt | Date | False |
Limit student payments to those made on or before this date (format: yyyy-mm-dd). |
| AcademicLevel_Prompt | String | False |
Reference prompt for selecting the academic level associated with the student. |
| AcademicUnit_Prompt | String | False |
Reference prompt for selecting the academic unit associated with the student. |
| ActiveOnly_Prompt | Bool | False |
If true, only returns active students. |
| ProgramOfStudy_Prompt | String | False |
For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | False |
A search string for fuzzy matching student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
Stores supplier invoice requests, including approval and payment details.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
billable: Boolean /* True if the supplier invoice request line or line split are billable. */
descriptor: Text /* A preview of the instance */
extendedAmount: Currency /* The extended amount for the document line. Excludes extended amount on tax only invoices. */
id: Text /* Id of the instance */
internalMemo: Text /* The internal line memo for the supplier invoice request line. */
item: { /* The item for the document line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
itemDescription: Text /* The description of the item on the document line. This is a text-only value. */
memo: Text /* The memo on the document line. */
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. */
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. */
serviceLine: Boolean /* The line type for supplier invoice request line. */
spendCategory: { /* Retrieves the spend category defined on the line for the Business Document Line Distribution. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
splitBy: { /* The distribution method for supplier invoice request line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
splits: [{
amount: Currency /* The amount on the transaction line split. This value displays in the same currency as the business document. */
billable: Boolean /* True if the supplier invoice request line or line split are billable. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
memo: Text /* The memo for a line split */
percent: Numeric /* The percentage specified for the Business Document Line distribution line split. */
quantity: Numeric /* The quantity specified for the Business Document Line distribution line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
unitCost: Currency /* The unit cost for the document line. */
unitOfMeasure: { /* The unit of measure for the document line. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
worktags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this supplier invoice request instance. |
| Company_Descriptor | String | False |
A human-readable description of the company associated with the supplier invoice request. |
| Company_Href | String | False |
A URL or reference link to the company instance. |
| Company_Id | String | False |
Unique identifier associated with the company. |
| ControlTotalAmount_Currency | String | False |
The currency of the total control amount, which should match the sum of the line amounts. |
| ControlTotalAmount_Value | Decimal | False |
The total control amount that should match the sum of the line amounts. |
| Currency_CurrencyID | String | False |
The reference ID for currency lookups within Workday Web Services. For supervisory organizations, this is also the 'Organization ID.' |
| Currency_Descriptor | String | False |
A human-readable description of the currency used in the supplier invoice request. |
| Currency_Id | String | False |
Unique identifier associated with the currency. |
| Descriptor | String | False |
A brief, human-readable summary of the instance. |
| DueDate | Datetime | False |
The due date for payment of the supplier invoice request. Example: If payment terms are Net 30, the due date is 30 days after the invoice date. |
| FreightAmount_Currency | String | False |
The currency of the freight amount for the supplier invoice request. |
| FreightAmount_Value | Decimal | False |
The freight amount for the supplier invoice request. |
| HandlingCode_Descriptor | String | False |
A human-readable description of the handling code. |
| HandlingCode_Href | String | False |
A URL or reference link to the handling code instance. |
| HandlingCode_Id | String | False |
Unique identifier associated with the handling code. |
| InvoiceDate | Datetime | False |
The date when the supplier invoice request was created. |
| InvoiceReceivedDate | Datetime | False |
The date when the supplier invoice was received. |
| Lines_Aggregate | String | False |
A list of supplier invoice request lines associated with the supplier invoice request. |
| Memo | String | False |
The memo or additional notes for the supplier invoice request. |
| PaymentTerms_Descriptor | String | False |
A human-readable description of the payment terms. |
| PaymentTerms_Href | String | False |
A URL or reference link to the payment terms instance. |
| PaymentTerms_Id | String | False |
Unique identifier associated with the payment terms. |
| ReferenceNumber | String | False |
The reference number containing key payment details for the invoice request document. |
| ReferenceType_Descriptor | String | False |
A human-readable description of the reference type. |
| ReferenceType_Href | String | False |
A URL or reference link to the reference type instance. |
| ReferenceType_Id | String | False |
Unique identifier associated with the reference type. |
| RemitToConnection_Descriptor | String | False |
A human-readable description of the remit-to connection. |
| RemitToConnection_Href | String | False |
A URL or reference link to the remit-to connection instance. |
| RemitToConnection_Id | String | False |
Unique identifier associated with the remit-to connection. |
| RequestNumber | String | False |
The unique number assigned to the supplier invoice request at the time of creation. |
| Requester_Descriptor | String | False |
A human-readable description of the requester. |
| Requester_Href | String | False |
A URL or reference link to the requester instance. |
| Requester_Id | String | False |
Unique identifier associated with the requester. |
| ShipToAddress_Descriptor | String | False |
A human-readable description of the shipping address. |
| ShipToAddress_Href | String | False |
A URL or reference link to the shipping address instance. |
| ShipToAddress_Id | String | False |
Unique identifier associated with the shipping address. |
| Status_Descriptor | String | False |
A human-readable description of the supplier invoice request status. |
| Status_Href | String | False |
A URL or reference link to the status instance. |
| Status_Id | String | False |
Unique identifier associated with the supplier invoice request status. |
| StatutoryInvoiceType_Descriptor | String | False |
A human-readable description of the statutory invoice type. |
| StatutoryInvoiceType_Href | String | False |
A URL or reference link to the statutory invoice type instance. |
| StatutoryInvoiceType_Id | String | False |
Unique identifier associated with the statutory invoice type. |
| Supplier_Descriptor | String | False |
A human-readable description of the supplier. |
| Supplier_Href | String | False |
A URL or reference link to the supplier instance. |
| Supplier_Id | String | False |
Unique identifier associated with the supplier. |
| SuppliersInvoiceNumber | String | False |
The reference number provided by the supplier for the supplier invoice request. |
| TaxAmount_Currency | String | False |
The currency of the tax amount for the supplier invoice request. |
| TaxAmount_Value | Decimal | False |
The tax amount for the supplier invoice request. |
| Company_Prompt | String | False |
Filter supplier invoice requests by company. Used for internal REST API purposes. |
| FromDueDate_Prompt | Date | False |
Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). |
| FromInvoiceDate_Prompt | Date | False |
Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | False |
Filter supplier invoice requests by requester using the Workday ID. |
| Status_Prompt | String | False |
Filter supplier invoice requests by status. Used for internal REST API purposes. |
| Supplier_Prompt | String | False |
Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | False |
Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). |
| ToInvoiceDate_Prompt | Date | False |
Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Manages attachments linked to supplier invoice requests.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for this supplier invoice request attachment instance. |
| SupplierInvoiceRequests_Id [KEY] | String | False |
Workday-generated unique ID linking this record to the associated supplier invoice request. |
| ContentType_Id | String | False |
Unique identifier associated with the content type of the attachment. |
| Descriptor | String | False |
A brief, human-readable summary of the instance. |
| FileExtension | String | False |
The file extension type of the attached document (for example, .pdf, .xlsx, .docx). |
| FileLength | Decimal | False |
The size of the attached file in bytes. |
| FileName | String | False |
The name of the attached file. |
| Company_Prompt | String | False |
Filter supplier invoice requests by company. Used for internal REST API purposes. |
| FromDueDate_Prompt | Date | False |
Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | False |
Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | False |
Filter supplier invoice requests by the requester using the Workday ID. |
| Status_Prompt | String | False |
Filter supplier invoice requests by status. Used for internal REST API purposes. |
| Supplier_Prompt | String | False |
Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | False |
Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | False |
Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Retrieves a collection of task resources, including metadata and dependencies associated with tasks within Workday.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
-processingUserHasAccessToViewWorker: Boolean /* Processing user has view access to \~Worker\~ */
-unnamedResource: Boolean /* If true, the project resource is an unnamed resource. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the project task resource instance. |
| Allocation | Decimal | False |
The percentage of time allocated to this task resource within the project. |
| Descriptor | String | False |
A brief preview of the task resource instance. |
| EndDate | Datetime | False |
The scheduled end date for this task resource assignment. |
| EstimatedHours | Decimal | False |
The estimated number of hours required for the task resource to complete the assigned work. |
| Memo | String | False |
Additional notes or comments associated with the project task resource. |
| ProjectPlanLine_AssociationResourcePlanDetail | Bool | False |
Indicates whether this resource plan detail is an association-type resource allocation. |
| ProjectPlanLine_Descriptor | String | False |
A brief preview of the project plan line instance. |
| ProjectPlanLine_Id | String | False |
The unique identifier for the project plan line. |
| ProjectPlanTask_Descriptor | String | False |
A description of the specific project task to which this resource is assigned. |
| ProjectPlanTask_Href | String | False |
A direct link to the project plan task instance. |
| ProjectPlanTask_Id | String | False |
The Workday ID of the project plan task. |
| ProjectResources_Aggregate | String | False |
A collection of workers or unnamed resources assigned to this resource plan. |
| StartDate | Datetime | False |
The scheduled start date for this task resource assignment. |
| WarningCustomValidations | String | False |
List of warning messages for custom validations associated with this project task resource. |
| ProjectPlanTask_Prompt | String | False |
Filters task resources by the specified project plan task. |
| Project_Prompt | String | False |
Filters task resources by the specified project. |
Fetches project resource data linked to tasks, enabling project tracking and resource allocation analysis.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the task resource instance. |
| TaskResources_Id [KEY] | String | False |
The Workday ID of the TaskResources table that contains this task resource entry. |
| Descriptor | String | False |
A brief preview or summary of the task resource instance. |
| ProcessingUserHasAccessToViewWorker | Bool | False |
Indicates whether the current user has permission to view worker details for this task resource. |
| UnnamedResource | Bool | False |
Indicates whether the assigned project resource is unnamed (a placeholder rather than a specific worker). |
| ProjectPlanTask_Prompt | String | False |
Filters task resources based on a specific project plan task. |
| Project_Prompt | String | False |
Filters task resources based on a specific project. |
Retrieves a single or a collection of State Unemployment Insurance (SUI) tax rates configured for different company entities.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the company's State Unemployment Insurance (SUI) rate. |
| ApplicableRate | String | False |
The applicable SUI tax rate assigned to the company. |
| CompanyInstance_Company | String | False |
The reference ID used for Workday Web Services lookups. For supervisory organizations, this also serves as the Organization ID. |
| CompanyInstance_Descriptor | String | False |
A preview or summary of the company instance. |
| CompanyInstance_Fein | String | False |
The Federal Employer Identification Number (FEIN) associated with the US-based company. |
| CompanyInstance_Id | String | False |
Unique identifier for the company instance. |
| Ein | String | False |
The Employer Identification Number (EIN) used for the company's SUI rate. |
| EinType | String | False |
The type of EIN assigned. Valid values: 'SUI EIN' (State Unemployment Insurance EIN), 'STATE EIN' (State-level EIN), 'FEIN' (Federal EIN). |
| EndDate | String | False |
The expiration date for the SUI rate entry. |
| Exempt | Bool | False |
Indicates whether the company is exempt from SUI tax. |
| RateType | String | False |
Specifies the type of rate assigned. Valid values: 'OR' (override rate) and 'DR' (default rate). |
| StartDate | Datetime | False |
The date when the SUI rate becomes effective. |
| StateInstance_Descriptor | String | False |
A preview or summary of the state instance. |
| StateInstance_Id | String | False |
Unique identifier for the state instance. |
| StateInstance_PayrollStateAuthorityTaxCode | String | False |
The payroll tax authority's state tax code associated with the SUI tax. |
| TaxCode | String | False |
The payroll tax code assigned to the SUI rate. Default value: 'W_SUIER'. |
| Company_Prompt | String | False |
Filters results by company reference ID or Workday ID. Example: company=comp1andcompany=comp2andcompany=cb550da820584750aae8f807882fa79a. |
| Effective_Prompt | Date | False |
Filters results by the effective date of the SUI rate using the format yyyy-mm-dd. |
| PayrollStateAuthorityTaxCode_Prompt | String | False |
Filters results by state tax authority using FIPS code or Workday ID. Example: payrollStateAuthorityTaxCode=06andpayrollStateAuthorityTaxCode=3b3d378d5f4a48b8b3ac46fee0703226andpayrollStateAuthorityTaxCode=48. |
Retrieves a collection of time clock entries for a worker within a specified date range, capturing punch-in/out details and timestamps.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance (Workday ID). |
| AllocationPool_Descriptor | String | False |
A brief description of the allocation pool, which represents a designated budget or resource allocation. |
| AllocationPool_Href | String | False |
A URL link to the allocation pool instance in Workday. |
| AllocationPool_Id | String | False |
The Workday ID associated with the allocation pool. |
| Appropriation_Descriptor | String | False |
A brief description of the appropriation, which defines specific budgeted amounts for expenditures. |
| Appropriation_Href | String | False |
A URL link to the appropriation instance in Workday. |
| Appropriation_Id | String | False |
The Workday ID for the appropriation. |
| BusinessUnit_Descriptor | String | False |
A short summary of the business unit, representing an operational division within the company. |
| BusinessUnit_Href | String | False |
A URL link to the business unit instance in Workday. |
| BusinessUnit_Id | String | False |
The Workday ID for the business unit. |
| Comment | String | False |
A free-text comment associated with the time clock event, used for additional notes or explanations. |
| CostCenter_Descriptor | String | False |
A description of the cost center, which is used for tracking financial transactions and expenses. |
| CostCenter_Href | String | False |
A URL link to the cost center instance in Workday. |
| CostCenter_Id | String | False |
The Workday ID for the cost center. |
| Currency_Descriptor | String | False |
A description of the currency being used for transactions. |
| Currency_Href | String | False |
A URL link to the currency instance in Workday. |
| Currency_Id | String | False |
The Workday ID for the currency. |
| CustomOrganization01_Descriptor | String | False |
A brief description of the first custom organization level, used for additional reporting or grouping. |
| CustomOrganization01_Href | String | False |
A URL link to the custom organization level 1 instance in Workday. |
| CustomOrganization01_Id | String | False |
The Workday ID for custom organization level 1. |
| CustomOrganization02_Descriptor | String | False |
A brief description of the second custom organization level. |
| CustomOrganization02_Href | String | False |
A URL link to the custom organization level 2 instance in Workday. |
| CustomOrganization02_Id | String | False |
The Workday ID for custom organization level 2. |
| CustomOrganization03_Descriptor | String | False |
A brief description of the third custom organization level. |
| CustomOrganization03_Href | String | False |
A URL link to the custom organization level 3 instance in Workday. |
| CustomOrganization03_Id | String | False |
The Workday ID for custom organization level 3. |
| CustomOrganization04_Descriptor | String | False |
A brief description of the fourth custom organization level. |
| CustomOrganization04_Href | String | False |
A URL link to the custom organization level 4 instance in Workday. |
| CustomOrganization04_Id | String | False |
The Workday ID for custom organization level 4. |
| CustomOrganization05_Descriptor | String | False |
A brief description of the fifth custom organization level. |
| CustomOrganization05_Href | String | False |
A URL link to the custom organization level 5 instance in Workday. |
| CustomOrganization05_Id | String | False |
The Workday ID for custom organization level 5. |
| CustomOrganization06_Descriptor | String | False |
A brief description of the sixth custom organization level. |
| CustomOrganization06_Href | String | False |
A URL link to the custom organization level 6 instance in Workday. |
| CustomOrganization06_Id | String | False |
The Workday ID for custom organization level 6. |
| CustomOrganization07_Descriptor | String | False |
A brief description of the seventh custom organization level. |
| CustomOrganization07_Href | String | False |
A URL link to the custom organization level 7 instance in Workday. |
| CustomOrganization07_Id | String | False |
The Workday ID for custom organization level 7. |
| CustomOrganization08_Descriptor | String | False |
A brief description of the eighth custom organization level. |
| CustomOrganization08_Href | String | False |
A URL link to the custom organization level 8 instance in Workday. |
| CustomOrganization08_Id | String | False |
The Workday ID for custom organization level 8. |
| CustomOrganization09_Descriptor | String | False |
A brief description of the ninth custom organization level. |
| CustomOrganization09_Href | String | False |
A URL link to the custom organization level 9 instance in Workday. |
| CustomOrganization09_Id | String | False |
The Workday ID for custom organization level 9. |
| CustomOrganization10_Descriptor | String | False |
A brief description of the tenth custom organization level. |
| CustomOrganization10_Href | String | False |
A URL link to the custom organization level 10 instance in Workday. |
| CustomOrganization10_Id | String | False |
The Workday ID for custom organization level 10. |
| CustomWorktag01_Descriptor | String | False |
A description of the first custom worktag, used for tagging transactions with additional metadata. |
| CustomWorktag01_Href | String | False |
A URL link to the first custom worktag instance in Workday. |
| CustomWorktag01_Id | String | False |
The Workday ID for the first custom worktag. |
| CustomWorktag02_Descriptor | String | False |
A description of the second custom worktag, typically used for categorization in financial and HR transactions. |
| CustomWorktag02_Href | String | False |
A URL link to the second custom worktag instance in Workday. |
| CustomWorktag02_Id | String | False |
The Workday ID for the second custom worktag. |
| CustomWorktag03_Descriptor | String | False |
A description of the third custom worktag, which may represent cost tracking or other organizational grouping. |
| CustomWorktag03_Href | String | False |
A URL link to the third custom worktag instance in Workday. |
| CustomWorktag03_Id | String | False |
The Workday ID for the third custom worktag. |
| CustomWorktag04_Descriptor | String | False |
A description of the fourth custom worktag, providing additional tracking for projects, grants, or business units. |
| CustomWorktag04_Href | String | False |
A URL link to the fourth custom worktag instance in Workday. |
| CustomWorktag04_Id | String | False |
The Workday ID for the fourth custom worktag. |
| CustomWorktag05_Descriptor | String | False |
A description of the fifth custom worktag, which can be configured for various reporting or tagging purposes. |
| CustomWorktag05_Href | String | False |
A URL link to the fifth custom worktag instance in Workday. |
| CustomWorktag05_Id | String | False |
The Workday ID for the fifth custom worktag. |
| CustomWorktag06_Descriptor | String | False |
A description of the sixth custom worktag, used for department-level or functional tracking. |
| CustomWorktag06_Href | String | False |
A URL link to the sixth custom worktag instance in Workday. |
| CustomWorktag06_Id | String | False |
The Workday ID for the sixth custom worktag. |
| CustomWorktag07_Descriptor | String | False |
A description of the seventh custom worktag, enabling finer-grained tracking of financial transactions. |
| CustomWorktag07_Href | String | False |
A URL link to the seventh custom worktag instance in Workday. |
| CustomWorktag07_Id | String | False |
The Workday ID for the seventh custom worktag. |
| CustomWorktag08_Descriptor | String | False |
A description of the eighth custom worktag, assigned for organizational or financial purposes. |
| CustomWorktag08_Href | String | False |
A URL link to the eighth custom worktag instance in Workday. |
| CustomWorktag08_Id | String | False |
The Workday ID for the eighth custom worktag. |
| CustomWorktag09_Descriptor | String | False |
A description of the ninth custom worktag, used for specialized reporting or cost allocation. |
| CustomWorktag09_Href | String | False |
A URL link to the ninth custom worktag instance in Workday. |
| CustomWorktag09_Id | String | False |
The Workday ID for the ninth custom worktag. |
| CustomWorktag10_Descriptor | String | False |
A description of the tenth custom worktag, which can be associated with compliance, budgeting, or grants. |
| CustomWorktag10_Href | String | False |
A URL link to the tenth custom worktag instance in Workday. |
| CustomWorktag10_Id | String | False |
The Workday ID for the tenth custom worktag. |
| CustomWorktag11_Descriptor | String | False |
A description of the eleventh custom worktag, designated for tracking purposes. |
| CustomWorktag11_Href | String | False |
A URL link to the eleventh custom worktag instance in Workday. |
| CustomWorktag11_Id | String | False |
The Workday ID for the eleventh custom worktag. |
| CustomWorktag12_Descriptor | String | False |
A description of the twelfth custom worktag, assigned for internal cost tracking. |
| CustomWorktag12_Href | String | False |
A URL link to the twelfth custom worktag instance in Workday. |
| CustomWorktag12_Id | String | False |
The Workday ID for the twelfth custom worktag. |
| CustomWorktag13_Descriptor | String | False |
A description of the thirteenth custom worktag, typically used in project tracking or internal audits. |
| CustomWorktag13_Href | String | False |
A URL link to the thirteenth custom worktag instance in Workday. |
| CustomWorktag13_Id | String | False |
The Workday ID for the thirteenth custom worktag. |
| CustomWorktag14_Descriptor | String | False |
A description of the fourteenth custom worktag, configured based on business needs. |
| CustomWorktag14_Href | String | False |
A URL link to the fourteenth custom worktag instance in Workday. |
| CustomWorktag14_Id | String | False |
The Workday ID for the fourteenth custom worktag. |
| CustomWorktag15_Descriptor | String | False |
A description of the fifteenth custom worktag, reserved for additional business classifications. |
| CustomWorktag15_Href | String | False |
A URL link to the fifteenth custom worktag instance in Workday. |
| CustomWorktag15_Id | String | False |
The Workday ID for the fifteenth custom worktag. |
| DateTime | Datetime | False |
The timestamp of a time clock event, recording when the event occurred. |
| Descriptor | String | False |
A brief summary or preview of the instance. |
| EventType_Descriptor | String | False |
A description of the event type, such as 'clock-in' or 'clock-out' for a time entry. |
| EventType_Href | String | False |
A URL link to the event type instance in Workday. |
| EventType_Id | String | False |
The Workday ID for the event type. |
| Fund_Descriptor | String | False |
A description of the financial fund, which represents a pool of money allocated for specific purposes. |
| Fund_Href | String | False |
A URL link to the fund instance in Workday. |
| Fund_Id | String | False |
The Workday ID for the fund instance. |
| Gift_Descriptor | String | False |
A description of the gift fund, typically used in grant and donation tracking. |
| Gift_Href | String | False |
A URL link to the gift instance in Workday. |
| Gift_Id | String | False |
The Workday ID for the gift instance. |
| Grant_Descriptor | String | False |
A description of the grant, often associated with research or project funding. |
| Grant_Href | String | False |
A URL link to the grant instance in Workday. |
| Grant_Id | String | False |
The Workday ID for the grant instance. |
| Href | String | False |
A URL link to the specific instance in Workday. |
| JobProfile_Descriptor | String | False |
A description of the job profile, representing a predefined set of job responsibilities. |
| JobProfile_Href | String | False |
A URL link to the job profile instance in Workday. |
| JobProfile_Id | String | False |
The Workday ID for the job profile. |
| Location_Descriptor | String | False |
A description of the location associated with a worker, project, or event. |
| Location_Href | String | False |
A URL link to the location instance in Workday. |
| Location_Id | String | False |
The Workday ID for the location instance. |
| OverrideRate | Decimal | False |
The override rate applied to a time clock event, used for special pay rates. |
| Position_Descriptor | String | False |
A description of the position, detailing assigned roles within the organization. |
| Position_Href | String | False |
A URL link to the position instance in Workday. |
| Position_Id | String | False |
The Workday ID for the position instance. |
| Program_Descriptor | String | False |
A description of the program, which may refer to an academic, financial, or HR initiative. |
| Program_Href | String | False |
A URL link to the program instance in Workday. |
| Program_Id | String | False |
The Workday ID for the program instance. |
| ProjectPlanTask_Descriptor | String | False |
A description of the project plan task, indicating a specific work breakdown item. |
| ProjectPlanTask_Href | String | False |
A URL link to the project plan task instance in Workday. |
| ProjectPlanTask_Id | String | False |
The Workday ID for the project plan task instance. |
| Project_Descriptor | String | False |
A description of the project, typically used in financial, HR, or work management contexts. |
| Project_Href | String | False |
A URL link to the project instance in Workday. |
| Project_Id | String | False |
The Workday ID for the project instance. |
| ReferenceID | String | False |
The reference ID used for Workday Web Services lookups. |
| Region_Descriptor | String | False |
A description of the region, used to group locations or define geographic boundaries. |
| Region_Href | String | False |
A URL link to the region instance in Workday. |
| Region_Id | String | False |
The Workday ID for the region instance. |
| TimeEntryCode_Descriptor | String | False |
A description of the time entry code, specifying different types of work hours or leave. |
| TimeEntryCode_Href | String | False |
A URL link to the time entry code instance in Workday. |
| TimeEntryCode_Id | String | False |
The Workday ID for the time entry code instance. |
| TimeZone_Descriptor | String | False |
A description of the time zone associated with a worker, location, or transaction. |
| TimeZone_Href | String | False |
A URL link to the time zone instance in Workday. |
| TimeZone_Id | String | False |
The Workday ID for the time zone instance. |
| Worker_Descriptor | String | False |
A description of the worker, referencing an employee or contractor in the system. |
| Worker_Href | String | False |
A URL link to the worker instance in Workday. |
| Worker_Id | String | False |
The Workday ID for the worker instance. |
| FromDate_Prompt | Date | False |
Filters the time events starting from the specified date (yyyy-mm-dd format). |
| ToDate_Prompt | Date | False |
Filters the time events ending on or before the specified date (yyyy-mm-dd format). |
| Worker_Prompt | String | False |
Filters time blocks or clock events for a specific worker by Workday ID. Multiple worker parameters can be specified. |
Represents address updates pending approval as part of a worker's contact information change process.
The Workday Cloud requires filtering on WorkContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM WorkContactInformationChangesAddresses WHERE WorkContactInformationChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
The unique Workday ID of the instance. |
| WorkContactInformationChange_Id [KEY] | String | False |
The Workday ID of the work contact information change process. Must be set in all queries. |
| AddressLine1 | String | False |
Primary address line 1. |
| AddressLine1Local | String | False |
Localized version of address line 1. |
| AddressLine2 | String | False |
Primary address line 2. |
| AddressLine2Local | String | False |
Localized version of address line 2. |
| AddressLine3 | String | False |
Primary address line 3. |
| AddressLine3Local | String | False |
Localized version of address line 3. |
| AddressLine4 | String | False |
Primary address line 4. |
| AddressLine4Local | String | False |
Localized version of address line 4. |
| AddressLine5 | String | False |
Primary address line 5. |
| AddressLine5Local | String | False |
Localized version of address line 5. |
| AddressLine6 | String | False |
Primary address line 6. |
| AddressLine6Local | String | False |
Localized version of address line 6. |
| AddressLine7 | String | False |
Primary address line 7. |
| AddressLine7Local | String | False |
Localized version of address line 7. |
| AddressLine8 | String | False |
Primary address line 8. |
| AddressLine8Local | String | False |
Localized version of address line 8. |
| AddressLine9 | String | False |
Primary address line 9. |
| AddressLine9Local | String | False |
Localized version of address line 9. |
| City | String | False |
City name. |
| CityLocal | String | False |
Localized city name. |
| CitySubdivision1 | String | False |
First subdivision within the city (for example, district, borough). |
| CitySubdivision1Local | String | False |
Localized version of city subdivision 1. |
| CitySubdivision2 | String | False |
Second subdivision within the city (for example, neighborhood). |
| CitySubdivision2Local | String | False |
Localized version of city subdivision 2. |
| CountryCity_Descriptor | String | False |
A preview description of the city instance. |
| CountryCity_Id | String | False |
The Workday ID of the city instance. |
| CountryRegion_Descriptor | String | False |
A preview description of the region instance. |
| CountryRegion_Id | String | False |
The Workday ID of the region instance. |
| Country_Descriptor | String | False |
A preview description of the country instance. |
| Country_Id | String | False |
The Workday ID of the country instance. |
| Effective | Datetime | False |
The date when this work contact information takes effect. |
| PostalCode | String | False |
Postal or ZIP code. |
| RegionSubdivision1 | String | False |
Primary region subdivision (for example, state or province). |
| RegionSubdivision1Local | String | False |
Localized version of primary region subdivision. |
| RegionSubdivision2 | String | False |
Secondary region subdivision (for example, county or district). |
| Usage_Comment | String | False |
Description of the communication method usage. |
| Usage_Primary | Bool | False |
Indicates whether this is the primary communication method (false by default). |
| Usage_Public | Bool | False |
Indicates whether this contact information is publicly visible. |
| Usage_UsageType_Descriptor | String | False |
A preview description of the usage type. |
| Usage_UsageType_Id | String | False |
The Workday ID of the usage type. |
| Usage_UsedFor_Aggregate | String | False |
List of purposes for which this contact information is used. |
| PublicOnly_Prompt | Bool | False |
Filters for publicly visible contact information. |
| UsedFor_Prompt | String | False |
Filters for specific usage types. |
Retrieves all email address changes staged for update as part of a Workday business process.
The Workday Cloud requires filtering on WorkContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM WorkContactInformationChangesEmailAddresses WHERE WorkContactInformationChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
The unique Workday ID of the instance. |
| WorkContactInformationChange_Id [KEY] | String | False |
The Workday ID of the work contact information change process. Required for all queries. |
| Descriptor | String | False |
A preview description of the email instance. |
| EmailAddress | String | False |
The email address associated with the instance. |
| Usage_Comment | String | False |
A description of how this communication method is used. |
| Usage_Primary | Bool | False |
True if this is the primary email address for the person. |
| Usage_Public | Bool | False |
True if the email address is publicly visible; otherwise, it is private. |
| Usage_UsageType_Id | String | False |
The Workday ID of the usage type associated with this email address. |
| Usage_UsedFor_Aggregate | String | False |
A list of usage behaviors for the email address, such as mailing, billing, or shipping. |
| PrimaryOnly_Prompt | Bool | False |
Filters results to return only primary email addresses. |
| PublicOnly_Prompt | Bool | False |
Filters results to return only public email addresses. |
| UsageType_Prompt | String | False |
Filters results by usage type, such as home or work email. |
| UsedFor_Prompt | String | False |
Filters results by usage behavior, such as mailing, billing, or shipping. |
Captures pending updates to a worker’s instant messaging details within the Workday system.
The Workday Cloud requires filtering on WorkContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM WorkContactInformationChangesInstantMessengers WHERE WorkContactInformationChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
The unique Workday ID of the instance. |
| WorkContactInformationChange_Id [KEY] | String | False |
The Workday ID of the work contact information change process. Required for all queries. |
| Type_Descriptor | String | False |
A preview description of the instant messenger type. |
| Type_Id | String | False |
The Workday ID of the instant messenger type. |
| Usage_Comment | String | False |
A description of how this communication method is used. |
| Usage_Primary | Bool | False |
True if this is the primary instant messenger account. |
| Usage_Public | Bool | False |
True if the instant messenger account is publicly visible; otherwise, it is private. |
| Usage_UsageType_Id | String | False |
The Workday ID of the usage type associated with this communication method. |
| Usage_UsedFor_Aggregate | String | False |
A list of usage behaviors for this communication method, such as mailing, billing, or shipping. |
| UserName | String | False |
The username associated with the instant messenger account. |
| PrimaryOnly_Prompt | Bool | False |
Filters results to return only primary instant messenger accounts. |
| PublicOnly_Prompt | Bool | False |
Filters results to return only public instant messenger accounts. |
| UsageType_Prompt | String | False |
Filters results by usage type, such as home or work. |
| UsedFor_Prompt | String | False |
Filters results by usage behavior, such as mailing, billing, or shipping. |
Records phone number changes for a worker before they are officially updated in Workday.
The Workday Cloud requires filtering on WorkContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM WorkContactInformationChangesPhoneNumbers WHERE WorkContactInformationChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
The unique Workday ID of the instance. |
| WorkContactInformationChange_Id [KEY] | String | False |
The Workday ID of the work contact information change process. Required for all queries. |
| CompletePhoneNumber | String | False |
The full phone number, including country code and extension if applicable. |
| CountryPhoneCode_CountryPhoneCode | String | False |
The dialing code associated with a country. |
| CountryPhoneCode_Country_Descriptor | String | False |
A preview description of the country associated with the phone code. |
| CountryPhoneCode_Country_Id | String | False |
The Workday ID of the country associated with the phone code. |
| CountryPhoneCode_Descriptor | String | False |
A preview description of the phone code. |
| CountryPhoneCode_Id | String | False |
The Workday ID of the phone code. |
| Descriptor | String | False |
A preview description of the phone number instance. |
| DeviceType_Descriptor | String | False |
A preview description of the device type (for example, mobile, landline, fax). |
| DeviceType_Id | String | False |
The Workday ID of the device type. |
| Extension | String | False |
The extension number associated with the phone number. |
| Usage_Comment | String | False |
A description of how this communication method is used. |
| Usage_Primary | Bool | False |
True if this phone number is the primary contact method. |
| Usage_Public | Bool | False |
True if this phone number is publicly visible; otherwise, it is private. |
| Usage_UsageType_Id | String | False |
The Workday ID of the usage type associated with this phone number. |
| Usage_UsedFor_Aggregate | String | False |
A list of usage behaviors for this phone number, such as mailing, billing, or shipping. |
| PrimaryOnly_Prompt | Bool | False |
Filters results to return only primary phone numbers. |
| PublicOnly_Prompt | Bool | False |
Filters results to return only public phone numbers. |
| UsageType_Prompt | String | False |
Filters results by usage type, such as home or work. |
| UsedFor_Prompt | String | False |
Filters results by usage behavior, such as mailing, billing, or shipping. |
Tracks updates to a worker's web address details, such as personal or professional websites, awaiting approval.
The Workday Cloud requires filtering on WorkContactInformationChange_Id in order to perform the query.
For example:
SELECT * FROM WorkContactInformationChangesWebAddresses WHERE WorkContactInformationChange_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 |
The unique Workday ID of the instance. |
| WorkContactInformationChange_Id [KEY] | String | False |
The Workday ID of the work contact information change process. Required for all queries. |
| Url | String | False |
The full web address (URL) for the contact information. |
| Usage_Comment | String | False |
A description of how this communication method is used. |
| Usage_Primary | Bool | False |
True if this web address is marked as the primary contact method. |
| Usage_Public | Bool | False |
True if this web address is publicly visible; otherwise, it is private. |
| Usage_UsageType_Id | String | False |
The Workday ID of the usage type associated with this web address. |
| Usage_UsedFor_Aggregate | String | False |
A list of usage behaviors for this web address, such as mailing, billing, or shipping. |
| PrimaryOnly_Prompt | Bool | False |
Filters results to return only primary web addresses. |
| PublicOnly_Prompt | Bool | False |
Filters results to return only public web addresses. |
| UsageType_Prompt | String | False |
Filters results by usage type, such as home or work. |
| UsedFor_Prompt | String | False |
Filters results by usage behavior, such as mailing, billing, or shipping. |
Retrieves feedback events given to or about a worker, including manager and peer reviews.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique Workday ID for the feedback instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback event. |
| Badge_Descriptor | String | False |
A description of the badge associated with the feedback event. |
| Badge_Href | String | False |
A link to the badge instance in Workday. |
| Badge_Id | String | False |
The Workday ID of the badge instance. |
| BusinessProcessParameters_Action_Descriptor | String | False |
A description of the action taken within the business process. |
| BusinessProcessParameters_Action_Href | String | False |
A link to the action instance in Workday. |
| BusinessProcessParameters_Action_Id | String | False |
The Workday ID of the action instance. |
| BusinessProcessParameters_Attachments_Aggregate | String | False |
Lists attachments associated with the business process, uploaded from the toolbar and accessible to the processing person. Returns blank if unavailable. |
| BusinessProcessParameters_Comment | String | False |
A comment related to the business process (returns null if unavailable). |
| BusinessProcessParameters_CriticalValidations | String | False |
Displays validation messages for action events triggered by conditions, requiring corrective action. |
| BusinessProcessParameters_For_Descriptor | String | False |
A description of the entity for which the business process was initiated. |
| BusinessProcessParameters_For_Href | String | False |
A link to the entity instance in Workday. |
| BusinessProcessParameters_For_Id | String | False |
The Workday ID of the entity instance. |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | False |
A description of the overall business process related to this transaction. |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | False |
A link to the overall business process instance. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | False |
The Workday ID of the overall business process. |
| BusinessProcessParameters_OverallStatus | String | False |
The current status of the business process (for example, Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | False |
A description of the transaction status within the business process. |
| BusinessProcessParameters_TransactionStatus_Href | String | False |
A link to the transaction status instance. |
| BusinessProcessParameters_TransactionStatus_Id | String | False |
The Workday ID of the transaction status. |
| BusinessProcessParameters_WarningValidations | String | False |
Displays warning messages for action events triggered by conditions that do not block the process. |
| Comment | String | False |
The comment text provided for the anytime feedback event. |
| Descriptor | String | False |
A preview of the feedback instance. |
| FeedbackAlsoAbout_Aggregate | String | False |
Lists other workers who were mentioned in the feedback event. |
| FeedbackGivenDate | Datetime | False |
The date when feedback was provided. |
| FromWorker_Descriptor | String | False |
A description of the worker who provided the feedback. |
| FromWorker_Href | String | False |
A link to the worker instance in Workday. |
| FromWorker_Id | String | False |
The Workday ID of the worker who gave the feedback. |
| HiddenFromManager | Bool | False |
True if the feedback is private and not visible to the worker’s manager. |
| HiddenFromWorker | Bool | False |
True if the feedback is confidential and not visible to the worker. |
| Href | String | False |
A link to the feedback instance in Workday. |
| RelatesTo_Descriptor | String | False |
A preview of the entity to which the feedback event relates. |
| RelatesTo_Id | String | False |
The Workday ID of the related entity. |
| ShowFeedbackProviderName | Bool | False |
True if the feedback provider has chosen to display their name. |
| ToWorker_Descriptor | String | False |
A description of the worker who received the feedback. |
| ToWorker_Href | String | False |
A link to the recipient worker instance in Workday. |
| ToWorker_Id | String | False |
The Workday ID of the worker who received the feedback. |
| WorkersToNotify_Aggregate | String | False |
Lists workers who were selected to be notified about the feedback event. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches workers by name or worker ID. The search is case-insensitive and supports space-delimited OR searches. |
Fetches attachments associated with business process events related to anytime feedback.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique Workday ID for the feedback attachment. |
| WorkersAnytimeFeedbackEvents_Id [KEY] | String | False |
The Workday ID of the Anytime Feedback event that contains this attachment. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this attachment. |
| Category_Descriptor | String | False |
A description of the category assigned to this attachment. |
| Category_Href | String | False |
A link to the category instance in Workday. |
| Category_Id | String | False |
The Workday ID of the category instance. |
| ContentType_Descriptor | String | False |
A description of the content type of the attachment (for example, document, image). |
| ContentType_Href | String | False |
A link to the content type instance in Workday. |
| ContentType_Id | String | False |
The Workday ID of the content type instance. |
| Description | String | False |
A user-provided description for the event attachment. |
| FileLength | Decimal | False |
The file size of the attachment in bytes. |
| FileName | String | False |
The name of the attached file. |
| UploadDate | Datetime | False |
The date and time when the attachment was uploaded. |
| UploadedBy_Descriptor | String | False |
A description of the worker who uploaded the attachment. |
| UploadedBy_Href | String | False |
A link to the worker instance in Workday. |
| UploadedBy_Id | String | False |
The Workday ID of the worker who uploaded the attachment. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Searches workers by name or worker ID. The search is case-insensitive and supports space-delimited OR searches. |
Lists additional workers referenced in a feedback event, providing context on multi-person evaluations.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the Anytime Feedback event instance. |
| WorkersAnytimeFeedbackEvents_Id [KEY] | String | False |
The Workday ID of the Anytime Feedback event that contains this instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this feedback event. |
| Descriptor | String | False |
A brief preview or description of the feedback event. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-delimited OR searches. |
Lists workers notified about a specific feedback event, including managers and HR personnel.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the Anytime Feedback event instance. |
| WorkersAnytimeFeedbackEvents_Id [KEY] | String | False |
The Workday ID of the Anytime Feedback event that contains this instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this feedback event. |
| Descriptor | String | False |
A brief preview or description of the feedback event. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-delimited OR searches. |
Retrieves historical and pending changes to a worker’s business title, tracking career progression.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the business process instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this business process. |
| CurrentBusinessTitle | String | False |
The worker's business title before this business process was initiated. If no title override exists, this field defaults to the job title or job profile name. |
| Descriptor | String | False |
A brief preview or summary of the instance. |
| Due | Datetime | False |
The deadline by which this business process must be completed. |
| Effective | Datetime | False |
The date when the changes from this business process take effect. |
| Href | String | False |
A direct link to the instance in Workday. |
| Initiated | Datetime | False |
The date and time when this business process was initiated. |
| Initiator_Descriptor | String | False |
A brief description of the person who initiated this business process. |
| Initiator_Href | String | False |
A direct link to the initiator's profile in Workday. |
| Initiator_Id | String | False |
The Workday ID of the initiator. |
| ProposedBusinessTitle | String | False |
The worker's new business title after this business process is completed. Defaults to the job title or job profile name if no title override exists. |
| Subject_Descriptor | String | False |
A brief description of the primary subject of this business process. |
| Subject_Href | String | False |
A direct link to the primary subject's profile in Workday. |
| Subject_Id | String | False |
The Workday ID of the primary subject. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves detailed information on a worker’s check-in records, including topics discussed and feedback received.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckIns WHERE Workers_Id = '4348b0198b131024e7b9d31ad2ce0c70';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the check-in instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this check-in. |
| Archived | Bool | False |
Indicates whether the check-in has been archived (true/false). |
| AssociatedTopics_Aggregate | String | False |
A list of topics included in this check-in session. |
| CheckInAttachments_Aggregate | String | False |
A collection of all attachments associated with this check-in. |
| Creator_Descriptor | String | False |
A brief description of the person who created this check-in. |
| Creator_Href | String | False |
A direct link to the creator's profile in Workday. |
| Creator_Id | String | False |
The Workday ID of the check-in creator. |
| Date | Datetime | False |
The scheduled or recorded date of the check-in. |
| Description | String | False |
A detailed description or summary of the check-in session. |
| Participant_Descriptor | String | False |
A brief description of the participant(s) involved in the check-in. |
| Participant_Href | String | False |
A direct link to the participant’s profile in Workday. |
| Participant_Id | String | False |
The Workday ID of the check-in participant. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Lists topics associated with check-in meetings, providing insights into recurring themes in discussions.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckInsAssociatedTopics WHERE Workers_Id = '4348b0198b131024e7b9d31ad2ce0c70';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the topic instance. |
| WorkersCheckIns_Id [KEY] | String | False |
The Workday ID of the check-in session that contains this topic. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this check-in topic. |
| Archived | Bool | False |
Indicates whether the topic has been archived (true/false). |
| Name | String | False |
The name or title of the check-in topic. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches attachments related to worker check-ins, such as documents or notes shared during a session.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckInsCheckInAttachments WHERE Workers_Id = 4348b0198b131024e7b9d31ad2ce0c70';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the attachment instance. |
| WorkersCheckIns_Id [KEY] | String | False |
The Workday ID of the check-in session that contains this attachment. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this attachment. |
| Comment | String | False |
Comment or description provided for the attachment. |
| ContentType_Descriptor | String | False |
A descriptive label for the file content type. |
| ContentType_Href | String | False |
A URL link to the content type metadata. |
| ContentType_Id | String | False |
The Workday ID/reference ID for the content type. |
| Descriptor | String | False |
A brief preview or summary of the attachment. |
| FileLength | Decimal | False |
Size of the attachment file in bytes. |
| FileName | String | False |
The original name of the uploaded attachment file. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a collection of discussion topics covered in worker check-ins, aiding in performance management.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckInTopics WHERE Workers_Id = '4348b0198b131024e7b9d31ad2ce0c70';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the check-in topic instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this check-in topic. |
| Archived | Bool | False |
Indicates whether the topic has been archived. |
| AssociatedCheckIns_Aggregate | String | False |
List of check-ins associated with this topic. |
| CheckInTopicAttachments_Aggregate | String | False |
Attachments linked to this check-in topic. |
| Creator_Descriptor | String | False |
A descriptive label for the creator of the topic. |
| Creator_Href | String | False |
A URL link to details about the creator. |
| Creator_Id | String | False |
The Workday ID/reference ID of the creator. |
| Name | String | False |
The title or name of the check-in topic. |
| Participant_Descriptor | String | False |
A descriptive label for the participant of the topic. |
| Participant_Href | String | False |
A URL link to details about the participant. |
| Participant_Id | String | False |
The Workday ID/reference ID of the participant. |
| PrivateNotes | String | False |
Personal notes visible only to the creator. |
| SharedNotes | String | False |
Notes shared with other participants. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Lists check-in sessions that reference a specific topic, useful for tracking recurring discussions over time.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckInTopicsAssociatedCheckIns WHERE Workers_Id = '4348b0198b131024e7b9d31ad2ce0c70';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the check-in instance. |
| WorkersCheckInTopics_Id [KEY] | String | False |
The Workday ID of the check-in topic associated with this check-in. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this check-in. |
| Archived | Bool | False |
Indicates whether the check-in has been archived. |
| Date | Datetime | False |
The date when the check-in took place. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches files or supporting materials attached to check-in topics for enhanced documentation.
The Workday Cloud requires filtering on Workers_Id in order to perform the query.
For example:
SELECT * FROM WorkersCheckInTopicsCheckInTopicAttachments WHERE Workers_Id = '4348b0198b131024e7b9d31ad2ce0c70';
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the check-in topic attachment instance. |
| WorkersCheckInTopics_Id [KEY] | String | False |
The Workday ID of the check-in topic associated with this attachment. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this attachment. |
| Comment | String | False |
The comment associated with the attachment. |
| ContentType_Descriptor | String | False |
A description of the file type or format of the attachment. |
| ContentType_Href | String | False |
A link to the content type instance. |
| ContentType_Id | String | False |
The Workday reference ID for the content type. |
| Descriptor | String | False |
A brief preview of the attachment. |
| FileLength | Decimal | False |
The size of the attachment file in bytes. |
| FileName | String | False |
The name of the attached file. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves development items for a worker, including skill-building tasks and career advancement plans.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the development item instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this development item. |
| AdditionalInformation | String | False |
A rich text field for providing additional details about the development item. |
| CompletionDate | String | False |
The formatted completion date of the development item in the worker's local time zone. |
| CreatedBy_Descriptor | String | False |
A description of the person who created the development item. |
| CreatedBy_Href | String | False |
A link to the creator's Workday profile. |
| CreatedBy_Id | String | False |
The Workday ID of the person who created the development item. |
| CreatedOnDate | String | False |
The date the development item was created, formatted based on the worker's locale. |
| Descriptor | String | False |
A brief preview of the development item. |
| InReview | Bool | False |
True if the development item is locked due to being under review. |
| LastChangedDateTime | String | False |
The last modified date and time of the development item, formatted locally. |
| LastUpdatedBy_Descriptor | String | False |
A description of the person who last updated the development item. |
| LastUpdatedBy_Href | String | False |
A link to the profile of the person who last updated the development item. |
| LastUpdatedBy_Id | String | False |
The Workday ID of the last person to update the development item. |
| StartDate | String | False |
The formatted start date of the development item based on the worker’s locale. |
| StatusNote | String | False |
A text field for providing additional details on the status of the development item. |
| StatusWorkdayOwned_Descriptor | String | False |
A description of the Workday-defined status of the development item. |
| StatusWorkdayOwned_Href | String | False |
A link to the Workday-defined status instance. |
| StatusWorkdayOwned_Id | String | False |
The Workday ID for the Workday-defined status. |
| Status_Descriptor | String | False |
A description of the custom status of the development item. |
| Status_Href | String | False |
A link to the custom status instance. |
| Status_Id | String | False |
The Workday ID for the custom status. |
| TiedTo_Descriptor | String | False |
A preview of the item or entity this development item is linked to. |
| TiedTo_Id | String | False |
The Workday ID of the linked item or entity. |
| Title | String | False |
The title or name assigned to the development item. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves explicitly recorded skills for a worker that are tracked and maintained as part of their professional profile in Workday.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
skillSource: { /* a set containing no instances */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
remoteID: Text /* Remote Skill ID for associated Remote Skill Item */
skillItem: { /* Indicates the skill item name */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
skillSources: [{
dateCreated: Date /* The Creation Date of this Skill Item Source */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
sourceType: Text /* The Source Type of this Skill Item Source */
sourceTypeID: Text /* source type ID */
}]
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique Workday ID for the skill instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this skill. |
| Descriptor | String | False |
A brief preview or summary of the skill entry. |
| RemoteID | String | False |
The external system's unique identifier for the associated skill item. |
| SkillItem_Descriptor | String | False |
A description of the specific skill. |
| SkillItem_Href | String | False |
A link to the skill instance in Workday. |
| SkillItem_Id | String | False |
Unique Workday ID for the specific skill item. |
| SkillItem_RemoteID | String | False |
The external system's skill ID mapped to the Workday skill. |
| SkillItem_SkillName | String | False |
The name of the skill as returned by Workday. |
| SkillSources_Aggregate | String | False |
List of sources where the skill data originates (for example, certifications, external systems, self-entry). |
| Skills_Aggregate | String | False |
Explicit skill usages associated with the worker. |
| SkillSource_Prompt | String | False |
Filters skills by the specified skill source Workday ID. |
| Skill_Prompt | String | False |
Retrieves skills based on the specified skill name. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the results. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches sources of explicit skills, such as self-reported skills, manager endorsements, or third-party assessments, providing context for skill validation.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique Workday ID for the explicit skill instance. |
| WorkersExplicitSkills_Id [KEY] | String | False |
The Workday ID of the WorkersExplicitSkills record containing this skill. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this explicit skill. |
| DateCreated | Datetime | False |
The date this skill was added to the worker's profile. |
| Descriptor | String | False |
A brief preview or summary of the explicit skill. |
| SourceType | String | False |
The category of the skill source (for example, self-reported, manager-validated, certification). |
| SourceTypeID | String | False |
The unique identifier for the source type of this skill. |
| SkillSource_Prompt | String | False |
Filters skills by the specified skill source Workday ID. |
| Skill_Prompt | String | False |
Retrieves skills based on the specified skill name. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the results. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves externally acquired skill levels for a worker from third-party systems, certifications, or external assessments.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique Workday ID for the external skill record. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this external skill. |
| Context | String | False |
Additional details or context for this external skill record. This information is not visible to end users. |
| EffectiveMoment | Datetime | False |
The date and time when the external skill level was last updated. |
| ExternalSkillId | String | False |
The unique identifier for the skill in the external system. |
| ExternalSkillLevel | Decimal | False |
The normalized skill level, measured on a scale from 1 to 5 with one decimal place. |
| ExternalSkillName | String | False |
The name of the skill as it appears in the external system. |
| SkillVendorId | String | False |
The unique identifier for the vendor associated with this external skill. |
| SkillVendorName | String | False |
The name of the vendor providing the external skill data. |
| ExternalSkillId_Prompt | String | False |
Filters results by the specified External Skill ID, returning the associated External Skill Level. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the results. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves instances where a worker has requested feedback on their own performance from colleagues, managers, or peers.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
-feedbackResponse: [{
-descriptor: Text /* A preview of the instance */
-feedbackDeclineReason: Text /* The reason a requested feedback question was declined. */
-feedbackDeclined: Boolean /* Returns True if the responder declined to submit a response to a specific feedback question. */
-feedbackResponder: { /* The person who gave the feedback (responder). */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
-id: Text /* wid / id / reference id */
}
-id: Text /* Id of the instance */
-response: Rich Text /* The feedback response for a feedback question. */
}]
id: Text /* Id of the instance */
question: Rich Text /* The rich text part of a Question in a feedback request. */
-questionMultipleChoiceAnswers: [{
-descriptor: Text /* A preview of the instance */
-id: Text /* Id of the instance */
}]
questionType: { /* The feedback question type for requested feedback events. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
relatesTo: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the feedback request instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker associated with this feedback request. |
| BusinessProcessParameters_Action_Descriptor | String | False |
Description of the associated business process action. |
| BusinessProcessParameters_Action_Href | String | False |
A link to the associated business process action instance. |
| BusinessProcessParameters_Action_Id | String | False |
Unique identifier for the business process action instance. |
| BusinessProcessParameters_Attachments_Aggregate | String | False |
Lists attachments uploaded for this business process and accessible to the processing person. |
| BusinessProcessParameters_Comment | String | False |
Returns null. |
| BusinessProcessParameters_CriticalValidations | String | False |
Critical validation messages triggered by conditions in the business process. |
| BusinessProcessParameters_For_Descriptor | String | False |
Description of the entity for which the business process is being executed. |
| BusinessProcessParameters_For_Href | String | False |
A link to the entity related to the business process. |
| BusinessProcessParameters_For_Id | String | False |
Unique identifier of the related entity. |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | False |
Description of the overall business process associated with the feedback request. |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | False |
A link to the overall business process instance. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | False |
Unique identifier of the overall business process instance. |
| BusinessProcessParameters_OverallStatus | String | False |
Current status of the business process (for example, Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | False |
Description of the transaction status for the business process. |
| BusinessProcessParameters_TransactionStatus_Href | String | False |
A link to the transaction status instance. |
| BusinessProcessParameters_TransactionStatus_Id | String | False |
Unique identifier for the transaction status instance. |
| BusinessProcessParameters_WarningValidations | String | False |
Warning messages for an action event triggered by a condition. |
| Descriptor | String | False |
A preview of the feedback request instance. |
| ExpirationDate | Datetime | False |
The date when the feedback request expires. |
| FeedbackAbout_Descriptor | String | False |
Description of the individual or entity receiving the feedback request. |
| FeedbackAbout_Href | String | False |
A link to the individual or entity receiving feedback. |
| FeedbackAbout_Id | String | False |
Unique identifier of the feedback recipient. |
| FeedbackOverallStatus | String | False |
Current overall status of the feedback request process. |
| FeedbackPrivate | Bool | False |
Indicates whether the feedback is private between the provider and the recipient. Private feedback isn't shared with managers. |
| FeedbackQuestions_Aggregate | String | False |
List of feedback questions used in the requested feedback event. |
| FeedbackResponders_Aggregate | String | False |
List of respondents requested to provide feedback. |
| FeedbackTemplate_Descriptor | String | False |
Description of the feedback template used in this request. |
| FeedbackTemplate_Href | String | False |
A link to the feedback template instance. |
| FeedbackTemplate_Id | String | False |
Unique identifier of the feedback template instance. |
| RequestDate | Datetime | False |
The date when the feedback request was initiated. |
| ShowFeedbackProviderName | Bool | False |
Indicates whether responder names are displayed or remain anonymous. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches attachments linked to feedback requests initiated by a worker, such as self-evaluations or supporting documents.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the feedback request instance. |
| WorkersRequestedFeedbackOnSelfEvents_Id [KEY] | String | False |
The Workday ID of the feedback event requested by the worker. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback request. |
| Category_Descriptor | String | False |
Description of the feedback category. |
| Category_Href | String | False |
A link to the feedback category instance. |
| Category_Id | String | False |
Unique identifier of the feedback category. |
| ContentType_Descriptor | String | False |
Description of the content type associated with the feedback attachment. |
| ContentType_Href | String | False |
A link to the content type instance. |
| ContentType_Id | String | False |
Unique identifier of the content type instance. |
| Description | String | False |
Description of the attachment associated with the feedback request. |
| FileLength | Decimal | False |
Size of the attachment file in bytes. |
| FileName | String | False |
Name of the attached file. |
| UploadDate | Datetime | False |
Timestamp indicating when the feedback attachment was last updated. |
| UploadedBy_Descriptor | String | False |
Description of the user who uploaded the attachment. |
| UploadedBy_Href | String | False |
A link to the user who uploaded the attachment. |
| UploadedBy_Id | String | False |
Unique identifier of the user who uploaded the attachment. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Lists questions included in a worker’s self-requested feedback, enabling structured evaluation.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
-feedbackDeclineReason: Text /* The reason a requested feedback question was declined. */
-feedbackDeclined: Boolean /* Returns True if the responder declined to submit a response to a specific feedback question. */
feedbackResponder: { /* The person who gave the feedback (responder). */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
-response: Rich Text /* The feedback response for a feedback question. */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the feedback question instance. |
| WorkersRequestedFeedbackOnSelfEvents_Id [KEY] | String | False |
The Workday ID of the feedback request event initiated by the worker. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback request. |
| Descriptor | String | False |
A preview of the instance. |
| FeedbackResponse_Aggregate | String | False |
All the feedback responses associated with the feedback question. |
| Question | String | False |
The rich text content of a question in the feedback request. |
| QuestionMultipleChoiceAnswers_Aggregate | String | False |
Aggregated responses for multiple-choice questions in requested feedback events. |
| QuestionType_Descriptor | String | False |
Description of the question type used in the feedback request. |
| QuestionType_Href | String | False |
A link to the question type instance in Workday. |
| QuestionType_Id | String | False |
Unique identifier of the question type. |
| RelatesTo_Aggregate | String | False |
Talent tags associated with the feedback question or response in requested feedback events. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves details on who has responded to a worker's self-requested feedback and their responses.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance. |
| WorkersRequestedFeedbackOnSelfEvents_Id [KEY] | String | False |
The Workday ID of the feedback request event initiated by the worker. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback request. |
| Descriptor | String | False |
A preview of the instance. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves feedback requests initiated by managers or peers regarding a specific worker.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
-feedbackResponse: [{
-descriptor: Text /* A preview of the instance */
-feedbackDeclineReason: Text /* The reason a requested feedback question was declined. */
-feedbackDeclined: Boolean /* Returns True if the responder declined to submit a response to a specific feedback question. */
-feedbackResponder: { /* The person who gave the feedback (responder). */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
-id: Text /* wid / id / reference id */
}
-id: Text /* Id of the instance */
-response: Rich Text /* The feedback response for a feedback question. */
}]
id: Text /* Id of the instance */
question: Rich Text /* The rich text part of a Question in a feedback request. */
-questionMultipleChoiceAnswers: [{
-descriptor: Text /* A preview of the instance */
-id: Text /* Id of the instance */
}]
questionType: { /* The feedback question type for requested feedback events. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
relatesTo: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback request. |
| BusinessProcessParameters_Action_Descriptor | String | False |
A description of the associated business process action. |
| BusinessProcessParameters_Action_Href | String | False |
A link to the associated business process action. |
| BusinessProcessParameters_Action_Id | String | False |
Workday ID of the associated business process action. |
| BusinessProcessParameters_Attachments_Aggregate | String | False |
Attachments uploaded as part of the business process, accessible to the processing person. |
| BusinessProcessParameters_Comment | String | False |
A reserved field intended for capturing comments related to the business process. Currently, this field returns a null value as it may not be actively used or populated in the system. |
| BusinessProcessParameters_CriticalValidations | String | False |
Validation messages for action events triggered by specific conditions. |
| BusinessProcessParameters_For_Descriptor | String | False |
A description of the instance. |
| BusinessProcessParameters_For_Href | String | False |
A link to the instance. |
| BusinessProcessParameters_For_Id | String | False |
Workday ID of the instance. |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | False |
A description of the overall business process. |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | False |
A link to the overall business process. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | False |
Workday ID of the overall business process. |
| BusinessProcessParameters_OverallStatus | String | False |
The current status of the business process (for example, Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | False |
A description of the transaction status. |
| BusinessProcessParameters_TransactionStatus_Href | String | False |
A link to the transaction status. |
| BusinessProcessParameters_TransactionStatus_Id | String | False |
Workday ID of the transaction status. |
| BusinessProcessParameters_WarningValidations | String | False |
Warning messages for action events triggered by specific conditions. |
| Descriptor | String | False |
A preview of the instance. |
| ExpirationDate | Datetime | False |
The expiration date of the feedback request. |
| FeedbackAbout_Descriptor | String | False |
A description of the worker the feedback is about. |
| FeedbackAbout_Href | String | False |
A link to the worker the feedback is about. |
| FeedbackAbout_Id | String | False |
Workday ID of the worker the feedback is about. |
| FeedbackConfidential | Bool | False |
Indicates if the feedback is confidential between the provider and the manager. |
| FeedbackOverallStatus | String | False |
Overall status of the requested feedback process. |
| FeedbackQuestions_Aggregate | String | False |
The list of feedback questions included in the request. |
| FeedbackResponders_Aggregate | String | False |
The list of respondents requested to provide feedback. |
| FeedbackTemplate_Descriptor | String | False |
A description of the feedback template used. |
| FeedbackTemplate_Href | String | False |
A link to the feedback template. |
| FeedbackTemplate_Id | String | False |
Workday ID of the feedback template. |
| RequestDate | Datetime | False |
The date the feedback request was initiated. |
| ShowFeedbackProviderName | Bool | False |
Indicates if responder names should be displayed or remain anonymous. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
Includes terminated workers in the output if set to true. |
| Search_Prompt | String | False |
Allows searching for workers by name or Workday ID (case-insensitive, supports space-separated OR searches). |
Fetches attachments related to feedback requests initiated by managers or peers for a worker.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance. |
| WorkersRequestedFeedbackOnWorkerEvents_Id [KEY] | String | False |
The Workday ID of the WorkersRequestedFeedbackOnWorkerEvents that contains this instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this instance. |
| Category_Descriptor | String | False |
A description of the feedback category. |
| Category_Href | String | False |
A link to the feedback category. |
| Category_Id | String | False |
Workday ID of the feedback category. |
| ContentType_Descriptor | String | False |
A description of the content type. |
| ContentType_Href | String | False |
A link to the content type. |
| ContentType_Id | String | False |
Workday ID of the content type. |
| Description | String | False |
Description of the event attachment. |
| FileLength | Decimal | False |
Size of the attachment file in bytes. |
| FileName | String | False |
The name of the attached file. |
| UploadDate | Datetime | False |
The date and time when the business process attachment was uploaded. |
| UploadedBy_Descriptor | String | False |
A description of the person who uploaded the attachment. |
| UploadedBy_Href | String | False |
A link to the uploader's profile. |
| UploadedBy_Id | String | False |
Workday ID of the uploader. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Lists evaluation questions used in peer or manager-initiated feedback for a worker.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
-feedbackDeclineReason: Text /* The reason a requested feedback question was declined. */
-feedbackDeclined: Boolean /* Returns True if the responder declined to submit a response to a specific feedback question. */
feedbackResponder: { /* The person who gave the feedback (responder). */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
-response: Rich Text /* The feedback response for a feedback question. */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the feedback question instance. |
| WorkersRequestedFeedbackOnWorkerEvents_Id [KEY] | String | False |
The Workday ID of the feedback event associated with this question. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback event. |
| Descriptor | String | False |
A preview of the feedback question instance. |
| FeedbackResponse_Aggregate | String | False |
All responses provided for this feedback question. |
| Question | String | False |
The text content of the feedback question. |
| QuestionMultipleChoiceAnswers_Aggregate | String | False |
Available multiple-choice answers for this feedback question. |
| QuestionType_Descriptor | String | False |
A description of the type of question in the feedback request. |
| QuestionType_Href | String | False |
A link to details about the question type. |
| QuestionType_Id | String | False |
The Workday ID/reference ID of the question type. |
| RelatesTo_Aggregate | String | False |
Talent tags or categories associated with the feedback question or responses. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Search workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a list of individuals who provided feedback in response to a manager or peer request regarding a worker.
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the feedback event instance. |
| WorkersRequestedFeedbackOnWorkerEvents_Id [KEY] | String | False |
The Workday ID of the feedback event associated with this instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this feedback event. |
| Descriptor | String | False |
A brief preview or summary of the feedback event instance. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the search results. |
| Search_Prompt | String | False |
Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Lists skill items associated with a worker, including validated competencies and self-reported skills.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
remoteID: Text /* The remote skill ID of a skill. */
skillItem: {
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
skillName: Text /* The skill name that Workday bases similar skill suggestions on. */
}]
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier for the instance. |
| Workers_Id [KEY] | String | False |
The Workday ID of the worker who owns this record. |
| Descriptor | String | False |
A preview of the instance. |
| RemoteID | String | False |
The remote skill ID of a skill. |
| SkillItems_Aggregate | String | False |
Lists skill items associated with a skill qualification. |
| SkillName | String | False |
The skill name used by Workday for generating similar skill suggestions. |
| IncludeTerminatedWorkers_Prompt | Bool | False |
If true, includes terminated workers in the output. |
| Search_Prompt | String | False |
Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
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 | Contains structured data about academic calendars, including term dates, session periods, and institutional scheduling rules. This table is essential for academic planning, enrollment processing, and compliance tracking, and it ensures accurate timeframes for course scheduling, financial aid eligibility, faculty workload distribution, and student records management. |
| AcademicCalendarsAcademicYears | Stores associations between academic calendars and their respective academic years, enabling structured time period management for institutional planning. This table ensures that term-based activities such as admissions, enrollment, tuition calculations, and graduation requirements align with defined academic cycles. |
| AcademicCalendarsPeriodTypes | Defines period types within academic calendars, categorizing different time segments such as terms, semesters, or quarters to facilitate scheduling, financial aid disbursement, and regulatory reporting requirements. |
| AcademicLevels | Contains academic-level classifications such as undergraduate, graduate, doctoral, and continuing education. These classifications define program eligibility, tuition rates, student progression criteria, and degree tracking requirements. |
| AcademicPeriods | Stores data about specific academic periods, including start and end dates, session types, and associated academic calendars. This table supports institutional operations such as registration windows, course scheduling, student billing, and compliance with accreditation requirements. |
| AcademicPeriodsPeriodUsages | Defines how academic periods are used within the institution, supporting functions such as enrollment eligibility, tuition calculation structures, academic standing assessments, and financial aid disbursement schedules. |
| AcademicPeriodsPeriodWeights | Maintains weightage information for academic periods, influencing calculations such as GPA weighting, credit hour distribution, academic progress tracking, and degree audit evaluations. |
| AcademicUnits | Represents academic units such as colleges, departments, or schools, facilitating administrative management, faculty assignments, financial planning, accreditation reporting, and governance structures. |
| AcademicUnitsLevels | Stores hierarchical relationships between academic units and academic levels. This table defines how different units contribute to institutional organization, program offerings, curriculum development, and student advising structures. |
| AcademicUnitsRelatedSupervisoryOrganizations | Links academic units to their related supervisory organizations. This table supports workflow approvals, reporting hierarchies, budget allocations, and faculty management within an institution. |
| AcademicUnitsSubordinates | Tracks subordinate relationships within academic units. These relationships define structural dependencies between departments, divisions, and other academic entities for budgeting, reporting, and governance purposes. |
| ActiveTasks | Maintains records of currently active tasks within the system. This table tracks user activities, pending operations, and workflow progress to support task management, workload distribution, and process automation. |
| ActiveUserSessions | Stores details about active user sessions, including login status, session duration, and user activity tracking, supporting security monitoring, access control enforcement, and system performance analysis. |
| ActivityLogging | Captures user activity logs within a specified time frame, enabling auditing, compliance tracking, troubleshooting, security monitoring, and forensic analysis of system interactions. |
| AdHocProjectTimeTransactionsWorktags | Associates worktags with ad hoc project-time transactions. This table enables classification of project time entries based on cost centers, grants, funding sources, project phases, and billing codes. |
| ArticleStatuses | Maintains a list of statuses for article versions, tracking publication states such as draft, approved, or archived. This list ensures proper content governance, knowledge management, and compliance with organizational publishing policies. |
| ArticleVersions | Stores historical versions of articles, preserving content revisions for auditability, compliance tracking, knowledge retention, and rollback capabilities in case of incorrect updates. |
| ArticleVersionsAudience | Defines audience segments for specific article versions. This table controls visibility and access based on user roles, departmental restrictions, or organizational hierarchy to ensure proper content dissemination. |
| ArticleVersionsCreatedByWorker | Logs the worker who is responsible for creating specific article versions. This table supports content ownership tracking, version accountability, and editorial oversight. |
| ArticleVersionsLastUpdatedByWorker | Tracks the worker who last updated an article version. This table ensures transparency in content modifications, change history tracking, and quality assurance in knowledge management systems. |
| ArticleVersionsTags | Associates keyword tags with article versions. This table enhances searchability, categorization, and metadata enrichment for improved information retrieval and content discovery. |
| AudiencePromptGroupAudienceTypeValues | Usage information for the operation AudiencePromptGroupAudienceTypeValues.rsd. |
| AudiencePromptGroupSelectionValues | Usage information for the operation AudiencePromptGroupSelectionValues.rsd. |
| Balances | Stores balance information for all absence-plan and leave-of-absence types. This table enables tracking of employee entitlements, accruals, and remaining leave balances for payroll processing and compliance with leave policies. |
| BillableTransactionsBillingRateApplication | Maintains a collection of billing rate applications that are linked to specific billable transactions. This table ensures accurate application of rate structures, adjustments, and contractual billing terms. |
| BusinessProcessTypes | Stores metadata about different business process types within the system. This table includes approval workflows, task sequences, and compliance-related processes that govern enterprise operations. |
| BusinessProcessTypesAttachmentCategories | Defines allowed attachment categories for each business process type. This table ensures proper documentation management, regulatory compliance, and reference material linkage. |
| BusinessTitleChanges | Tracks instances of business-title changes for employees. This table captures historical data on role adjustments, promotions, and organizational restructuring for reporting and compliance. |
| CasesSatisfactionSurveyResultsQuestionnaireResponseQuestionAnswerPair | Stores questionnaire response-and-answer pairings from satisfaction surveys that are associated with cases. This table facilitates sentiment analysis, service quality assessment, and operational improvements. |
| CasesTimelineActions | Tracks specific actions taken within a case timeline. This table captures operational workflows, resolution steps, and decision-making history for compliance and service monitoring. |
| CasesTimelineGuidanceKbArticleCurrentArticleData | Links knowledge-base article data to case timelines. This table enables agents and users to access relevant guidance materials and best practices for case resolution. |
| CasesTimelineQuestionnaireResponseQuestionAnswerPair | Records responses to questionnaires that are embedded in case timelines. This table enables structured data collection, survey analytics, and process optimization. |
| CaseSuggestions | Generates a list of suggested cases based on the case type. This table uses historical data, user behavior, and system intelligence to improve case-resolution efficiency. |
| CaseTypes | Stores definitions of different case types that are available to a worker. This table facilitates categorization of requests, issue tracking, and workflow automation. |
| CaseTypesExternalLink | Maintains external links associated with case types. This table provides users with quick access to related policies, third-party documentation, or supplementary resources. |
| ClientDetails | Stores OAuth client authentication details for OCFR clients. This table ensures secure access, identity validation, and compliance with API security protocols. |
| CommonAudiencesValues | Contains predefined audience segment values. This table supportstargeted communications, access control configurations, and data filtering for different business needs. |
| CommonCompaniesValues | Stores a list of predefined company values. This table enables standardization in reporting, financial transactions, and business entity relationships. |
| CommonCountriesValues | Maintains a list of recognized country values that are used for location-based configurations, global compliance tracking, and regional business operations. |
| CommonCurrenciesValues | Contains a standardized list of currency values. This table ensures consistency in financial transactions, exchange rate applications, and multi-currency reporting. |
| CommonCustomersValues | Stores customer-related values. This table enables structured customer categorization, customer relationship management (CRM) integrations, and sales process standardization. |
| CommonGroupsValues | Defines standard group values that are used across the system. This table supports team structures, role-based access controls, and organizational unit classifications. |
| CommonHierarchiesValues | Maintains predefined hierarchical structures that are used in organizational reporting, management workflows, and data aggregation across business units. |
| CommonImportanceRatingsValues | Contains predefined importance rating values. This table enables prioritization of tasks, cases, risks, and business decisions within workflows. |
| CommonOptionalHierarchiesValues | Stores optional hierarchy values that are used for structuring flexible organizational models, financial roll-ups, and reporting structures. |
| CommonOwnersValues | Tracks predefined owner values that are used for data ownership assignment, accountability tracking, and workflow approval structures. |
| CommonPhoneCountryPhoneCodesValues | Stores a list of country phone codes. This table supports global telecommunication standards, contact validation, and regional calling rules. |
| CommonPhonePhoneDeviceTypesValues | Defines phone-device type values (for example, mobile, landline, and VoIP). This table ensures proper classification and validation of contact information. |
| CommonPrioritiesValues | Contains predefined priority values for tasks, cases, and workflows. This table enables structured triage, service level agreement (SLA) enforcement, and workload management. |
| CommonProjectDependenciesValues | Stores predefined project dependency values. This table facilitates project management, task sequencing, and impact analysis across multiple initiatives. |
| CommonProjectStatesValues | Stores predefined project state values. This table allows categorization of project progress such as 'Planned,' 'In Progress,' or 'Completed' for reporting and tracking. |
| CommonProjectsValues | Contains a list of standardized project values. This table supports project categorization, financial tracking, and portfolio management. |
| CommonRiskLevelsValues | Defines standardized risk-level values. This table enables risk assessment, compliance tracking, and decision-making in business processes. |
| CommonStatusesValues | Maintains predefined status values used across different workflows. This table ensures consistency in tracking task, case, or project progression. |
| CommonSuccessRatingsValues | Stores predefined success rating values that are used in performance evaluations, project assessments, and business process effectiveness analysis. |
| CommonWorktagsValues | Contains a list of worktags that are used for financial and operational tagging. This table enables classification of transactions, expenses, and projects. |
| CommonWorktagTypesValues | Defines types of worktags that are available within the system. This table ensures standardized categorization for cost allocation, reporting, and business segmentation. |
| Configuration | Retrieves tenant setup configurations that are related to Help Case Management. This table enables administrators to customize and control case handling processes. |
| ContractComplianceGroupCompaniesOrHierarchiesValues | Maintains compliance-related groupings of companies or hierarchical structures. This table ensures regulatory adherence and contract governance. |
| ContractComplianceGroupContractTypesValues | Stores predefined contract type groupings for compliance management. This table supports contract lifecycle tracking and legal adherence. |
| Countries | Retrieves standardized information about countries, including country codes, regional groupings, and regulatory requirements for global operations. |
| CountriesAddressComponents | Defines allowed address components and their configurations for each country. This table ensures accurate address validation and formatting compliance. |
| CountriesNameComponents | Maintains name component configurations for different countries. This table ensures proper formatting of personal and business names based on regional conventions. |
| CountryComponentsCountryCityValues | Contains predefined values for country-city relationships. This table supports regional mapping, tax jurisdiction tracking, and location-based services. |
| CountryComponentsCountryRegionValues | Defines country-region associations. This table ensures accurate mapping of administrative divisions such as states, provinces, and territories. |
| CountryComponentsCountryValues | Stores predefined country values. This table facilitates standardization in international transactions, compliance reporting, and address verification. |
| Courses | Contains details about individual courses, including course descriptions, credits, prerequisites, and availability for academic offerings. |
| CoursesAcademicUnits | Links courses to their respective academic units. This table supports departmental ownership, program alignment, and reporting on course distribution. |
| CoursesAllowedLocations | Defines the locations where a course is permitted to be offered. This table ensures compliance with institutional policies and facility availability. |
| CoursesCompetencies | Associates courses with specific competencies. This table enables skills-based learning assessments and alignment with certification requirements. |
| CourseSections | Contains records of course sections, including scheduling details, instructor assignments, and enrolled student counts. |
| CourseSectionsCampusLocations | Defines campus locations where specific course sections are held. This table supports logistical planning and facility management. |
| CourseSectionsCompetencies | Links course sections to associated competencies. This table tracks how individual sections contribute to competency-based education outcomes. |
| CourseSectionsComponents | Stores details about course section components, such as lectures, labs, and discussion groups. This table ensures complete scheduling and workload tracking. |
| CourseSectionsInstuctors | Maintains instructor assignments for course sections. This table tracks faculty workload, teaching responsibilities, and student-instructor interactions. |
| CourseSectionsLearningOutcomes | Links course sections to expected learning outcomes. This table ensures alignment with accreditation standards and student assessment metrics. |
| CourseSectionsOfferingAcademicUnits | Associates course sections with the academic units that offer them. This table supports departmental resource allocation and reporting. |
| CourseSectionsTags | Stores keyword tags for course sections. This table enhances searchability and categorization for curriculum management. |
| CoursesInstructionalFormats | Defines instructional formats for courses, such as online, in-person, or hybrid. This table supports flexible course-delivery models. |
| CoursesLearningOutcomes | Stores learning outcomes that are associated with courses. This table ensures program objectives align with educational goals and accreditation requirements. |
| CoursesTags | Contains keyword tags for courses. This table enables categorization and search optimization within course catalogs. |
| CoursesTypicalPeriodsOffered | Tracks typical periods in which courses are offered. This table supports scheduling, academic planning, and enrollment forecasting. |
| CourseSubjects | Stores academic subjects, categorizing courses into subject areas for curriculum organization and program structuring. |
| CourseSubjectsInstitutionalAcademicUnits | Links course subjects to institutional academic units. This table ensures proper curriculum governance and reporting alignment. |
| Currencies | Maintains details about all currencies in the tenant, including currency codes, exchange rate configurations, and regional applicability. |
| Customers | Contains customer profile data, including contact details, purchase history, and account preferences for business operations and CRM integrations. |
| CustomersActivities | Tracks activities that are associated with customers, such as transactions, interactions, and engagement metrics. This table supports customer relationship management. |
| CustomersGroups | Associates customers with predefined groups. This table enables segmentation for targeted marketing, account management, and service-level differentiation. |
| DataSources | Provides access to data sources and their associated primary business objects within Workday, facilitating the execution of Workday Query Language (WQL) queries. This table allows users to extract structured data for reporting and analysis. |
| DataSourcesDataSourceFilters | Contains filter criteria for data sources, allowing users to retrieve specific subsets of data based on predefined conditions. |
| DataSourcesDataSourceFiltersOptionalParameters | Stores optional filter parameters for data sources, providing additional flexibility when querying specific datasets. This table enables customization of data retrieval conditions. |
| DataSourcesDataSourceFiltersRequiredParameters | Maintains required parameters for data source filters, ensuring the necessary criteria are met when querying data. This table defines the mandatory conditions for filtering data sources effectively. |
| DataSourcesFields | Lists available fields within data sources, along with their associated business objects. Users can retrieve detailed metadata about each field, including access control restrictions based on security settings. |
| DataSourcesOptionalParameters | Contains optional parameters applicable to data sources, allowing users to refine queries and customize data retrieval criteria. These parameters provide additional flexibility in reporting. |
| DataSourcesRequiredParameters | Stores required parameters for data sources, defining essential constraints that must be met when retrieving data from Workday's database. These parameters enforce structured query execution. |
| EducationalCredentials | Maintains records of educational qualifications, including degrees, certifications, and academic achievements, for workers within Workday. This table is used for background verification and workforce planning. |
| EffectiveChangesRequestCriteriaFieldsOnlyInclude | Stores specific field-based inclusion criteria for filtering effective change data, enabling users to retrieve only the most relevant updates based on predefined conditions. |
| EffectiveChangesRequestCriteriaWorkers | Defines worker-based filtering criteria for effective change data, enabling targeted retrieval of employee updates based on predefined selection parameters. |
| EvaluateAccountPostingRules | Retrieves details about ledger accounts and their associated worktags based on predefined account posting rules, ensuring accurate financial tracking and reporting. |
| EvaluateAccountPostingRulesResultingWorktags | Stores resulting worktags derived from evaluated account posting rules, linking financial transactions to specific business dimensions for precise reporting. |
| Events | Tracks business process events within Workday, including key workflows, approvals, and operational milestones, providing a comprehensive audit trail of activities. |
| EventsAttachments | Contains document and file attachments associated with business process events, enabling users to access supporting documentation directly within Workday workflows. |
| EventsComments | Stores user comments linked to business process events, facilitating collaboration and decision-making through contextual feedback. |
| EventsCompletedSteps | Logs completed steps within business process events, ensuring visibility into workflow progress and operational status tracking. |
| EventsCompletedStepsAwaitingPersons | Tracks individuals awaiting specific actions within completed business process steps, helping manage task assignments and approvals. |
| EventsCompletedStepsComments | Stores comments related to completed business process steps, providing insights into workflow decisions and rationale. |
| EventsInProgressSteps | Monitors ongoing steps within business process events, allowing users to track in-progress activities and pending actions. |
| EventsInProgressStepsAwaitingPersons | Identifies persons awaiting responses or approvals in active business process steps, enhancing workflow transparency. |
| EventsRemainingSteps | Lists outstanding steps for business process events, helping users prioritize and complete pending tasks. |
| EventsRemainingStepsGroups | Categorizes remaining business process steps into groups for better organization and process tracking. |
| EventsSubBusinessProcesses | Tracks sub-processes within business process events, offering a hierarchical view of dependent workflows. |
| EventSteps | Stores detailed information about individual steps in business process events, including assigned users, timestamps, and completion status. |
| EventStepsAwaitingPersons | Identifies individuals responsible for pending actions in event steps, ensuring accountability in process execution. |
| EventStepsComments | Logs comments for business process event steps, providing context and justification for actions taken. |
| ExpenseItems | Contains detailed information about individual expense items, including descriptions, categories, amounts, and associated metadata for financial tracking and reporting. |
| ExternalRecordsSourceValues | Stores source reference data for externally linked records, providing context and traceability for integrations and data imports. |
| FeedbackBadges | Manages a collection of active feedback badges available in the system, which can be awarded to employees for recognition and performance evaluations. |
| FeedbackOnWorkerFeedbackOnWorkerValues | Contains feedback records provided for specific workers, including details about performance, strengths, and areas for improvement. |
| FeedbackResponderFeedbackResponderValues | Stores information about individuals who respond to feedback requests, ensuring traceability and accountability in feedback collection. |
| FeedbackTemplateFeedbackTemplateValues | Maintains predefined feedback templates used for performance reviews and employee evaluations, ensuring consistency in feedback collection. |
| GiveRequestedFeedbackEventsBusinessProcessParametersComments | Stores comments added during the feedback process within a business workflow, providing context and additional insights for evaluations. |
| HolidayEvents | Stores information about company holidays and scheduled non-working days, used for workforce planning and payroll adjustments. |
| Interviews | Holds records of scheduled interviews, including candidate details, interview stages, and scheduled time slots. |
| InterviewsInterviewers | Lists interviewers assigned to an interview session, providing accountability and visibility into the recruitment process. |
| InterviewsInterviewStatuses | Tracks the status of interviews, including scheduled, completed, canceled, and rescheduled interviews. |
| InterviewsJobRequisitionPrimaryRecruiters | Links primary recruiters responsible for job requisitions associated with interview events, maintaining recruiter accountability. |
| InterviewsJobRequisitionRecruiters | Stores additional recruiter assignments for job requisitions linked to interviews, ensuring visibility of all involved hiring personnel. |
| InterviewsWorkersPendingFeedback | Lists employees awaiting interview feedback, ensuring timely evaluation and completion of interview assessments. |
| Invoices | Manages customer invoices and adjustments, tracking details such as amounts, due dates, and payment statuses. |
| InvoicesDisputeReasons | Stores dispute reasons associated with customer invoices, supporting resolution processes for billing discrepancies. |
| InvoicesPrintRuns | Tracks invoice print run instances, recording batch printing events for customer invoices. |
| InvoicesPrintRunsDeliveryMethod | Maintains records of delivery methods used in invoice print runs, including email, postal mail, and digital distribution. |
| InvoicesRelatedAdjustments | Links related adjustments to customer invoices, detailing modifications, credits, and refunds applied to billing records. |
| JobChangeReasons | Retrieves a list of job change reasons, including promotions, transfers, and other employment status changes. |
| JobChangesGroupAssignmentTypesValues | Retrieves available assignment types applicable to job changes, such as full-time, part-time, or contract roles. |
| JobChangesGroupCompanyInsiderTypesValues | Lists company insider types relevant to job changes, helping to classify roles with specific regulatory considerations. |
| JobChangesGroupContingentWorkerTypesValues | Provides available contingent worker types, including temporary and contract employees, for job change processing. |
| JobChangesGroupCurrenciesValues | Retrieves available currency options applicable to job changes, ensuring correct financial calculations in compensation changes. |
| JobChangesGroupEmployeeTypesValues | Lists various employee types, such as salaried, hourly, and contractor, available for job change operations. |
| JobChangesGroupFrequenciesValues | Provides available pay frequency options for job changes, including weekly, bi-weekly, and monthly payroll schedules. |
| JobChangesGroupHeadcountOptionsValues | Retrieves headcount-related options relevant to job changes, aiding workforce planning and reporting. |
| JobChangesGroupJobClassificationsValues | Lists available job classifications used in job change records, ensuring proper categorization within the organization. |
| JobChangesGroupJobProfilesValues | Retrieves predefined job profiles applicable to job changes, including job descriptions, responsibilities, and required qualifications. |
| JobChangesGroupJobRequisitionsValues | Provides available job requisitions for job changes, linking open job postings with internal role changes. |
| JobChangesGroupJobsValues | Lists job positions associated with job changes, supporting internal mobility and organizational structure updates. |
| JobChangesGroupLocationsValues | Retrieves location options applicable to job changes, ensuring updates align with geographical employment policies. |
| JobChangesGroupPayRateTypesValues | Lists pay rate types available for job changes, including hourly, salaried, and commission-based structures. |
| JobChangesGroupProposedPositionValues | Retrieves proposed positions linked to job changes, supporting internal promotions and transfers. |
| JobChangesGroupReasonValues | Lists available reasons for job changes, such as promotions, department transfers, or policy-driven updates. |
| JobChangesGroupSupervisoryOrganizationValues | Retrieves supervisory organization structures applicable to job changes, ensuring correct reporting relationships. |
| JobChangesGroupTemplatesValues | Lists predefined job change templates that standardize employment updates for various scenarios. |
| JobChangesGroupTimeTypesValues | Provides available time types, such as full-time and part-time, relevant to job change operations. |
| JobChangesGroupWorkersCompensationCodeOverridesValues | Lists workers' compensation codes applicable to job changes, ensuring accurate legal and insurance reporting. |
| JobChangesGroupWorkersValues | Retrieves worker records associated with job changes, supporting employment status modifications. |
| JobChangesGroupWorkerTypesValues | Lists worker types relevant to job changes, including contractors, employees, and interns. |
| JobChangesGroupWorkShiftsValues | Retrieves available work shift options for job changes, ensuring scheduling and workforce alignment. |
| JobChangesGroupWorkSpacesValues | Lists workspace assignments applicable to job changes, helping manage seating arrangements and facility allocations. |
| JobChangesGroupWorkStudyAwardsValues | Retrieves work-study award details relevant to job changes, ensuring compliance with academic employment regulations. |
| JobFamilies | Retrieves a collection of job families, grouping related job roles based on function or discipline. |
| JobFamiliesJobProfiles | Lists job profiles associated with job families, providing insight into role groupings and career paths. |
| JobPostings | Retrieves a list of active job postings, including available positions and recruitment details. |
| JobPostingsAdditionalLocations | Retrieves additional job location details linked to job postings, supporting multi-site hiring processes. |
| JobPostingsCategories | Lists job categories associated with job postings, classifying roles based on industry, department, or function. |
| JobProfiles | Retrieves a comprehensive list of job profiles, including descriptions, responsibilities, and required qualifications. |
| JobProfilesCompanyInsiderTypes | Lists company insider classifications associated with job profiles, ensuring compliance with regulatory requirements. |
| JobProfilesJobExempts | Retrieves exemption status details for job profiles, helping manage FLSA and other labor law classifications. |
| JobProfilesJobFamilies | Lists job families associated with job profiles, supporting structured career path planning. |
| JobProfilesPayRateTypes | Retrieves pay rate types applicable to job profiles, including salary, hourly, and commission-based structures. |
| JobProfilesRestrictedToCountries | Lists countries where specific job profiles are restricted, ensuring compliance with local employment laws. |
| JobProfilesWorkersCompensationCodes | Retrieves workers' compensation codes linked to job profiles, ensuring compliance with legal and insurance requirements. |
| Jobs | Retrieves a list of jobs available within the organization, including details on responsibilities and reporting structures. |
| JobsPayGroup | Retrieves pay group details associated with a job, determining salary and payroll processing rules. |
| JobsPayGroupPayGroupDetails | Retrieves detailed pay group settings related to jobs, ensuring correct payroll categorization and processing. |
| JobsWorkspace | Retrieves workspace assignments for a given job, managing physical office locations and seating arrangements. |
| LeaveStatusValues | Lists available leave status options, including approved, pending, and denied requests. |
| Mentorships | Retrieves details on mentorship programs and participant assignments within the organization. |
| NameComponentsAcademicValues | Lists available academic-related name components, such as degrees and academic titles. |
| NameComponentsHereditaryValues | Retrieves hereditary name components, such as generational suffixes used in official records. |
| NameComponentsHonoraryValues | Lists honorary title values, including distinguished recognitions like 'Sir' or 'Dame.' |
| NameComponentsProfessionalValues | Retrieves professional name components, such as certifications or licensure designations. |
| NameComponentsReligiousValues | Lists religious title values, including designations like 'Reverend' or 'Rabbi.' |
| NameComponentsRoyalValues | Retrieves royal title values, such as 'King' or 'Queen,' used in official name records. |
| NameComponentsSalutationValues | Lists available salutations, such as 'Mr.,' 'Ms.,' and 'Dr.,' for use in formal communications. |
| NameComponentsSocialValues | Retrieves social title values, including informal name components used in cultural contexts. |
| NameComponentsTitleValues | Lists all available name title components, including professional, academic, and social titles. |
| NotificationTypes | Retrieves a list of notification types used for system-generated alerts and messages. |
| OrganizationAssignmentChangesGroupBusinessUnitsValues | Lists available business unit options applicable to organization assignment changes. |
| OrganizationAssignmentChangesGroupCompaniesValues | Retrieves a list of company options relevant to organization assignment changes. |
| OrganizationAssignmentChangesGroupCostCentersValues | Lists available cost centers for organization assignment changes, aiding financial structuring. |
| OrganizationAssignmentChangesGroupCustomsValues | Lists available custom organization values applicable to organization assignment changes. |
| OrganizationAssignmentChangesGroupFundsValues | Retrieves fund details associated with organization assignment changes, supporting grant and budget tracking. |
| OrganizationAssignmentChangesGroupGiftsValues | Lists available gift-related organization values relevant to assignment changes, ensuring proper allocation. |
| OrganizationAssignmentChangesGroupGrantsValues | Retrieves grant-related details associated with organization assignment changes, aiding financial management. |
| OrganizationAssignmentChangesGroupJobsValues | Lists job options applicable to organization assignment changes, supporting workforce planning. |
| OrganizationAssignmentChangesGroupPositionsValues | Retrieves a list of available positions linked to organization assignment changes. |
| OrganizationAssignmentChangesGroupProgramsValues | Lists available program assignments related to organization assignment changes. |
| OrganizationAssignmentChangesGroupRegionsValues | Retrieves a list of region options relevant to organization assignment changes, ensuring compliance with geographic policies. |
| OrganizationAssignmentChangesGroupWorkersValues | Lists worker values applicable to organization assignment changes, ensuring accurate employee tracking. |
| Organizations | Retrieves a collection of organizational entities, including departments, business units, and cost centers. |
| OrganizationTypes | Retrieves a list of organization types, categorizing entities based on function, structure, or legal status. |
| PayGroupDetails | Provides detailed information on a specific pay group, including attributes such as pay frequency, country, and associated payroll policies. |
| PayGroupDetailsPayRunGroup | Links the pay group details with pay run group data, ensuring accurate processing of payroll across defined pay cycles. |
| PayGroups | Stores and retrieves structured data related to payroll groups, including identification, eligibility rules, and payment processing settings. |
| PayGroupsPayGroupDetails | Establishes relationships between pay groups and their respective pay group details, enabling efficient organization and retrieval of payroll group data. |
| PayrollInputsGroupPayComponentsValues | Aggregates and organizes pay component values for payroll input groups, ensuring accurate payroll calculations based on earnings, bonuses, and deductions. |
| PayrollInputsGroupPositionsValues | Maintains position-related payroll inputs, providing insight into pay details associated with specific job roles within an organization. |
| PayrollInputsGroupRunCategoriesValues | Defines and categorizes payroll input groups based on run categories, allowing flexible payroll processing configurations. |
| PayrollInputsGroupWorktagsValues | Manages worktag-based payroll input groups, facilitating tracking and allocation of payroll costs to specific projects, grants, or departments. |
| People | Represents individual employee or worker records within the Workday system, capturing essential personal and employment-related details. |
| PeopleAdditionalNames | Stores alternate names or aliases associated with a person, ensuring accurate name recognition for internal records and compliance purposes. |
| PeopleAudioNamePronunciation | Contains audio recordings of name pronunciations, supporting accessibility and correct name articulation in workplace interactions. |
| PeopleHomeAddresses | Maintains residential address details for individuals, facilitating accurate communication and legal documentation. |
| PeopleHomeAddressesUsageUsedFor | Tracks usage and purpose classifications for home addresses, defining contexts in which the stored address information is utilized. |
| PeopleHomeEmails | Stores and retrieves personal email addresses for employees and workers, ensuring effective communication outside of work-related channels. |
| PeopleHomeEmailsUsageUsedFor | Defines the usage classification for home email addresses, ensuring clarity on when and how these emails are referenced. |
| PeopleHomeInstantMessengers | Captures personal instant messaging account details, supporting flexible communication options beyond traditional email and phone. |
| PeopleHomeInstantMessengersUsageUsedFor | Establishes usage classifications for personal instant messenger accounts, ensuring clarity in work and non-work communication policies. |
| PeopleHomePhones | Maintains personal contact numbers for individuals, ensuring up-to-date records for emergency contacts and personal outreach. |
| PeopleHomePhonesUsageUsedFor | Defines the intended usage of personal phone numbers, specifying contexts where they are referenced or required. |
| PeopleHomeWebAddresses | Stores personal website URLs associated with an individual, allowing records of professional or social web presence. |
| PeopleHomeWebAddressesUsageUsedFor | Categorizes the usage of stored home web addresses, defining their relevance within the organization. |
| PeopleLegalName | Captures official legal name records, ensuring compliance with regulatory and identification requirements. |
| PeoplePersonalInformation | Stores various personal attributes of an individual, such as birthdate, gender, marital status, and nationality, for Human Resources (HR) and compliance purposes. |
| PeoplePhotos | Manages employee profile pictures and identification images, supporting security, recognition, and workplace directories. |
| PeoplePreferredName | Stores the person's preferred name, which can differ from their legal name, ensuring inclusivity and personalization in workplace interactions. |
| PeoplePublicContactInformation | Tracks publicly accessible contact details for employees or workers, supporting professional networking and corporate directories. |
| PeopleWorkAddresses | Captures and retrieves work location details for employees, supporting accurate office assignments and logistical planning. |
| PeopleWorkAddressesUsageUsedFor | Classifies the intended usage of work addresses, defining their function within HR and organizational processes. |
| PeopleWorkEmails | Stores professional email addresses assigned to employees, ensuring secure and official work-related communication. |
| PeopleWorkEmailsUsageUsedFor | Defines usage contexts for work email addresses, distinguishing them from personal or external email use cases. |
| PeopleWorkInstantMessengers | Manages work-related instant messaging account details, enabling internal communication through designated corporate messaging platforms. |
| PeopleWorkInstantMessengersUsageUsedFor | Retrieves information about how work-related instant messenger accounts are utilized within the organization, providing context on their specific usage and communication purposes. |
| PeopleWorkPhones | Stores and retrieves work phone numbers associated with employees, enabling contact tracking and communication within the system. |
| PeopleWorkPhonesUsageUsedFor | Extracts details on how work phone numbers are utilized within the organization, offering insights into their assigned purposes and communication workflows. |
| PeopleWorkWebAddresses | Maintains and retrieves work-related web addresses linked to employees, such as corporate websites or personal work profiles, for streamlined access to online resources. |
| PeopleWorkWebAddressesUsageUsedFor | Identifies and retrieves data on the designated use cases of work-related web addresses, ensuring proper classification of online resources. |
| PersonalInformationCountryAllowedCountryValues | Retrieves the list of countries that are permitted for use in personal information records, ensuring compliance with organizational and regulatory policies. |
| PersonalInformationCountryPopulatedCountryValues | Fetches the list of countries currently represented in the system based on existing personal information records, supporting analytics and reporting needs. |
| ProgramsOfStudy | Holds records of educational programs offered within the organization or institution, allowing retrieval of program details based on unique ID. |
| ProgramsOfStudyEducationalCredentials | Links educational credentials with programs of study, enabling retrieval of relevant degrees, certifications, or qualifications associated with each program. |
| ProjectPlanProjectPhasesValues | Stores predefined values related to different project plan phases, ensuring consistency in project phase classification and reporting. |
| ProjectPlanProjectPlanPhasesValues | Captures standard values associated with project plan phases, supporting structured project planning and tracking. |
| ProjectPlanProjectPlanTasksValues | Maintains predefined task values related to project plans, facilitating consistency in task categorization and workflow automation. |
| ProjectPlanProjectTasksValues | Contains structured data on predefined project task values, improving reporting accuracy and project task standardization. |
| PurchaseOrders | Stores and retrieves purchase order details, including supplier information, order amounts, and transaction records. |
| PurchaseOrdersBillToAddress | Maintains billing address details associated with purchase orders, ensuring accurate invoicing and financial processing. |
| PurchaseOrdersGoodsLines | Stores detailed line items for goods included in purchase orders, providing transparency into ordered products, quantities, and costs. |
| PurchaseOrdersProjectBasedServiceLines | Tracks service lines within project-based purchase orders, detailing services procured in connection with specific projects. |
| PurchaseOrdersServiceLines | Maintains records of service-based line items in purchase orders, supporting procurement tracking and contract management. |
| PurchaseOrdersTaxCodes | Stores tax codes applicable to purchase orders, ensuring correct tax calculations and compliance with financial regulations. |
| RelatesToRelatesToValues | Stores relationships between various entities in the system to support data linking. |
| RequestsQuestionnaireResponsesSurveyTarget | Tracks the survey targets linked to questionnaire responses in request records. |
| RequestTypes | Stores and categorizes different types of requests available in the system. |
| RequestTypesAllowedRequestResolutions | Defines the allowed resolution types for specific request categories. |
| RequisitionsGroupCommodityCodesValues | Associates commodity codes with requisitions for classification and reporting. |
| RequisitionsGroupCompaniesValues | Links requisitions to companies for organizational tracking. |
| RequisitionsGroupCurrenciesValues | Tracks the currencies used in grouped requisitions for international purchases. |
| RequisitionsGroupDeliverToLocationValues | Stores delivery location details related to grouped requisitions. |
| RequisitionsGroupInventorySiteValues | Links inventory sites to requisitions to manage stock and supply chain data. |
| RequisitionsGroupLineCompanyValues | Associates requisition line items with specific companies for cost allocation. |
| RequisitionsGroupOrderFromConnectionValues | Tracks supplier ordering relationships for grouped requisitions. |
| RequisitionsGroupParLocationValues | Defines Periodic Automatic Replenishment (PAR) locations for efficient inventory restocking. |
| RequisitionsGroupRequestersValues | Lists users who initiated requisitions within a grouped dataset. |
| RequisitionsGroupRequestingEntityValues | Tracks entities that generate purchase requisitions within the system. |
| RequisitionsGroupRequisitionTypesValues | Categorizes requisitions based on their purchasing needs. |
| RequisitionsGroupResolvedWorktagsValues | Stores resolved worktag values assigned to grouped requisitions. |
| RequisitionsGroupResourceProviderValues | Links resource providers to grouped requisitions for procurement tracking. |
| RequisitionsGroupShipToAddressValues | Stores shipping addresses linked to grouped requisitions. |
| RequisitionsGroupSourcingBuyerValues | Associates sourcing buyers with grouped requisitions. |
| RequisitionsGroupSpendCategoryValues | Tracks spending categories for requisitions to facilitate financial analysis. |
| RequisitionsGroupSupplierContractValues | Links supplier contracts to requisitions for contract-based purchasing. |
| RequisitionsGroupUnitOfMeasureValues | Defines units of measurement used in grouped requisitions. |
| RequisitionsGroupWorktagsValues | Associates worktags with grouped requisitions for financial tracking. |
| RequisitionsPurchaseOrders | Retrieves purchase orders that were generated from requisitions. |
| RequisitionsRelatedPurchaseOrders | Identifies purchase orders linked to a specific requisition. |
| RequisitionTemplates | Contains predefined requisition templates for streamlined purchasing processes. |
| RequisitionTemplatesCompanies | Links requisition templates to specific companies. |
| RequisitionTemplatesGoodsLines | Stores details of goods line items within requisition templates. |
| RequisitionTemplatesLocations | Tracks location-based data for requisition templates. |
| RequisitionTemplatesServiceLines | Manages service-related requisition line items within templates. |
| RequisitionTemplatesTypes | Classifies requisition templates based on type and purpose. |
| RequisitionTemplatesWorktags | Links worktags to requisition templates for financial reporting. |
| ResourceForecastLines | Tracks projected resource allocations for planning and budgeting purposes. |
| ResourcePlanBookingStatusValues | Defines status values for resource plan bookings. |
| ResourcePlanCostRateCurrenciesValues | Lists currency types used in cost rate calculations for resource planning. |
| ResourcePlanLinesPendingWorkers | Lists workers pending confirmation within resource plans. |
| ResourcePlanLinesProjectResources | Links resource plan lines to specific project resource assignments. |
| ResourcePlanRequirementCategoriesValues | Categorizes different types of resource plan requirements based on project needs. |
| ResourcePlanRequirementsValues | Defines different types of resource plan requirements based on project needs. |
| ResourcePlanResourceTypesValues | Stores classifications of resources available for planning and allocation. |
| ResourcePlanRoleCategoriesValues | Categorizes roles assigned to resources in project planning. |
| ResourcePlanRolesValues | Tracks specific job roles within resource plans, detailing their responsibilities. |
| ResourcePlanUnnamedResourcesValues | Manages unnamed resources within planning scenarios where exact assignments are not defined. |
| ResourcePlanWorkerGroupsValues | Groups workers together based on project or organizational criteria for planning. |
| ResourcePlanWorkersValues | Stores information about workers assigned to resource plans. |
| ResourcePlanWorkerToReplaceUnnamedResourcesValues | Tracks workers intended to replace unnamed resources in project plans. |
| SendBackToValues | Defines available options for sending back items in approval workflows. |
| Students | Stores student records, including enrollment and academic details. |
| StudentsHolds | DEPRECATED. Managed student holds assigned to specific student IDs. |
| StudentsHoldsOverrideEventHoldTypes | Stores override events related to student hold types. |
| StudentsHoldsTypeContexts | Links student holds to their respective type contexts. |
| StudentsPrimaryStudentRecord | Retrieves the primary student record associated with an individual. |
| SupervisoryOrganizations | Stores data related to supervisory organizations and their hierarchies. |
| SupervisoryOrganizationsMembers | Tracks individual members within a supervisory organization. |
| SupervisoryOrganizationsOrgChart | Stores organizational chart details for a supervisory organization. |
| SupervisoryOrganizationsOrgChartSubordinates | Retrieves subordinates linked to a supervisory organization's org chart. |
| SupervisoryOrganizationsOrgChartSuperiorManagers | Tracks superior managers within a supervisory organization's hierarchy. |
| SupervisoryOrganizationsWorkers | Stores worker details within specific supervisory organizations. |
| SupplierContracts | Manages supplier contracts, including agreements, terms, and conditions. |
| SupplierContractsCatalogs | Links supplier contracts to associated product or service catalogs. |
| SupplierContractsChargeControls | Tracks charge control policies for supplier contracts. |
| SupplierContractsMultiParticipants | Manages multiple participant entries within supplier contracts. |
| SupplierContractsMultiSuppliers | Stores multi-supplier contract details, linking contracts to multiple vendors. |
| SupplierContractsServiceLines | Tracks service line details within supplier contracts. |
| SupplierInvoiceRequestsLines | Tracks individual line items within supplier invoice requests. |
| SupplierInvoiceRequestsLinesItemIdentifiers | Stores item identifier data for supplier invoice request line items. |
| SupplierInvoiceRequestsLinesItemTags | Links item tags to supplier invoice request line items. |
| SupplierInvoiceRequestsLinesSplits | Manages cost distribution across split line items within supplier invoices. |
| SupplierInvoiceRequestsLinesWorktags | Associates worktags with supplier invoice request line items. |
| SystemMetricsOverview | Retrieves real-time system metrics, including active sessions, queued tasks, and performance data. |
| TaxRatesGroupCompanyInstancesValues | Fetches company-specific tax rate values, including applicable tax jurisdictions and employer-specific rates. |
| TaxRatesGroupStateInstancesValues | Provides a list of state-level tax rate values applicable to an organization’s payroll processing. |
| TimeOffStatusValues | Lists possible status values for time-off requests, including pending, approved, denied, and processed states. |
| TimeTypesDefaultTimeEntryCodeValues | Retrieves the default time entry codes mapped to different time types, ensuring correct classification of recorded time. |
| TimeTypesProjectPlanTasksValues | Links time types to specific project plan tasks, enabling accurate tracking of billable and non-billable work hours. |
| TimeTypesProjectsValues | Maps time types to projects, ensuring correct assignment of hours worked within Workday’s project management framework. |
| TimeTypesTimeEntryCodesValues | Provides a list of valid time entry codes associated with different time types used in Workday’s time-tracking module. |
| TimeValidations | Retrieves a collection of validation rules applied to time entry submissions, ensuring compliance with business policies. |
| TimeValuesOutReasonValues | Lists the reasons associated with an employee's time-out entries, such as break periods, end-of-shift, or off-site work. |
| TimeValuesPositionsValues | Usage information for the operation TimeValuesPositionsValues.rsd. |
| TimeValuesWorkerTimeZoneValues | Retrieves a list of valid time zones associated with workers to support accurate time-tracking and reporting. |
| Workers | Retrieves detailed worker records, including employment history, job assignments, and organizational roles. |
| WorkersAdditionalJobs | Fetches additional job assignments linked to workers who hold multiple positions within an organization. |
| WorkersAnytimeFeedbackEventsBusinessProcessParametersComments | Retrieves comments linked to anytime feedback events recorded as part of Workday's business process workflow. |
| WorkersAnytimeFeedbackEventsRelatedFeedbackEvents | Links feedback events that are related to one another, helping track performance review history. |
| WorkersDevelopmentItemsCategory | Lists categories associated with a worker’s development items, such as leadership training or technical skill development. |
| WorkersDevelopmentItemsRelatesTo | Links development items to broader career goals, helping employees align training with job expectations. |
| WorkersDevelopmentItemsSkills | Retrieves specific skills associated with a worker’s development plan, aiding in competency tracking. |
| WorkersDirectReports | Retrieves a list of direct reports for a worker, providing insight into hierarchical relationships. |
| WorkersEligibleAbsenceTypes | Retrieves a list of absence types available to a worker, such as vacation, sick leave, or parental leave, based on their eligibility and company policies. |
| WorkersEligibleAbsenceTypesAbsenceReasons | Fetches the predefined reasons associated with each eligible absence type, ensuring proper classification and compliance with leave policies. |
| WorkersEligibleAbsenceTypesAdditionalFields | Retrieves any additional fields linked to absence types, such as required approvals, supporting documentation, or specific absence conditions. |
| WorkersEligibleAbsenceTypesPosition | Provides details on how eligible absence types vary by worker position, ensuring position-based leave eligibility is correctly managed. |
| WorkersGoals | Retrieves a worker’s personal and professional goals, including development plans and performance objectives. |
| WorkersGoalsActivityStreamableItem | Fetches activities associated with a worker’s goals, such as milestones, progress updates, or feedback related to goal completion. |
| WorkersGoalsAssociatedReviews | Links worker goals to associated performance reviews, providing insights into progress and evaluation alignment. |
| WorkersGoalsCategory | Retrieves the categories assigned to worker goals, such as career growth, leadership development, or compliance training. |
| WorkersGoalsRelatesTo | Links worker goals to broader initiatives, such as department objectives or company-wide targets, for performance tracking. |
| WorkersHistory | Retrieves historical employment records for a worker, including job changes, salary adjustments, and departmental transfers. |
| WorkersInboxTasks | Fetches pending and completed tasks from a worker's Workday inbox, such as approvals, performance evaluations, and training assignments. |
| WorkersLeavesOfAbsence | Retrieves detailed information on leaves of absence taken by a worker, including duration, type of leave, and status. |
| WorkersOrganizations | Retrieves details about the organizations or departments a worker is associated with, including hierarchical structure and reporting relationships. |
| WorkersPaySlips | Retrieves pay slips for a worker, detailing earnings, deductions, tax information, and net pay over different pay periods. |
| WorkersPeriod | Fetches details about the worker’s applicable pay periods, leave cycles, or reporting periods based on their employment schedule. |
| WorkersRequestedFeedbackOnSelfEventsBusinessProcessParametersComments | Retrieves comments related to feedback requests initiated by a worker, providing additional context to the request. |
| WorkersRequestedFeedbackOnWorkerEventsBusinessProcessParametersComments | Retrieves comments provided in feedback requests related to a worker’s performance. |
| WorkersServiceDates | Retrieves key service dates for a worker, including hire date, tenure milestones, and eligibility dates for benefits. |
| WorkersSupervisoryOrganizationsManaged | Retrieves a collection of supervisory organizations that a worker manages, providing insight into their leadership responsibilities. |
| WorkersTimeOffDetails | Provides a detailed breakdown of a worker’s time off, including leave type, usage, and remaining balance. |
| WorkersTimeOffEntries | Retrieves individual time-off entries for a worker, including the request date, approval status, and duration. |
| WorkersTimeOffPlans | Retrieves the specific time-off plan a worker is enrolled in, outlining accrual rules and available balances. |
| WorkersTimeTotals | Provides a summary of the total hours reported by a worker over a given period, including overtime and adjustments. |
| WorkersToNotifyWorkersToNotifyValues | Retrieves a list of workers who need to be notified about specific tasks, events, or updates related to time tracking or HR activities. |
| WorkersValidTimeOffDates | Lists valid time-off dates for a worker based on company policies, blackout periods, and accrual rules. |
| WorkerTimeBlocks | Retrieves individual worker time blocks, detailing specific periods of reported work hours or absences. |
| WorkerTimeBlocksCalculatedTimeDetails | Fetches detailed calculations applied to worker time blocks, including adjustments for overtime, breaks, and pay rate variations. |
Contains structured data about academic calendars, including term dates, session periods, and institutional scheduling rules. This table is essential for academic planning, enrollment processing, and compliance tracking, and it ensures accurate timeframes for course scheduling, financial aid eligibility, faculty workload distribution, and student records management.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for the academic calendar instance. This Id uniquely distinguishes the instance within the system and is used for referencing the calendar in integrations and reporting. |
| Descriptor | String | A descriptive preview of the academic calendar instance. This preview provides a human-readable label or summary that can include the academic year, institution, or key attributes of the calendar. |
| NonInstructionalDaysCalendar_Descriptor | String | A descriptive preview of the non-instructional days calendar associated with this academic calendar instance, offering insight into designated holidays, professional development days, or other periods when instruction does not occur. |
| NonInstructionalDaysCalendar_Id | String | The unique Id for the non-instructional days calendar linked to this academic calendar instance. This Id ensures accurate tracking and association of non-instructional periods within academic planning and compliance reporting. |
Stores associations between academic calendars and their respective academic years, enabling structured time period management for institutional planning. This table ensures that term-based activities such as admissions, enrollment, tuition calculations, and graduation requirements align with defined academic cycles.
The Workday Cloud requires filtering on AcademicCalendars_Id in order to perform the query.
For example:
SELECT * FROM AcademicCalendarsAcademicYears WHERE AcademicCalendars_Id = '1234';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic calendar academic year instance. This Id is used internally to track and manage different academic years within a specific academic calendar. |
| AcademicCalendars_Id [KEY] | String | The unique Id for the academic calendar associated with this academic year. This linkage ensures that each academic year is correctly assigned to its respective calendar, allowing institutions to manage multiple years under a single academic structure. |
| Descriptor | String | A human-readable summary of the academic year instance. This value provides a descriptive label that helps users quickly identify the academic year within the broader academic calendar. |
| EndDate | Datetime | The end date for the academic year within the specified academic calendar. This date marks the conclusion of the academic cycle and is used for scheduling, reporting, and compliance purposes. |
| StartDate | Datetime | The start date for the academic year within the specified academic calendar. This date signifies the beginning of the academic cycle, impacting course scheduling, enrollment, and institutional planning. |
Defines period types within academic calendars, categorizing different time segments such as terms, semesters, or quarters to facilitate scheduling, financial aid disbursement, and regulatory reporting requirements.
The Workday Cloud requires filtering on AcademicCalendars_Id in order to perform the query.
For example:
SELECT * FROM AcademicCalendarsPeriodTypes WHERE AcademicCalendars_Id = '1234';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic period type. This Id is used to distinguish different period types within an academic calendar, such as semesters, trimesters, or quarters. |
| AcademicCalendars_Id [KEY] | String | The unique Id for the academic calendar that contains this period type. This linkage ensures that each academic period type is correctly associated with the appropriate academic calendar, supporting structured academic scheduling. |
| Descriptor | String | A human-readable summary of the academic period type instance. This value provides a descriptive label that helps users quickly identify the period type within the academic calendar. |
| Standard | Bool | Indicates whether the period follows a standard ordering within the academic calendar. A value of 'true' signifies that the period adheres to a predefined, institutionally recognized sequence, ensuring consistency in academic structuring and scheduling. |
Contains academic-level classifications such as undergraduate, graduate, doctoral, and continuing education. These classifications define program eligibility, tuition rates, student progression criteria, and degree tracking requirements.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic level instance. This Id is used to categorize and track different academic levels within an institution, such as undergraduate, graduate, or doctoral programs, supporting student classification and academic progression. |
| Descriptor | String | A human-readable summary of the academic level instance. This value provides a descriptive label that helps users quickly identify the academic level within the institution’s educational framework, aiding in curriculum planning, student record management, and reporting. |
Stores data about specific academic periods, including start and end dates, session types, and associated academic calendars. This table supports institutional operations such as registration windows, course scheduling, student billing, and compliance with accreditation requirements.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic period instance. This Id ensures that each academic period is distinctly tracked and managed within the institution’s academic structure. |
| AcademicCalendar_Descriptor | String | A human-readable summary of the academic calendar associated with this academic period. This summary helps users quickly identify the academic calendar without referencing the unique Id. |
| AcademicCalendar_Href | String | A direct link to the academic calendar instance associated with this academic period. This link provides programmatic access for retrieving detailed information about the academic calendar. |
| AcademicCalendar_Id | String | The unique Id for the academic calendar linked to this academic period. This Id establishes a structured relationship between academic periods and their corresponding academic calendars. |
| AcademicYear_Descriptor | String | A human-readable summary of the academic year associated with this academic period. This summary provides context for reporting and scheduling purposes. |
| AcademicYear_EndDate | Datetime | The end date of the academic year associated with this academic period. This date marks the official conclusion of the academic year and impacts reporting, grading, and transition planning. |
| AcademicYear_Id | String | The unique Id for the academic year associated with this academic period. This Id ensures proper tracking and management of academic years within an institution. |
| AcademicYear_StartDate | Datetime | The start date of the academic year associated with this academic period. This date determines when the academic year officially begins and affects course enrollment and scheduling. |
| Descriptor | String | A human-readable summary of the academic period instance. This summary helps users quickly identify the academic period without needing to reference the unique Id. |
| EndDate | Datetime | The official end date of the academic period. This date determines when the academic period concludes and affects academic scheduling, grading, and reporting. |
| PeriodType_Descriptor | String | A human-readable summary of the period type associated with this academic period. This summary provides context on whether the academic period follows a semester, trimester, quarter, or another structure. |
| PeriodType_Href | String | A direct link to the period type instance associated with this academic period. This link provides programmatic access to retrieve detailed information about the period type. |
| PeriodType_Id | String | The unique Id for the period type linked to this academic period. This Id ensures consistency in categorizing academic periods within an institution’s academic structure. |
| Standard | Bool | Indicates whether this academic period is a standard academic period within the academic calendar. A value of 'true' means the period follows a predefined, institutionally recognized schedule. |
| StandardEndDate | Datetime | The standard end date of this academic period if it is classified as a standard period in the academic calendar. This date ensures uniformity in academic scheduling and reporting. |
| StandardStartDate | Datetime | The standard start date of this academic period if it is classified as a standard period in the academic calendar. This date ensures consistency in academic planning and course structuring. |
| StartDate | Datetime | The official start date of the academic period. This date determines when courses, instructional activities, and academic events begin. |
| WeeksOfInstruction | Decimal | The total number of instructional weeks within this academic period. This value helps institutions plan course durations, faculty schedules, and student workload distribution. |
| AcademicCalendar_Prompt | String | The unique Id for the academic calendar that contains this academic period. This Id ensures proper association between academic periods and academic calendars. |
| AcademicYear_Prompt | String | The unique Id for the academic year that includes this academic period. This Id allows institutions to structure academic planning and maintain accurate historical records. |
| FromDate_Prompt | Date | Filters academic periods based on their start date using the YYYY-MM-DD format. This filter returns academic periods starting on or after the specified date when used alone or within a date range when combined with ToDate_Prompt. |
| ToDate_Prompt | Date | Filters academic periods based on their end date using the YYYY-MM-DD format. This filter returns academic periods ending on or before the specified date when used alone or within a date range when combined with FromDate_Prompt. |
Defines how academic periods are used within the institution, supporting functions such as enrollment eligibility, tuition calculation structures, academic standing assessments, and financial aid disbursement schedules.
The Workday Cloud requires filtering on AcademicPeriods_Id in order to perform the query.
For example:
SELECT * FROM AcademicPeriodsPeriodUsages WHERE AcademicPeriods_Id = '1234';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic period usage instance. This Id ensures that each usage type within an academic period is uniquely tracked and managed. |
| AcademicPeriods_Id [KEY] | String | The unique Id for the academic period that contains this usage instance. This Id links the period usage to a specific academic period, ensuring accurate classification within the academic calendar. |
| Descriptor | String | A human-readable summary of the academic period usage instance. This summary provides context about how the academic period is used within the institution, such as for enrollment, grading, or financial aid processing. |
| AcademicCalendar_Prompt | String | The unique Id for the academic calendar that contains the academic period. This Id can be retrieved from GET /academicCalendars and ensures the proper association between academic periods and their respective calendars. |
| AcademicYear_Prompt | String | The unique Id for the academic year associated with the academic period. This Id can be retrieved from GET /academicCalendars/{ID}/academicYears and ensures structured academic planning and accurate historical recordkeeping. |
| FromDate_Prompt | Date | Filters academic periods based on their start date using the YYYY-MM-DD format. This filter returns academic periods starting on or after the specified date when used alone or within a date range when combined with ToDate_Prompt. |
| ToDate_Prompt | Date | Filters academic periods based on their end date using the YYYY-MM-DD format. This filter returns academic periods ending on or before the specified date when used alone or within a date range when combined with FromDate_Prompt. |
Maintains weightage information for academic periods, influencing calculations such as GPA weighting, credit hour distribution, academic progress tracking, and degree audit evaluations.
The Workday Cloud requires filtering on AcademicPeriods_Id in order to perform the query.
For example:
SELECT * FROM AcademicPeriodsPeriodWeights WHERE AcademicPeriods_Id = '1234';
| Name | Type | Description |
| AcademicPeriods_Id | String | The unique identifier (Id) for the academic period that contains this weight instance. This Id ensures proper linkage between the weight assignment and the academic period within the institution’s academic structure. |
| Descriptor | String | A human-readable summary of the academic period weight instance. This summary provides context for the weight assignment, which can represent factors such as course credit weighting or instructional load distribution. |
| AcademicCalendar_Prompt | String | The unique Id for the academic calendar that contains the academic period. This Id can be retrieved from GET /academicCalendars and ensures the proper association of academic periods with their respective calendars. |
| AcademicYear_Prompt | String | The unique Id for the academic year associated with the academic period. This Id can be retrieved from GET /academicCalendars/{ID}/academicYears and ensures structured academic planning and accurate historical recordkeeping. |
| FromDate_Prompt | Date | Filters academic periods based on their start date using the YYYY-MM-DD format. This filter returns academic periods that start on or after the specified date when used alone or within a date range when combined with ToDate_Prompt. |
| ToDate_Prompt | Date | Filters academic periods based on their end date using the YYYY-MM-DD format. This filter returns academic periods that end on or before the specified date when used alone or within a date range when combined with FromDate_Prompt. |
Represents academic units such as colleges, departments, or schools, facilitating administrative management, faculty assignments, financial planning, accreditation reporting, and governance structures.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic unit instance. This Id ensures that each academic unit is distinctly tracked and managed within the institution’s academic structure. |
| CipCode_Descriptor | String | A human-readable summary of the Classification of Instructional Programs (CIP) code associated with the academic unit. This summary provides context on the educational program classification used for reporting and accreditation. |
| CipCode_Href | String | A direct link to the CIP code instance associated with this academic unit. This link provides programmatic access to retrieve details about the CIP classification. |
| CipCode_Id | String | The unique Id for the CIP code associated with this academic unit. This Id ensures proper classification of programs based on national education standards. |
| Code | String | The institutional code assigned to the academic unit as of the effective date. This code is used for internal tracking, reporting, and administrative purposes. |
| Company_Descriptor | String | A human-readable summary of the company or organization associated with this academic unit. This summary provides context about the entity governing or financially supporting the academic unit. |
| Company_Href | String | A direct link to the company or organization instance associated with this academic unit. This link provides programmatic access to retrieve details about the parent institution or affiliated company. |
| Company_Id | String | The unique Id for the company or organization linked to this academic unit. This Id ensures that financial and administrative structures are correctly associated. |
| ExternalURL_Descriptor | String | A human-readable summary of the external URL associated with the academic unit. This summary provides context about an external website or online resource linked to the unit. |
| ExternalURL_Href | String | A direct link to an external Uniform Resource Locator (URL) associated with this academic unit. This link provides access to institutional websites, department pages, or accreditation resources. |
| ExternalURL_Id | String | The unique Id for the external URL associated with this academic unit. This Id ensures structured linking between academic units and relevant external resources. |
| Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. A value of 'true' signifies that the academic unit is no longer active within the institution’s academic structure. |
| Institution | Bool | Indicates whether the academic unit is designated as an institution as of the effective date. A value of 'true' signifies that the academic unit represents a full institution rather than a subdivision. |
| Name | String | The official name of the academic unit as of the effective date. This name identifies the unit within the institution’s organizational hierarchy. |
| Subtype_Descriptor | String | A human-readable summary of the academic unit subtype. This summary provides context on the classification of the academic unit, such as department, school, or faculty. |
| Subtype_Href | String | A direct link to the academic unit subtype instance associated with this academic unit. This link provides programmatic access to retrieve details about the subtype classification. |
| Subtype_Id | String | The unique Id for the subtype associated with this academic unit. This Id ensures structured classification of academic units within the institution. |
| Superior_Id | String | The unique Id for the immediate superior academic unit. This Id ensures hierarchical structuring of academic units within the institution’s academic framework. |
| Superior_Inactive | Bool | Indicates whether the immediate superior academic unit is inactive as of the effective date. A value of 'true' signifies that the superior unit is no longer active in the institution’s hierarchy. |
| Superior_Institution | Bool | Indicates whether the immediate superior academic unit is designated as an institution as of the effective date. A value of 'true' signifies that the superior unit represents a full institution rather than a subdivision. |
| Superior_Name | String | The official name of the immediate superior academic unit as of the effective date. This name provides hierarchical context and helps in structuring the academic organization. |
| EffectiveDate_Prompt | Date | Filters academic units based on their effective date using the YYYY-MM-DD format. This filter determines which academic units are retrieved based on their status as of the specified date, with the default being the current date. |
| Inactive_Prompt | Bool | Indicates whether to retrieve inactive academic units as of the effective date. A value of 'true' returns only inactive academic units, while the default value of 'false' retrieves only active units. |
| Institution_Prompt | Bool | Indicates whether to retrieve academic units designated as institutions as of the effective date. A value of 'true' returns only institutions, while the default value of 'false' retrieves all types of academic units. |
| Superior_Prompt | String | The unique Id for the immediate superior academic unit as of the effective date. This Id ensures hierarchical structuring and can be retrieved using GET /academicUnits. |
Stores hierarchical relationships between academic units and academic levels. This table defines how different units contribute to institutional organization, program offerings, curriculum development, and student advising structures.
The Workday Cloud requires filtering on AcademicUnits_Id in order to perform the query.
For example:
SELECT * FROM AcademicUnitsLevels WHERE AcademicUnits_Id = '12345';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic unit level instance. This Id ensures that each academic unit level is distinctly tracked and managed within the institution’s hierarchy. |
| AcademicUnits_Id [KEY] | String | The unique Id for the academic unit that contains this level instance. This Id ensures the proper classification of academic units within the institutional structure. |
| Descriptor | String | A human-readable summary of the academic unit level instance. This summary helps users quickly identify the academic level without needing to reference the unique Id. |
| EffectiveDate_Prompt | Date | Filters academic unit levels based on their effective date using the YYYY-MM-DD format. This filter determines which academic unit levels are retrieved based on their status as of the specified date, with the default being the current date. |
| Inactive_Prompt | Bool | Indicates whether to retrieve inactive academic unit levels as of the effective date. A value of 'true' returns only inactive academic unit levels, while the default value of 'false' retrieves only active ones. |
| Institution_Prompt | Bool | Indicates whether to retrieve academic units designated as institutions as of the effective date. A value of 'true' returns only institutions, while the default value of 'false' retrieves all types of academic units. |
| Superior_Prompt | String | The unique Id for the immediate superior academic unit as of the effective date. This Id ensures hierarchical structuring and can be retrieved using GET /academicUnits. |
Tracks subordinate relationships within academic units. These relationships define structural dependencies between departments, divisions, and other academic entities for budgeting, reporting, and governance purposes.
The Workday Cloud requires filtering on AcademicUnits_Id in order to perform the query.
For example:
SELECT * FROM AcademicUnitsSubordinates WHERE AcademicUnits_Id = '12345';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the academic unit subordinate instance. This Id ensures that each subordinate academic unit is accurately tracked and associated with its superior unit. |
| AcademicUnits_Id [KEY] | String | The unique Id for the academic unit that contains this subordinate unit. This Id establishes a structured relationship between the superior academic unit and its subordinates, supporting hierarchical organization and reporting. |
| Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. A value of 'true' signifies that the academic unit is no longer active within the institution’s academic structure. |
| Institution | Bool | Indicates whether the academic unit is designated as an institution as of the effective date. A value of 'true' signifies that the academic unit represents a full institution rather than a subdivision such as a department or faculty. |
| Name | String | The official name of the academic unit as of the effective date. This name provides a recognizable label for the unit within the institution’s academic hierarchy. |
| EffectiveDate_Prompt | Date | Filters academic units based on their effective date using the YYYY-MM-DD format. This filter determines which academic units are retrieved based on their status as of the specified date, with the default being the current date. |
| Inactive_Prompt | Bool | Indicates whether to retrieve inactive academic units as of the effective date. A value of 'true' returns only inactive academic units, while the default value of 'false' retrieves only active units. |
| Institution_Prompt | Bool | Indicates whether to retrieve academic units designated as institutions as of the effective date. A value of 'true' returns only institutions, while the default value of 'false' retrieves all types of academic units. |
| Superior_Prompt | String | The unique Id for the immediate superior academic unit as of the effective date. This Id ensures hierarchical structuring and can be retrieved using GET /academicUnits. |
Maintains records of currently active tasks within the system. This table tracks user activities, pending operations, and workflow progress to support task management, workload distribution, and process automation.
| Name | Type | Description |
| Account_Descriptor | String | A human-readable summary of the account associated with the active task. This summary provides context about which user or system account initiated the task. |
| Account_Href | String | A direct link to the account instance associated with the active task. This link provides programmatic access to retrieve detailed information about the account. |
| Account_Id | String | The unique identifier (Id) for the account associated with the active task. This Id ensures accurate tracking of task ownership and execution permissions. |
| BytesAllocated | Decimal | The amount of memory allocated for the task in mebibytes (MiB). This value represents the memory consumption of the task during execution. |
| CpuTimeMillis | Decimal | The amount of time, in milliseconds, that the CPU has spent processing the task. This value provides insight into the computational load of the task. |
| InstancesAccessed | Decimal | The total count of all instances that have been traversed or accessed to process the task. This value helps assess the scope of data processing. |
| Origin | String | The name of the service that launched the task. This value identifies the origin of task execution within the system. |
| QueueMillis | Decimal | The total duration, in milliseconds, that the task has spent waiting in the queue before execution. This value indicates system load and task prioritization. |
| QueueName | String | The name of the queue that is currently processing the task. This value helps track task execution paths and workload distribution. |
| QueuedSubtaskCount | Decimal | The total count of queued subtasks, including self-executing and child processes, within this sample. This value provides insight into the level of parallel execution. |
| RunningSubtaskCount | Decimal | The total count of running subtasks, including self-executing and child processes, within this sample. This value helps monitor the real-time execution load. |
| StartTime | Datetime | The timestamp indicating when the task started execution. This timestamp is used for tracking and performance analysis. |
| Status | String | The current status of the task, which is either 'queued' or 'running.' This value provides insight into the task's progress in the execution pipeline. |
| TaskDurationMillis | Decimal | The total duration, in milliseconds, that the task has spent both queued and running. This value provides an overall measure of task lifecycle time. |
| Task_Descriptor | String | A human-readable summary of the task instance. This summary provides context about the task’s purpose or execution scope. |
| Task_Href | String | A direct link to the task instance. This link provides programmatic access to retrieve detailed information about the task. |
| Task_Id | String | The unique Id for the task instance. This Id ensures accurate tracking of active tasks within the system. |
Stores details about active user sessions, including login status, session duration, and user activity tracking, supporting security monitoring, access control enforcement, and system performance analysis.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the active user session instance. This Id ensures that each active session is distinctly tracked within the system. |
| AuthenticationType_Descriptor | String | A human-readable summary of the authentication type used for the session. This summary provides context on whether authentication was performed using single sign-on, multi-factor authentication, or another method. |
| AuthenticationType_Href | String | A direct link to the authentication type instance associated with this session. This link provides programmatic access to retrieve detailed information about the authentication method. |
| AuthenticationType_Id | String | The unique Id for the authentication type associated with the session. This Id ensures accurate tracking of how users authenticate during login. |
| Descriptor | String | A human-readable summary of the active user session instance. This summary provides context about the session, including relevant details about the user or system account. |
| DeviceType_Descriptor | String | A human-readable summary of the device type used for the session. This summary provides context on whether the session was initiated from a desktop, mobile device, or another platform. |
| DeviceType_Href | String | A direct link to the device type instance associated with this session. This link provides programmatic access to retrieve detailed information about the device. |
| DeviceType_Id | String | The unique Id for the device type used in the session. This Id ensures accurate tracking of user access methods. |
| ElapsedMinutes | Decimal | The total time, in minutes, that has elapsed since the user signed in. This value measures session duration or the time since the session started if it is still active. |
| Role_Descriptor | String | A human-readable summary of the role assigned to the session. This summary provides context on the user's role, such as administrator, manager, or employee. |
| Role_Href | String | A direct link to the role instance associated with the session. This link provides programmatic access to retrieve detailed information about the assigned role. |
| Role_Id | String | The unique Id for the role associated with the session. This Id ensures that each session is linked to a specific role within the system. |
| SignonTime | Datetime | The timestamp indicating when the user's session started. This timestamp helps track session activity and duration for security and reporting purposes. |
| SystemAccount_Descriptor | String | A human-readable summary of the system account associated with this session. This summary provides context on whether the session belongs to a personal or service account. |
| SystemAccount_Href | String | A direct link to the system account instance associated with this session. This link provides programmatic access to retrieve details about the account that initiated the session. |
| SystemAccount_Id | String | The unique Id for the system account associated with this session. This identifier ensures accurate tracking of session ownership within the system. |
Captures user activity logs within a specified time frame, enabling auditing, compliance tracking, troubleshooting, security monitoring, and forensic analysis of system interactions.
The Workday Cloud requires filtering on From_Prompt and To_Prompt in order to perform the query.
For example:
SELECT * FROM ActivityLogging WHERE From_Prompt = '01-03-2025' AND To_Prompt = '01-04-2025';
| Name | Type | Description |
| ActivityAction | String | The type of action that was executed within the system. This value indicates the specific operation performed, such as login, logout, data retrieval, or modification. |
| DeviceType | String | The type of device used during the user sign-on that initiated the request. This value helps identify whether the action was performed from a desktop, mobile device, or other platform. |
| IpAddress | String | The IP address of the user from the sign-on session that was used to make the request. This value helps track user activity and enhance security monitoring. |
| RequestTime | Datetime | The exact date and time when the action was requested. This timestamp is used for logging, auditing, and monitoring system interactions. |
| SessionId | String | The unique system-generated identifier (Id) for tracking user sign-ons. This Id links activity logs to specific user sessions for accountability and security analysis. |
| SystemAccount | String | The system account that initiated the request. This value identifies whether the request originated from a personal user account or an automated system process. |
| Target_Descriptor | String | A human-readable summary of the target entity affected by the request. This summary provides context on the specific object, record, or resource that was accessed or modified. |
| Target_Href | String | A direct link to the target entity associated with the logged action. This link provides programmatic access to retrieve additional details about the affected resource. |
| Target_Id | String | The unique Id for the target entity affected by the action. This Id ensures accurate tracking of changes and interactions with system resources. |
| TaskDisplayName | String | The human-readable name of the action executed in the transaction. This value provides a descriptive label for the logged task. |
| TaskId | String | The unique Id for the task executed in the transaction. This Id links activity logs to specific tasks performed within the system. |
| UserActivityEntryCount | Decimal | The total number of user activity instances recorded for the specified filter parameters. This count helps in generating system usage reports and monitoring user interactions. |
| UserAgent | String | The client browser and operating system details from the user sign-on used to make this request. This value helps track device-specific activity and system compatibility. |
| From_Prompt | Date | (Required) The start date and time for filtering log entries, using the format '{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z'. The default timezone is UTC/GMT. This parameter determines the earliest recorded activity included in the results. |
| InstancesReturned_Prompt | Long | The number of user activity instances requested, calculated as this value multiplied by 10,000. For example, a value of '5' requests a maximum of 50,000 instances. The default and maximum values are '25', meaning the system can retrieve up to 250,000 instances. Adjusting this value can optimize performance. |
| ReturnUserActivityEntryCount_Prompt | Bool | Indicates whether to return only the total count of user activity instances for the specified parameters. A value of 'true' retrieves only the count, while a value of 'false' returns detailed activity records. |
| SystemAccount_Prompt | String | Filters user activity logs based on the specified system account. This value helps narrow results to actions performed by a particular account. |
| TaskId_Prompt | String | Filters user activity logs based on the specified task Id. This value retrieves logs related to a specific task execution. |
| To_Prompt | Date | (Required) The end date and time for filtering log entries, using the format '{YYYY}-{MM}-{DD}T{HH}:{MM}:{SS}Z'. The default timezone is UTC/GMT. This parameter determines the latest recorded activity included in the results. |
Associates worktags with ad hoc project-time transactions. This table enables classification of project time entries based on cost centers, grants, funding sources, project phases, and billing codes.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the ad hoc project time transaction worktag instance. This Id ensures that each worktag entry is distinctly tracked and managed within the system. |
| AdHocProjectTimeTransactions_Id [KEY] | String | The unique Id for the ad hoc project time transaction that contains this worktag. This Id ensures that the worktag is correctly associated with the corresponding time transaction for reporting and cost allocation. |
| Descriptor | String | A human-readable summary of the ad hoc project time transaction worktag instance. This summary provides context about the worktag assigned to the transaction, aiding in classification and financial tracking. |
| ProjectOrProjectHierarchy_Prompt | String | The unique Id or reference Id of a project or project hierarchy. This value can be retrieved using GET /projects and ensures accurate project selection for cost assignment and worktag association. |
Maintains a list of statuses for article versions, tracking publication states such as draft, approved, or archived. This list ensures proper content governance, knowledge management, and compliance with organizational publishing policies.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article status instance. This Id ensures that each article status is distinctly tracked and managed within the system. |
| Descriptor | String | A human-readable summary of the article status instance. This summary provides context about the current state of an article, such as draft, published, archived, or under review. |
Stores historical versions of articles, preserving content revisions for auditability, compliance tracking, knowledge retention, and rollback capabilities in case of incorrect updates.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article version instance. This Id ensures that each version of an article is distinctly tracked and managed within the system. |
| Category_Descriptor | String | A human-readable summary of the category associated with this article version. This summary provides context on the classification of the article, such as knowledge base, policy, or procedure. |
| Category_Href | String | A direct link to the category instance associated with this article version. This link provides programmatic access to retrieve details about the category. |
| Category_Id | String | The unique Id for the category associated with this article version. This Id ensures accurate classification and organization of articles within Workday. |
| Content | String | The plain-text content of the article version. This value represents the actual text that is displayed to users, excluding any formatting or media attachments. |
| CreatedDate | Datetime | The date and time when the article version was created. This timestamp provides historical tracking of article revisions and publishing activity. |
| Language_Descriptor | String | A human-readable summary of the language associated with this article version. This summary provides context on the language in which the article is written. |
| Language_Href | String | A direct link to the language instance associated with this article version. This link provides programmatic access to retrieve details about the language settings. |
| Language_Id | String | The unique Id for the language associated with this article version. This Id ensures proper categorization of articles by language for localization and accessibility. |
| LastUpdatedDate | Datetime | The date and time when the article version was last updated. This timestamp indicates the most recent modification and ensures version control. |
| LatestPublishedVersionViewURL | String | A Uniform Resource Locator (URL) that links to the latest published version of the article in Workday. This field only returns a value if the article is currently published and accessible. |
| Location_Descriptor | String | A human-readable summary of the location associated with this article version. This summary provides context on where the article is stored or applicable within the organization. |
| Location_Href | String | A direct link to the location instance associated with this article version. This link provides programmatic access to retrieve details about the location settings. |
| Location_Id | String | The unique Id for the location associated with this article version. This Id ensures proper categorization of articles based on location-based relevance. |
| ParentArticle_Descriptor | String | A human-readable summary of the parent article associated with this version. This summary provides context on the main article to which this version belongs. |
| ParentArticle_Href | String | A direct link to the parent article instance. This link provides programmatic access to retrieve details about the main article. |
| ParentArticle_Id | String | The unique Id for the parent article of this version. This Id ensures versioning relationships are maintained within the knowledge management system. |
| Status_Descriptor | String | A human-readable summary of the status of the article version. This summary provides insight into whether the article is in draft, published, archived, or under review. |
| Status_Href | String | A direct link to the status instance associated with this article version. This link provides programmatic access to retrieve details about the current status. |
| Status_Id | String | The unique Id for the status associated with this article version. This Id ensures accurate tracking of article workflow stages. |
| Title | String | The title of the article version. This value represents the headline or subject of the article as displayed to users. |
| Version | Decimal | The version number assigned to the article instance. This value ensures proper tracking of article updates and enables version control. |
| ViewLink | String | A URL that links to the article version in Workday. This field only returns a value if the article is published and accessible to users. |
| Audience_Prompt | String | The intended audience of the article version. This value ensures that the article reaches the appropriate users based on roles, permissions, or department access. |
| Status_Prompt | String | The status of the article version. This value specifies whether the article is in draft, published, archived, or another workflow stage. |
Defines audience segments for specific article versions. This table controls visibility and access based on user roles, departmental restrictions, or organizational hierarchy to ensure proper content dissemination.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article version audience instance. This Id ensures that each audience entry is distinctly tracked and associated with a specific article version. |
| ArticleVersions_Id [KEY] | String | The unique Id for the article version that contains this audience instance. This Id establishes the relationship between an article version and its intended readership. |
| Descriptor | String | A human-readable summary of the article version audience instance. This summary provides insight into the target audience that the article version is intended for. |
| Audience_Prompt | String | The specified audience for the article version. This value helps define who can view or access the article, ensuring content is directed to the appropriate users or groups. |
| Status_Prompt | String | The status of the article version. This value specifies whether the article is in draft, published, archived, or another workflow stage. |
Logs the worker who is responsible for creating specific article versions. This table supports content ownership tracking, version accountability, and editorial oversight.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article version creator instance. This Id ensures that each record of an article version's creator is distinctly tracked and managed. |
| ArticleVersions_Id [KEY] | String | The unique Id for the article version that contains this creator instance. This Id establishes the relationship between an article version and the worker who created it. |
| Descriptor | String | A human-readable summary of the worker who created the article version. This summary provides insight into the individual responsible for authoring or submitting the content. |
| Audience_Prompt | String | The specified audience for the article version. This value helps define who can view or access the article, ensuring content is directed to the appropriate users or groups. |
| Status_Prompt | String | The status of the article version. This value specifies whether the article is in draft, published, archived, or another workflow stage. |
Tracks the worker who last updated an article version. This table ensures transparency in content modifications, change history tracking, and quality assurance in knowledge management systems.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article version last updated by a worker. This Id ensures that each update entry is distinctly tracked and managed. |
| ArticleVersions_Id [KEY] | String | The unique Id for the article version that contains this update instance. This Id establishes the relationship between an article version and the worker who last modified it. |
| Descriptor | String | A human-readable summary of the worker who last updated the article version. This summary provides insight into the individual responsible for the most recent modifications or revisions. |
| Audience_Prompt | String | The specified audience for the article version. This value helps define who can view or access the article, ensuring content is directed to the appropriate users or groups. |
| Status_Prompt | String | The status of the article version. This value specifies whether the article is in draft, published, archived, or another workflow stage. |
Associates keyword tags with article versions. This table enhances searchability, categorization, and metadata enrichment for improved information retrieval and content discovery.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the article version tag instance. This Id ensures that each tag associated with an article version is distinctly tracked and managed. |
| ArticleVersions_Id [KEY] | String | The unique Id for the article version that contains this tag instance. This Id establishes the relationship between an article version and its associated tags. |
| Descriptor | String | A human-readable summary of the tag associated with the article version. This summary provides insight into the categorization or classification of the article for searchability and organization. |
| Audience_Prompt | String | The specified audience for the article version. This value helps define who can view or access the article, ensuring content is directed to the appropriate users or groups. |
| Status_Prompt | String | The status of the article version. This value specifies whether the article is in draft, published, archived, or another workflow stage. |
Usage information for the operation AudiencePromptGroupAudienceTypeValues.rsd.
| Name | Type | Description |
| Id [KEY] | String | wid / id / reference id |
| Descriptor | String | A description of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AudienceTypeParm_Prompt | String | |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| ConnectType_Prompt | String |
Usage information for the operation AudiencePromptGroupSelectionValues.rsd.
| Name | Type | Description |
| Id [KEY] | String | wid / id / reference id |
| Descriptor | String | A description of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AudienceTypeParm_Prompt | String | |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| ConnectType_Prompt | String |
Stores balance information for all absence-plan and leave-of-absence types. This table enables tracking of employee entitlements, accruals, and remaining leave balances for payroll processing and compliance with leave policies.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| AbsencePlan_AbsenceTable_Aggregate | String | This field returns the absence table associated with the absence balance. The absence table provides detailed records of time off accruals, usage, and remaining balances. |
| AbsencePlan_Descriptor | String | This field provides a human-readable summary of the absence container based on the calendar display option. This descriptor ensures clarity in understanding the specific absence plan being referenced. |
| AbsencePlan_Id | String | This field contains the unique identifier (Id) for the absence container. The Id ensures that each absence plan is properly linked to a worker's leave or time-off records. |
| AbsencePlan_Timeoffs | String | This field returns the name of the time off category for which the balance is being reported. The time-off category defines the type of leave, such as vacation, sick leave, or parental leave. |
| Category_Descriptor | String | This field provides a human-readable summary of the absence category instance. The category descriptor helps classify absence balances based on specific leave types. |
| Category_Href | String | This field contains a direct link to the absence category instance. The link provides programmatic access to retrieve additional details about the category. |
| Category_Id | String | This field contains the unique Id for the absence category. The Id ensures accurate classification and grouping of absence balances within the system. |
| DateOfFirstAbsence | Datetime | This field records the first day of leave for the corresponding leave type for which the balance is being returned. The date helps track the start of an employee's time off period. |
| EffectiveDate | Datetime | This field specifies the date for which the absence balance is reported. The effective date ensures that the balance is accurate based on a specific point in time. |
| Position_Descriptor | String | This field provides a human-readable summary of the position associated with the absence balance. The descriptor helps identify which position the absence applies to, especially for workers with multiple roles. |
| Position_Id | String | This field contains the unique Id for the position associated with the absence balance. The Id ensures that absence balances are accurately linked to a worker's job position. |
| Quantity | Decimal | This field represents the balance amount for the time off, absence table, or leave type. The balance value specifies the remaining leave entitlement or accrued time available. |
| Unit_Descriptor | String | This field provides a human-readable summary of the unit used for tracking the absence balance. The unit descriptor helps clarify whether the balance is measured in hours, days, or another metric. |
| Unit_Href | String | This field contains a direct link to the unit instance associated with the absence balance. The link provides programmatic access to retrieve additional details about the unit of measure (UOM). |
| Unit_Id | String | This field contains the unique Id for the UOM. The Id ensures that the balance is accurately categorized based on the applicable unit type. |
| Worker_Descriptor | String | This field provides a human-readable summary of the worker associated with the absence balance. The descriptor helps identify the individual for whom the balance is being reported. |
| Worker_Href | String | This field contains a direct link to the worker instance. The link provides programmatic access to retrieve additional details about the worker's absence records. |
| Worker_Id | String | This field contains the unique Id for the worker associated with the absence balance. The Id ensures that absence balances are correctly attributed to the appropriate employee. |
| Category_Prompt | String | This field specifies the Workday Id of the time off, leave type, or absence table. The Id allows retrieval of absence balances for a specific leave category. |
| Effective_Prompt | Date | This field specifies the absence balance as of a given date using the YYYY-MM-DD format. The date filter allows users to view balance history and future entitlements. |
| Worker_Prompt | String | This field specifies the Workday Id of the worker for whom the balances are being returned. The Id ensures that absence balance information is retrieved for the correct employee. |
Maintains a collection of billing rate applications that are linked to specific billable transactions. This table ensures accurate application of rate structures, adjustments, and contractual billing terms.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the billing rate application instance. This Id ensures that each billing rate application is distinctly tracked and associated with the correct billable transaction. |
| BillableTransactions_Id [KEY] | String | The unique Id for the billable transaction that owns this billing rate application. This Id ensures that billing rates are properly linked to the corresponding transaction. |
| AmountToBill_Currency | String | The currency type for the total amount in the base currency of the billing schedule applied to the billing rate rule break. This value ensures consistency in financial calculations. |
| AmountToBill_Value | Decimal | The total amount in the base currency of the billing schedule applied to the billing rate rule break. This amount represents the charge after applying the billing rate rules. |
| ApplicationOrder | Decimal | The numerical order in which the billing rate application is applied. This value determines the sequence of rate adjustments in the billing process. |
| BillingRateRuleType | String | The type of rate rule applied to the billing rate application. This classification specifies whether the rate is fixed, tiered, or percentage-based. |
| Descriptor | String | A human-readable summary of the billing rate application instance. This summary provides a quick reference to key details about the applied rate. |
| QuantityToBill | Decimal | The number of units to which the billing rate rule break is applied for this transaction. This value represents the billable quantity under the specified rate rule. |
| RateAdjustmentAmount_Currency | String | The currency type for the total rate adjustment amount applied to the billable transaction. This value ensures that adjustments are recorded in the correct monetary unit. |
| RateAdjustmentAmount_Value | Decimal | The total rate adjustment amount applied to the billable transaction. This value reflects any discounts, markups, or other changes made to the original rate. |
| RateEndingAmount_Currency | String | The currency type for the ending rate amount after adjustments are applied. This value ensures accurate representation of final rates in financial reporting. |
| RateEndingAmount_Value | Decimal | The final billing rate amount after adjustments are applied. This value represents the effective rate charged to the customer. |
| RateStartingAmount_Currency | String | The currency type for the starting rate amount before adjustments are applied. This value ensures accurate tracking of the initial rate before modifications. |
| RateStartingAmount_Value | Decimal | The original billing rate amount before any adjustments are applied. This value serves as the baseline for rate modifications. |
| ReasonForChange | String | The justification for the change in the billing rate. This reason documents the cause of adjustments, such as contract updates, pricing agreements, or rate corrections. |
| RuleName | String | The name of the billing rate rule applied to this billable transaction. This name helps identify and differentiate various billing rate rules used in invoicing. |
| BillingStatus_Prompt | String | Filters the billable transactions by billing status. This field requires the Workday Id of the billing status. Multiple status query parameters can be specified to refine the results. |
| Customer_Prompt | String | Filters the billable transactions by customer. This field requires the Workday Id of the customer associated with the project for the billable transaction. To retrieve a valid Id, call GET /customers in the Customer Accounts REST service. |
| FromDate_Prompt | Date | Filters the billable transactions to include only those with a transaction date on or after the specified date. This filter uses the YYYY-MM-DD format to define the starting range. |
| Phase_Prompt | String | Filters the billable transactions by project phase. This field requires the Workday Id of the project phase associated with the billable transaction for the time entry. To retrieve a valid Id, call GET /planPhases in the Projects REST service. |
| Project_Prompt | String | Filters the billable transactions by project. This field requires the Workday Id of the project associated with the billable transactions. To retrieve a valid Id, call GET /projects in the Projects REST service. |
| SpendCategory_Prompt | String | Filters the billable transactions by spend category. This field requires the Workday Id of the spend category associated with the billable transaction related to the expense report line. |
| Task_Prompt | String | Filters the billable transactions by project task. This field requires the Workday Id of the project task associated with the billable transaction for the time entry. To retrieve a valid Id, call GET /planTasks in the Projects REST service. |
| TimeCode_Prompt | String | Filters the billable transactions by time code. This field requires the Workday Id of the time code associated with the billable transaction for the time entry. |
| ToDate_Prompt | Date | Filters the billable transactions to include only those with a transaction date on or before the specified date. This filter uses the YYYY-MM-DD format to define the ending range. |
| TransactionSource_Prompt | String | Filters the billable transactions by transaction source. This field requires the Workday Id of the transaction source to refine the results. |
| Worker_Prompt | String | Filters the billable transactions by worker. This field requires the Workday Id of the worker associated with the billable transaction. To retrieve a valid Id, call GET /workers in the Staffing service. |
Stores metadata about different business process types within the system. This table includes approval workflows, task sequences, and compliance-related processes that govern enterprise operations.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the business process type instance. This Id ensures that each business process type is distinctly tracked and referenced within the system. |
| Descriptor | String | A human-readable summary of the business process type instance. This summary provides a quick reference to the key details about the business process. |
| HelpText | String | The instructional text that appears during the initiation step of a business process. This text provides guidance to users on how to correctly initiate the process and complete required actions. |
Defines allowed attachment categories for each business process type. This table ensures proper documentation management, regulatory compliance, and reference material linkage.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the business process attachment category instance. This Id ensures that each attachment category is distinctly tracked and referenced within the system. |
| BusinessProcessTypes_Id [KEY] | String | The unique Id for the business process type that owns this attachment category. This Id links the attachment category to its associated business process. |
| Descriptor | String | A human-readable summary of the business process attachment category instance. This summary provides a quick reference to the key details about the attachment category. |
| ReferenceID | String | The reference Id used for lookups within Workday Web Services. This Id is also known as the 'Organization ID' for supervisory organizations. |
| EventTarget_Prompt | String | The unique Id for the event target associated with this business process. This Id specifies the target entity, such as a worker, that the business process applies to. A valid Id can be retrieved from an API that returns instances of the event target type. For example, if the event target is a worker, call GET /workers in the Staffing service. |
Tracks instances of business-title changes for employees. This table captures historical data on role adjustments, promotions, and organizational restructuring for reporting and compliance.
The Workday Cloud requires filtering on Id in order to perform the query.
For example:
SELECT * FROM BusinessTitleChanges WHERE Id = '123454';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the business title change instance. This Id ensures that each business title change process is distinctly tracked and referenced. |
| CurrentBusinessTitle | String | The business title for the worker prior to this business process. If no business-title override exists, this field defaults to the job title or job profile name, ensuring consistency with standard job classifications. |
| Descriptor | String | A human-readable summary of the business title change instance. This summary provides a quick reference to key details about the title change. |
| Due | Datetime | The deadline by which the business process must be completed. This date ensures timely execution of the business title change. |
| Effective | Datetime | The date on which the business title change takes effect. This date determines when the new title is officially recognized within the system. |
| Href | String | A direct link to the business title change instance. This link provides programmatic access to retrieve additional details about the instance. |
| Initiated | Datetime | The date and time when the business title change process was initiated. This timestamp helps track when the change request was submitted. |
| Initiator_Descriptor | String | A human-readable summary of the worker who initiated the business title change. This summary identifies the individual responsible for requesting the change. |
| Initiator_Href | String | A direct link to the initiator's instance. This link provides programmatic access to retrieve details about the worker who initiated the process. |
| Initiator_Id | String | The unique Id for the initiator of the business title change. This Id ensures that the correct worker is recorded as initiating the process. |
| ProposedBusinessTitle | String | The new business title for the worker as of the effective date. If no business-title override exists, this field defaults to the job title or job profile name, ensuring alignment with job classifications. |
| Subject_Descriptor | String | A human-readable summary of the worker whose business title is being changed. This summary provides quick identification of the affected individual. |
| Subject_Href | String | A direct link to the subject's instance. This link provides programmatic access to retrieve details about the worker whose title is being changed. |
| Subject_Id | String | The unique Id for the worker whose business title is being updated. This Id ensures that the correct individual is associated with the title change. |
Stores questionnaire response-and-answer pairings from satisfaction surveys that are associated with cases. This table facilitates sentiment analysis, service quality assessment, and operational improvements.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
comment: Text /* Questionnaire attachment comment */
fileName: Text /* File name of the attachment */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| Cases_Id | String | The Workday identifier (Id) of the case that includes this question-answer pair in the satisfaction survey results. This Id links the survey response to the corresponding case record for tracking and reference. |
| Answer | String | The text response provided for the survey question. This field captures qualitative feedback from the user related to the case. |
| Attachments_Aggregate | String | A collection of questionnaire attachments. These attachments can include supporting documents, images, or additional context provided by the respondent. |
| Question | String | The text of the survey question presented to the respondent. This field defines the specific aspect of the case being evaluated or commented on. |
| Desc_Prompt | Bool | If the value is 'true', the query sorts the results in descending order. This option allows users to retrieve the most recent survey responses first when querying data. |
| MyCases_Prompt | Bool | Retrieves cases owned by the processing user. This filter ensures that only cases assigned to or initiated by the user are included in the results. |
| OpenCases_Prompt | Bool | Retrieves open cases and cases that were resolved or canceled less than 7 days ago. This filter helps users focus on active or recently closed cases that might require attention. |
| Sort_Prompt | String | The field used to sort results in query responses. The default sorting field is creationDate, ensuring results are ordered chronologically based on when the case was created. |
Tracks specific actions taken within a case timeline. This table captures operational workflows, resolution steps, and decision-making history for compliance and service monitoring.
The Workday Cloud requires filtering on Cases_Id in order to perform the query.
For example:
SELECT * FROM CasesTimelineActions WHERE Cases_Id = '1234';
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the case timeline action entry. This Id ensures that each recorded action within the case timeline is tracked independently. |
| CasesTimeline_Id [KEY] | String | The Workday Id of the case timeline that contains this action. This Id links the action to a specific timeline entry for proper sequencing of case events. |
| Cases_Id [KEY] | String | The Workday Id of the case that owns this timeline action. This Id ensures that the action is associated with the correct case record for reference and reporting. |
| Text | String | The text description of the action recorded in the case timeline. This field provides details on what action was taken or what update was made. |
| Desc_Prompt | Bool | If set to 'true', the query sorts the results in descending order. This setting ensures the most recent case timeline actions appear first. |
| MyCases_Prompt | Bool | Retrieves case timeline actions for cases owned by the processing user. This filter ensures that only relevant case activity is included in the results. |
| OpenCases_Prompt | Bool | Retrieves timeline actions for open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on active or recently closed case updates. |
| Sort_Prompt | String | Specifies the field used to sort query results. The default sorting field is creationDate, ensuring timeline actions are displayed in chronological order. |
Links knowledge-base article data to case timelines. This table enables agents and users to access relevant guidance materials and best practices for case resolution.
The Workday Cloud requires filtering on Cases_Id in order to perform the query.
For example:
SELECT * FROM CasesTimelineGuidanceKbArticleCurrentArticleData WHERE Cases_Id = '1234';
| Name | Type | Description |
| CasesTimeline_Id | String | The Workday identifier (Id) of the case timeline entry that contains this knowledge base article reference. This Id ensures that the article is linked to the correct timeline event within the case. |
| Cases_Id | String | The Workday Id of the case that owns this knowledge base article reference. This Id ensures that the guidance article is associated with the appropriate case for contextual support. |
| Url | String | The static Uniform Resource Locator (URL) that links to the published version of the knowledge base article. This link dynamically resolves to the latest available version in the user's preferred language. |
| Desc_Prompt | Bool | If set to 'true', the query sorts results in descending order. This option ensures that the most recent knowledge base article references appear first. |
| MyCases_Prompt | Bool | Retrieves knowledge base article references for cases owned by the processing user. This filter ensures that only relevant case-related articles are included in the results. |
| OpenCases_Prompt | Bool | Retrieves knowledge base article references for open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on active or recently closed cases. |
| Sort_Prompt | String | Specifies the field used to sort query results. The default sorting field is creationDate, ensuring article references are displayed in chronological order. |
Records responses to questionnaires that are embedded in case timelines. This table enables structured data collection, survey analytics, and process optimization.
The Workday Cloud requires filtering on Cases_Id in order to perform the query.
For example:
SELECT * FROM CasesTimelineQuestionnaireResponseQuestionAnswerPair WHERE Cases_Id = '1234';
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
comment: Text /* Questionnaire attachment comment */
fileName: Text /* File name of the attachment */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| CasesTimeline_Id | String | The Workday identifier (Id) of the case timeline entry that contains this questionnaire response. This Id ensures that the response is correctly associated with the relevant timeline event within the case. |
| Cases_Id | String | The Workday Id of the case that owns this questionnaire response. This Id ensures that the response is linked to the appropriate case for accurate tracking and reference. |
| Answer | String | The recorded answer for the questionnaire question. This field captures the respondent’s input, which can be used for case resolution or further analysis. |
| Attachments_Aggregate | String | A collection of attachments related to the questionnaire response. These attachments can include supporting documents or additional context provided by the respondent. |
| Question | String | The text of the questionnaire question being answered. This field provides context for the corresponding answer in the response. |
| Desc_Prompt | Bool | If the value is 'true', the query sorts results in descending order. This option ensures that the most recent questionnaire responses appear first. |
| MyCases_Prompt | Bool | Retrieves questionnaire responses for cases owned by the processing user. This filter ensures that only relevant case-related responses are included in the results. |
| OpenCases_Prompt | Bool | Retrieves questionnaire responses for open cases and cases that were resolved or canceled within the last seven days. This filter helps users focus on active or recently closed cases. |
| Sort_Prompt | String | Specifies the field used to sort query results. The default sorting field is creationDate, ensuring responses are displayed in chronological order. |
Generates a list of suggested cases based on the case type. This table uses historical data, user behavior, and system intelligence to improve case-resolution efficiency.
| Name | Type | Description |
| CaseSuggestionContentId | String | The Workday identifier (Id) of the task, learning content, help article, or website link that is suggested as a case resolution. This Id ensures that the suggested resource is properly linked to the case for reference. |
| Description | String | A brief explanation of the suggested case resource. This description provides context on why the suggestion is relevant to the case. |
| Name | String | The name of the suggested resource, which may be a task, knowledge base article, learning content, or a display name for a linked website. This field allows users to quickly identify the suggestion. |
| Order | String | The numerical position of the suggestion in the display order. This value determines the ranking of case suggestions shown to users. |
| Type_Descriptor | String | A human-readable summary of the type of suggestion. This descriptor provides insight into whether the suggestion is a task, help article, or another resource type. |
| Type_Href | String | A direct link to the instance of the case suggestion type. This link allows programmatic access to retrieve additional details about the suggestion. |
| Type_Id | String | The unique Workday Id for the type of suggestion. This Id ensures that each case suggestion is categorized appropriately. |
| Url | String | A Uniform Resource Locator (URL) that opens the suggested case resource. This link directs users to the external or internal resource that can assist in case resolution. |
| CaseType_Prompt | String | The Workday Id of the case type for which suggestions should be retrieved. This prompt allows users to filter case suggestions based on the type of case they are handling. |
Stores definitions of different case types that are available to a worker. This table facilitates categorization of requests, issue tracking, and workflow automation.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) assigned to the case type record. This value is used to reference the case type uniquely within the system. |
| Confidential | Bool | Indicates whether the case type is confidential, affecting its visibility in API calls. This flag is essential for enforcing data privacy by restricting access to sensitive records. |
| Description | String | Provides a detailed explanation of the case type, outlining its purpose and usage. This column offers additional context to help users understand how the case type should be applied in business processes. |
| External | Bool | Specifies whether the case type originates from an external system. A value of 'true' signifies that the case type is managed outside the internal workflow and may require additional integration support. |
| HasQuestionnaire | Bool | Indicates if a questionnaire is associated with the case type. This flag enables the system to prompt users for supplementary information through a structured questionnaire. |
| Name | String | The designated title for the case type, used for display and identification. This field contains a concise and meaningful label that clearly represents the case type to users. |
| Questionnaire_Id | String | The unique Id for the linked questionnaire template, if available. This Id ensures that the correct questionnaire is associated with the case type when applicable. |
| Worker_Prompt | String | Specifies the worker role or prompt used to determine access permissions for case types. This field assists in configuring access control by identifying the responsible personnel. |
Maintains external links associated with case types. This table provides users with quick access to related policies, third-party documentation, or supplementary resources.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) assigned to the external link record. This Id is used to reference the specific external link within the system. |
| CaseTypes_Id [KEY] | String | The unique Id for the parent case type record in Workday. This value links the external link to its corresponding case type. |
| Link | String | Specifies the Uniform Resource Locator (URL) or external reference for the case type. This field enables integration with external systems by providing a direct link to additional information. |
| LinkDescription | String | Provides additional details about the external link associated with the case type. This description clarifies the purpose and usage of the external reference. |
| Worker_Prompt | String | Specifies the worker role or prompt used to determine access permissions for case types. This field assists in enforcing proper access control by identifying the responsible personnel. |
Stores OAuth client authentication details for OCFR clients. This table ensures secure access, identity validation, and compliance with API security protocols.
| Name | Type | Description |
| AuthorizationEndpoint | String | Specifies the Uniform Resource Locator (URL) endpoint where the client can request an authorization code via OAuth 2.0. This endpoint is crucial for initiating the authentication workflow. |
| ClientId | String | The unique identifier (Id) for the OAuth 2.0 client. This Id is used to authenticate the client during the authorization process. |
| GrantType | String | Specifies the type of grant utilized in the OAuth 2.0 flow. This field determines the method by which the client obtains an access token. |
| TokenEndpoint | String | Specifies the URL endpoint for requesting access tokens using OAuth 2.0. This endpoint facilitates the exchange of authorization codes for access tokens. |
| WorkdayAPIEndpoint | String | Specifies the URL endpoint for accessing Workday's API via REST services. This endpoint enables secure communication and data retrieval from Workday. |
| Client_name_Prompt | String | Provides the prompt for displaying the client's name. This field ensures that the client is clearly identified within the system. |
Contains predefined audience segment values. This table supportstargeted communications, access control configurations, and data filtering for different business needs.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the audience record. This value can be referenced as a Workday Id, the Id, or the reference Id within the system. |
| Descriptor | String | Provides a detailed, human-readable description of the audience instance. This field helps users quickly understand the context and content of the record. |
| CollectionToken | String | Specifies a token used to retrieve members of a collection when paired with the Collection_Prompt input. This field returns NULL if the record represents a standalone value rather than a collection. |
| Collection_Prompt | String | Specifies the prompt value derived from the CollectionToken column. This input retrieves all child elements belonging to the collection. |
Stores a list of predefined company values. This table enables standardization in reporting, financial transactions, and business entity relationships.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the company record. This identifier can also be referred to as the Workday Id, the Id, or the reference Id. |
| Descriptor | String | Provides a detailed description of the company instance. This field helps users understand the context and significance of the record. |
| CollectionToken | String | Specifies the token used to retrieve members of a collection when paired with the Collection_Prompt input. A NULL value indicates that the record represents an individual value rather than a collection. |
| Collection_Prompt | String | Specifies the prompt value derived from the CollectionToken column. This input retrieves all child elements within the collection. |
| WorktagType_Prompt | String | Specifies the prompt value for worktag type classification associated with the company record. This field is used to filter or categorize companies based on their worktag attributes. |
Maintains a list of recognized country values that are used for location-based configurations, global compliance tracking, and regional business operations.
| Name | Type | Description |
| Id [KEY] | String | A unique string identifier (Id) for the country record in the Workday database. This Id is used for referencing specific entries. |
| Descriptor | String | A detailed, human-readable label that provides context and key details about the country record. |
| CollectionToken | String | A token used as an input parameter to retrieve a related set of country records. This field is NULL when the record represents a standalone value rather than a collection. |
| Collection_Prompt | String | A parameter value derived from the CollectionToken column that, when provided, returns all associated child records within the country collection. |
Contains a standardized list of currency values. This table ensures consistency in financial transactions, exchange rate applications, and multi-currency reporting.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the currency, which can include the Workday Id, the external system Id, or the reference Id used for integrations and reporting. |
| Descriptor | String | A detailed description of the currency instance that provides clarity in user interfaces and reporting. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value rather than a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt used to specify or filter the type of worktag associated with the currency, enabling retrieval of relevant worktag details. |
Stores customer-related values. This table enables structured customer categorization, customer relationship management (CRM) integrations, and sales process standardization.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the customer, which can include the Workday Id, the external system Id, or the reference Id used for integrations and reporting. |
| Descriptor | String | A detailed description of the customer instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the customer, enabling effective categorization and tagging for customer management. |
Defines standard group values that are used across the system. This table supports team structures, role-based access controls, and organizational unit classifications.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the group, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the group instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a group collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input retrieves all child elements associated with the specified group collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the group, facilitating effective categorization and tagging for group management. |
Maintains predefined hierarchical structures that are used in organizational reporting, management workflows, and data aggregation across business units.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the hierarchy, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the hierarchy instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the hierarchy, enabling effective categorization and tagging for hierarchical management and reporting. |
Contains predefined importance rating values. This table enables prioritization of tasks, cases, risks, and business decisions within workflows.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the importance rating, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the importance rating instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the importance rating, enabling effective categorization and tagging for reporting and analysis. |
Stores optional hierarchy values that are used for structuring flexible organizational models, financial roll-ups, and reporting structures.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the optional hierarchy, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the optional hierarchy instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the optional hierarchy, enabling effective categorization and tagging for hierarchical management and reporting. |
Tracks predefined owner values that are used for data ownership assignment, accountability tracking, and workflow approval structures.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the owner, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the owner instance, used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the owner, enabling effective categorization and tagging for reporting and analysis. |
Stores a list of country phone codes. This table supports global telecommunication standards, contact validation, and regional calling rules.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| CountryPhoneCode | String | The phone code for a country. |
| CountryPhoneCodeID | String | Reference id of the instance |
| Country_Descriptor | String | A preview of the instance |
| Country_Id | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
Defines phone-device type values (for example, mobile, landline, and VoIP). This table ensures proper classification and validation of contact information.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Default | Bool | Returns if Phone Device Type is default |
| Descriptor | String | A preview of the instance |
| HiddenForRecruiting | Bool | Returns if Phone Device Type is hidden for Recruiting. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| MetadataType_Descriptor | String | A description of the instance |
| MetadataType_Href | String | A link to the instance |
| MetadataType_Id | String | wid / id / reference id |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
Contains predefined priority values for tasks, cases, and workflows. This table enables structured triage, service level agreement (SLA) enforcement, and workload management.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the priority, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the priority instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the priority, enabling effective categorization and tagging for reporting and analysis. |
Stores predefined project dependency values. This table facilitates project management, task sequencing, and impact analysis across multiple initiatives.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the project dependency, which can include the Workday Id, the external system Id, or the reference Id used for integrations and reporting. |
| Descriptor | String | A detailed description of the project dependency instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the project dependency, enabling effective categorization and tagging for reporting. |
Stores predefined project state values. This table allows categorization of project progress such as 'Planned,' 'In Progress,' or 'Completed' for reporting and tracking.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the project state, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the project state instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the project state, enabling effective categorization and tagging for reporting and analysis. |
Contains a list of standardized project values. This table supports project categorization, financial tracking, and portfolio management.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the project, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the project instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the project, enabling effective categorization and tagging for reporting and analysis. |
Defines standardized risk-level values. This table enables risk assessment, compliance tracking, and decision-making in business processes.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the risk level, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the risk level instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the risk level, enabling effective categorization and tagging for reporting and analysis. |
Maintains predefined status values used across different workflows. This table ensures consistency in tracking task, case, or project progression.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the status, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the status instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the status, enabling effective categorization and tagging for reporting and analysis. |
Stores predefined success rating values that are used in performance evaluations, project assessments, and business process effectiveness analysis.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the success rating, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the success rating instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type related to the success rating, enabling effective categorization and tagging for reporting and analysis. |
Contains a list of worktags that are used for financial and operational tagging. This table enables classification of transactions, expenses, and projects.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the worktag, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the worktag instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type for the worktag, facilitating effective categorization and tagging for enhanced reporting and analysis. |
Defines types of worktags that are available within the system. This table ensures standardized categorization for cost allocation, reporting, and business segmentation.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the worktag, which can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | A detailed description of the worktag instance. This description is used for display purposes and to provide clarity in user interfaces and reports. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve members of a collection. This value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | A value derived from the CollectionToken column. Providing this input triggers the retrieval of all child elements associated with the specified collection. |
| WorktagType_Prompt | String | A prompt for selecting the appropriate worktag type for the worktag, facilitating effective categorization and tagging for enhanced reporting and analysis. |
Retrieves tenant setup configurations that are related to Help Case Management. This table enables administrators to customize and control case handling processes.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
url: Text /* Static URL to the article view, which will always be resolved to the published version in the users language. */
}]
[{
descriptor: Text /* A preview of the instance */
}]
| Name | Type | Description |
| AllowResolvedCasesToBeReopened | Bool | Specifies whether resolved cases can be reopened. This setting indicates whether users have the ability to reopen cases that were marked as resolved. |
| ConfidentialCasesMessage | String | Displays a confidential cases message. This message provides guidance on handling sensitive case information. |
| CreateCaseInformation_Article_CurrentArticleData_Aggregate | String | Contains aggregated published article data versions for the current article. This field consolidates all available revisions for reference and audit purposes. |
| CreateCaseInformation_Article_Descriptor | String | Provides a concise preview of the article instance. This preview summarizes key details for quick identification and review. |
| CreateCaseInformation_Article_Id | String | Represents the unique identifier (Id) for the article instance. This Id is used to reference and retrieve specific article details. |
| CreateCaseInformation_CreateCaseCustomText | String | Contains custom text entered during case creation. This custom text allows users to add additional context or instructions for the case. |
| DisplayServiceCategories | Bool | Indicates whether service categories are displayed in the user interface. This setting enables users to filter and select the relevant service categories for their case. |
| FileConfigurations_AllFileTypesSupported | Bool | Indicates whether all file attachment types are permitted. This configuration allows any file type to be attached to a case if set to 'true'. |
| FileConfigurations_MaxFileSizeInMB | Decimal | Specifies the maximum file attachment size in megabytes. This limit ensures that attachments remain within acceptable storage parameters. |
| FileConfigurations_SupportedFileTypes_Aggregate | String | Provides a comma-separated list of allowed file types for the tenant. This list includes all permitted file extensions, with each value separated by a comma and a space. |
| MaxAttachments | Decimal | Specifies the maximum number of attachments that can be added to a single case submission. This limit ensures that cases do not exceed the allowed number of file attachments. |
Maintains compliance-related groupings of companies or hierarchical structures. This table ensures regulatory adherence and contract governance.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Stores a token used in conjunction with the Collection_Prompt input to retrieve members of a collection. The value is NULL if the current row represents a standalone value and not a collection. |
| OrganizationReferenceID | String | Reference id of the instance |
| Collection_Prompt | String | Contains a value derived from the CollectionToken column. The value allows users to retrieve all child elements associated with the specified collection. |
Stores predefined contract type groupings for compliance management. This table supports contract lifecycle tracking and legal adherence.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Stores a token used in conjunction with the Collection_Prompt input to retrieve members of a collection. The value is NULL if the current row represents a standalone value and not a collection. |
| SupplierContractTypeID | String | Reference id of the instance |
| Collection_Prompt | String | Contains a value derived from the CollectionToken column. The value allows users to retrieve all child elements associated with the specified collection. |
Retrieves standardized information about countries, including country codes, regional groupings, and regulatory requirements for global operations.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the country instance. The Id is used to reference and retrieve specific country details. |
| Alpha2Code | String | Stores the ISO alpha-2 code for a country. The alpha-2 code is a two-letter country code defined by the ISO 3166 standard. |
| Alpha3Code | String | Stores the ISO alpha-3 code for a country. The alpha-3 code is a three-letter country code defined by the ISO 3166 standard. |
| Descriptor | String | Provides a preview of the country instance. The preview includes key details that help users quickly identify and review the country. |
| EnabledForAddressLookup | Bool | Indicates whether the country is enabled for address lookup. A value of 'true' means that address lookup services are available for this country. |
| Href | String | Contains a link to the country instance. The link allows users or systems to access additional details about the country. |
Defines allowed address components and their configurations for each country. This table ensures accurate address validation and formatting compliance.
| Name | Type | Description |
| Countries_Id | String | Stores the Workday identifier (Id) for the country that owns this address component. The Id establishes the relationship between the address component and its corresponding country. |
| ComponentType_Descriptor | String | Provides a description of the address component type. The description helps users understand the function and classification of the component. |
| ComponentType_Href | String | Contains a link to the address component type instance. The link allows users or systems to access additional details about the component. |
| ComponentType_Id | String | Represents the unique Id for the address component type. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Label | String | Stores a country-specific label override for an address component. If no country-specific override exists, the generic component name is used. For example, in the United States, the label 'State' overrides the generic component name 'Region.' |
| Order | String | Specifies the order in which the address component appears on the address maintenance page. The display order of an address component is determined based on country-specific formatting rules. |
| Required | Bool | Indicates whether the address component is required for the country. A 'True' value means the component must be provided when entering an address for the specified country. |
| Type | String | Defines the type of address component. The type categorizes the component based on its function within the address structure. |
| WebServiceAlias | String | Stores the custom Web Service Alias defined for an address component. The alias is used for integration with the Recruiting API and other web services. |
| AddressConfigurationFormat_Prompt | String | Represents a prompt for selecting the address configuration format. The prompt helps users return values based on the selected address format. |
| CurrentAddress_Prompt | String | Represents a prompt for specifying the existing address that is being updated. The prompt ensures that updates are applied to the correct address record. |
| UseWesternScript_Prompt | Bool | Indicates whether local script components should be enabled for countries using a local script in the default format. A 'True' value enables local script support. |
Maintains name component configurations for different countries. This table ensures proper formatting of personal and business names based on regional conventions.
| Name | Type | Description |
| Countries_Id | String | Stores the Workday identifier (Id) for the country that owns this name component. The Id establishes the relationship between the name component and its corresponding country. |
| ComponentType_Descriptor | String | Provides a description of the name component type. The description helps users understand the function and classification of the component. |
| ComponentType_Href | String | Contains a link to the name component type instance. The link allows users or systems to access additional details about the component. |
| ComponentType_Id | String | Represents the unique Id for the name component type. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Label | String | Stores a country-specific label override for a name component. If no country-specific override exists, the generic name component name is used. For example, in Russia, the label 'Patronymic Name' overrides the generic component name 'Secondary.' |
| Order | String | Specifies the order assigned to the name component in the Maintain Name Components by Country task. The display order of a name component is determined based on country-specific formatting rules. |
| Required | Bool | Indicates whether the name component is required for the country. A 'True' value means the component must be provided when entering a name for the specified country. |
| ShowDisplayOnlyOnPreferred | Bool | Indicates whether the name component is display-only for a preferred name. This setting applies only to China and restricts modifications for specific name components. |
| Type | String | Defines the type of name component. The type categorizes the component based on its function within the name structure. |
| WebServiceAlias | String | Stores the custom Web Service Alias defined for a name component. The alias is used for integration with the Recruiting API and other web services. |
| CurrentName_Prompt | String | Represents a prompt for specifying the Workday Id of the person's current name being updated. The prompt ensures that updates are applied to the correct name record. |
| NameConfigurationFormat_Prompt | String | Represents a prompt for selecting the name configuration format. The prompt helps users return values based on the selected name format. |
| UseWesternScript_Prompt | Bool | Indicates whether the method returns the set of allowed and required name components using Western Script. A 'True' value enables Western Script formatting. |
Contains predefined values for country-city relationships. This table supports regional mapping, tax jurisdiction tracking, and location-based services.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the country-component city instance. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | Provides a detailed description of the country component city instance. The description helps users understand the purpose and classification of the city within the country component structure. |
| CollectionToken | String | Stores a token used in conjunction with the Collection_Prompt input to retrieve members of a collection. The value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | Contains a value derived from the CollectionToken column. The value allows users to retrieve all child elements associated with the specified collection. |
Defines country-region associations. This table ensures accurate mapping of administrative divisions such as states, provinces, and territories.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the country component region instance. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | Provides a detailed description of the country component region instance. The description helps users understand the purpose and classification of the region within the country component structure. |
| CollectionToken | String | Stores a token used in conjunction with the Collection_Prompt input to retrieve members of a collection. The value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | Contains a value derived from the CollectionToken column. The value allows users to retrieve all child elements associated with the specified collection. |
Stores predefined country values. This table facilitates standardization in international transactions, compliance reporting, and address verification.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the country component instance. The Id can include the Workday Id, the external system Id, or the reference Id that is used for integrations and reporting. |
| Descriptor | String | Provides a detailed description of the country component instance. The description helps users understand the purpose and classification of the country within the component structure. |
| CollectionToken | String | Stores a token used in conjunction with the Collection_Prompt input to retrieve members of a collection. The value is NULL if the current row represents a standalone value and not a collection. |
| Collection_Prompt | String | Contains a value derived from the CollectionToken column. The value allows users to retrieve all child elements associated with the specified collection. |
Contains details about individual courses, including course descriptions, credits, prerequisites, and availability for academic offerings.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the course instance. The Id is used to reference and retrieve specific course details. |
| AcademicLevel_Descriptor | String | Provides a preview of the academic level associated with the course. The preview includes key details that help users quickly identify and understand the academic level. |
| AcademicLevel_Id | String | Represents the unique Id for the academic level associated with the course. The Id is used to reference and retrieve specific academic level details. |
| CourseSubject_Descriptor | String | Provides a description of the course subject instance. The description helps users understand the classification and categorization of the course subject. |
| CourseSubject_Href | String | Contains a link to the course subject instance. The link allows users or systems to access additional details about the course subject. |
| CourseSubject_Id | String | Represents the unique Id for the course subject. The Id can include the Workday Id, the external system Id, or a reference Id used for integrations and reporting. |
| Description | String | Stores the course description from the course definition associated with this student course. The description provides context about the course content and objectives. |
| Descriptor | String | Provides a preview of the course instance. The preview includes key details that help users quickly recognize and review the course. |
| EligibilityRule_Descriptor | String | Provides a preview of the eligibility rule associated with the course. The preview summarizes key details about the eligibility criteria. |
| EligibilityRule_EligibilityRuleMeaning | String | Defines the meaning of the eligibility rule. The rule meaning provides insights into the criteria required for enrollment or participation in the course. |
| EligibilityRule_Id | String | Represents the unique Id for the eligibility rule instance. The Id is used to reference and retrieve specific eligibility rule details. |
| InstitutionalAcademicUnit_Id | String | Represents the unique Id for the institutional academic unit associated with the course. The Id establishes the relationship between the course and its academic unit. |
| InstitutionalAcademicUnit_Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. A 'True' value means the academic unit is not active. |
| InstitutionalAcademicUnit_Institution | Bool | Indicates whether the academic unit is designated as an institution as of the effective date. A 'True' value means the unit functions as an institution. |
| InstitutionalAcademicUnit_Name | String | Stores the name of the academic unit as of the effective date. The name helps identify the academic unit within the institution. |
| ListingNumber | String | Represents the course number of the course listing. The course number helps categorize and reference the course within the academic system. |
| Title | String | Stores the course title from the course definition associated with this student course. The title provides a concise summary of the course content. |
| AcademicLevel_Prompt | String | Represents a prompt for selecting the academic level used by the courses. The academic level can be specified using the Workday Id or reference Id, and retrieved from GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | Represents a prompt for selecting the academic unit used by the course. Multiple academic unit query parameters can be specified using the Workday Id or reference Id, and retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | Represents a prompt for selecting the subject for the course. The course subject can be specified using the Workday Id or reference Id, and retrieved from GET /courseSubjects. |
| EffectiveDate_Prompt | Date | Represents a prompt for specifying the effective date of the course’s effective-dated fields. These fields include competencies, academic level, typical periods offered, academic units, allowed locations, owning institutional academic unit, tags, description, eligibility rule, instructional formats, learning outcomes, and title. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | Represents a prompt for selecting the institutional academic unit used by the course. The unit can be specified using the Workday Id or reference Id, and retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | Represents a prompt for searching course information. The prompt allows users to specify search criteria for retrieving relevant course details. |
Links courses to their respective academic units. This table supports departmental ownership, program alignment, and reporting on course distribution.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the course academic unit instance. The Id ensures that each academic unit association can be referenced and retrieved individually. |
| Courses_Id [KEY] | String | Stores the Workday Id for the course that contains this academic unit. The Id links the academic unit to its corresponding course. |
| Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. A 'True' value means the academic unit is no longer active for course assignments. |
| Institution | Bool | Indicates whether the academic unit is designated as an institution as of the effective date. A 'True' value means the unit functions as an institution within the academic system. |
| Name | String | Stores the name of the academic unit as of the effective date. The name provides identification and classification within the institution. |
| AcademicLevel_Prompt | String | Represents a prompt for selecting the academic level used by the courses. The academic level can be specified using the Workday Id or reference Id and can be retrieved from GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | Represents a prompt for selecting the academic unit used by the course. Multiple academic unit query parameters can be specified using the Workday Id or reference Id and can be retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | Represents a prompt for selecting the subject for the course. The course subject can be specified using the Workday Id or reference Id, and retrieved from GET /courseSubjects. |
| EffectiveDate_Prompt | Date | Represents a prompt for specifying the effective date of the course’s effective-dated fields. These fields include competencies, academic level, typical periods offered, academic units, allowed locations, owning institutional academic unit, tags, description, eligibility rule, instructional formats, learning outcomes, and title. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | Represents a prompt for selecting the institutional academic unit used by the course. The unit can be specified using the Workday Id or reference Id and can be retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | Represents a prompt for searching course academic unit information. The prompt allows users to specify search criteria for retrieving relevant academic unit details. |
Defines the locations where a course is permitted to be offered. This table ensures compliance with institutional policies and facility availability.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the allowed course location instance. The Id ensures that each location assignment can be referenced and retrieved individually. |
| Courses_Id [KEY] | String | Stores the Workday Id for the course that contains this allowed location. The Id links the allowed location to its corresponding course. |
| Descriptor | String | Provides a preview of the allowed course location instance. The preview includes key details that help users quickly recognize and review the location. |
| AcademicLevel_Prompt | String | Represents a prompt for selecting the academic level used by the courses. The academic level can be specified using the Workday Id or reference Id and can be retrieved from GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | Represents a prompt for selecting the academic unit used by the course. Multiple academic-unit query parameters can be specified using the Workday Id or reference Id and can be retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | Represents a prompt for selecting the subject for the course. The course subject can be specified using the Workday Id or reference Id and can be retrieved from GET /courseSubjects. |
| EffectiveDate_Prompt | Date | Represents a prompt for specifying the effective date of the course’s effective-dated fields. These fields include competencies, academic level, typical periods offered, academic units, allowed locations, owning institutional academic unit, tags, description, eligibility rule, instructional formats, learning outcomes, and title. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | Represents a prompt for selecting the institutional academic unit used by the course. The unit can be specified using the Workday Id or reference Id and can retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | Represents a prompt for searching allowed course location information. The prompt allows users to specify search criteria for retrieving relevant course location details. |
Associates courses with specific competencies. This table enables skills-based learning assessments and alignment with certification requirements.
| Name | Type | Description |
| Id [KEY] | String | Represents the unique identifier (Id) for the course competency instance. The Id ensures that each competency assignment can be referenced and retrieved individually. |
| Courses_Id [KEY] | String | Stores the Workday Id for the course that contains this competency. The Id links the competency to its corresponding course. |
| Descriptor | String | Provides a preview of the course competency instance. The preview includes key details that help users quickly recognize and review the competency. |
| AcademicLevel_Prompt | String | Represents a prompt for selecting the academic level used by the courses. The academic level can be specified using the Workday Id or reference Id and can be retrieved from GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | Represents a prompt for selecting the academic unit used by the course. Multiple academic-unit query parameters can be specified using the Workday Id or reference Id and can retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | Represents a prompt for selecting the subject for the course. The course subject can be specified using the Workday Id or reference Id and can be retrieved from GET /courseSubjects. |
| EffectiveDate_Prompt | Date | Represents a prompt for specifying the effective date of the course’s effective-dated fields. These fields include competencies, academic level, typical periods offered, academic units, allowed locations, owning institutional academic unit, tags, description, eligibility rule, instructional formats, learning outcomes, and title. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | Represents a prompt for selecting the institutional academic unit used by the course. The unit can be specified using the Workday Id or reference Id, and retrieved from GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | Represents a prompt for searching course competency information. The prompt allows users to specify search criteria for retrieving relevant competency details. |
Contains records of course sections, including scheduling details, instructor assignments, and enrolled student counts.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the course section instance. |
| AcademicLevel_Descriptor | String | A description of the academic level associated with the course section, such as undergraduate, graduate, or doctoral. |
| AcademicLevel_Href | String | A link to the academic level instance providing further details. |
| AcademicLevel_Id | String | The system-generated Id or reference Id for the academic level instance. |
| AcademicPeriod_Descriptor | String | A description of the academic period associated with the course section, such as Fall 2025 or Spring 2026. |
| AcademicPeriod_Href | String | A link to the academic period instance providing further details. |
| AcademicPeriod_Id | String | The system-generated Id or reference Id for the academic period instance. |
| Capacity | Decimal | The maximum number of students that can enroll in this course section. |
| Cluster_Descriptor | String | A description of the cluster associated with the course section, which can refer to a grouping of related courses or instructional units. |
| Cluster_Href | String | A link to the cluster instance providing further details. |
| Cluster_Id | String | The system-generated Id or reference Id for the cluster instance. |
| CourseSubject_Descriptor | String | A description of the subject area to which the course belongs, such as Mathematics, Biology, or History. |
| CourseSubject_Href | String | A link to the course subject instance providing further details. |
| CourseSubject_Id | String | The system-generated Id or reference Id for the course subject instance. |
| Course_Descriptor | String | A description of the course associated with this section, including course title or summary. |
| Course_Href | String | A link to the course instance providing further details. |
| Course_Id | String | The system-generated Id or reference Id for the course instance. |
| DeliveryMode_Descriptor | String | A description of the mode of delivery for the course section, such as in-person, online, or hybrid. |
| DeliveryMode_Href | String | A link to the delivery mode instance providing further details. |
| DeliveryMode_Id | String | The system-generated Id or reference Id for the delivery mode instance. |
| Descriptor | String | A general preview or summary of the course section instance. |
| EligibilityRule_Descriptor | String | A preview of the eligibility criteria required for enrollment in the course section. |
| EligibilityRule_EligibilityRuleMeaning | String | The meaning or purpose of the eligibility rule, explaining any prerequisites or restrictions for enrollment. |
| EligibilityRule_Id | String | The unique Id for the eligibility rule instance. |
| EndDate | Datetime | The date when the course section officially concludes. |
| Hidden | Bool | Indicates whether the course section is hidden from student or public view. A value of 'true' means that it is hidden. |
| InstructionalFormat_Descriptor | String | A description of the instructional format used in the course section, such as lecture, seminar, or lab. |
| InstructionalFormat_Href | String | A link to the instructional format instance providing further details. |
| InstructionalFormat_Id | String | The system-generated Id or reference Id for the instructional format instance. |
| OwningAcademicUnit_Id | String | The unique Id for the academic unit responsible for offering the course section. |
| OwningAcademicUnit_Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. A value of 'true' means that it is inactive. |
| OwningAcademicUnit_Institution | Bool | Indicates whether the academic unit functions as an institution. A value of 'true' means it is classified as an institution as of the effective date. |
| OwningAcademicUnit_Name | String | The official name of the academic unit responsible for the course section, as of the effective date. |
| OwningInstitutionalAcademicUnit_Id | String | The unique Id for the institutional academic unit associated with the course section. |
| OwningInstitutionalAcademicUnit_Inactive | Bool | Indicates whether the institutional academic unit is inactive as of the effective date. A value of 'true' means that it is inactive. |
| OwningInstitutionalAcademicUnit_Institution | Bool | Indicates whether the institutional academic unit is designated as an institution as of the effective date. A value of 'true' means that it is classified as an institution. |
| OwningInstitutionalAcademicUnit_Name | String | The official name of the institutional academic unit responsible for the course section, as of the effective date. |
| StartDate | Datetime | The date when the course section officially begins. |
| Status_Descriptor | String | A description of the current status of the course section, such as open, closed, or waitlisted. |
| Status_Href | String | A link to the status instance providing further details. |
| Status_Id | String | The system-generated Id or reference Id for the status instance. |
| AcademicLevel_Prompt | String | The academic level used by the course section. You can specify using the Workday Id or reference Id. You can retrieve a valid Id from GET /academicLevels in the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The starting academic period of the course section. You can specify using the Workday Id or reference Id. You can retrieve a valid Id from GET /academicPeriods in the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The campus location where the course section is offered. This location can be specified using the appropriate Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject associated with the course section. You can specify this subject using the Workday Id or reference Id. You can retrieve a valid Id from GET /courseSubjects. |
| Course_Prompt | String | The course associated with the course section. You can specify this course using the Workday Id or reference Id. You can retrieve a valid Id from GET /courses. |
| DeliveryMode_Prompt | String | The mode of delivery for the course section. You can specify this mode using the Workday Id or reference Id. Available values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The instructional format for the course section. You can specify using the Workday Id or reference Id. Available values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit that offers this course section. You can specify multiple academic-unit query parameters using the Workday Id or reference Id. You can retrieve a valid Id from GET /academicUnits in the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns this course section. You can specify the academic unit using the Workday Id or reference Id. You can retrieve a valid Id from GET /academicUnits in the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section. You can specify using the Workday Id or reference Id. You can retrieve a valid Id from GET /academicUnits in the studentAcademicFoundation service. |
| Status_Prompt | String | The section status of the course section. You can specify using the Workday Id or reference Id. Available values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Defines campus locations where specific course sections are held. This table supports logistical planning and facility management.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (Id) for the course section campus location instance, which distinguishes this specific record in the system. |
| CourseSections_Id [KEY] | String | The Workday Id for the course section to which this campus location is linked. This Id connects the campus location to its corresponding course section. |
| Descriptor | String | A general preview or summary of the course section campus location instance, often used for display purposes. |
| AcademicLevel_Prompt | String | The academic level associated with the course section, such as Undergraduate, Graduate, or Doctoral. You can specify this academic level using the Workday Id or reference Id. A valid Id can be retrieved from GET /academicLevels in the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic period when the course section is scheduled to take place, such as Fall 2025 or Spring 2026. You can specify this academic period using the Workday Id or reference Id. A valid Id can be retrieved from GET /academicPeriods in the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The physical or virtual campus location where the course section is conducted. This location can represent a specific building, classroom, or an online platform. You can specify this campus location using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which the course section belongs, such as Mathematics, Biology, or History. You can specify this subject using the Workday Id or reference Id. A valid Id can be retrieved from GET /courseSubjects. |
| Course_Prompt | String | The specific course that the course section is a part of, such as 'Introduction to Psychology' or 'Advanced Calculus.' You can specify this course using the Workday Id or reference Id. A valid Id can be retrieved from GET /courses. |
| DeliveryMode_Prompt | String | The mode in which the course section is delivered to students, such as in-person, online, or hybrid. You can specify this delivery mode using the Workday Id or reference Id. Available values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The instructional format that defines how the course section is taught, such as lecture, seminar, or laboratory. You can specify this instructional format using the Workday Id or reference Id. Available values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department, school, or college. This unit manages the course but might not necessarily own it. You can specify this academic unit using the Workday Id or reference Id. A valid Id can be retrieved from GET /academicUnits in the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns this course section, meaning it has primary authority over its content and administration. This could be a specific department, school, or division within an institution. You can specify this academic unit using the Workday Id or reference Id. A valid Id can be retrieved from GET /academicUnits in the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The institutional academic unit that owns this course section, which may be a larger administrative entity such as a college or faculty. You can specify this institutional academic unit using the Workday Id or reference Id. A valid Id can be retrieved from GET /academicUnits in the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, which determines whether enrollment is open, closed, or restricted. You can specify this status using the Workday Id or reference Id. Available values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Links course sections to associated competencies. This table tracks how individual sections contribute to competency-based education outcomes.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course-section competency record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this competency is associated. |
| Descriptor | String | A brief textual preview that summarizes the competency record. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section is held. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course that this section is associated with. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Stores details about course section components, such as lectures, labs, and discussion groups. This table ensures complete scheduling and workload tracking.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course section component record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this component is associated. |
| Descriptor | String | A brief textual preview that summarizes the course section component. |
| Location | String | The display Id for the physical or virtual location where the activity offering component is held. |
| MeetingPattern_Descriptor | String | A brief textual preview of the meeting pattern assigned to this course section component. |
| MeetingPattern_Id | String | The system-generated Id for the meeting pattern associated with this course section component. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section component is held. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course with which this section is associated. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Maintains instructor assignments for course sections. This table tracks faculty workload, teaching responsibilities, and student-instructor interactions.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course section instructor record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this instructor is associated. |
| Descriptor | String | A brief textual preview that summarizes the instructor's role in the course section. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section is conducted. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course that this section is associated with. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Links course sections to expected learning outcomes. This table ensures alignment with accreditation standards and student assessment metrics.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course section learning outcome record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this learning outcome is associated. |
| Descriptor | String | A brief textual preview that summarizes the learning outcome for this course section. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section is conducted. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course that this section is associated with. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Associates course sections with the academic units that offer them. This table supports departmental resource allocation and reporting.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course section offering academic unit record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this academic unit is associated. |
| Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. If the value is 'true', the academic unit is no longer active. |
| Institution | Bool | Indicates whether the academic unit is classified as an institution as of the effective date. If the value is 'true', the academic unit represents an institution. |
| Name | String | The official name of the academic unit as of the effective date. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section is conducted. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course with which this section is associated. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Stores keyword tags for course sections. This table enhances searchability and categorization for curriculum management.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course section tag record. |
| CourseSections_Id [KEY] | String | The Workday Id of the Course Sections record with which this tag is associated. |
| Descriptor | String | A brief textual preview that summarizes the tag assigned to the course section. |
| AcademicLevel_Prompt | String | The academic level assigned to the course section, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicPeriod_Prompt | String | The academic term or period in which the course section is offered, such as Fall 2025 or Spring 2026. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicPeriods from the studentAcademicFoundation service. |
| CampusLocation_Prompt | String | The specific campus or location where the course section is conducted. You can specify this using the Workday Id or reference Id. |
| CourseSubject_Prompt | String | The subject area to which this course section belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| Course_Prompt | String | The specific course with which this section is associated. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courses. |
| DeliveryMode_Prompt | String | The method by which instruction is delivered for this course section. You can specify this using the Workday Id or reference Id. Valid values include Correspondence, Hybrid, In-Person, Online, and Other Distance Mode. |
| InstructionalFormat_Prompt | String | The format in which instruction is provided for this course section, such as Lecture, Laboratory, or Seminar. You can specify this using the Workday Id or reference Id. Valid values include Clinical, Combination, Discussion, Experiential, Independent Study, Internship, Laboratory, Lecture, Recitation, Research, Seminar, Service Learning, Studio, Thesis, and Workshop. |
| OfferingAcademicUnit_Prompt | String | The academic unit responsible for offering this course section, such as a department or school. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningAcademicUnit_Prompt | String | The academic unit that owns and manages this course section, which can differ from the offering academic unit. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| OwningInstitutionalAcademicUnit_Prompt | String | The higher-level institutional academic unit, such as a college or faculty, that owns this course section. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Status_Prompt | String | The current status of the course section, indicating whether it is available for enrollment. You can specify this using the Workday Id or reference Id. Valid values include Preliminary, Open, Closed, Waitlist, Hold, and Canceled. |
Defines instructional formats for courses, such as online, in-person, or hybrid. This table supports flexible course-delivery models.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course instruction format record. |
| Courses_Id [KEY] | String | The Workday Id of the Courses record with which this instruction format is associated. |
| Descriptor | String | A brief textual preview that summarizes the instruction format for the course. |
| AcademicLevel_Prompt | String | The academic level assigned to the course, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | The academic unit responsible for the course. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | The subject area to which this course belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| EffectiveDate_Prompt | Date | The date on which changes to the course's effective-dated fields (for example, competencies, academic level, typical periods offered, academic units, and so on) take effect. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit that governs this course, such as a college or faculty. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | A search field that is used for retrieving courses based on various parameters. |
Stores learning outcomes that are associated with courses. This table ensures program objectives align with educational goals and accreditation requirements.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course learning outcome record. |
| Courses_Id [KEY] | String | The Workday Id of the Courses record with which this learning outcome is associated. |
| Descriptor | String | A brief textual preview that summarizes the learning outcome for the course. |
| AcademicLevel_Prompt | String | The academic level assigned to the course, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | The academic unit responsible for the course. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | The subject area to which this course belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| EffectiveDate_Prompt | Date | The date on which changes to the course's effective-dated fields (for example, competencies, academic level, typical periods offered, academic units, and so on) take effect. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit that governs this course, such as a college or faculty. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | A search field that is used for retrieving courses based on various parameters. |
Contains keyword tags for courses. This table enables categorization and search optimization within course catalogs.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course tag record. |
| Courses_Id [KEY] | String | The Workday Id of the Courses record with which this tag is associated. |
| Descriptor | String | A brief textual preview that summarizes the tag assigned to the course. |
| AcademicLevel_Prompt | String | The academic level assigned to the course, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | The academic unit responsible for the course. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | The subject area to which this course belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| EffectiveDate_Prompt | Date | The date on which changes to the course's effective-dated fields (for example, competencies, academic level, typical periods offered, academic units, and so on) take effect. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit that governs this course, such as a college or faculty. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | A search field that is used for retrieving courses based on various parameters. |
Tracks typical periods in which courses are offered. This table supports scheduling, academic planning, and enrollment forecasting.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course typical periods followed record. |
| Courses_Id [KEY] | String | The Workday Id of the Courses record with which this typical period is associated. |
| Descriptor | String | A brief textual preview that summarizes the typical periods followed for the course. |
| AcademicLevel_Prompt | String | The academic level assigned to the course, which determines the level of study (such as Undergraduate or Graduate). You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicLevels from the studentAcademicFoundation service. |
| AcademicUnit_Prompt | String | The academic unit responsible for the course. You can specify multiple academic units using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| CourseSubject_Prompt | String | The subject area to which this course belongs, such as Mathematics, Biology, or History. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /courseSubjects. |
| EffectiveDate_Prompt | Date | The date on which changes to the course's effective-dated fields (for example, competencies, academic level, typical periods offered, academic units, and so on) take effect. The format for input is YYYY-MM-DD. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit that governs this course, such as a college or faculty. You can specify this using the Workday Id or reference Id. Retrieve valid values using GET /academicUnits from the studentAcademicFoundation service. |
| Search_Prompt | String | A search field that is used for retrieving courses based on various parameters. |
Stores academic subjects, categorizing courses into subject areas for curriculum organization and program structuring.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course subject record, uniquely distinguishing it from other course subjects in the Workday system. |
| Abbreviation | String | The abbreviated code used to represent the course subject, typically consisting of a short abbreviation (for example, 'MATH' for Mathematics, 'BIO' for Biology, and 'ENG' for English). This abbreviation is often used in course catalogs, transcripts, and reporting. |
| Descriptor | String | A brief textual preview that summarizes the course subject, providing an overview of its focus area or discipline. |
| Inactive | Bool | Indicates whether the course subject is inactive in the Workday system. If the value is 'true', the course subject is no longer available for use in course offerings, scheduling, or academic planning. |
| Inactive_Prompt | Bool | Indicates whether the course subject is inactive as of the effective date. If the value is 'true', the course subject is no longer valid for new courses or academic planning. However, historical records might still reference it. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit responsible for overseeing this course subject, such as a college, faculty, or academic department (for example, College of Arts and Sciences or School of Engineering). This unit ensures that courses within this subject align with institutional academic standards. You can specify this using the Workday Id or reference Id. |
Links course subjects to institutional academic units. This table ensures proper curriculum governance and reporting alignment.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this course subject institutional academic unit record, uniquely distinguishing it from other records in the Workday system. |
| CourseSubjects_Id [KEY] | String | The Workday Id of the Course Subject with which this institutional academic unit is associated. This links the course subject to its governing academic unit. |
| Inactive | Bool | Indicates whether the academic unit is inactive as of the effective date. If the value is 'true', this academic unit is no longer active for new course associations. However, historical data might still reference it. |
| Institution | Bool | Indicates whether the academic unit is classified as an institution as of the effective date. If the value is 'true', this unit represents an institution rather than a department or faculty. |
| Name | String | The official name of the academic unit as of the effective date. This value represents the name of the institution, faculty, or department overseeing the course subject. |
| Inactive_Prompt | Bool | Indicates whether the course subject is inactive as of the effective date. If the value is 'true', the course subject is no longer valid for new courses or academic planning. However, historical records might still reference it. |
| InstitutionalAcademicUnit_Prompt | String | The institutional academic unit responsible for governing this course subject, such as a college, faculty, or university division (for example, College of Arts and Sciences or School of Business). This unit ensures academic alignment and curriculum oversight. You can specify this using the Workday Id or reference Id. |
Maintains details about all currencies in the tenant, including currency codes, exchange rate configurations, and regional applicability.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier for this currency record, uniquely distinguishing it in the system. |
| Code | String | The standard currency code, typically following the ISO 4217 format (for example, USD for US Dollar, EUR for Euro). |
| Descriptor | String | A brief textual preview or description of the currency, providing a human-readable reference. |
| Precision | Decimal | The number of decimal places used for the currency. This number indicates the level of precision required for calculations and transactions (for example, 2 for USD, 3 for JOD). |
Contains customer profile data, including contact details, purchase history, and account preferences for business operations and CRM integrations.
| Name | Type | Description |
| Id [KEY] | String | The system-generated identifier (Id) for this customer record, uniquely distinguishing it in the system. This Id is used internally by Workday to reference the customer in transactions, reports, and integrations. |
| Category_Descriptor | String | A brief textual description of the customer category, providing a human-readable reference. Customer categories are used to classify customers based on attributes such as business type, industry, or risk level. |
| Category_Href | String | A link to the Workday resource for the customer category, allowing retrieval of additional details about the category, such as its definition, applicable customers, and financial implications. |
| Category_Id | String | The unique Id for the customer category, which can be a Workday Id, an internal Id, or a reference Id. This value is used in API calls and integrations to link a customer to a predefined category. |
| CommercialCreditScore | Decimal | The Dun and Bradstreet commercial credit score assigned to the customer, indicating their creditworthiness based on financial data, payment history, and business risk factors. A higher score represents lower credit risk, influencing the terms and limits of credit extended to the customer. |
| CompositeRiskScore | Decimal | The Dun and Bradstreet composite risk score for the customer, assessing their overall financial stability and risk level. This score helps businesses evaluate potential financial exposure and make informed credit decisions. |
| CreditLimit_Currency | String | The currency in which the customer's maximum credit limit is defined, typically following ISO 4217 standards (for example, USD for US Dollar, EUR for Euro). This field ensures consistency in financial reporting and transactions. |
| CreditLimit_Value | Decimal | The maximum credit amount that can be extended to the customer, based on their financial standing and risk profile. This value determines the upper limit for outstanding balances on invoices before additional approvals or restrictions apply. |
| Name | String | The official name of the customer, as recorded in the Workday system. This name appears on invoices, reports, and financial transactions. |
| PaymentTerms_Descriptor | String | A brief textual description of the payment terms assigned to the customer, such as 'Net 30' (payment due 30 days after invoice) or 'Due on Receipt' (payment required immediately upon invoicing). Payment terms influence cash flow and financial planning. |
| PaymentTerms_Href | String | A link to the Workday resource for the customer's payment terms, allowing retrieval of additional details (for examples, payment schedules, late fees, and applicable discounts). |
| PaymentTerms_Id | String | The unique Id for the payment terms assigned to the customer, which can be a Workday Id, an internal Id, or a reference Id. This value is used in financial transactions and reporting to ensure accurate tracking of payment conditions. |
| PrimaryPhone | String | The primary phone number associated with the customer, used for business communications, account inquiries, and support services. |
| SatisfactionScore | Decimal | A numerical score representing customer satisfaction, based on feedback, surveys, or performance metrics. This score can be used in customer relationship management (CRM) processes to track engagement and loyalty. |
| TotalBalance_Currency | String | The currency in which the total customer balance is recorded, typically following ISO 4217 standards (for example, USD for US Dollar, EUR for Euro). The balance currency can differ from the default company currency if transactions are conducted in multiple currencies. |
| TotalBalance_Value | Decimal | The total outstanding balance due from the customer, calculated as the sum of all approved and uncanceled customer invoices minus the total amount of all approved and uncanceled customer payments. This value represents the total amount owed by the customer as of the report run time. |
| Name_Prompt | String | A reference field used to specify or retrieve the customer's name in Workday, typically used in reports, integrations, and API calls. |
Tracks activities that are associated with customers, such as transactions, interactions, and engagement metrics. This table supports customer relationship management.
| Name | Type | Description |
| Id [KEY] | String | The system-generated Workday identifier (Id) for this customer activity record, uniquely distinguishing it in the system. |
| Customers_Id [KEY] | String | The Workday Id of the customer associated with this activity, linking the transaction to a specific customer record. |
| ApplicationStatus | String | The payment or application status of the customer invoice, invoice adjustment, or invoice payment. Possible values for customer invoice payments include Unapplied, Applied with On Account, or Fully Applied. For invoices, statuses can include Paid, Partially Paid, or Unpaid. |
| InvoiceDueDate | Datetime | The due date for the customer invoice or invoice adjustment as of the defined reporting date, indicating when payment is expected. |
| InvoiceOpportunity_Id | String | The Workday Id of the invoice-related opportunity associated with this customer activity. |
| InvoiceOpportunity_Name | String | The non-unique name assigned to the invoice opportunity. This name is used for internal tracking purposes. |
| InvoiceOpportunity_OpportunityReferenceID | String | The reference Id used for lookups within Workday Web Services. For supervisory organizations, this is also known as the 'Organization ID'. |
| PaymentReference | String | The check number or reference number for a customer payment. This value is only available when processed through a settlement run and does not represent a check number. |
| TransactionAmountSigned_Currency | String | The currency of the transaction amount, indicating whether it is positive or negative in the context of customer transactions. |
| TransactionAmountSigned_Value | Decimal | The transaction amount, including the sign to indicate whether it is a debit or credit. Used internally in REST API processing. |
| TransactionDate | Datetime | The date when the customer transaction was recorded> This date is used for reporting and tracking purposes. |
| TransactionNumber | String | The unique transaction number associated with the reporting transaction. This transaction number is used internally for tracking in REST APIs. |
| TransactionStatus | String | The current status of the transaction, applicable across all transaction types. This status is used internally for transaction processing and reporting. |
| TransactionType | String | The classification of the customer transaction, defining whether it is an invoice, payment, adjustment, or another transaction type. This classification is used internally in Workday REST APIs. |
| FromDate_Prompt | Date | A reference field that is used to specify the starting date for filtering customer activities in reports or API queries. |
| ToDate_Prompt | Date | A reference field that is used to specify the ending date for filtering customer activities in reports or API queries. |
| Name_Prompt | String | A reference field that is used to specify or retrieve the customer's name in Workday. |
Associates customers with predefined groups. This table enables segmentation for targeted marketing, account management, and service-level differentiation.
| Name | Type | Description |
| Id [KEY] | String | The system-generated unique identifier (Id) for this customer group record. This Id is used for tracking and referencing within Workday. |
| Customers_Id [KEY] | String | The Workday Id of the customer associated with this group. This Id establishes a relationship between the customer and a specific customer grouping. Customer groups are often used for segmentation, reporting, and targeted financial processing. |
| Descriptor | String | A human-readable preview of the customer group, providing a brief summary or classification that helps identify the group in Workday reports and user interfaces. |
| Name_Prompt | String | A reference field used to specify or retrieve the official name of the customer group within Workday. This name is used in reports, financial transactions, and API queries. |
Provides access to data sources and their associated primary business objects within Workday, facilitating the execution of Workday Query Language (WQL) queries. This table allows users to extract structured data for reporting and analysis.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the data source instance. |
| Alias | String | Workday Query Language (WQL) alias used for Adhoc Query Enabled instances within WQL Rest APIs, intended for internal system operations. |
| Description | String | Detailed summary providing information about the purpose and function of the data source. |
| Descriptor | String | A concise preview that represents the data source instance. |
| FilterIsRequired | Bool | Indicates whether applying a filter is mandatory for using the data source. |
| Href | String | URL link that references the specific data source instance. |
| PrimaryBusinessObject_Descriptor | String | Summary description of the primary business object associated with the data source. |
| PrimaryBusinessObject_Href | String | URL link that references the primary business object connected to the data source. |
| PrimaryBusinessObject_Id | String | Unique identifier for the primary business object, which can be a Workday identifier (WID), ID, or reference ID. |
| SupportsEffectiveDate | Bool | Indicates whether the data source can filter or return data based on effective dates. |
| SupportsEntryDate | Bool | Indicates whether the data source can filter or return data based on entry dates. |
| Alias_Prompt | String | Input prompt for specifying the alias of the data source. |
| SearchString_Prompt | String | Input prompt for entering a case-insensitive search string that scans within the descriptors of available data sources. |
Contains filter criteria for data sources, allowing users to retrieve specific subsets of data based on predefined conditions.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the data source filter instance. |
| DataSources_Id [KEY] | String | The unique Workday identifier (WID) that identifies the data source associated with this filter. |
| Alias | String | Represents the Workday Query Language (WQL) alias used for Adhoc Query Enabled instances in WQL REST APIs. This field is intended for internal system use. |
| Description | String | A brief summary describing the purpose or characteristics of the data source filter. |
| Descriptor | String | A preview or concise representation of the data source filter instance, typically used for display purposes. |
| Alias_Prompt | String | The alias name assigned to the data source filter, used to reference the filter within queries. |
| SearchString_Prompt | String | A case-insensitive search string used to find matches within the descriptors of data source filters. |
| Alias_Prompt_For_DataSources | String | The alias name assigned to the data source, used to reference the data source within queries. |
| SearchString_Prompt_For_DataSources | String | A case-insensitive search string used to find matches within the descriptors of data sources. |
Stores optional filter parameters for data sources, providing additional flexibility when querying specific datasets. This table enables customization of data retrieval conditions.
| Name | Type | Description |
| DataSourcesDataSourceFilters_Id | String | The unique WID that identifies the specific DataSourcesDataSourceFilters instance containing this record. |
| DataSources_Id | String | The unique WID that identifies the DataSources instance associated with this filter. |
| Alias | String | The Workday Query Language (WQL) alias used for Adhoc Query Enabled instances in WQL Rest APIs. This is intended for internal use only. |
| Description | String | Provides additional information about the query parameter, typically for external promptable filters. |
| Type | String | Indicates the data type of the element, with possible values including Text, Date, Numeric, Currency, Boolean, Single Instance, or Multi Instance. |
| WorkData_Descriptor | String | A brief textual description of the instance, intended to help identify its purpose or content. |
| WorkData_Href | String | A Uniform Resource Locator (URL) link that references the instance, typically used for navigation or API calls. |
| WorkData_Id | String | A unique identifier for the instance, which can be a Workday identifier (WID), standard Id, or reference Id. |
| Alias_Prompt | String | The alias of the data source filter, used as a shorthand identifier in prompts and queries. |
| SearchString_Prompt | String | A case-insensitive search string used to match text within the descriptors of data source filters. |
| Alias_Prompt_For_DataSources | String | The alias of the data source, used as a shorthand identifier when referencing the source in prompts and queries. |
| SearchString_Prompt_For_DataSources | String | A case-insensitive search string used to match text within the descriptors of data sources. |
Maintains required parameters for data source filters, ensuring the necessary criteria are met when querying data. This table defines the mandatory conditions for filtering data sources effectively.
| Name | Type | Description |
| DataSourcesDataSourceFilters_Id | String | The Workday identifier (WID) that uniquely identifies the DataSourcesDataSourceFilters instance containing this record. |
| DataSources_Id | String | The WID that uniquely identifies the parent DataSources instance associated with this record. |
| Alias | String | The Workday Query Language (WQL) alias used for Adhoc Query Enabled instances within WQL Rest APIs. This field is intended for internal use only. |
| Description | String | A brief description of the query parameter used for external promptable inputs. |
| Type | String | Specifies the type of data expected, for example, Text |
| WorkData_Descriptor | String | A human-readable description of the data source filter instance. |
| WorkData_Href | String | A hyperlink that provides direct access to the data source filter instance. |
| WorkData_Id | String | A unique identifier for the data source filter instance, which can be a WID, Id, or reference Id. |
| Alias_Prompt | String | The alias used to reference the data source filter when creating prompts. |
| SearchString_Prompt | String | A case-insensitive string used to search within the descriptors of data source filters. Each value is separated by a comma with one space after each comma. |
| Alias_Prompt_For_DataSources | String | The alias used to reference the data source when creating prompts. |
| SearchString_Prompt_For_DataSources | String | A case-insensitive string used to search within the descriptors of data sources. Each value is separated by a comma with one space after each comma. |
Lists available fields within data sources, along with their associated business objects. Users can retrieve detailed metadata about each field, including access control restrictions based on security settings.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
description: Text /* Description for Query Parameter for External Promptable */
type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */
workData: {
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
relatedBusinessObject: { /* Related Business Object */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
type: Text /* The type of the field */
}]
[{
alias: Text /* This field exposes WQL alias for Adhoc Query Enabled instances in WQL Rest APIs. This is for internal use only. */
description: Text /* Description for Query Parameter for External Promptable */
type: Text /* Returns "Text", "Date", "Numeric", "Currency", "Boolean", "Single Instance" or "Multi Instance". */
workData: {
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the instance within Workday. |
| DataSources_Id [KEY] | String | The unique Workday identifier (WID) of the DataSources that owns this element, used to establish ownership and context. |
| Alias | String | Internal Workday Query Language (WQL) alias used to reference this element in queries. |
| Descriptor | String | A brief preview or summary of the instance for quick identification. |
| Href | String | A URL link pointing to the specific instance within Workday. |
| OptionalParameters_Aggregate | String | Optional parameters available for use in WQL, allowing additional query customization. |
| RelatedBusinessObject_Descriptor | String | A textual description of the related business object for contextual understanding. |
| RelatedBusinessObject_Href | String | A URL link pointing to the related business object within Workday. |
| RelatedBusinessObject_Id | String | Identifier for the related business object, which can be a WID, a standard Id, or a reference Id. |
| RelatedFields_Aggregate | String | Collection of fields from the related business object that can be accessed or referenced. |
| RequiredParameters_Aggregate | String | Required parameters that must be provided when using WQL to ensure the query executes correctly. |
| Type | String | Specifies the type of the field, indicating its data format and usage. |
| Alias_Prompt | String | Prompt text guiding users to enter the alias of the data source field. |
| SearchString_Prompt | String | Prompt text for entering a search string that is matched in a case-insensitive manner within the descriptors of the data source fields. |
| Alias_Prompt_For_DataSources | String | Prompt text guiding users to enter the alias of the data source itself. |
| SearchString_Prompt_For_DataSources | String | Prompt text for entering a search string that is matched in a case-insensitive manner within the descriptors of the data sources. |
Contains optional parameters applicable to data sources, allowing users to refine queries and customize data retrieval criteria. These parameters provide additional flexibility in reporting.
| Name | Type | Description |
| DataSources_Id | String | The unique Workday identifier (WID) that identifies the data source containing this element. |
| Alias | String | Represents the Workday Query Language (WQL) alias used for adhoc query enabled instances in WQL REST APIs. Intended for internal use only. |
| Description | String | Provides context or additional details about the query parameter used for external prompts. |
| Type | String | Specifies the data type of the element. Possible values include Text |
| WorkData_Descriptor | String | A human-readable description of the instance. |
| WorkData_Href | String | A URL link that references the instance. |
| WorkData_Id | String | A unique identifier for the instance, which can be a WID, Id, or reference Id. |
| Alias_Prompt | String | The alias used to identify the data source during prompts. |
| SearchString_Prompt | String | The search string used to perform a case-insensitive search within data source descriptors. |
Stores required parameters for data sources, defining essential constraints that must be met when retrieving data from Workday's database. These parameters enforce structured query execution.
| Name | Type | Description |
| DataSources_Id | String | The unique Workday identifier (WID) for the DataSources object that contains this parameter. |
| Alias | String | This field exposes the Workday Query Language (WQL) alias for ad hoc query-enabled instances in WQL REST APIs. This field is intended for internal use only. |
| Description | String | Specifies the query parameter used as an external prompt, providing additional context for users. |
| Type | String | Indicates the data type of the parameter, such as Text, Date, Numeric, Currency, Boolean, Single Instance, or Multi Instance. |
| WorkData_Descriptor | String | A human-readable description of the Workday instance associated with the parameter. |
| WorkData_Href | String | A URL link pointing to the Workday instance associated with the parameter. |
| WorkData_Id | String | The identifier of the Workday instance, which can be a WID, a standard Id, or a reference Id. |
| Alias_Prompt | String | The alias assigned to the data source, typically used as a prompt when specifying query parameters. |
| SearchString_Prompt | String | A case-insensitive search string used to filter data sources based on their descriptors. Separate multiple search terms with commas, adding a space after each comma. |
Maintains records of educational qualifications, including degrees, certifications, and academic achievements, for workers within Workday. This table is used for background verification and workforce planning.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the educational credential instance, typically used for referencing within the system. |
| Description | String | Detailed description of the educational credential, including its significance or role. |
| Descriptor | String | A brief summary or preview that represents the educational credential instance. |
| Name | String | Official name of the educational credential, as recognized by the institution or organization. |
| Type_Descriptor | String | Explanation of the category or classification of the educational credential. |
| Type_Href | String | URL or hyperlink that provides access to additional information about the educational credential instance. |
| Type_Id | String | Identifier used to reference the educational credential, which can be a Workday identifier (WID), standard Id, or reference Id, depending on context. |
Stores specific field-based inclusion criteria for filtering effective change data, enabling users to retrieve only the most relevant updates based on predefined conditions.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance, typically used to reference or join related records. |
| EffectiveChanges_Id [KEY] | String | The Workday identifier (WID) that identifies the associated EffectiveChanges record, which tracks modifications in worker data or organizational attributes. |
Defines worker-based filtering criteria for effective change data, enabling targeted retrieval of employee updates based on predefined selection parameters.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance. This value is typically used to reference a specific record within the system. |
| EffectiveChanges_Id [KEY] | String | The Workday identifier (WID) associated with the EffectiveChanges object that includes this record. This Id is essential for tracking and linking related changes within the system. |
Retrieves details about ledger accounts and their associated worktags based on predefined account posting rules, ensuring accurate financial tracking and reporting.
The Workday Cloud requires filtering on AccountPostingRuleSet_Prompt and AccountPostingRuleType_Prompt in order to perform the query.
For example:
SELECT * FROM EvaluateAccountPostingRules WHERE AccountPostingRuleSet_Prompt = 'Account_Posting_Rule_Set_ID=ACCOUNT_POSTING_RULE_SET-1' AND AccountPostingRuleType_Prompt = 'Account_Posting_Rule_Type_ID=CASH';
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the account posting rule instance within Workday. Typically used for internal tracking and referencing. |
| Descriptor | String | A brief summary or preview of the account posting rule instance, providing context for users reviewing records. |
| LedgerAccountName | String | The official name of the ledger account associated with the posting rule. This name is typically defined within the organization's chart of accounts. |
| AccountPostingRuleSet_Prompt | String | This field is required. The Workday identifier (WID) or reference Id that identifies the account posting rule set to be evaluated. The reference Id should follow the format accountPostingRuleSet=sampleRefIdType=value. For example, accountPostingRuleSet=Account_Posting_Rule_Set_ID=ACCOUNT_POSTING_RULE_SET-1. |
| AccountPostingRuleType_Prompt | String | This field is required. The WID or reference Id that specifies the type of account posting rule. Use the format accountPostingRuleType=sampleRefIdType=value, such as accountPostingRuleType=Account_Posting_Rule_Type_ID=CASH. |
| DimensionValue_Prompt | String | A list of WIDs or reference Ids representing dimension values used in the account posting rule condition. The reference Id should follow the format dimensionValue=sampleRefIdType=value. For example, dimensionValue=Fund_ID=F03.1.3. Separate multiple values with commas, adding one space after each comma. |
Stores resulting worktags derived from evaluated account posting rules, linking financial transactions to specific business dimensions for precise reporting.
The Workday Cloud requires filtering on AccountPostingRuleSet_Prompt and AccountPostingRuleType_Prompt in order to perform the query.
For example:
SELECT * FROM EvaluateAccountPostingRulesResultingWorktags WHERE AccountPostingRuleSet_Prompt = 'Account_Posting_Rule_Set_ID=ACCOUNT_POSTING_RULE_SET-1' AND AccountPostingRuleType_Prompt = 'Account_Posting_Rule_Type_ID=PAYROLL';
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the current instance of the account posting rule evaluation. |
| EvaluateAccountPostingRules_Id [KEY] | String | The Workday identifier (WID) that uniquely identifies the EvaluateAccountPostingRules process containing this instance. |
| Descriptor | String | A brief preview or summary of the current instance, often used for display purposes. |
| AccountPostingRuleSet_Prompt | String | This field is required. The WID or reference Id that identifies the specific account posting rule set being applied. The reference Id should be formatted as accountPostingRuleSet=sampleRefIdType=value, such as accountPostingRuleSet=Account_Posting_Rule_Set_ID=ACCOUNT_POSTING_RULE_SET-1. |
| AccountPostingRuleType_Prompt | String | This field is required. The WID or reference Id that specifies the type of account posting rule being applied. The reference Id should be formatted as accountPostingRuleType=sampleRefIdType=value, such as accountPostingRuleType=Account_Posting_Rule_Type_ID=CASH. |
| DimensionValue_Prompt | String | The WIDs or reference Ids that represent the dimension values used in the account posting rule condition. The reference Id should be formatted as dimensionValue=sampleRefIdType=value, such as dimensionValue=Fund_ID=F03.1.3. |
Tracks business process events within Workday, including key workflows, approvals, and operational milestones, providing a comprehensive audit trail of activities.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for an individual event record, automatically assigned by Workday upon the creation of the event. |
| CompletedDate | Datetime | The date and time when the business process was fully completed. |
| CreationDate | Datetime | The date and time when the business process was initiated. |
| Descriptor | String | A brief summary or preview of the business process instance. |
| DueDate | Datetime | The deadline by which the business process is expected to be completed. |
| EffectiveDate | Datetime | The date when the business process takes effect within the system. |
| For_Descriptor | String | A descriptive label representing the subject of the business process. |
| For_Href | String | A URL link to view the subject of the business process. |
| For_Id | String | The Workday identifier (WID), Id, or reference Id of the subject. |
| Initiator_Descriptor | String | A descriptive label representing the user who initiated the business process. |
| Initiator_Href | String | A URL link to view the profile of the user who initiated the business process. |
| Initiator_Id | String | The WID, Id, or reference Id of the user who initiated the process. |
| OverallBusinessProcess_Descriptor | String | A descriptive label representing the overall business process. |
| OverallBusinessProcess_Href | String | A URL link to view the overall business process. |
| OverallBusinessProcess_Id | String | The WID, Id, or reference Id of the overall business process. |
| Status_Descriptor | String | A descriptive label representing the current status of the business process. |
| Status_Href | String | A URL link to view detailed information about the business process status. |
| Status_Id | String | The WID, Id, or reference Id of the status. |
| BusinessProcess_Prompt | String | Prompt value used to filter business processes by type or category. |
| CompletedOnOrAfter_Prompt | Date | Filter to include business processes completed on or after this date. |
| CompletedOnOrBefore_Prompt | Date | Filter to include business processes completed on or before this date. |
| InitiatedOnOrAfter_Prompt | Date | Filter to include business processes initiated on or after this date. |
| InitiatedOnOrBefore_Prompt | Date | Filter to include business processes initiated on or before this date. |
| Initiator_Prompt | String | Filter to include business processes initiated by a specific user. |
| Status_Prompt | String | Filter to include business processes with a specific status. |
| Worker_Prompt | String | Filter to include business processes associated with a specific worker. |
Contains document and file attachments associated with business process events, enabling users to access supporting documentation directly within Workday workflows.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the event attachment instance. |
| Events_Id [KEY] | String | The Workday identifier (WID) links each event to its attachment, connecting each record to its corresponding event. |
| Category_Descriptor | String | Text description specifying the category of the attachment. |
| Category_Href | String | URL link to access the category details of the attachment. |
| Category_Id | String | Identifier used to reference the attachment category (WID, Id, or reference Id). |
| ContentType_Descriptor | String | Text description specifying the content type of the attachment. |
| ContentType_Href | String | URL link to access the content type details of the attachment. |
| ContentType_Id | String | Identifier used to reference the content type (WID, Id, or reference Id). |
| Description | String | Detailed description of the event attachment content. |
| FileLength | Decimal | Size of the attached file in bytes. This field indicates the precise length of an attachment. |
| FileName | String | A text attribute that stores the name of the file attached to an event, typically containing the original file name. |
| UploadDate | Datetime | Date and time when the attachment was uploaded to the business process. |
| UploadedBy_Descriptor | String | Text description specifying the person who uploaded the attachment. |
| UploadedBy_Href | String | URL link to the profile of the person who uploaded the attachment. |
| UploadedBy_Id | String | Identifier used to reference the uploader (WID, Id, or reference Id). |
| BusinessProcess_Prompt | String | Prompt for selecting a specific business process related to the event attachment. |
| CompletedOnOrAfter_Prompt | Date | Filter to include events completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filter to include events completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filter to include events initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filter to include events initiated on or before the specified date. |
| Initiator_Prompt | String | Prompt for selecting the person who initiated the event. |
| Status_Prompt | String | Prompt for specifying the status of the event (for example, In Progress, Completed, Canceled). |
| Worker_Prompt | String | Prompt for selecting the worker associated with the event. |
Stores user comments linked to business process events, facilitating collaboration and decision-making through contextual feedback.
| Name | Type | Description |
| Events_Id | String | The unique Workday identifier (WID) for the event associated with this comment. |
| Comment | String | The text of the comment provided for the event. |
| CommentDate | Datetime | The date and time when the comment was originally created. |
| Person_Descriptor | String | A brief description of the person associated with the comment. |
| Person_Href | String | A URL link to the detailed profile of the person who made the comment. |
| Person_Id | String | The WID, user Id, or reference Id of the person who made the comment. |
| BusinessProcess_Prompt | String | The name or identifier of the business process linked to the event. |
| CompletedOnOrAfter_Prompt | Date | Filters events that were completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters events that were completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters events that were initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters events that were initiated on or before the specified date. |
| Initiator_Prompt | String | The identifier or name of the person who initiated the event. |
| Status_Prompt | String | The current status of the event, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | The identifier or name of the worker associated with the event. |
Logs completed steps within business process events, ensuring visibility into workflow progress and operational status tracking.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the event step instance. |
| Events_Id [KEY] | String | The Workday identifier (WID) of the event that this step belongs to. |
| CompletedByPerson_Descriptor | String | A text description of the person who completed this step. |
| CompletedByPerson_Href | String | A hyperlink to the profile of the person who completed this step. |
| CompletedByPerson_Id | String | The unique identifier (WID, Id, or reference Id) of the person who completed this step. |
| CompletedDate | Datetime | The exact date and time when this step was completed. |
| CreationDate | Datetime | The exact date and time when the event record was initially created. |
| Descriptor | String | A brief textual preview of the event step instance. |
| DueDate | Datetime | The deadline date and time for completing this step. |
| Event_Descriptor | String | A text description of the event associated with this step. |
| Event_Href | String | A hyperlink to the event associated with this step. |
| Event_Id | String | The unique identifier (WID, Id, or reference Id) of the event associated with this step. |
| Order | String | Retired. This field is no longer used because it does not return the order for each associated step when multiple steps are present. Use the Order report field instead. |
| ParallelStepInboxOrder | String | The order of parallel steps in the My Tasks inbox depends on the Parallel Step Order configuration, if allowed by the business process. |
| Status_Descriptor | String | A text description of the status of this event step. |
| Status_Href | String | A hyperlink to the status details of this event step. |
| Status_Id | String | The unique identifier (WID, Id, or reference Id) of the status of this event step. |
| BusinessProcess_Prompt | String | A prompt for selecting a business process related to the event. |
| CompletedOnOrAfter_Prompt | Date | A prompt to filter event steps completed on or after a specified date. |
| CompletedOnOrBefore_Prompt | Date | A prompt to filter event steps completed on or before a specified date. |
| InitiatedOnOrAfter_Prompt | Date | A prompt to filter events initiated on or after a specified date. |
| InitiatedOnOrBefore_Prompt | Date | A prompt to filter events initiated on or before a specified date. |
| Initiator_Prompt | String | A prompt for selecting the person who initiated the event. |
| Status_Prompt | String | A prompt for selecting the status of the event step. |
| Worker_Prompt | String | A prompt for selecting the worker associated with the event step. |
Tracks individuals awaiting specific actions within completed business process steps, helping manage task assignments and approvals.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the current instance within the Workday system. |
| EventsCompletedSteps_Id [KEY] | String | Workday identifier (WID) that uniquely identifies the related EventsCompletedSteps record. |
| Events_Id [KEY] | String | WID that represents the parent Events record associated with this instance. |
| Descriptor | String | A brief preview or summary of the instance, often used for quick identification. |
| BusinessProcess_Prompt | String | Specifies the business process associated with the event, allowing users to filter or categorize results. |
| CompletedOnOrAfter_Prompt | Date | Filters events to include only those completed on or after the specified date. The format is YYYY-MM-DD. |
| CompletedOnOrBefore_Prompt | Date | Filters events to include only those completed on or before the specified date. The format is YYYY-MM-DD. |
| InitiatedOnOrAfter_Prompt | Date | Filters events based on their initiation date, including only those initiated on or after the specified date. Format: YYYY-MM-DD. |
| InitiatedOnOrBefore_Prompt | Date | Filters events based on their initiation date, including only those initiated on or before the specified date. Format: YYYY-MM-DD. |
| Initiator_Prompt | String | Specifies the person who initiated the event, identified by their WID or name. |
| Status_Prompt | String | Filters events by their current status, such as In Progress, Completed, or Cancelled. |
| Worker_Prompt | String | Identifies the worker associated with the event, either by WID or name. |
Stores comments related to completed business process steps, providing insights into workflow decisions and rationale.
| Name | Type | Description |
| EventsCompletedSteps_Id | String | The unique Workday identifier (WID) for the EventsCompletedSteps record that contains this comment. |
| Events_Id | String | The unique WID for the Event associated with this comment. |
| Comment | String | The text of the comment provided for the completed step within the event. |
| CommentDate | Datetime | The exact date and time when the comment was created, recorded in Workday. |
| Person_Descriptor | String | A descriptive label for the person associated with this comment, typically including their name and role. |
| Person_Href | String | A hyperlink to the person's profile or record within Workday. |
| Person_Id | String | The Workday identifier for the person, which can be in the format of WID, Id, or reference Id. |
| BusinessProcess_Prompt | String | The name or identifier of the business process related to the completed step. |
| CompletedOnOrAfter_Prompt | Date | Filters comments for steps completed on or after this specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters comments for steps completed on or before this specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters comments for steps initiated on or after this specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters comments for steps initiated on or before this specified date. |
| Initiator_Prompt | String | The name or identifier of the person who initiated the business process associated with the completed step. |
| Status_Prompt | String | Filters comments based on the status of the event or business process, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | The name or identifier of the worker associated with the completed step, used to filter relevant comments. |
Monitors ongoing steps within business process events, allowing users to track in-progress activities and pending actions.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the event step instance. |
| Events_Id [KEY] | String | The Workday identifier (WID) of the parent event that owns this step. |
| Anonymous | Bool | Indicates whether the event step was assigned anonymously. Returns true if anonymous, false otherwise. |
| BusinessProcessStep_Descriptor | String | A brief preview or summary of the business process step instance. |
| BusinessProcessStep_Id | String | Unique identifier of the business process step instance. |
| CreationDate | Datetime | The date and time when the event record was created in the system. |
| DelayedDate | Datetime | The date and time when a delayed step is scheduled to trigger. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| DueDate | Datetime | The date by which this step is expected to be completed. |
| Order | String | [Retired] This field is no longer in use because it does not return the order for multiple associated steps. Use the Order report field instead. |
| ParallelStepInboxOrder | String | The order in which parallel steps appear in the My Tasks inbox. This field only returns a value if the business process type supports the Parallel Step Order in My Tasks configuration. No value is returned if multiple steps are associated with this event step. |
| Status_Descriptor | String | A descriptive summary of the current status of the event step instance. |
| Status_Href | String | A URL link to view the event step instance in Workday. |
| Status_Id | String | The unique identifier (WID, Id, or reference Id) of the status. |
| BusinessProcess_Prompt | String | Specifies the business process associated with the event step. |
| CompletedOnOrAfter_Prompt | Date | Filters results to include only steps completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters results to include only steps completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters results to include only steps initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters results to include only steps initiated on or before the specified date. |
| Initiator_Prompt | String | Specifies the user who initiated the event step. |
| Status_Prompt | String | Filters results by the status of the event step. |
| Worker_Prompt | String | Specifies the worker associated with the event step. |
Identifies persons awaiting responses or approvals in active business process steps, enhancing workflow transparency.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance of the event in progress. |
| EventsInProgressSteps_Id [KEY] | String | The Workday identifier (WID) of the parent EventsInProgressSteps record that includes this instance. |
| Events_Id [KEY] | String | The WID of the parent event associated with this step. |
| Descriptor | String | A brief summary or preview of the current instance, typically used for quick identification. |
| BusinessProcess_Prompt | String | Specifies the name of the business process associated with the event in progress. |
| CompletedOnOrAfter_Prompt | Date | Filters events that were completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters events that were completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters events that were initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters events that were initiated on or before the specified date. |
| Initiator_Prompt | String | Specifies the WID or name of the user who initiated the event. |
| Status_Prompt | String | Indicates the current status of the event, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | Specifies the WID or name of the worker associated with the event. |
Lists outstanding steps for business process events, helping users prioritize and complete pending tasks.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the business process step instance. |
| Events_Id [KEY] | String | The Workday identifier (WID) of the event associated with this step. |
| CompletionStep | Bool | Indicates whether this step marks the completion of the business process. Returns true if it does. |
| Descriptor | String | A brief summary or label representing the step instance. |
| DueDate_Descriptor | String | A description of the due date for this step, providing context for its timing. |
| DueDate_Href | String | A URL linking to the detailed view of the due date for this step. |
| DueDate_Id | String | Unique identifier (WID, Id, or reference Id) associated with the due date. |
| Order | String | The sequential order of this step within the overall business process definition. |
| ParallelStepInboxOrder | String | The order of parallel steps as displayed in the My Tasks inbox. This value is returned only if the business process configuration allows the Parallel Step Order in My Tasks option. |
| Step | String | The alternate or custom name assigned to this workflow step in the business process definition. |
| StepType_Descriptor | String | A description of the type or category of this workflow step. |
| StepType_Href | String | A URL linking to detailed information about the step type. |
| StepType_Id | String | Unique identifier (WID, Id, or reference Id) associated with the step type. |
| BusinessProcess_Prompt | String | The name or identifier of the business process for which steps are being retrieved. |
| CompletedOnOrAfter_Prompt | Date | Filters results to include steps completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters results to include steps completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters results to include steps initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters results to include steps initiated on or before the specified date. |
| Initiator_Prompt | String | The name or identifier of the person who initiated the business process. |
| Status_Prompt | String | Filters results based on the current status of the business process step, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | The name or identifier of the worker associated with the business process step. |
Categorizes remaining business process steps into groups for better organization and process tracking.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance of the event step group. |
| EventsRemainingSteps_Id [KEY] | String | The Workday identifier (WID) of the parent EventsRemainingSteps instance that this group belongs to. |
| Events_Id [KEY] | String | The WID of the parent Event instance associated with this group. |
| Descriptor | String | A brief summary or preview of the current event step group. |
| BusinessProcess_Prompt | String | A prompt indicating the business process associated with this event step group. |
| CompletedOnOrAfter_Prompt | Date | Filters results to include only those completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filters results to include only those completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filters results to include only those initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filters results to include only those initiated on or before the specified date. |
| Initiator_Prompt | String | Specifies the individual who initiated the event or business process. |
| Status_Prompt | String | Indicates the current status of the event step group, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | Identifies the worker associated with the event step group. |
Tracks sub-processes within business process events, offering a hierarchical view of dependent workflows.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance of the sub-business process. |
| Events_Id [KEY] | String | The Workday identifier (WID) that references the parent Events process containing this sub-business process. |
| Descriptor | String | A brief summary or preview of the sub-business process instance. |
| BusinessProcess_Prompt | String | Prompt that specifies the type of business process being referenced. |
| CompletedOnOrAfter_Prompt | Date | Filter to include sub-business processes that were completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | Filter to include sub-business processes that were completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | Filter to include sub-business processes that were initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | Filter to include sub-business processes that were initiated on or before the specified date. |
| Initiator_Prompt | String | Specifies the person who initiated the sub-business process. |
| Status_Prompt | String | Filter to include sub-business processes with the specified status, such as In Progress, Completed, or Canceled. |
| Worker_Prompt | String | Filter to include sub-business processes associated with a specific worker. |
Stores detailed information about individual steps in business process events, including assigned users, timestamps, and completion status.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance of the business process step. |
| BusinessProcessStep_Descriptor | String | Textual description that summarizes the business process step. |
| BusinessProcessStep_Href | String | URL link that provides access to the business process step in Workday. |
| BusinessProcessStep_Id | String | Reference identifier (WID, Id, or reference Id) for the business process step. |
| BusinessProcess_Descriptor | String | Textual description that summarizes the overall business process. |
| BusinessProcess_Href | String | URL link that provides access to the overall business process in Workday. |
| BusinessProcess_Id | String | Reference identifier (WID, Id, or reference Id) for the overall business process. |
| CompletedByPerson_Descriptor | String | Textual description of the person who completed the step. |
| CompletedByPerson_Href | String | URL link that provides access to the person who completed the step. |
| CompletedByPerson_Id | String | Reference identifier (WID, Id, or reference Id) for the person who completed the step. |
| CompletedDate | Datetime | Date and time when the step was marked as completed. |
| CreationDate | Datetime | Date and time when the event record was initially created. |
| DelayedDate | Datetime | Date and time when the delayed step is scheduled to trigger. |
| Descriptor | String | Preview or summary information related to the instance. |
| DueDate | Datetime | Date and time by which the step must be completed. |
| Event_Descriptor | String | Textual description that summarizes the event. |
| Event_Href | String | URL link that provides access to the event in Workday. |
| Event_Id | String | Reference identifier (WID, Id, or reference Id) for the event. |
| Order | String | This field is retired. When multiple steps are associated with the event step, it does not return the order for each step. Use the Order report field instead. |
| OverallProcess_Descriptor | String | Textual description that summarizes the overall process related to the event. |
| OverallProcess_Href | String | URL link that provides access to the overall process in Workday. |
| OverallProcess_Id | String | Reference identifier (WID, Id, or reference Id) for the overall process. |
| ParallelStepInboxOrder | String | Order of parallel steps in the My Tasks inbox. Returns a value only if the business process type supports the Parallel Step Order in My Tasks configuration. No value is returned if multiple steps are associated with the event step. |
| Questionnaire_Descriptor | String | Textual description that summarizes the questionnaire related to the step. |
| Questionnaire_Href | String | URL link that provides access to the questionnaire in Workday. |
| Questionnaire_Id | String | Reference identifier (WID, Id, or reference Id) for the questionnaire. |
| Status_Descriptor | String | Textual description of the current status of the step or process. |
| Status_Href | String | URL link that provides access to the status details in Workday. |
| Status_Id | String | Reference identifier (WID, Id, or reference Id) for the status. |
| StepEvent_Descriptor | String | Textual description that summarizes the step event. |
| StepEvent_Href | String | URL link that provides access to the step event in Workday. |
| StepEvent_Id | String | Reference identifier (WID, Id, or reference Id) for the step event. |
| StepHelpText | String | Instructional text configured for the workflow step of the event record. |
| StepType_Descriptor | String | Textual description of the type of workflow step. |
| StepType_Href | String | URL link that provides access to step type details in Workday. |
| StepType_Id | String | Reference identifier (WID, Id, or reference Id) for the step type. |
| Task_Descriptor | String | Textual description that summarizes the task related to the step. |
| Task_Href | String | URL link that provides access to the task in Workday. |
| Task_Id | String | Reference identifier (WID, Id, or reference Id) for the task. |
| BusinessProcess_Prompt | String | Input prompt for selecting the business process. |
| CreatedOnOrAfter_Prompt | Date | Input prompt for filtering records created on or after the specified date. |
| CreatedOnOrBefore_Prompt | Date | Input prompt for filtering records created on or before the specified date. |
| DueDateOnOrAfter_Prompt | Date | Input prompt for filtering steps due on or after the specified date. |
| DueDateOnOrBefore_Prompt | Date | Input prompt for filtering steps due on or before the specified date. |
| StepType_Prompt | String | Input prompt for selecting the workflow step type. |
Identifies individuals responsible for pending actions in event steps, ensuring accountability in process execution.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance, used to reference this specific record. |
| EventSteps_Id [KEY] | String | The Workday identifier (WID) of the EventSteps table that this record is associated with. This Id helps link the event step to its related process. |
| Descriptor | String | A brief summary or preview of the instance, providing key details at a glance. |
| BusinessProcess_Prompt | String | Specifies the business process associated with the event step, allowing users to filter or categorize records by process. |
| CreatedOnOrAfter_Prompt | Date | Filters event steps created on or after the specified date, helping narrow down results based on creation time. |
| CreatedOnOrBefore_Prompt | Date | Filters event steps created on or before the specified date, helping narrow down results based on creation time. |
| DueDateOnOrAfter_Prompt | Date | Filters event steps with due dates on or after the specified date, ensuring focus on pending or upcoming tasks. |
| DueDateOnOrBefore_Prompt | Date | Filters event steps with due dates on or before the specified date, helping identify overdue or imminent tasks. |
| StepType_Prompt | String | Specifies the type of step within the workflow, providing context for the step’s role in the overall process. |
Logs comments for business process event steps, providing context and justification for actions taken.
| Name | Type | Description |
| EventSteps_Id | String | The Workday Identifier (WID) links this record to the EventSteps table, serving as a reference for managing event-related data in Workday. |
| Comment | String | A user-entered comment related to the event step. |
| CommentDate | Datetime | The exact date and time when the comment was created. |
| Person_Descriptor | String | A human-readable description of the person associated with this event step, typically including name and role. |
| Person_Href | String | A URL link to the person's profile or related Workday resource. |
| Person_Id | String | The unique Workday identifier for the person, which can be a WID, Id, or reference Id. |
| BusinessProcess_Prompt | String | The name or identifier of the business process associated with the event step. |
| CreatedOnOrAfter_Prompt | Date | Filters results to include only those created on or after the specified date. |
| CreatedOnOrBefore_Prompt | Date | Filters results to include only those created on or before the specified date. |
| DueDateOnOrAfter_Prompt | Date | Filters results to include only those with a due date on or after the specified date. |
| DueDateOnOrBefore_Prompt | Date | Filters results to include only those with a due date on or before the specified date. |
| StepType_Prompt | String | Specifies the type of step within the business process, such as approval, task, or notification. |
Contains detailed information about individual expense items, including descriptions, categories, amounts, and associated metadata for financial tracking and reporting.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the expense item instance, typically used for referencing specific records. |
| Descriptor | String | A concise summary or name that represents the expense item instance, often used in search results or dropdowns. |
| Href | String | A URL link that provides direct access to the expense item instance, useful for navigation and API integrations. |
| DisallowFixedItems_Prompt | Bool | Indicates whether fixed items are restricted for selection, with true meaning selection is not allowed. |
| SearchString_Prompt | String | A text field allowing users to search for expense items using keywords or phrases. |
Stores source reference data for externally linked records, providing context and traceability for integrations and data imports.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the record, which can be a Workday identifier (WID), reference Id, or other unique Id. |
| Descriptor | String | A descriptive label that provides context or a human-readable name for the record instance. |
| CollectionToken | String | A token used to retrieve members of a collection when passed to the Collection_Prompt input. This value is NULL if the current row represents a single value rather than a collection. |
| Collection_Prompt | String | An input value sourced from the CollectionToken column. Supplying this value allows you to retrieve all child elements within the collection. |
Manages a collection of active feedback badges available in the system, which can be awarded to employees for recognition and performance evaluations.
| Name | Type | Description |
| FeedbackBadgeID | String | The unique reference Id used to identify and look up feedback badges within Workday Web Services. For supervisory organizations, this Id also serves as the 'Organization ID.' |
| FeedbackBadgeIcon_Descriptor | String | A textual description that provides context about the feedback badge icon, helping users understand its visual representation. |
| FeedbackBadgeIcon_Href | String | A URL that links directly to the feedback badge icon, allowing access to its image file within Workday. |
| FeedbackBadgeIcon_Id | String | The internal identifier for the feedback badge icon. Accepts values such as WID, Id, or reference Id, depending on the integration context. |
| Name | String | The display name assigned to the feedback badge, typically reflecting the type of recognition it represents. |
| WorkdayID | String | The system-generated Workday identifier (WID) that uniquely identifies the feedback badge object within the platform. |
Contains feedback records provided for specific workers, including details about performance, strengths, and areas for improvement.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the record, which can be a Workday identifier (WID), reference Id, or another system-generated Id. Used to distinguish individual records. |
| Descriptor | String | A human-readable description of the instance, typically used for display purposes in reports and user interfaces. |
| CollectionToken | String | A token that represents a collection of related records. Use this value with the Collection_Prompt input to retrieve the full set of associated records. This value is NULL if the row represents a single value rather than a collection. |
| Collection_Prompt | String | An input value sourced from the CollectionToken column. Supplying this input allows you to retrieve all child records associated with the specified collection, supporting hierarchical data navigation. |
Stores information about individuals who respond to feedback requests, ensuring traceability and accountability in feedback collection.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (WID, Id, or reference Id) for the feedback event. |
| Descriptor | String | A brief description that identifies the feedback instance. |
| CollectionToken | String | Use this token in combination with the Collection_Prompt input to retrieve members within a collection. Returns NULL if the row represents a single value instead of a collection. |
| Collection_Prompt | String | Accepts a value from the CollectionToken column to retrieve all child elements associated with the collection. |
| TemplateType_Prompt | String | Specifies the feedback template type for the event. Options include Feedback on Self, 133de7d11fea10001dbb45a701140098, or Feedback on Worker, 133de7d11fea10001dbb45973dec0097. This field is required. |
| Worker_Prompt | String | The unique Workday identifier (WID) of the worker. Required when using the Feedback on Worker templateType and not supported for the Feedback on Self templateType. Cannot be the same as the processing worker. |
Maintains predefined feedback templates used for performance reviews and employee evaluations, ensuring consistency in feedback collection.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier (WID, Id, or reference Id) for the feedback template instance. |
| Descriptor | String | Descriptive label providing context for the feedback template instance. |
| CollectionToken | String | Token used to retrieve members of a collection when combined with the Collection_Prompt input. Returns NULL if the row represents a value rather than a collection. |
| Collection_Prompt | String | Token value obtained from the CollectionToken column. Use this input to retrieve all child elements within a collection. |
| TemplateType_Prompt | String | Specifies the feedback template type for the event. Accepted values are Feedback on Self, 133de7d11fea10001dbb45a701140098, or Feedback on Worker, 133de7d11fea10001dbb45973dec0097. This field is required. |
| Worker_Prompt | String | Unique identifier (WID) of the worker receiving feedback. Required when using the Feedback on Worker template and not applicable for Feedback on Self. The worker cannot be the person processing the feedback. |
Stores comments added during the feedback process within a business workflow, providing context and additional insights for evaluations.
| Name | Type | Description |
| GiveRequestedFeedbackEvents_Id | String | The unique Workday identifier (WID) that identifies the specific GiveRequestedFeedbackEvents instance containing this comment. |
| Comment | String | The feedback comment provided within the event, capturing the user's input. |
| CommentDate | Datetime | The exact date and time when the feedback comment was created, recorded in the system. |
| Person_Descriptor | String | A textual description identifying the individual associated with the feedback event, typically their name and relevant context. |
| Person_Href | String | A direct URL link to the individual's profile or related information within Workday. |
| Person_Id | String | A unique identifier for the individual, which may be presented as a WID, reference Id, or standard Id, separated by commas with one space after each: wid, id, reference id. |
Stores information about company holidays and scheduled non-working days, used for workforce planning and payroll adjustments.
| Name | Type | Description |
| Date | Datetime | The date when the holiday event takes place, formatted as a datetime value. |
| HolidayCalendar_Descriptor | String | A brief description of the holiday calendar associated with the event. |
| HolidayCalendar_Href | String | A URL link that provides direct access to the holiday calendar instance. |
| HolidayCalendar_Id | String | The unique identifier (WID, Id, or reference Id) associated with the holiday calendar. |
| HolidayName | String | The official name of the holiday event. |
| Worker_Descriptor | String | A summary or preview of the worker associated with the holiday event. |
| Worker_Id | String | The unique identifier of the worker participating in or affected by the holiday event. |
| FromDate_Prompt | Date | The starting date used to filter holiday events within a specified date range. |
| ToDate_Prompt | Date | The ending date used to filter holiday events within a specified date range. |
| Worker_Prompt | String | The identifier or name used to filter holiday events by a specific worker. |
Holds records of scheduled interviews, including candidate details, interview stages, and scheduled time slots.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the interview instance. |
| Descriptor | String | A short summary or label representing the interview instance. |
| GiveInterviewFeedbackLink | String | A URL that provides access to the 'Give Interview Feedback' task, available to workers authorized to review and submit interview feedback for pending Interview Feedback Detail events. |
| HasCompetenciesQuestionnaires | Bool | Indicates whether the interviewer feedback task includes Competencies or Questionnaires that have configured Extended Integration Protocol (XIP) settings. True if present, false otherwise. |
| JobApplication_Descriptor | String | A concise summary or label representing the job application associated with the interview. |
| JobApplication_Id | String | Unique identifier for the job application associated with the interview. |
| JobApplication_NumberOfJobs | Decimal | The total number of job positions the candidate has applied for within this job application. |
| JobApplication_TotalYearsExperience | Decimal | The candidate’s cumulative years of professional experience as stated in the job application. |
| JobApplication_YearsInCurrentJob | Decimal | The number of years the candidate has been employed at their current job, as specified in the job application. |
| JobRequisition_Descriptor | String | A concise summary or label representing the job requisition linked to the interview. |
| JobRequisition_HiringManager_Descriptor | String | A brief summary or label representing the hiring manager associated with the job requisition. |
| JobRequisition_HiringManager_Id | String | Unique identifier for the hiring manager associated with the job requisition. |
| JobRequisition_Id | String | Unique identifier for the job requisition linked to the interview. |
| OverallComment | String | The overall comment provided during the interview feedback process, formatted according to XIP settings. |
| OverallRating | String | The overall rating assigned during the interview feedback process, formatted according to XIP settings. |
| InterviewStatus_Prompt | String | A list of all applicable interview statuses for an interview event. Status options include Scheduled, Completed, Canceled, Rescheduled, Pending Feedback, Awaiting Assessment, and Not Selected. |
Lists interviewers assigned to an interview session, providing accountability and visibility into the recruitment process.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the interview instance, used to reference this specific record. |
| Interviews_Id [KEY] | String | The Workday identifier (WID) of the interview that this record is associated with, used for linking to the interview details. |
| Descriptor | String | A brief summary or name that provides a quick preview of the interview instance. |
| InterviewStatus_Prompt | String | All applicable interview statuses for an interview event. Status options include Scheduled, Completed, Canceled, Pending Feedback, Awaiting Confirmation, or Rescheduled. Each status represents a different phase in the interview process. |
Tracks the status of interviews, including scheduled, completed, canceled, and rescheduled interviews.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the interview status instance within the Workday system. |
| Interviews_Id [KEY] | String | The Workday identifier (WID) of the interview associated with this status, used to reference the specific interview event. |
| Descriptor | String | A brief summary or name representing the interview status, designed for quick identification. |
| Href | String | A URL link to access the interview status instance within the Workday platform. |
| InterviewStatus_Prompt | String | All relevant interview statuses that can be applied to an interview event. Status options include Scheduled, Completed, Canceled, Rescheduled, No Show, Pending Feedback, and Declined. |
Links primary recruiters responsible for job requisitions associated with interview events, maintaining recruiter accountability.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the interview instance. Used to reference a specific interview within the Workday system. |
| Interviews_Id [KEY] | String | The Workday identifier (WID) of the interview associated with the job requisition. This Id is used to track and manage interview events within Workday. |
| Descriptor | String | A brief summary or preview of the interview instance. This can include key details such as candidate name, interview date, or position title. |
| InterviewStatus_Prompt | String | List of possible interview statuses that can apply to an interview event. Statuses include Scheduled, Completed, Canceled, Rescheduled, Pending Feedback, and Not Attended. |
Stores additional recruiter assignments for job requisitions linked to interviews, ensuring visibility of all involved hiring personnel.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier of the interview instance within Workday. Used for tracking and referencing specific interviews. |
| Interviews_Id [KEY] | String | The Workday identifier (WID) of the interview that this record is associated with. Essential for linking interview details to the correct instance. |
| Descriptor | String | A brief summary or preview of the interview instance, typically used for quick identification in lists and reports. |
| InterviewStatus_Prompt | String | All applicable interview statuses for an interview event. Statuses options include Scheduled, Completed, Canceled, Rescheduled, Pending Feedback, Awaiting Candidate Response, and No Show. |
Lists employees awaiting interview feedback, ensuring timely evaluation and completion of interview assessments.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the interview instance, used to track and reference individual records. |
| Interviews_Id [KEY] | String | The system-generated Workday Id associated with the interview event that this record pertains to. |
| Descriptor | String | A brief textual summary or label that provides a quick reference for the interview instance. |
| InterviewStatus_Prompt | String | All applicable interview statuses for an interview event, including Scheduled, Completed, Pending Feedback, Canceled, and Rescheduled. |
Manages customer invoices and adjustments, tracking details such as amounts, due dates, and payment statuses.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the invoice instance. |
| AdjustmentReason_Descriptor | String | Description of the reason for the invoice adjustment. |
| BillToCustomerAddress_AddressLine1 | String | First line of the bill-to customer's address, typically containing the street name and number. |
| BillToCustomerAddress_AddressLine2 | String | Second line of the bill-to customer's address, often used for apartment or suite numbers. |
| BillToCustomerAddress_AddressLine3 | String | Third line of the bill-to customer's address, used for additional address details. |
| BillToCustomerAddress_AddressLine4 | String | Fourth line of the bill-to customer's address, reserved for any remaining address information. |
| BillToCustomerAddress_City | String | City where the bill-to customer is located. |
| BillToCustomerAddress_CitySubdivision1 | String | Primary subdivision within the city, such as a district or borough. |
| BillToCustomerAddress_CitySubdivision2 | String | Secondary subdivision within the city, such as a neighborhood or zone. |
| BillToCustomerAddress_CountryRegion_Descriptor | String | Name or description of the country or region where the bill-to customer is located. |
| BillToCustomerAddress_Country_Descriptor | String | Country name where the bill-to customer is located. |
| BillToCustomerAddress_Descriptor | String | Concise summary of the bill-to customer's address. |
| BillToCustomerAddress_Id | String | Unique identifier for the bill-to customer's address instance. |
| BillToCustomerAddress_PostalCode | String | Postal code of the bill-to customer's location. |
| BillToCustomerAddress_RegionSubdivision1 | String | Primary regional subdivision, such as a state or province. |
| BillToCustomerAddress_RegionSubdivision2 | String | Secondary regional subdivision, such as a county or district. |
| BillToCustomer_Descriptor | String | Name or description of the bill-to customer. |
| BillToCustomer_Id | String | Unique identifier for the bill-to customer instance. |
| Company_Descriptor | String | Name or description of the company associated with the invoice. |
| Company_Id | String | Unique identifier for the company instance. |
| Currency_Descriptor | String | Description of the currency used in the invoice. |
| Descriptor | String | General description or summary of the invoice instance. |
| DisputeAmount_Currency | String | Currency of the disputed amount on the customer invoice. |
| DisputeAmount_Value | Decimal | Monetary value of the disputed amount on the customer invoice. |
| DisputeDate | Datetime | Date when the customer invoice was placed in dispute. |
| DueAmount_Currency | String | Currency of the amount due for the customer invoice. |
| DueAmount_Value | Decimal | Monetary value of the amount due for the customer invoice, which can be positive or negative. |
| DueDate | Datetime | Due date of the customer invoice or adjustment as of the defined reporting date. |
| Href | String | Hyperlink to access the invoice instance. |
| InCollection | Bool | Flag indicating if the invoice is currently in collections (true or false). |
| InDispute | Bool | Flag indicating if the invoice is currently in dispute (true or false). |
| InvoiceDate | Datetime | Date when the customer invoice was issued. |
| InvoiceNumber | String | Unique number assigned to the customer invoice. |
| InvoiceStatus_Descriptor | String | Description of the current status of the customer invoice. |
| InvoiceStatus_Id | String | Unique identifier for the invoice status instance. |
| InvoiceType_Descriptor | String | Description of the type of customer invoice, such as standard or adjustment. |
| Memo | String | Additional notes or comments provided on the customer invoice. |
| NetAmount_Currency | String | Currency of the net amount, which is the total of all invoice line amounts minus tax and prepaid utilization amounts. |
| NetAmount_Value | Decimal | Net monetary value printed on the invoice, which can be positive or negative. |
| PaymentStatus_Descriptor | String | Description of the current payment status of the invoice. |
| PaymentStatus_Id | String | Unique identifier for the payment status instance. |
| PoNumber | String | Purchase order number referenced on the customer invoice. |
| RelatedInvoice_Descriptor | String | Description of a related invoice, if applicable. |
| RelatedInvoice_Href | String | Hyperlink to access the related invoice instance. |
| RelatedInvoice_Id | String | Unique identifier (WID, Id, or reference Id) for the related invoice. |
| RetentionAmount_Currency | String | Currency of the total retention amount from invoice lines. |
| RetentionAmount_Value | Decimal | Total monetary value of the retention amount from invoice lines. |
| TaxAmount_Currency | String | Currency of the total tax amount applied to the invoice. |
| TaxAmount_Value | Decimal | Total monetary value of the tax amount applied to the invoice. |
| TotalAmount_Currency | String | Currency of the total amount for the customer invoice, including tax. |
| TotalAmount_Value | Decimal | Total monetary value for the customer invoice, which can be positive or negative. |
| TransactionType | String | Type of customer invoice document, either 'invoice' or 'adjustment'. |
| WithholdingAmount_Currency | String | Currency of the tax amount withheld from the customer invoice. |
| WithholdingAmount_Value | Decimal | Monetary value of the tax amount withheld from the customer invoice. |
| BillToCustomer_Prompt | String | Customer listed on the invoice. |
| Company_Prompt | String | Company associated with the invoice. |
| FromDueDate_Prompt | Date | Starting due date of the invoice or adjustment, formatted as YYYY-MM-DD. |
| FromInvoiceDate_Prompt | Date | Starting issue date of the invoice, formatted as YYYY-MM-DD. |
| InvoiceStatus_Prompt | String | Current status of the invoice document. |
| PaymentStatus_Prompt | String | Current payment status of the invoice document. |
| ToDueDate_Prompt | Date | Ending due date of the invoice or adjustment, formatted as YYYY-MM-DD. |
| ToInvoiceDate_Prompt | Date | Ending issue date of the invoice, formatted as YYYY-MM-DD. |
| TransactionType_Prompt | String | Type of customer transaction. Use 'invoice' or 'adjustment' to filter results. |
Stores dispute reasons associated with customer invoices, supporting resolution processes for billing discrepancies.
| Name | Type | Description |
| Invoices_Id | String | The unique Workday identifier (WID) that identifies the invoice associated with this record. This Id is system-generated and used for internal tracking and referencing. |
| Descriptor | String | A concise preview of the invoice instance, typically including key identifying details for quick recognition. |
| BillToCustomer_Prompt | String | The name or identifier of the customer billed on the invoice. This value helps identify the recipient of the invoice. |
| Company_Prompt | String | The name or identifier of the company issuing the invoice. This value helps distinguish the entity responsible for billing. |
| FromDueDate_Prompt | Date | The earliest due date of the customer invoice or invoice adjustment within the specified reporting period, formatted as YYYY-MM-DD. Use this to filter results starting from a specific due date. |
| FromInvoiceDate_Prompt | Date | The earliest issue date of the customer invoice within the specified reporting period, formatted as YYYY-MM-DD. Use this to filter results starting from a specific invoice date. |
| InvoiceStatus_Prompt | String | The current lifecycle status of the invoice document, such as Draft, Submitted, Approved, or Cancelled. |
| PaymentStatus_Prompt | String | The current payment status of the invoice document, such as Paid, Partially Paid, or Unpaid. |
| ToDueDate_Prompt | Date | The latest due date of the customer invoice or invoice adjustment within the specified reporting period, formatted as YYYY-MM-DD. Use this to filter results ending on a specific due date. |
| ToInvoiceDate_Prompt | Date | The latest issue date of the customer invoice within the specified reporting period, formatted as YYYY-MM-DD. Use this to filter results ending on a specific invoice date. |
| TransactionType_Prompt | String | The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Tracks invoice print run instances, recording batch printing events for customer invoices.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier of the invoice print run instance. |
| Invoices_Id [KEY] | String | The Workday identifier (WID) of the invoice associated with this print run. |
| Descriptor | String | A brief summary or label representing the invoice print run. |
| Pdf_Id | String | Unique identifier of the PDF file associated with the customer invoice. |
| Pdf_Name | String | The name of the PDF file generated for the customer invoice. |
| PrintRunType_Descriptor | String | A textual description of the print run type, indicating the purpose or category of the print run. |
| PrintRunType_Href | String | A URL link referencing detailed information about the print run type. |
| PrintRunType_Id | String | The WID, Id, or reference Id of the print run type. |
| PrintedDateTime | Datetime | The date and time when the customer invoice was printed, formatted as YYYY-MM-DD HH:MM:SS. |
| BillToCustomer_Prompt | String | The name or identifier of the customer billed on the invoice. |
| Company_Prompt | String | The name of the company issuing the invoice. |
| FromDueDate_Prompt | Date | The starting due date range for customer invoices or invoice adjustments, formatted as YYYY-MM-DD. |
| FromInvoiceDate_Prompt | Date | The starting date range when customer invoices were issued, formatted as YYYY-MM-DD. |
| InvoiceStatus_Prompt | String | The current status of the invoice, such as pending |
| PaymentStatus_Prompt | String | The current payment status of the invoice, such as unpaid |
| ToDueDate_Prompt | Date | The ending due date range for customer invoices or invoice adjustments, formatted as YYYY-MM-DD. |
| ToInvoiceDate_Prompt | Date | The ending date range when customer invoices were issued, formatted as YYYY-MM-DD. |
| TransactionType_Prompt | String | The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Maintains records of delivery methods used in invoice print runs, including email, postal mail, and digital distribution.
| Name | Type | Description |
| InvoicesPrintRuns_Id | String | The unique Workday identifier (WID) for the InvoicesPrintRuns instance that this record is associated with. |
| Invoices_Id | String | The unique WID for the invoice to which this record belongs. |
| Descriptor | String | A brief textual summary providing a preview of this invoice instance. |
| BillToCustomer_Prompt | String | The name of the customer responsible for paying the invoice. |
| Company_Prompt | String | The name of the company issuing the invoice. |
| FromDueDate_Prompt | Date | The starting date for the due date range of customer invoices or invoice adjustments, formatted as YYYY-MM-DD. |
| FromInvoiceDate_Prompt | Date | The starting date for the invoice creation date range, formatted as YYYY-MM-DD. |
| InvoiceStatus_Prompt | String | The current processing status of the invoice, such as Draft, Approved, or Paid. |
| PaymentStatus_Prompt | String | The current status of the invoice payment, indicating whether the invoice is Paid, Unpaid, or Partially Paid. |
| ToDueDate_Prompt | Date | The ending date for the due date range of customer invoices or invoice adjustments, formatted as YYYY-MM-DD. |
| ToInvoiceDate_Prompt | Date | The ending date for the invoice creation date range, formatted as YYYY-MM-DD. |
| TransactionType_Prompt | String | The transaction type of this customer transaction. Use the string "invoice" or "adjustment" to filter to retrieve either only invoices or adjustments. |
Retrieves a list of job change reasons, including promotions, transfers, and other employment status changes.
| Name | Type | Description |
| Id [KEY] | String | A system-generated unique identifier assigned to each job change reason, ensuring distinct records within Workday. |
| Descriptor | String | A concise, user-friendly label that describes the job change reason, helping users quickly understand its purpose. |
| Href | String | A direct Uniform Resource Locator (URL) to the specific job change reason record within Workday, enabling quick access for reference or modification. |
| IsForContingentWorker | Bool | Specifies whether this job change reason is applicable to contingent workers, including contractors and temporary staff, distinguishing it from employee-specific reasons. |
| IsForEmployee | Bool | Specifies whether this job change reason applies to full-time or part-time employees, ensuring appropriate classification within Workday. |
| ManagerReason | Bool | Indicates whether managers can select this job change reason when modifying an employee's job details, supporting structured decision-making in employment changes. |
Retrieves available assignment types applicable to job changes, such as full-time, part-time, or contract roles.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the assignment type value, ensuring accurate record tracking. |
| Descriptor | String | A concise, user-friendly description of the assignment type value, helping users interpret its purpose. |
| CollectionToken | String | A token used in conjunction with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the assignment type change, allowing users to filter records based on when the change takes effect. |
| Job_Prompt | String | The job associated with the assignment type change, used as a filter to refine query results. |
| Location_Prompt | String | The work location linked to the assignment type change, providing filtering options based on geographic assignments. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the assignment type change, allowing filtering by managerial assignments. |
| StaffingEvent_Prompt | String | The staffing event related to the assignment type change, enabling queries based on specific workforce events. |
| Worker_Prompt | String | The worker linked to the assignment type change, allowing targeted queries for individual employees. |
Lists company insider types relevant to job changes, helping to classify roles with specific regulatory considerations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the company insider type value, ensuring accurate tracking of insider classifications. |
| Descriptor | String | A concise, user-friendly description of the company insider type, helping users interpret its role in regulatory and compliance requirements. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the company insider type change, allowing users to filter records based on when the classification change takes effect. |
| Job_Prompt | String | The job associated with the company insider type change, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the company insider type change, providing filtering options based on geographic assignments. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the company insider type change, allowing filtering by managerial assignments. |
| StaffingEvent_Prompt | String | The staffing event related to the company insider type change, enabling queries based on specific workforce events. |
| Worker_Prompt | String | The worker linked to the company insider type change, allowing targeted queries for individual employees. |
Provides available contingent worker types, including temporary and contract employees, for job change processing.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the contingent worker type value, ensuring accurate classification and tracking. |
| Descriptor | String | A concise, user-friendly description of the contingent worker type, helping users differentiate between various worker categories. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the contingent worker type change, allowing users to filter records based on when the classification update takes effect. |
| Job_Prompt | String | The job associated with the contingent worker type change, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the contingent worker type change, providing filtering options based on geographic assignments. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the contingent worker type change, allowing filtering by managerial assignments. |
| StaffingEvent_Prompt | String | The staffing event related to the contingent worker type change, enabling queries based on specific workforce events. |
| Worker_Prompt | String | The worker linked to the contingent worker type change, allowing targeted queries for individual contingent employees. |
Retrieves available currency options applicable to job changes, ensuring correct financial calculations in compensation changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the currency, ensuring accurate financial record tracking. |
| Descriptor | String | A concise, user-friendly description of the currency, helping users interpret financial transactions and payroll details. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the currency assignment, allowing users to filter records based on when the currency was assigned. |
| Job_Prompt | String | The job associated with the currency assignment, used as a filter to refine query results for specific positions. |
| Location_Prompt | String | The work location linked to the currency assignment, providing filtering options based on geographic financial policies. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the currency assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the currency assignment, enabling queries based on specific workforce transactions. |
| Worker_Prompt | String | The worker linked to the currency assignment, allowing targeted queries for individual employees and contingent workers. |
Lists various employee types, such as salaried, hourly, and contractor, available for job change operations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the employee type, ensuring accurate classification and tracking. |
| Descriptor | String | A concise, user-friendly description of the employee type, helping users differentiate between various employment categories. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the employee type assignment, allowing users to filter records based on when the classification update takes effect. |
| Job_Prompt | String | The job associated with the employee type assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the employee type assignment, providing filtering options based on geographic assignments. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the employee type assignment, allowing filtering by managerial assignments. |
| StaffingEvent_Prompt | String | The staffing event related to the employee type assignment, enabling queries based on specific workforce events. |
| Worker_Prompt | String | The worker linked to the employee type assignment, allowing targeted queries for individual employees. |
Provides available pay frequency options for job changes, including weekly, bi-weekly, and monthly payroll schedules.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the pay frequency, ensuring accurate payroll classification. |
| Descriptor | String | A concise, user-friendly description of the pay frequency, helping users understand payroll cycles such as weekly, biweekly, or monthly payments. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the pay frequency assignment, allowing users to filter records based on when the payroll cycle change takes effect. |
| Job_Prompt | String | The job associated with the pay frequency assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the pay frequency assignment, providing filtering options based on geographic payroll policies. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the pay frequency assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the pay frequency assignment, enabling queries based on specific workforce transactions. |
| Worker_Prompt | String | The worker linked to the pay frequency assignment, allowing targeted queries for individual employees and contingent workers. |
Retrieves headcount-related options relevant to job changes, aiding workforce planning and reporting.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the headcount option, ensuring accurate workforce planning and tracking. |
| Descriptor | String | A concise, user-friendly description of the headcount option, helping users understand its role in workforce allocation and budgeting. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the headcount option assignment, allowing users to filter records based on when the workforce allocation change takes effect. |
| Job_Prompt | String | The job associated with the headcount option assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the headcount option assignment, providing filtering options based on geographic workforce planning. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the headcount option assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the headcount option assignment, enabling queries based on specific workforce changes. |
| Worker_Prompt | String | The worker linked to the headcount option assignment, allowing targeted queries for individual employees and workforce planning. |
Lists available job classifications used in job change records, ensuring proper categorization within the organization.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job classification, ensuring accurate tracking and categorization. |
| Descriptor | String | A concise, user-friendly description of the job classification, helping users understand its role in employment structure. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job classification assignment, allowing users to filter records based on when the classification change takes effect. |
| Job_Prompt | String | The job associated with the job classification assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job classification assignment, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job classification assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the job classification assignment, enabling queries based on specific workforce transactions. |
| Worker_Prompt | String | The worker linked to the job classification assignment, allowing targeted queries for individual employees and job role assignments. |
Retrieves predefined job profiles applicable to job changes, including job descriptions, responsibilities, and required qualifications.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job profile, ensuring accurate job categorization and tracking. |
| Descriptor | String | A concise, user-friendly description of the job profile, helping users understand its role and responsibilities within the organization. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job profile assignment, allowing users to filter records based on when the job profile change takes effect. |
| Job_Prompt | String | The job associated with the job profile assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job profile assignment, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job profile assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the job profile assignment, enabling queries based on specific workforce transactions. |
| Worker_Prompt | String | The worker linked to the job profile assignment, allowing targeted queries for individual employees and job role assignments. |
Provides available job requisitions for job changes, linking open job postings with internal role changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job requisition, ensuring accurate tracking of open positions. |
| Descriptor | String | A concise, user-friendly description of the job requisition, helping users understand its purpose within the hiring process. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job requisition assignment, allowing users to filter records based on when the requisition becomes active. |
| Job_Prompt | String | The job associated with the job requisition assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job requisition assignment, providing filtering options based on geographic hiring needs. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job requisition assignment, allowing filtering by hiring managers. |
| StaffingEvent_Prompt | String | The staffing event related to the job requisition assignment, enabling queries based on specific hiring transactions. |
| Worker_Prompt | String | The worker linked to the job requisition assignment, allowing targeted queries for job applicants or hired candidates. |
Lists job positions associated with job changes, supporting internal mobility and organizational structure updates.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job, ensuring accurate tracking and classification. |
| Descriptor | String | A concise, user-friendly description of the job, providing insight into its responsibilities and role within the organization. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job assignment, allowing users to filter records based on when the job role becomes active. |
| Job_Prompt | String | The job associated with the job assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job assignment, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the job assignment, enabling queries based on specific hiring or workforce changes. |
| Worker_Prompt | String | The worker linked to the job assignment, allowing targeted queries for individual employees and job placements. |
Retrieves location options applicable to job changes, ensuring updates align with geographical employment policies.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the location, ensuring accurate workforce tracking and management. |
| Descriptor | String | A concise, user-friendly description of the location, helping users identify work sites and office locations. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the location assignment, allowing users to filter records based on when the location change takes effect. |
| Job_Prompt | String | The job associated with the location assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job change, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the location assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the location assignment, enabling queries based on specific workforce movements. |
| Worker_Prompt | String | The worker linked to the location assignment, allowing targeted queries for individual employees and job placements. |
Lists pay rate types available for job changes, including hourly, salaried, and commission-based structures.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the pay rate type, ensuring accurate payroll classification and reporting. |
| Descriptor | String | A concise, user-friendly description of the pay rate type, helping users understand how compensation is structured (e.g., hourly, salary). |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the pay rate type assignment, allowing users to filter records based on when the payroll classification change takes effect. |
| Job_Prompt | String | The job associated with the pay rate type assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the pay rate type assignment, providing filtering options based on geographic payroll policies. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the pay rate type assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the pay rate type assignment, enabling queries based on specific workforce transactions. |
| Worker_Prompt | String | The worker linked to the pay rate type assignment, allowing targeted queries for individual employees and payroll adjustments. |
Retrieves proposed positions linked to job changes, supporting internal promotions and transfers.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the proposed position, ensuring accurate tracking in job changes. |
| Descriptor | String | A concise, user-friendly description of the proposed position, helping users understand the role and responsibilities. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the proposed position assignment, allowing users to filter records based on when the role change takes effect. |
| Job_Prompt | String | The job associated with the proposed position assignment, used as a filter to refine query results for specific job transitions. |
| Location_Prompt | String | The work location linked to the proposed position assignment, providing filtering options based on geographic workforce planning. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the proposed position assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the proposed position assignment, enabling queries based on specific hiring or workforce changes. |
| Worker_Prompt | String | The worker linked to the proposed position assignment, allowing targeted queries for employees transitioning into new roles. |
Lists available reasons for job changes, such as promotions, department transfers, or policy-driven updates.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job change reason, ensuring proper tracking of employment changes. |
| Descriptor | String | A concise, user-friendly description of the job change reason, helping users understand the rationale for the employment action. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job change reason assignment, allowing users to filter records based on when the employment change takes effect. |
| Job_Prompt | String | The job associated with the job change reason, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job change reason, providing filtering options based on geographic workforce adjustments. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job change reason, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the job change reason, enabling queries based on specific employment transitions. |
| Worker_Prompt | String | The worker linked to the job change reason, allowing targeted queries for employees undergoing job modifications. |
Retrieves supervisory organization structures applicable to job changes, ensuring correct reporting relationships.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the supervisory organization, ensuring accurate workforce tracking. |
| Descriptor | String | A concise, user-friendly description of the supervisory organization, helping users understand its structure and hierarchy. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the supervisory organization assignment, allowing users to filter records based on when the organizational change takes effect. |
| Job_Prompt | String | The job associated with the supervisory organization assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the supervisory organization assignment, providing filtering options based on geographic workforce organization. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the supervisory organization assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the supervisory organization assignment, enabling queries based on specific workforce structure changes. |
| Worker_Prompt | String | The worker linked to the supervisory organization assignment, allowing targeted queries for employees within specific organizational units. |
Lists predefined job change templates that standardize employment updates for various scenarios.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job change template, ensuring accurate record-keeping for standardized job transitions. |
| Descriptor | String | A concise, user-friendly description of the job change template, helping users understand its purpose in structuring employment changes. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the job change template assignment, allowing users to filter records based on when the structured job change process takes effect. |
| Job_Prompt | String | The job associated with the job change template assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the job change template assignment, providing filtering options based on geographic workforce planning. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the job change template assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the job change template assignment, enabling queries based on specific employment transitions. |
| Worker_Prompt | String | The worker linked to the job change template assignment, allowing targeted queries for employees undergoing structured job changes. |
Provides available time types, such as full-time and part-time, relevant to job change operations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the time type, ensuring accurate classification for work schedules. |
| Descriptor | String | A concise, user-friendly description of the time type, helping users understand whether it pertains to full-time, part-time, or flexible work arrangements. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the time type assignment, allowing users to filter records based on when the schedule change takes effect. |
| Job_Prompt | String | The job associated with the time type assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the time type assignment, providing filtering options based on geographic work schedule policies. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the time type assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the time type assignment, enabling queries based on specific workforce scheduling changes. |
| Worker_Prompt | String | The worker linked to the time type assignment, allowing targeted queries for employees based on their work schedule type. |
Lists workers' compensation codes applicable to job changes, ensuring accurate legal and insurance reporting.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the worker's compensation code override, ensuring accurate classification for insurance and liability purposes. |
| Descriptor | String | A concise, user-friendly description of the worker's compensation code override, helping users understand why the standard code has been modified. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the worker's compensation code override assignment, allowing users to filter records based on when the override takes effect. |
| Job_Prompt | String | The job associated with the worker's compensation code override, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the worker's compensation code override, providing filtering options based on geographic liability policies. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the worker's compensation code override assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the worker's compensation code override, enabling queries based on specific employment changes impacting insurance classification. |
| Worker_Prompt | String | The worker linked to the worker's compensation code override, allowing targeted queries for employees whose standard compensation classification has been adjusted. |
Retrieves worker records associated with job changes, supporting employment status modifications.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the worker, ensuring accurate tracking of employment records. |
| Descriptor | String | A concise, user-friendly description of the worker, typically displaying their full name for easy identification. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the worker assignment, allowing users to filter records based on when the worker's role or employment details change. |
| Job_Prompt | String | The job associated with the worker assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the worker assignment, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the worker assignment, enabling queries based on specific employment changes. |
| Worker_Prompt | String | The worker linked to the assignment, allowing targeted queries for individuals within workforce planning and management. |
Lists worker types relevant to job changes, including contractors, employees, and interns.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the worker type, ensuring accurate classification and workforce management. |
| Descriptor | String | A concise, user-friendly description of the worker type, distinguishing between categories such as full-time, part-time, or contingent workers. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the worker type assignment, allowing users to filter records based on when the classification takes effect. |
| Job_Prompt | String | The job associated with the worker type assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the worker type assignment, providing filtering options based on geographic workforce distribution. |
| ProposedManager_Prompt | String | The proposed manager for the worker type assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the worker type assignment, enabling queries based on specific employment classification changes. |
| Worker_Prompt | String | The worker linked to the worker type assignment, allowing targeted queries for employees based on their employment category. |
Retrieves available work shift options for job changes, ensuring scheduling and workforce alignment.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the work shift, ensuring accurate tracking of employee schedules. |
| Descriptor | String | A concise, user-friendly description of the work shift, specifying details such as shift type (e.g., morning, night, rotating). |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the work shift assignment, allowing users to filter records based on when the shift schedule change takes effect. |
| Job_Prompt | String | The job associated with the work shift assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the work shift assignment, providing filtering options based on geographic workforce scheduling. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the work shift assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the work shift assignment, enabling queries based on specific employment scheduling changes. |
| Worker_Prompt | String | The worker linked to the work shift assignment, allowing targeted queries for employees based on their assigned shift schedules. |
Lists workspace assignments applicable to job changes, helping manage seating arrangements and facility allocations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the workspace, ensuring accurate tracking of assigned work areas. |
| Descriptor | String | A concise, user-friendly description of the workspace, providing details about office locations, desks, or remote workspaces. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the workspace assignment, allowing users to filter records based on when the workspace allocation takes effect. |
| Job_Prompt | String | The job associated with the workspace assignment, used as a filter to refine query results for specific roles. |
| Location_Prompt | String | The work location linked to the workspace assignment, providing filtering options based on geographic office locations or remote setups. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the workspace assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the workspace assignment, enabling queries based on specific office or desk allocation changes. |
| Worker_Prompt | String | The worker linked to the workspace assignment, allowing targeted queries for employees based on their assigned workspace. |
Retrieves work-study award details relevant to job changes, ensuring compliance with academic employment regulations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the work-study award, ensuring accurate financial aid tracking. |
| Descriptor | String | A concise, user-friendly description of the work-study award, providing details about the type and purpose of the funding. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a specific collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Entering this input retrieves all associated child elements within the specified collection. |
| EffectiveDate_Prompt | Date | The effective date for the work-study award assignment, allowing users to filter records based on when the award was granted. |
| Job_Prompt | String | The job associated with the work-study award assignment, used as a filter to refine query results for specific student employment roles. |
| Location_Prompt | String | The work location linked to the work-study award assignment, providing filtering options based on geographic placement of the job. |
| ProposedManager_Prompt | String | The proposed manager for the worker in the work-study award assignment, allowing filtering by managerial oversight. |
| StaffingEvent_Prompt | String | The staffing event related to the work-study award assignment, enabling queries based on specific student employment changes. |
| Worker_Prompt | String | The worker linked to the work-study award assignment, allowing targeted queries for students receiving work-study financial aid. |
Retrieves a collection of job families, grouping related job roles based on function or discipline.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job family instance, ensuring accurate tracking. |
| Descriptor | String | A brief, user-friendly summary of the job family, describing its overall purpose and scope within the organization. |
| Inactive | Bool | Indicates whether the job family is inactive ('true' or 'false'). Default is false, meaning the job family is active unless specified otherwise. |
| JobFamilyGroup_Descriptor | String | A brief, user-friendly summary of the job family group, categorizing related job families. |
| JobFamilyGroup_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job family group, ensuring proper classification. |
| Summary | String | A detailed summary of the job family, including key attributes, responsibilities, and career paths associated with the roles within it. |
| Inactive_Prompt | Bool | Indicates whether to include inactive job families in the query ('true' or 'false'). Default is false, filtering out inactive families unless explicitly included. |
| JobFamilyGroup_Prompt | String | Filters job families by their associated job family group. Multiple job family groups can be specified to refine search results. |
| JobProfile_Prompt | String | Filters job families by their associated job profile. Multiple job profiles can be specified. Accepts job profile IDs returned from GET /jobProfiles. |
Lists job profiles associated with job families, providing insight into role groupings and career paths.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job profile instance, ensuring accurate classification within the system. |
| JobFamilies_Id [KEY] | String | A unique identifier (Workday ID) of the job family that contains this job profile, establishing its association within the organization. |
| Descriptor | String | A brief, user-friendly summary of the job profile, describing the role’s responsibilities and qualifications. |
| Inactive_Prompt | Bool | Indicates whether to include inactive job families in the query ('true' or 'false'). Default is false, excluding inactive job families unless explicitly included. |
| JobFamilyGroup_Prompt | String | Filters job families by their associated job family group. Multiple job family groups can be specified for refined search results. |
| JobProfile_Prompt | String | Filters job families by their associated job profile. Multiple job profiles can be specified. Accepts job profile IDs returned from GET /jobProfiles. |
Retrieves a list of active job postings, including available positions and recruitment details.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job posting instance, ensuring accurate tracking. |
| Company_Descriptor | String | A brief, user-friendly description of the company associated with the job posting. |
| Company_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the company associated with the job posting. |
| EndDate | Datetime | The date when the job posting will no longer be available, marking the closing of applications. |
| JobDescription | String | A detailed description of the job role, outlining responsibilities, requirements, and expectations. |
| JobSite_Descriptor | String | A brief, user-friendly description of the job site, clarifying the physical or virtual location of the job. |
| JobSite_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job site associated with the job posting. |
| JobType_Descriptor | String | A brief, user-friendly description of the job type, specifying employment classifications such as full-time or contract. |
| JobType_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job type. |
| PrimaryLocation_Country_Alpha3Code | String | The three-letter ISO country code representing the primary job location. |
| PrimaryLocation_Country_Descriptor | String | A brief, user-friendly description of the country associated with the primary job location. |
| PrimaryLocation_Descriptor | String | A brief, user-friendly description of the primary job location, helping candidates understand the work setting. |
| PrimaryLocation_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the primary job location, ensuring proper location tracking. |
| PrimaryLocation_Region_Code | String | The regional portion of the ISO 3166-2 country region code representing the job location’s specific region. |
| PrimaryLocation_Region_Descriptor | String | A brief, user-friendly description of the region associated with the primary job location. |
| RemoteType_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the remote work type for the job posting. |
| RemoteType_Name | String | The external or internal name of the job requisition remote type associated with the job posting. |
| SpotlightJob | Bool | Indicates whether the job posting is a Spotlight Job ('true' or 'false'), used for highlighting key listings. |
| StartDate | Datetime | The date when the job posting becomes active, marking the start of candidate applications. |
| TimeType_Descriptor | String | A brief, user-friendly description of the time type (e.g., full-time, part-time). |
| TimeType_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the time type associated with the job posting. |
| Title | String | The title of the job posting, as specified in the associated job requisition. |
| Url | String | The external URL for the job posting if published on a Workday External Career Site. |
| Category_Prompt | String | A filter category for job postings, enabling refined searches. |
| JobPosting_Prompt | String | Filters job postings based on anchor criteria, helping users find relevant job listings. |
| JobRequisition_Prompt | String | Filters job postings based on associated job requisitions, ensuring alignment with hiring needs. |
| JobSite_Prompt | String | Filters job postings based on the job site, refining results based on location. |
Retrieves additional job location details linked to job postings, supporting multi-site hiring processes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the additional job location instance, ensuring accurate tracking. |
| JobPostings_Id [KEY] | String | A unique identifier (Workday ID) of the job posting associated with this additional location, linking it to a specific job listing. |
| Country_Alpha3Code | String | The three-letter ISO country code representing the additional job location. |
| Country_Descriptor | String | A brief, user-friendly description of the country associated with the additional job location. |
| Descriptor | String | A brief, user-friendly summary of the additional job location, clarifying its purpose. |
| Region_Code | String | The regional portion of the ISO 3166-2 country region code representing the additional job location’s specific region. |
| Region_Descriptor | String | A brief, user-friendly description of the region associated with the additional job location. |
| Category_Prompt | String | A filter category for additional job locations, enabling refined searches. |
| JobPosting_Prompt | String | Filters additional job locations based on the associated job posting, ensuring accurate location mapping. |
| JobRequisition_Prompt | String | Filters additional job locations based on the associated job requisition, aligning job postings with hiring needs. |
| JobSite_Prompt | String | Filters additional job locations based on the job site, refining results based on geographic locations. |
Lists job categories associated with job postings, classifying roles based on industry, department, or function.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to this job posting category instance, ensuring proper classification of job listings for organizational reporting. |
| JobPostings_Id [KEY] | String | A unique identifier (Workday ID) of the job posting associated with this category, linking a specific job listing to one or more predefined job categories. |
| Descriptor | String | A descriptive label for the job posting category, providing insight into the type of role, industry, or department associated with the listing. |
| Category_Prompt | String | A filter that enables users to refine job searches based on predefined job categories, helping candidates find relevant positions more efficiently. |
| JobPosting_Prompt | String | A filtering criterion that allows users to retrieve job postings based on their associated job posting anchor, ensuring relevant category alignment. |
| JobRequisition_Prompt | String | A filtering option that enables users to search for job postings linked to a specific job requisition, improving tracking of hiring processes. |
| JobSite_Prompt | String | A filtering option that refines job searches based on the associated job site, allowing for targeted location-based job searches. |
Retrieves a comprehensive list of job profiles, including descriptions, responsibilities, and required qualifications.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job profile instance, ensuring precise role tracking. |
| AdditionalJobDescription | String | Additional details about the job role, including specialized responsibilities, expectations, or key qualifications. |
| CriticalJob | Bool | Indicates whether this job is considered essential to business operations ('true' or 'false'), helping prioritize recruitment efforts. |
| DefaultJobTitle | String | The default job title assigned to this job profile, which may be modified based on role specifications. |
| DifficultyToFill_Descriptor | String | A brief description of how challenging it is to fill this job role, providing insight into hiring difficulties. |
| DifficultyToFill_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the difficulty-to-fill classification, ensuring standardized categorization. |
| Inactive | Bool | Indicates whether the job profile is inactive ('true' or 'false'), allowing for status-based job profile filtering. |
| JobCategory_Descriptor | String | A user-friendly description of the job category, classifying the job profile within broader employment groups. |
| JobCategory_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job category, ensuring proper classification in the system. |
| JobDescription | String | The official job description containing key responsibilities, qualifications, and expectations for this job profile. |
| JobLevel_Descriptor | String | A brief description of the job level, helping categorize the seniority and scope of the role. |
| JobLevel_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job level, supporting structured job classification. |
| ManagementLevel_Descriptor | String | A brief description of the management level, indicating whether the job profile involves leadership responsibilities. |
| ManagementLevel_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the management level, aiding in workforce structuring. |
| Name | String | The official name of the job profile as defined within Workday, used for internal reference and reporting. |
| Public | Bool | Indicates whether the job profile is publicly accessible ('true' or 'false'), determining its visibility to external job seekers. |
| Summary | String | A summary of the job profile’s key responsibilities, core functions, and minimum qualifications required for the role. |
| WorkShiftRequired | Bool | Indicates whether specifying a work shift is required for positions using this job profile ('true' or 'false'), ensuring scheduling accuracy. |
| IncludeInactive_Prompt | Bool | If the value is 'true', the query results include inactive job profiles. The default value is 'false', excluding inactive profiles from searches. |
Lists company insider classifications associated with job profiles, ensuring compliance with regulatory requirements.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the company insider type instance, used to classify roles with access to privileged company information. |
| JobProfiles_Id [KEY] | String | A unique identifier (Workday ID) of the job profile linked to this company insider type, defining which job roles require special insider status. |
| Descriptor | String | A user-friendly description of the company insider type, indicating whether a job role involves restricted financial, legal, or strategic business information. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are returned unless explicitly specified. |
Retrieves exemption status details for job profiles, helping manage FLSA and other labor law classifications.
| Name | Type | Description |
| JobProfiles_Id | String | A unique identifier (Workday ID) of the job profile associated with this exemption status, ensuring proper classification for compliance tracking. |
| CountryOrRegion_Descriptor | String | A user-friendly description of the country or region where the exemption status applies, helping align labor regulations with geographic requirements. |
| CountryOrRegion_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the country or region linked to this exemption, ensuring accurate compliance reporting. |
| Exempt | Bool | Indicates whether the job profile is classified as exempt from overtime pay or other labor regulations ('true' or 'false'), based on regional employment laws. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are returned unless explicitly specified. |
Lists job families associated with job profiles, supporting structured career path planning.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job family instance, used to group related job profiles under a shared category. |
| JobProfiles_Id [KEY] | String | A unique identifier (Workday ID) of the job profile associated with this job family, linking specific job roles to broader employment categories. |
| Descriptor | String | A user-friendly description of the job family, summarizing its purpose and the types of roles it encompasses. |
| Name | String | The official name of the job family as recognized within Workday, defining its classification within the organizational structure. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are returned unless explicitly specified. |
Retrieves pay rate types applicable to job profiles, including salary, hourly, and commission-based structures.
| Name | Type | Description |
| JobProfiles_Id | String | A unique identifier (Workday ID) of the job profile associated with this pay rate type, ensuring proper classification of compensation structures. |
| Country_Alpha3Code | String | The three-letter ISO country code representing the country where this pay rate type is applicable, aligning pay structures with regional labor laws. |
| Country_Descriptor | String | A user-friendly description of the country where this pay rate type applies, providing clarity on geographic pay policies. |
| Country_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the country associated with this pay rate type, supporting accurate compensation tracking. |
| PayRateType_Descriptor | String | A brief, user-friendly description of the pay rate type, defining how compensation is structured (e.g., hourly, salaried, commission-based). |
| PayRateType_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the pay rate type, ensuring consistent pay classification within the system. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are considered unless explicitly specified. |
Lists countries where specific job profiles are restricted, ensuring compliance with local employment laws.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the country restriction instance, ensuring proper compliance tracking. |
| JobProfiles_Id [KEY] | String | A unique identifier (Workday ID) of the job profile associated with this country restriction, defining geographic eligibility for the role. |
| Alpha3Code | String | The three-letter ISO country code representing the country where this job profile is restricted, ensuring regulatory compliance. |
| Descriptor | String | A user-friendly description of the country restriction, providing context on why the job profile is limited to specific regions. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are considered unless explicitly specified. |
Retrieves workers' compensation codes linked to job profiles, ensuring compliance with legal and insurance requirements.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
country: { /* Returns the country from the primary address for the location. */
descriptor: Text /* A preview of the instance */
}
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
}]
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the worker's compensation code instance, ensuring proper tracking for labor compliance. |
| JobProfiles_Id [KEY] | String | A unique identifier (Workday ID) of the job profile associated with this worker's compensation code, linking job roles to specific legal classifications. |
| Code | String | The official worker's compensation code assigned to this job profile, used for regulatory and insurance purposes. |
| Country_Alpha3Code | String | The three-letter ISO country code representing the country where this worker's compensation code applies, ensuring location-based compliance. |
| Country_Descriptor | String | A user-friendly description of the country where this worker's compensation code is applicable, providing geographic context. |
| Country_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the country associated with this worker's compensation code, supporting accurate jurisdictional tracking. |
| Descriptor | String | A brief, user-friendly description of the worker's compensation code, clarifying its purpose and usage. |
| Inactive | Bool | Indicates whether the worker's compensation code is inactive ('true' or 'false'), determining its current validity. |
| Locations_Aggregate | String | A list of locations where this worker's compensation code is applicable, helping define its coverage scope. |
| Name | String | A detailed description of the worker's compensation code, specifying its relevance to different job profiles and industries. |
| Regions_Aggregate | String | A list of country regions where this worker's compensation code is used, ensuring accurate assignment in multi-region companies. |
| IncludeInactive_Prompt | Bool | If true, includes inactive job profiles in query results. Default is false, ensuring that only active job profiles are considered unless explicitly specified. |
Retrieves a list of jobs available within the organization, including details on responsibilities and reporting structures.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the job instance, ensuring precise tracking of job assignments. |
| BusinessTitle | String | The business title associated with the position, which may differ from the official job profile title and is often customized for clarity. |
| Descriptor | String | A user-friendly summary of the job instance, providing essential details about the role within the organization. |
| JobProfile_Descriptor | String | A brief, human-readable description of the job profile linked to this job, summarizing its purpose and key responsibilities. |
| JobProfile_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job profile, ensuring accurate classification of job roles. |
| JobType_Descriptor | String | A user-friendly description of the job type, indicating employment status (e.g., full-time, part-time, or contract). |
| Location_Country_Descriptor | String | A user-friendly description of the country where the job is based, aligning job assignments with geographic locations. |
| Location_Descriptor | String | A user-friendly description of the specific job location, providing clarity on the worksite or remote status. |
| Location_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the job location, ensuring consistency in job tracking. |
| NextPayPeriodStartDate | Datetime | The start date of the next pay period for this job, used for payroll and compensation scheduling. |
| SupervisoryOrganization_Descriptor | String | A user-friendly description of the supervisory organization responsible for managing this job, ensuring proper reporting structures. |
| SupervisoryOrganization_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the supervisory organization, supporting workforce structuring. |
| Worker_Descriptor | String | A user-friendly description of the worker assigned to this job, typically including their name or position reference. |
| Worker_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the worker currently holding this job, ensuring accurate employee-job mapping. |
Retrieves pay group details associated with a job, determining salary and payroll processing rules.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the pay group instance, ensuring proper classification for payroll processing. |
| Jobs_Id [KEY] | String | A unique identifier (Workday ID) of the job associated with this pay group, linking job roles to specific compensation structures. |
| Country_Descriptor | String | A user-friendly description of the country where this pay group applies, providing geographic context for payroll regulations. |
| Country_Href | String | A direct URL linking to the country instance in Workday, allowing quick access to country-specific payroll details. |
| Country_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the country associated with this pay group, ensuring accurate compliance tracking. |
| Descriptor | String | A user-friendly summary of the pay group instance, describing the compensation policies and grouping of employees under the same payroll structure. |
| Effective_Prompt | Date | The effective date of the pay group in YYYY-MM-DD format, defining when the pay group becomes active for payroll calculations. |
Retrieves detailed pay group settings related to jobs, ensuring correct payroll categorization and processing.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the pay group detail instance, ensuring accurate payroll classification. |
| JobsPayGroup_Id [KEY] | String | A unique identifier (Workday ID) of the pay group associated with this detail, linking payroll structures to specific compensation models. |
| Jobs_Id [KEY] | String | A unique identifier (Workday ID) of the job associated with this pay group detail, defining how compensation is processed for specific roles. |
| Descriptor | String | A user-friendly summary of the pay group detail instance, describing the payroll processing details related to this job. |
| RunCategory_Descriptor | String | A user-friendly description of the payroll run category, indicating the type of payroll processing schedule used, such as bi-weekly or monthly. |
| RunCategory_Href | String | A direct URL linking to the payroll run category instance in Workday, providing access to detailed payroll scheduling information. |
| RunCategory_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the payroll run category, ensuring structured payroll classification. |
| Effective_Prompt | Date | The effective date of the pay group detail in yyyy-mm-dd format, marking when these payroll settings take effect for the associated job. |
Retrieves workspace assignments for a given job, managing physical office locations and seating arrangements.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the workspace instance, ensuring precise tracking of job locations within the organization. |
| Jobs_Id [KEY] | String | A unique identifier (Workday ID) of the job associated with this workspace, defining the physical or virtual location where the job duties are performed. |
| Descriptor | String | A user-friendly summary of the workspace instance, describing the assigned work environment, such as an office, remote setup, shared workstation, or designated department space. |
| LocationChain | String | The full hierarchical path of the job location, displaying the structured organization of the worksite, including higher-level locations such as company headquarters, regional offices, or specific departments for easier navigation and reference. |
Lists available leave status options, including approved, pending, and denied requests.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each leave status value, ensuring precise tracking and classification of employee leave statuses within the system. |
| Descriptor | String | A user-friendly description of the leave status, indicating an employee’s current leave state, such as active leave, pending approval, canceled leave, or completed leave. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this leave status collection. If the value is 'NULL', the row represents an individual leave status value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all child elements within the leave status collection. This enables structured queries for managing and reporting on leave records. |
Retrieves details on mentorship programs and participant assignments within the organization.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to the mentorship instance, ensuring accurate tracking and management. |
| CloseMentorshipReason_Descriptor | String | A user-friendly description of the reason why the mentorship was closed, providing context on mentorship completion or termination. |
| CloseMentorshipReason_Href | String | A direct URL linking to the close mentorship reason instance in Workday, allowing easy access to closure details. |
| CloseMentorshipReason_Id | String | A unique identifier (WID, ID, or reference ID) for the reason the mentorship was closed, ensuring standardized tracking. |
| Descriptor | String | A user-friendly summary of the mentorship instance, outlining key details of the program. |
| EndDate | Datetime | The date when the mentorship officially ends, marking its completion. |
| Mentee_Descriptor | String | A user-friendly description of the mentee participating in the mentorship, providing insight into their role. |
| Mentee_Href | String | A direct URL linking to the mentee instance in Workday, allowing quick access to the mentee's profile. |
| Mentee_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the mentee, ensuring proper record-keeping. |
| MentorType_Descriptor | String | A user-friendly description of the mentor type, specifying the category or level of mentorship provided. |
| MentorType_Href | String | A direct URL linking to the mentor type instance in Workday, helping users access mentor classification details. |
| MentorType_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the mentor type, ensuring accurate classification. |
| Mentor_Descriptor | String | A user-friendly description of the mentor participating in the mentorship, providing insight into their role. |
| Mentor_Href | String | A direct URL linking to the mentor instance in Workday, allowing quick access to the mentor’s profile. |
| Mentor_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the mentor, ensuring accurate tracking of mentorship assignments. |
| Mentorship_Descriptor | String | A user-friendly description of the mentorship, summarizing its goals and key attributes. |
| Mentorship_Href | String | A direct URL linking to the mentorship instance in Workday, enabling quick navigation to mentorship details. |
| Mentorship_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the mentorship, supporting structured record-keeping. |
| Purpose | String | The stated purpose or objective of the mentorship, defining its focus areas such as leadership development, skill enhancement, or career progression. |
| StartDate | Datetime | The date when the mentorship officially starts, marking the beginning of the relationship. |
| CloseMentorshipReason_Prompt | String | A filter to retrieve mentorships based on the reason for closure, allowing focused queries on mentorship completion trends. |
| Closed_Prompt | Bool | A filter to include only closed mentorships ('true' or 'false'), helping users refine searches based on mentorship status. |
| InProgress_Prompt | Bool | A filter to include only mentorships that are currently in progress ('true' or 'false'), ensuring visibility into active programs. |
| Mentee_Prompt | String | A filter to retrieve mentorships based on the mentee, allowing personalized searches. |
| MentorType_Prompt | String | A filter to retrieve mentorships based on the mentor type, ensuring alignment with specific mentoring roles. |
| Mentor_Prompt | String | A filter to retrieve mentorships based on the mentor, allowing searches based on mentor participation. |
Lists available academic-related name components, such as degrees and academic titles.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each academic name component, ensuring precise classification and tracking. |
| Descriptor | String | A user-friendly description of the academic name component, such as academic titles, honors, or distinctions used in formal names. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this academic name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the academic name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows academic name components to be retrieved based on country, ensuring alignment with regional naming conventions and academic standards. |
Retrieves hereditary name components, such as generational suffixes used in official records.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each hereditary name component, ensuring proper classification and tracking. |
| Descriptor | String | A user-friendly description of the hereditary name component, such as inherited titles, nobility designations, or generational name markers. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this hereditary name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the hereditary name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows hereditary name components to be retrieved based on country, ensuring alignment with regional naming traditions and legal naming conventions. |
Lists honorary title values, including distinguished recognitions like 'Sir' or 'Dame.'
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each honorary name component, ensuring accurate classification and record-keeping. |
| Descriptor | String | A user-friendly description of the honorary name component, such as professional titles, honorary degrees, awards, or recognitions added to a person's name. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this honorary name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the honorary name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows honorary name components to be retrieved based on country, ensuring compliance with regional naming conventions and professional title standards. |
Retrieves professional name components, such as certifications or licensure designations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each professional name component, ensuring proper classification and record-keeping. |
| Descriptor | String | A user-friendly description of the professional name component, such as job titles, certifications, or professional designations included in a person’s name. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this professional name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the professional name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows professional name components to be retrieved based on country, ensuring compliance with regional professional title conventions and legal standards. |
Lists religious title values, including designations like 'Reverend' or 'Rabbi.'
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each religious name component, ensuring accurate classification and record-keeping. |
| Descriptor | String | A user-friendly description of the religious name component, such as clerical titles, honorifics, or designations used in religious contexts. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this religious name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the religious name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows religious name components to be retrieved based on country, ensuring alignment with regional traditions and religious naming conventions. |
Retrieves royal title values, such as 'King' or 'Queen,' used in official name records.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each royal name component, ensuring precise classification and record-keeping. |
| Descriptor | String | A user-friendly description of the royal name component, such as titles of nobility, monarchial ranks, or honorifics traditionally associated with royalty. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this royal name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the royal name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows royal name components to be retrieved based on country, ensuring alignment with regional customs and traditional naming conventions. |
Lists available salutations, such as 'Mr.,' 'Ms.,' and 'Dr.,' for use in formal communications.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each salutation name component, ensuring proper classification and record-keeping. |
| Descriptor | String | A user-friendly description of the salutation name component, such as formal greetings or courtesy titles (for example, Mr., Mrs., Dr., Prof.). |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this salutation name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the salutation name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows salutation name components to be retrieved based on country, ensuring alignment with regional etiquette and naming conventions. |
Retrieves social title values, including informal name components used in cultural contexts.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each social name component, ensuring accurate classification and record-keeping. |
| Descriptor | String | A user-friendly description of the social name component, which may include informal or culturally significant titles, aliases, or nicknames used in social settings. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this social name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the social name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows social name components to be retrieved based on country, ensuring alignment with regional customs and social naming conventions. |
Lists all available name title components, including professional, academic, and social titles.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each title name component, ensuring precise classification and record-keeping. |
| Descriptor | String | A user-friendly description of the title name component, such as honorifics, professional titles, academic distinctions, or other formal designations used in a name. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this title name component collection. If the value is 'NULL', the row represents an individual value rather than a group. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the title name component collection, enabling structured queries. |
| Country_Prompt | String | A filtering option that allows title name components to be retrieved based on country, ensuring alignment with regional customs, professional standards, and naming conventions. |
Retrieves a list of notification types used for system-generated alerts and messages.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each notification type instance, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly summary of the notification type, describing its function and intended use within Workday. |
| Name | String | The name assigned to the notification type, providing a recognizable label for easy identification. |
| ParentCategory_Descriptor | String | A user-friendly description of the parent category to which this notification type belongs, helping users understand its hierarchical structure. |
| ParentCategory_Href | String | A direct URL linking to the parent category instance in Workday, allowing quick access to related notifications. |
| ParentCategory_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the parent category of the notification type, ensuring structured classification. |
| ReferenceID | String | A reference ID used for lookups within Workday Web Services. In supervisory organizations, this also serves as the 'Organization ID' to facilitate integration and reporting. |
Lists available business unit options applicable to organization assignment changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each business unit, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly description of the business unit, providing insights into its role, function, or scope within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this business unit collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the business unit collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the business unit assignment takes effect, marking the point from which the organizational change is officially recognized. |
| Event_Prompt | String | A filtering option that allows business units to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows business units to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows business units to be retrieved based on the assigned worker, ensuring visibility into workforce assignments within different business units. |
Retrieves a list of company options relevant to organization assignment changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each company, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly description of the company, providing insights into its name, function, or role within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this company collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the company collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the company assignment takes effect, marking the point from which the organizational change is officially recognized. |
| Event_Prompt | String | A filtering option that allows companies to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows companies to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows companies to be retrieved based on the assigned worker, ensuring visibility into workforce assignments within different companies. |
Lists available cost centers for organization assignment changes, aiding financial structuring.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each cost center, ensuring accurate classification and tracking of financial allocations. |
| Descriptor | String | A user-friendly description of the cost center, providing insights into its function, budget responsibility, or department association. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this cost center collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the cost center collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the cost center assignment takes effect, marking the point from which the organizational change is officially recognized. |
| Event_Prompt | String | A filtering option that allows cost centers to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows cost centers to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows cost centers to be retrieved based on the assigned worker, ensuring visibility into workforce financial assignments within different cost centers. |
Lists available custom organization values applicable to organization assignment changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each custom organization, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly description of the custom organization, providing insights into its role, function, or scope within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this custom organization collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the custom organization collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the custom organization assignment takes effect, marking the point from which the organizational change is officially recognized. |
| Event_Prompt | String | A filtering option that allows custom organizations to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows custom organizations to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows custom organizations to be retrieved based on the assigned worker, ensuring visibility into workforce assignments within different custom organizations. |
Retrieves fund details associated with organization assignment changes, supporting grant and budget tracking.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each fund, ensuring accurate classification and tracking of financial allocations. |
| Descriptor | String | A user-friendly description of the fund, providing insights into its purpose, financial source, or designated use within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this fund collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the fund collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the fund assignment takes effect, marking the point from which the financial allocation is officially recognized. |
| Event_Prompt | String | A filtering option that allows fund assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows fund assignments to be retrieved based on their organization type, ensuring structured financial classification and reporting. |
| Worker_Prompt | String | A filtering option that allows fund assignments to be retrieved based on the assigned worker, ensuring visibility into workforce financial allocations. |
Lists available gift-related organization values relevant to assignment changes, ensuring proper allocation.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each gift, ensuring accurate classification and tracking of financial contributions. |
| Descriptor | String | A user-friendly description of the gift, providing insights into its purpose, donor source, or designated use within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this gift collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the gift collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the gift assignment takes effect, marking the point from which the financial contribution is officially recognized. |
| Event_Prompt | String | A filtering option that allows gift assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows gift assignments to be retrieved based on their organization type, ensuring structured financial classification and reporting. |
| Worker_Prompt | String | A filtering option that allows gift assignments to be retrieved based on the assigned worker, ensuring visibility into workforce financial allocations linked to gifts. |
Retrieves grant-related details associated with organization assignment changes, aiding financial management.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each grant, ensuring accurate classification and tracking of financial awards. |
| Descriptor | String | A user-friendly description of the grant, providing insights into its purpose, funding source, or designated use within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this grant collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the grant collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the grant assignment takes effect, marking the point from which the financial award is officially recognized. |
| Event_Prompt | String | A filtering option that allows grant assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows grant assignments to be retrieved based on their organization type, ensuring structured financial classification and reporting. |
| Worker_Prompt | String | A filtering option that allows grant assignments to be retrieved based on the assigned worker, ensuring visibility into workforce financial allocations linked to grants. |
Lists job options applicable to organization assignment changes, supporting workforce planning.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each job, ensuring accurate classification and tracking of job roles. |
| Descriptor | String | A user-friendly description of the job, providing insights into its title, responsibilities, or department within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this job collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the job collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the job assignment takes effect, marking the point from which the employment or role change is officially recognized. |
| Event_Prompt | String | A filtering option that allows job assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows job assignments to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows job assignments to be retrieved based on the assigned worker, ensuring visibility into workforce role changes. |
Retrieves a list of available positions linked to organization assignment changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each position, ensuring accurate classification and tracking of role assignments. |
| Descriptor | String | A user-friendly description of the position, providing insights into its title, job function, or department within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this position collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the position collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the position assignment takes effect, marking the point from which the role or employment change is officially recognized. |
| Event_Prompt | String | A filtering option that allows position assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows position assignments to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows position assignments to be retrieved based on the assigned worker, ensuring visibility into workforce position changes and allocations. |
Lists available program assignments related to organization assignment changes.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each program, ensuring accurate classification and tracking of program assignments. |
| Descriptor | String | A user-friendly description of the program, providing insights into its purpose, scope, or strategic role within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this program collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the program collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the program assignment takes effect, marking the point from which the initiative, project, or educational program is officially recognized. |
| Event_Prompt | String | A filtering option that allows program assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows program assignments to be retrieved based on their organization type, ensuring structured classification and reporting. |
| Worker_Prompt | String | A filtering option that allows program assignments to be retrieved based on the assigned worker, ensuring visibility into workforce allocations within different programs. |
Retrieves a list of region options relevant to organization assignment changes, ensuring compliance with geographic policies.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each region, ensuring accurate classification and tracking of geographic assignments. |
| Descriptor | String | A user-friendly description of the region, providing insights into its geographic boundaries, country affiliation, or administrative role within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this region collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the region collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the region assignment takes effect, marking the point from which the geographic classification is officially recognized. |
| Event_Prompt | String | A filtering option that allows region assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows region assignments to be retrieved based on their organization type, ensuring structured geographic classification and reporting. |
| Worker_Prompt | String | A filtering option that allows region assignments to be retrieved based on the assigned worker, ensuring visibility into workforce assignments across different regions. |
Lists worker values applicable to organization assignment changes, ensuring accurate employee tracking.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each worker, ensuring accurate classification and tracking of workforce assignments. |
| Descriptor | String | A user-friendly description of the worker, providing insights into their name, role, or position within the organization. |
| CollectionToken | String | A system-generated token used with the Collection_Prompt input to retrieve specific members of this worker collection. If the value is 'NULL', the row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column that allows retrieval of all related elements within the worker collection, enabling structured queries. |
| EffectiveDate_Prompt | Date | The date when the worker's organizational assignment takes effect, marking the point from which the job role or department change is officially recognized. |
| Event_Prompt | String | A filtering option that allows worker assignments to be retrieved based on a specific organizational assignment change event, ensuring relevant data selection. |
| OrganizationType_Prompt | String | A filtering option that allows worker assignments to be retrieved based on their organization type, ensuring structured workforce classification and reporting. |
| Worker_Prompt | String | A filtering option that allows worker assignments to be retrieved based on the assigned worker, ensuring visibility into workforce movements and allocations. |
Retrieves a collection of organizational entities, including departments, business units, and cost centers.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each organization instance, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly description of the organization, providing insights into its name, function, structure, or purpose within the enterprise. |
| Href | String | A direct URL linking to the organization instance in Workday, allowing users to navigate to detailed organizational information. |
| OrganizationType_Prompt | String | A reference to an organization type that defines the classification of the organization. Requests must specify an organization type to retrieve relevant data. |
Retrieves a list of organization types, categorizing entities based on function, structure, or legal status.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier (WID, ID, or reference ID) assigned to each organization type instance, ensuring accurate classification and tracking. |
| Descriptor | String | A user-friendly description of the organization type, providing insights into its category, function, or role within the enterprise. |
| Href | String | A direct URL linking to the organization type instance in Workday, allowing users to navigate to detailed classification information. |
Provides detailed information on a specific pay group, including attributes such as pay frequency, country, and associated payroll policies.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the pay group details instance is used to reference and retrieve specific records. |
| CurrentPeriodInProgress_Descriptor | String | A human-readable description of the payroll period that is currently being processed. This provides insight into the ongoing payroll cycle. |
| CurrentPeriodInProgress_Href | String | A URL link directing to the detailed information page for the payroll period currently in progress. This allows users to navigate to the full record. |
| CurrentPeriodInProgress_Id | String | The unique identifier (for example, Workday ID (WID), reference ID, or other ID) for the payroll period that is currently in progress. |
| Descriptor | String | A brief, user-friendly summary or preview of the pay group details instance for easier identification. |
| FirstProcessingPeriod_Descriptor | String | A description of the first payroll period that was processed within this pay group. This helps in tracking payroll history. |
| FirstProcessingPeriod_Href | String | A URL link directing to the record of the first payroll period processed within this pay group. This provides fast access to historical payroll details. |
| FirstProcessingPeriod_Id | String | The unique identifier (for example, WID, reference ID, or other ID) for the first payroll period that was processed in this pay group. |
| LastPeriodCompleted_Descriptor | String | A description of the most recent payroll period that has been fully completed. This helps in understanding the payroll processing timeline. |
| LastPeriodCompleted_Href | String | A URL link directing to the completed payroll period's details, providing access to finalized payroll information. |
| LastPeriodCompleted_Id | String | The unique identifier (for example, WID, reference ID, or other ID) for the last payroll period that has been successfully completed. |
| NextPeriodToProcess_Descriptor | String | A description of the upcoming payroll period that is scheduled for processing. This assists in payroll planning and scheduling. |
| NextPeriodToProcess_Href | String | A URL link directing to the details of the next payroll period to be processed, enabling proactive management of payroll cycles. |
| NextPeriodToProcess_Id | String | The unique identifier (for example, WID, reference ID, or other ID) for the next payroll period that is scheduled for processing. |
| PayGroup_Descriptor | String | A user-friendly description of the pay group, providing context about the payroll entity being referenced. |
| PayGroup_Id | String | The unique identifier for the pay group instance. This is used to reference a specific pay group within Workday. |
| PeriodSchedule_Descriptor | String | A description of the period schedule associated with this pay group, outlining the pay cycle structure. |
| PeriodSchedule_Href | String | A URL link directing to the details of the period schedule, allowing users to access full schedule configurations. |
| PeriodSchedule_Id | String | The unique identifier (for example, WID, reference ID, or other ID) for the period schedule related to this pay group. |
| RunCategory_Descriptor | String | A description of the payroll run category associated with this pay group, indicating the classification of payroll runs. |
| RunCategory_Href | String | A URL link directing to the payroll run category details, enabling users to access relevant payroll processing configurations. |
| RunCategory_Id | String | The unique identifier (for example, WID, reference ID, or other ID) for the payroll run category linked to this pay group. |
| RunCategories_Prompt | String | One or more WIDs specify the run categories for the pay group, such as runCategories=category1 and runCategories=category2. |
Links the pay group details with pay run group data, ensuring accurate processing of payroll across defined pay cycles.
| Name | Type | Description |
| Id [KEY] | String | The unique ID for the pay group details instance within Workday, ensuring that every entry can be distinctly referenced and accessed. |
| PayGroupDetails_Id [KEY] | String | The Workday ID (WID) of the pay group details record that this entry belongs to. This ID links the pay run group to its associated pay group details. |
| Descriptor | String | A brief preview or summary of this pay run group instance, typically used for display purposes in the UI. |
| RunCategories_Prompt | String | Specify one or more WIDs connected to the run categories for this pay group. Multiple run category parameters can be used (for example, runCategories=category1 and runCategories=category2). |
Stores and retrieves structured data related to payroll groups, including identification, eligibility rules, and payment processing settings.
| Name | Type | Description |
| Id [KEY] | String | The unique ID for the pay group instance, used to reference this specific record within the system. |
| Country_Descriptor | String | A human-readable description of the country or territory associated with this pay group, providing additional context about its location. |
| Country_Href | String | A direct link to the pay group instance within Workday, enabling quick access to related details via the Workday API. |
| Country_Id | String | A reference ID for the country or territory associated with the pay group, which can be represented as a Workday ID (WID), an internal system ID, or another reference key. |
| Descriptor | String | A brief textual summary of the pay group instance, often used for display or selection purposes in Workday. |
| Country_Prompt | String | The WID associated with the country or territory of the pay group, used for filtering or querying relevant data. |
Establishes relationships between pay groups and their respective pay group details, enabling efficient organization and retrieval of payroll group data.
| Name | Type | Description |
| Id [KEY] | String | A Unique ID for this specific instance of the pay group details record, used for tracking and reference purposes. |
| PayGroups_Id [KEY] | String | The Workday ID (WID) generated for the pay groups entity is essential for linking related pay group data. |
| Descriptor | String | A textual representation providing a brief yet informative summary of this pay group details record, aiding in quick identification. |
| RunCategory_Descriptor | String | A descriptive label providing additional context about the run category associated with this pay group, distinguishing between different payroll run categories. |
| RunCategory_Href | String | A URL link pointing to the specific Workday instance of the run category. This can be used for navigation or API-based retrieval of more details. |
| RunCategory_Id | String | A unique ID (for example, WID, ID, or reference ID) assigned to the run category, used to associate the correct run category with the pay group. |
| Country_Prompt | String | The generated WID for the country or territory associated with this pay group. This value can be used to filter or retrieve relevant payroll data based on geographic location. |
Aggregates and organizes pay component values for payroll input groups, ensuring accurate payroll calculations based on earnings, bonuses, and deductions.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the payroll input group pay component value. This can be a Workday ID (WID), an external ID, or a reference ID, used for system integration. |
| Descriptor | String | A human-readable description of the payroll input group pay component value, providing context about its purpose or relevance. |
| CollectionToken | String | The system-generated token used to retrieve members of a collection when working with hierarchical payroll data. |
| Collection_Prompt | String | A reference to a collection token value that allows retrieval of all child elements in a collection. This is useful for navigating hierarchical payroll data structures. |
| EndDate_Prompt | Date | Specifies the last effective date for the payroll input group pay component value in the format YYYY-MM-DD. This determines when the pay component is no longer applicable. |
| PayComponent_Prompt | String | Identifies the pay component associated with this payroll input group. This can refer to elements such as bonuses, base pay, or deductions. |
| StartDate_Prompt | Date | Defines the first effective date for the payroll input group pay component value in the format YYYY-MM-DD. This determines when the pay component becomes applicable. |
| Worker_Prompt | String | The WID of the worker associated with this payroll input, linking the payroll component to a specific employee. |
Maintains position-related payroll inputs, providing insight into pay details associated with specific job roles within an organization.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the payroll input group position value. This can be a Workday ID (WID), a reference ID, or another system-generated ID. |
| Descriptor | String | A textual representation providing a human-readable summary of the payroll input group position value. This helps users understand what the record represents without relying solely on the ID. |
| CollectionToken | String | A system-generated token used for retrieving hierarchical collections of data. When present, used with the collection prompt input to fetch all associated members of a collection. |
| Collection_Prompt | String | A reference to a CollectionToken value. By providing this input, users can retrieve all child records associated with the specified collection, ensuring hierarchical data retrieval in structured queries. |
| EndDate_Prompt | Date | The date indicating when the specified position ends. This is formatted as YYYY-MM-DD and is essential for defining the validity period of the payroll input. Any positions beyond this date are considered inactive. |
| PayComponent_Prompt | String | The specific pay component associated with the payroll input group. This could refer to different elements such as bonuses, allowances, or base salary components. |
| StartDate_Prompt | Date | The date indicating when the specified position becomes active. This is formatted as YYYY-MM-DD and determines when payroll inputs start applying to the associated worker. |
| Worker_Prompt | String | The unique WID of the worker to whom the payroll input applies. This ID links the payroll data to an individual worker record. |
Defines and categorizes payroll input groups based on run categories, allowing flexible payroll processing configurations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the payroll input group run category value. This can be a Workday ID (WID), reference ID, or another system-generated ID. |
| Descriptor | String | A human-readable description of the payroll input group run category value, providing context for the specific instance. |
| CollectionToken | String | A system-generated token used to group related payroll input values, used with the Collection_Prompt input to retrieve all associated members. |
| Collection_Prompt | String | A reference to a CollectionToken value, allowing retrieval of all related payroll input values in the specified collection. |
| EndDate_Prompt | Date | The final date in the date range for payroll input applicability. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | The pay component associated with this payroll input group run category value. |
| StartDate_Prompt | Date | The first date for which this payroll input group run category value applies. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | The WID associated with this payroll input group run category can be retrieved using the GET /workers endpoint in the Staffing service. |
Manages worktag-based payroll input groups, facilitating tracking and allocation of payroll costs to specific projects, grants, or departments.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the record, which can be a Workday ID (WID), reference ID, or another system-generated ID. |
| Descriptor | String | A human-readable description of the record, providing context about the instance it represents. |
| CollectionToken | String | A system-generated token that identifies a collection of related records. This value can be used with the Collection_Prompt input to retrieve associated members of the collection. |
| Collection_Prompt | String | A value obtained from the CollectionToken column. When provided as input, it retrieves all related child records within the collection. |
| EndDate_Prompt | Date | Specifies the last date of the relevant position or worktag assignment. The date must be in the format YYYY-MM-DD. |
| PayComponent_Prompt | String | Represents the specific pay component associated with the worktags, such as salary, bonus, or allowance. |
| StartDate_Prompt | Date | Specifies the first date of the relevant position or worktag assignment. The date must be in the format YYYY-MM-DD. |
| Worker_Prompt | String | The WID of the worker associated with this record. This value can be retrieved from GET /workers in the Staffing service. |
Represents individual employee or worker records within the Workday system, capturing essential personal and employment-related details.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier assigned to each person within the system, used to track and reference their record. |
| AdditionalNames | String | A list of any additional names associated with a person, including middle names, nicknames, or alternate spellings. |
| AudioNamePronunciation | String | A media file containing the audio pronunciation of the person’s name, which can be used for correct name articulation. |
| HomeAddresses | String | A collection of home addresses associated with the person, including primary and secondary residences. |
| HomeEmails | String | A list of personal email addresses provided by the person for communication outside of work. |
| HomeInstantMessengers | String | A list of instant messaging accounts that the person has registered for personal use, such as Skype, WhatsApp, or other messaging platforms. |
| HomePhones | String | A set of personal phone numbers associated with the person, including mobile and landline numbers. |
| HomeWebAddresses | String | A collection of personal websites or web-based profiles maintained by the person, such as blogs or portfolio pages. |
| Href | String | A hyperlink reference to the person’s record, providing direct access to their details in the system. |
| LegalName | String | The legally recognized full name of the person, as documented in official records such as passports or government IDs. |
| PersonalInformation | String | A collection of general personal details about the individual, including demographic and identity-related attributes. |
| Photos | String | A stored image or profile picture of the person, which can be used for identification in the system. |
| PreferredName | String | The name the person prefers to be addressed by, which can differ from their legal name and can include shortened names or aliases. |
| SocialNetworks | String | A collection of social media accounts linked to the person, such as LinkedIn, Twitter, or Facebook profiles. |
| UniversalID_Id | String | A globally unique identifier assigned to the person, used to ensure uniqueness across systems. |
| WorkAddresses | String | A collection of business addresses associated with the person, including office locations or remote work addresses. |
| WorkEmails | String | A list of company-provided email addresses assigned to the person for professional communication. |
| WorkInstantMessengers | String | A set of work-related instant messaging accounts, such as internal chat tools or enterprise communication platforms. |
| WorkPhones | String | A list of work-related phone numbers assigned to the person, including office desk phones and business mobile numbers. |
| WorkWebAddresses | String | A collection of work-related web addresses linked to the person, such as intranet profiles or company pages. |
| Universal_ID_Prompt | String | The unique Universal ID of the person being retrieved, used to query specific records. |
Stores alternate names or aliases associated with a person, ensuring accurate name recognition for internal records and compliance purposes.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this record instance within the system. |
| People_Id [KEY] | String | The assigned Workday ID (WID) for the individual associated with this name record. |
| Country_Descriptor | String | A textual representation of the country associated with this name record, often used for display purposes. |
| Country_Id | String | A unique identifier assigned to the country associated with this name record. |
| Descriptor | String | A human-readable summary or display name for the current record, commonly used for user interfaces. |
| First | String | The person's given name, often used as the primary name for addressing the individual. |
| FirstLocal | String | The given name of the person in the local script, applicable in countries where non-Latin scripts are commonly used. |
| FirstLocal2 | String | The given name of the person in a secondary local script, applicable in multilingual regions using multiple writing systems. |
| Full | String | The complete name of the individual as officially recorded, used in regions where a full name format is standard. |
| Hereditary_Descriptor | String | A textual representation of hereditary titles or names associated with family lineage, where applicable. |
| Middle | String | The person's middle name, often used to distinguish individuals with similar given and family names. |
| MiddleLocal | String | The middle name of the person in local script, applicable where non-Latin scripts are in use. |
| Primary | String | The person's primary family name or surname, which is typically inherited and used for identification. |
| PrimaryLocal | String | The person's family name in local script, used in regions where names are written differently in native languages. |
| PrimaryLocal2 | String | The person's family name in a secondary local script, applicable in regions with multiple language conventions. |
| Salutation_Descriptor | String | A textual label representing the salutation or honorific title associated with the individual, such as Mr., Mrs., or Dr. |
| SecondaryLast | String | An additional family name for the person, often used in cultures where multiple surnames are standard. |
| SecondaryLocal | String | The person's secondary family name in local script, applicable where names are recorded in non-Latin alphabets. |
| Social_Descriptor | String | A label or descriptor related to the individual's social identity, title, or commonly recognized name. |
| TertiaryLast | String | A third family name associated with the person, used in naming conventions where multiple surnames are common. |
| Title_Descriptor | String | A label representing the individual's professional, academic, or social title, such as Professor or Sir. |
| Universal_ID_Prompt | String | A universal identifier used to retrieve the specific individual’s record in the system. |
Contains audio recordings of name pronunciations, supporting accessibility and correct name articulation in workplace interactions.
| Name | Type | Description |
| People_Id | String | The unique identifier assigned to a person in Workday, used to track individuals across the system. |
| DownloadAudio | String | A direct link to download the audio file associated with the person's name pronunciation. |
| Filename | String | The name of the audio file that contains the recorded pronunciation of the person's name. |
| MediaId | String | A unique identifier assigned to the stored media file. This is used to reference the audio file within the system. |
| PersonId | String | A secondary identifier associated with the person. This can be used in conjunction with other identifiers for lookup purposes. |
| CurrentAudio_Prompt | Bool | A flag indicating whether to retrieve only the most recent and currently active pronunciation audio file. |
| Universal_ID_Prompt | String | The universal identifier of the individual whose name pronunciation audio is being retrieved. This ID is used across various systems for identification. |
Maintains residential address details for individuals, facilitating accurate communication and legal documentation.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this address entry within the system. |
| People_Id [KEY] | String | The unique Workday ID (WID) associated with the person who owns this address. |
| AddressLine1 | String | The primary street address line for the person's home address, typically includes house number and street name. |
| AddressLine1Local | String | The primary street address line in the local language or format of the address location. |
| AddressLine2 | String | An additional street address line used for apartment, suite, or other secondary address information. |
| AddressLine2Local | String | An additional street address line formatted for local language or address conventions. |
| AddressLine3 | String | A third line for extended address details, such as building name or internal mail routing. |
| AddressLine3Local | String | A third address line formatted according to local address conventions. |
| AddressLine4 | String | A fourth address line for further address specifications, if necessary. |
| AddressLine4Local | String | A fourth address line adapted to local address formatting and language preferences. |
| AddressLine5 | String | An optional fifth line for extended address details beyond standard fields. |
| AddressLine5Local | String | An optional fifth address line formatted for local language or address standards. |
| AddressLine6 | String | An optional sixth line to capture additional address-related details. |
| AddressLine6Local | String | A localized version of the sixth address line, adhering to regional formatting. |
| AddressLine7 | String | An optional seventh address line for further refinement of location details. |
| AddressLine7Local | String | A localized version of the seventh address line, following regional conventions. |
| AddressLine8 | String | An optional eighth address line to accommodate highly detailed address structures. |
| AddressLine8Local | String | A localized version of the eighth address line, formatted for regional usage. |
| AddressLine9 | String | An optional ninth address line for additional address information beyond standard fields. |
| AddressLine9Local | String | A localized version of the ninth address line for region-specific formatting. |
| City | String | The name of the city where the person's home address is located. |
| CityLocal | String | The city name in the local language or formatted according to regional address conventions. |
| CitySubdivision1 | String | The first subdivision of the city, such as a district or neighborhood, providing more granular location details. |
| CitySubdivision1Local | String | The first city subdivision formatted in the local language or regional conventions. |
| CitySubdivision2 | String | The second subdivision of the city, typically a smaller unit such as a ward or precinct. |
| CitySubdivision2Local | String | The second city subdivision formatted in the local language or according to regional address standards. |
| CountryCity_Descriptor | String | A textual representation of the country and city associated with the address, providing an overview of the location. |
| CountryCity_Id | String | A unique identifier for the country-city combination used within Workday. |
| CountryRegion_Descriptor | String | A description of the country and region where the address is located, offering additional geographic context. |
| CountryRegion_Id | String | A unique identifier for the country-region combination within Workday. |
| Country_Descriptor | String | A descriptive name of the country where the address is located. |
| Country_Id | String | A unique WID associated with the country of the address. |
| Effective | Datetime | The date when the address becomes valid or officially takes effect. |
| FullFormattedAddress | String | A fully formatted version of the home address, including all relevant address fields in a standardized format. |
| FullFormattedLocalAddress | String | A fully formatted version of the home address adapted to the local language and address conventions. |
| PostalCode | String | The postal code or ZIP code associated with the address, used for mail delivery and location identification. |
| RegionSubdivision1 | String | The first level of regional subdivision, such as a state, province, or territory. |
| RegionSubdivision1Local | String | The first regional subdivision formatted in the local language or according to regional standards. |
| RegionSubdivision2 | String | The second level of regional subdivision, such as a county, municipality, or district. |
| Usage_Primary | Bool | Indicates whether this address is designated as the primary residence for the person. A value of 'true' means this is the primary home address. |
| Usage_Public | Bool | Indicates whether this address is publicly accessible. If this value is 'false' or missing, the address is private and not shared publicly. |
| Usage_UsageType_Descriptor | String | A description of how this address is used, such as mailing, billing, or shipping purposes. |
| Usage_UsageType_Id | String | A unique WID for the usage type associated with the address. |
| Effective_Prompt | Date | Specifies the effective date for retrieving the person’s addresses. The date must be in the format YYYY-MM-DD. |
| PrimaryOnly_Prompt | Bool | If this value is 'true,' only the primary home address for the person is returned. |
| PublicOnly_Prompt | Bool | If this value is 'true,' only publicly accessible addresses for the person are returned. |
| UsedFor_Prompt | String | Defines the purpose of the address, such as mailing, billing, or shipping, to filter the retrieved addresses. |
| Universal_ID_Prompt | String | The universal identifier of the person whose address information is being retrieved. |
Tracks usage and purpose classifications for home addresses, defining contexts in which the stored address information is utilized.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this instance of a home address usage record. |
| PeopleHomeAddresses_Id [KEY] | String | The system-generated Workday ID (WID) for the home address record associated with a person. |
| People_Id [KEY] | String | The system-generated WID for the person to whom this home address usage record belongs. |
| Descriptor | String | A brief summary or label representing this home address usage instance, typically used for display purposes. |
| Effective_Prompt | Date | The date when this home address usage takes effect. The date must be in the format YYYY-MM-DD. |
| PrimaryOnly_Prompt | Bool | If this value is 'true,' it retrieves only the person's primary home address IDs, excluding secondary addresses. |
| PublicOnly_Prompt | Bool | If this value is 'true,' it retrieves only the person's public home address IDs, excluding private addresses. |
| UsedFor_Prompt | String | Indicates how the home address is used, such as mailing, billing, or shipping purposes. |
| Universal_ID_Prompt | String | A globally unique identifier for the person whose home address usage information is being retrieved. |
Stores and retrieves personal email addresses for employees and workers, ensuring effective communication outside of work-related channels.
| Name | Type | Description |
| Id [KEY] | String | The system-generated unique identifier that distinguishes this specific email record from others in the database, used as a primary key to reference and track individual email entries. |
| People_Id [KEY] | String | A unique Workday ID (WID) linking this email record to a specific individual in the system. This ensures each email address is associated with the correct person. |
| EmailAddress | String | The complete email address of the person, which is used for communication and notifications. This field must follow standard email formatting conventions, such as a username, '@' symbol, and domain. |
| EmailComment | String | Additional notes or comments related to this email address, such as its purpose or any relevant details. |
| Usage_Primary | Bool | Indicates whether this email address is designated as the primary contact method for the person. Returns 'true' if it is primary. |
| Usage_Public | Bool | Specifies if this email address is publicly accessible. If the value is 'false' or no results are returned, the email address is private and not shared publicly. |
| Usage_UsageType_Descriptor | String | A brief descriptor providing an overview of the usage type for this email address, such as work, personal, or other categories. |
| Usage_UsageType_Id | String | The unique identifier corresponding to the usage type of this email address, linking it to a predefined usage classification. |
| PrimaryOnly_Prompt | Bool | When this value is 'true,' the query returns only the primary email addresses associated with a person, filtering out secondary addresses. |
| PublicOnly_Prompt | Bool | When this value is 'true,' the query retrieves only email addresses that are marked as public, excluding private ones. |
| UsedFor_Prompt | String | Defines how this email address is used, specifying purposes such as mailing, billing, or shipping communications. |
| Universal_ID_Prompt | String | The Universal ID associated with the person whose email addresses need to be retrieved, providing a unique reference across different systems. |
Defines the usage classification for home email addresses, ensuring clarity on when and how these emails are referenced.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this specific usage instance within the people home emails usage table. |
| PeopleHomeEmails_Id [KEY] | String | The unique Workday ID (WID) for the people home emails record to which this usage entry belongs. |
| People_Id [KEY] | String | The unique Workday ID (WID) for the person associated with this email usage entry. |
| Descriptor | String | A brief textual representation of this usage instance, often used for display or quick reference purposes. |
| PrimaryOnly_Prompt | Bool | When the value is 'true,' it filters results to include only email addresses designated as primary for the associated person. |
| PublicOnly_Prompt | Bool | When the value is 'true,' it filters results to include only email addresses marked as public and available for external visibility. |
| UsedFor_Prompt | String | Indicates the intended purpose of the email address, such as mailing, billing, or shipping communications. |
| Universal_ID_Prompt | String | A globally unique identifier used to retrieve the person's email usage data across different Workday instances. |
Captures personal instant messaging account details, supporting flexible communication options beyond traditional email and phone.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instant messenger record, ensuring each entry is distinct within the system. |
| People_Id [KEY] | String | The unique Workday ID (WID) for the person to whom this instant messenger account belongs. |
| Comment | String | Additional information or notes related to this instant messenger account, which can include details on usage, restrictions, or other relevant metadata. |
| Type_Descriptor | String | A textual representation that provides a human-readable summary of the instant messenger type or category. |
| Usage_Primary | Bool | Indicates whether this instant messenger account is designated as the primary method of communication for the person. A value of 'true' means it is the primary account. |
| Usage_Public | Bool | Indicates whether the instant messenger account is publicly visible. If this value is 'true,' the account is accessible to others, whereas if 'false' or absent, the account remains private. |
| Usage_UsageType_Descriptor | String | A human-readable representation describing the specific purpose or category of use for this instant messenger account. |
| Usage_UsageType_Id | String | A unique identifier assigned to the specific usage type of the instant messenger account, linking it to a predefined category of usage. |
| UserName | String | The username associated with this instant messenger account, which is required for identification and communication through the messaging platform. |
| PrimaryOnly_Prompt | Bool | If this value is 'true,' the query will return only the IDs of instant messenger accounts marked as the primary communication method for each person. |
| PublicOnly_Prompt | Bool | If this value is 'true,' the query will return only the IDs of instant messenger accounts that have been marked as publicly accessible. |
| UsedFor_Prompt | String | Defines the specific purpose of the instant messenger account, such as internal messaging, external communication, or other predefined usage types. |
| Universal_ID_Prompt | String | The globally unique identifier of the individual for whom instant messenger details are being retrieved, ensuring consistency across systems. |
Establishes usage classifications for personal instant messenger accounts, ensuring clarity in work and non-work communication policies.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for each instance of an instant messenger usage record. This value is system-generated and immutable. |
| PeopleHomeInstantMessengers_Id [KEY] | String | The unique Workday ID (WID) linking this record to a specific PeopleHomeInstantMessengers entry, which represents a person's registered instant messaging accounts. |
| People_Id [KEY] | String | The unique Workday identifier for the individual associated with this instant messenger usage record. This establishes the relationship between the person and their recorded instant messaging accounts. |
| Descriptor | String | A concise summary or human-readable preview of the instant messenger usage record, useful for quick reference in user interfaces. |
| PrimaryOnly_Prompt | Bool | A boolean flag that, when 'true,' filters the results to include only primary instant messenger account usernames associated with the individual. If the value is 'false,' all associated usernames are included. |
| PublicOnly_Prompt | Bool | A boolean flag that, when 'true,' filters the results to include only publicly visible instant messenger usernames. If the value is 'false,' both public and private usernames are included. |
| UsedFor_Prompt | String | Indicates the specific purpose for which this instant messenger is used, such as communication, authentication, notifications, or other business-related functions. |
| Universal_ID_Prompt | String | A globally unique identifier used to retrieve a specific person's instant messenger usage details, ensuring consistency across Workday systems. |
Maintains personal contact numbers for individuals, ensuring up-to-date records for emergency contacts and personal outreach.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this specific phone record instance within Workday. |
| People_Id [KEY] | String | The unique Workday ID (WID) for the person who owns this phone record. |
| CompletePhoneNumber | String | The full phone number, including country code, area code, and local number, formatted as a single string. |
| CountryPhoneCode_CountryPhoneCode | String | The numeric dialing code assigned to a country, used as a prefix for international dialing. |
| CountryPhoneCode_CountryPhoneCodeID | String | Reference id of the instance |
| CountryPhoneCode_Country_Descriptor | String | A human-readable label providing a preview or brief description of the associated country for the phone code. |
| CountryPhoneCode_Country_Id | String | The unique identifier representing the country associated with the phone code in Workday. |
| CountryPhoneCode_Descriptor | String | A user-friendly description of the country phone code, typically used for display purposes. |
| CountryPhoneCode_Id | String | A unique system-generated identifier assigned to the country phone code entry. |
| Descriptor | String | A general preview or description of the phone record, often used in UI elements or summary displays. |
| DeviceType_Descriptor | String | A brief label or description of the type of device associated with this phone number, such as Mobile, Work, or Home. |
| DeviceType_Id | String | A unique identifier for the type of device linked to this phone number. |
| Extension | String | An additional numeric extension assigned to a phone number, often used in office environments to route calls within an organization. |
| Usage_Primary | Bool | Indicates whether this phone number is designated as the primary contact number for the person. A value of 'true' means it is the primary number. |
| Usage_Public | Bool | Indicates whether this phone number is publicly visible. A value of 'true' means the number is publicly accessible, while 'false' means it is private. |
| Usage_UsageType_Descriptor | String | A user-friendly description of how this phone number is used, such as 'Work Contact' or 'Emergency Contact.' |
| Usage_UsageType_Id | String | A unique identifier for the specific usage type associated with this phone number. |
| PrimaryOnly_Prompt | Bool | If the value is 'true', only the primary phone numbers associated with a person will be returned in the query results. |
| PublicOnly_Prompt | Bool | If the value is 'true', only publicly accessible phone numbers associated with a person will be included in the query results. |
| UsedFor_Prompt | String | Defines the intended purpose of this phone number, such as for mailing, billing, or shipping notifications. |
| Universal_ID_Prompt | String | The globally unique Universal ID used to retrieve specific phone number records for a person within Workday. |
Defines the intended usage of personal phone numbers, specifying contexts where they are referenced or required.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this specific instance of home phone usage data. |
| PeopleHomePhones_Id [KEY] | String | The system-generated Workday ID (WID) for the associated home phone record of a person. |
| People_Id [KEY] | String | The system-generated WID for the person to whom this home phone record belongs. |
| Descriptor | String | A brief textual representation of this instance, typically providing key identifying details. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' the query will return only the person's primary home phone numbers, excluding any secondary or alternate numbers. |
| PublicOnly_Prompt | Bool | If the value is 'true,' the query will return only the person's publicly available home phone numbers, filtering out any private or restricted numbers. |
| UsedFor_Prompt | String | Indicates the specific purpose for which this home phone number is used, such as mailing, billing, or shipping communications. |
| Universal_ID_Prompt | String | A globally unique identifier used to retrieve a specific person's home phone usage data across Workday systems. |
Stores personal website URLs associated with an individual, allowing records of professional or social web presence.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this web address entry within the system. |
| People_Id [KEY] | String | The unique Workday ID (WID) for the person to whom this web address belongs. |
| Comment | String | An optional note or remark associated with the web address, providing additional context or clarification. |
| Url | String | The full web address (URL) associated with the person, including protocol (for example, http:// or https://). |
| Usage_Primary | Bool | Indicates whether this web address is designated as the primary contact method for the person. A value of 'true' means it is the main web address. |
| Usage_Public | Bool | Indicates whether this web address is publicly visible. A value of 'true' means the address can be accessed by external users, while 'false' means it is private. |
| Usage_UsageType_Descriptor | String | A descriptive label providing context for how this web address is used, such as 'Personal Website' or 'Company Portal'. |
| Usage_UsageType_Id | String | A unique identifier representing the specific usage type assigned to this web address. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' the query returns only the primary web addresses for each person, filtering out secondary addresses. |
| PublicOnly_Prompt | Bool | If the value is 'true,' the query returns only public web addresses, excluding those marked as private. |
| UsedFor_Prompt | String | Specifies the intended function of the web address, such as 'Business Communication', 'Billing', or 'Personal Contact'. |
| Universal_ID_Prompt | String | The globally unique identifier is associated with the person for whom web address details are being retrieved. |
Categorizes the usage of stored home web addresses, defining their relevance within the organization.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this specific instance within the dataset. This ID helps track individual records and ensures data integrity. |
| PeopleHomeWebAddresses_Id [KEY] | String | The unique Workday ID (WID) associated with the PeopleHomeWebAddresses table. This links the current entry to a specific web address record under PeopleHomeWebAddresses. |
| People_Id [KEY] | String | The unique WID associated with a person in the system. This establishes a connection between this record and the individual it pertains to. |
| Descriptor | String | A brief textual representation or summary of the instance, often used for display or selection purposes to provide context for users. |
| PrimaryOnly_Prompt | Bool | Indicates whether only the primary web addresses associated with the person should be returned. If the value is 'true,' non-primary addresses are excluded. |
| PublicOnly_Prompt | Bool | Indicates whether only publicly visible web addresses should be retrieved. If the value is 'true,' private or internal addresses are excluded from the results. |
| UsedFor_Prompt | String | Defines the intended purpose of the web address, such as for mailing, billing, or shipping purposes. Multiple usage types can be supported based on the system configuration. |
| Universal_ID_Prompt | String | The universal identifier of the person whose web address information is being queried. This identifier is unique across different systems within Workday. |
Captures official legal name records, ensuring compliance with regulatory and identification requirements.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the instance within Workday. This value is used internally to track records. |
| People_Id [KEY] | String | The unique Workday ID (WID) associated with the individual to whom this record belongs. |
| Country_Descriptor | String | A human-readable label or name representing the country associated with this record. |
| Country_Id | String | A unique identifier for the country associated with this person's legal name. This value is used for system reference. |
| Descriptor | String | A textual representation that provides a summary or preview of the instance for easier identification. |
| First | String | The given name or first name of the individual as recorded in Workday. This is typically the person's primary first name. |
| FirstLocal | String | The given name of the person in their native or local script, where applicable. Workday tracks local names only for countries where non-Latin scripts are commonly used. |
| FirstLocal2 | String | A secondary representation of the person's given name in another local script, applicable for countries with multiple non-Latin script variations. |
| Full | String | The complete legal name of the individual as it is recorded in Workday, where applicable. Some countries use a single field for full names instead of separate components. |
| Hereditary_Descriptor | String | A descriptor indicating hereditary or familial titles associated with the individual, such as generational suffixes. |
| Middle | String | The middle name or additional given name of the individual, if applicable. This can be omitted if not provided. |
| MiddleLocal | String | The middle name of the individual as recorded in their native or local script, applicable in regions using non-Latin scripts. |
| Primary | String | The primary surname or last name of the individual, as used in official records and identification. |
| PrimaryLocal | String | The primary surname of the person in their native or local script, where applicable. Workday tracks local names only for countries where non-Latin scripts are commonly used. |
| PrimaryLocal2 | String | A secondary representation of the individual's primary surname in another local script, applicable for multilingual regions. |
| Salutation_Descriptor | String | A descriptor that captures honorifics, formal titles, or preferred salutations associated with the individual, such as 'Dr.' or 'Mr.'. |
| SecondaryLast | String | An additional surname or secondary family name, if applicable, used in cultures where multiple family names are standard. |
| SecondaryLocal | String | The secondary family name of the person in their native or local script, applicable where non-Latin scripts are commonly used. |
| Social_Descriptor | String | A descriptor capturing informal or commonly used social identifiers, such as nicknames or social titles. |
| TertiaryLast | String | A tertiary surname or additional last name used in cultures where multiple family names are common. |
| Title_Descriptor | String | A descriptor indicating professional, academic, or honorific titles, such as 'Professor' or 'Sir'. |
| Universal_ID_Prompt | String | The globally unique identifier used to retrieve the individual's record within Workday, ensuring accurate identity management. |
Stores various personal attributes of an individual, such as birthdate, gender, marital status, and nationality, for Human Resources (HR) and compliance purposes.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
citizen: Boolean /* Identifies Citizenship Status as citizen. */
country: { /* Country for the Citizenship Status. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
description: Text /* Description for the Citizenship Status. */
descriptor: Text /* A preview of the instance */
inactive: Boolean /* True if the Citizenship Status is inactive. */
name: Text /* Name for the Citizenship Status. */
}]
[{
accommodationProvided: Text /* The Accommodations Provided for a \~Disability\~ status. */
accommodationRequested: Text /* The Accommodations Requested for a \~Disability\~ status. */
certificationBasis: { /* The Certification Basis for a \~Disability\~ status. */
descriptor: Text /* A preview of the instance */
}
certificationID: Text /* The Certification ID for a \~Disability\~ status. */
certifiedAt: Text /* The Certification Location for a \~Disability\~ status. */
certifiedBy: Text /* The \~Disability\~ Authority for a \~Disability\~ Status */
degreePercent: Numeric /* The Degree for a \~Disability\~ status. */
descriptor: Text /* A preview of the instance */
disability: { /* The \~Disability\~ for a \~Disability\~ Status. */
descriptor: Text /* A preview of the instance */
}
endDate: Date /* The End Date for a \~Disability\~ status. */
fteTowardQuota: Numeric /* The FTE Toward Quota for a \~Disability\~ status. */
grade: { /* The Grade for a \~Disability\~ status. */
descriptor: Text /* A preview of the instance */
}
knownDate: Date /* The Date Known for a \~Disability\~ status. */
note: Text /* The Note for a \~Disability\~ status. */
rehabilitationProvided: Text /* The Rehabilitation Provided for a \~Disability\~ status. */
rehabilitationRequested: Text /* The Rehabilitation Requested for a \~Disability\~ status. */
remainingCapacity: Numeric /* The Remaining Capacity for a \~Disability\~ status. */
severityRecognitionDate: Date /* The Severity Recognition Date for a \~Disability\~ status. */
statusDate: Date /* The \~Disability\~ Status Date for a \~Disability\~ Status. */
statusID: Text /* The reference id for the \~disability\~ status. This is the unique identifier for the \~disability\~ status that is assigned at creation and then maintained throughout its life as it is edited. */
workRestrictions: Text /* The Work Restrictions for a \~Disability\~ status. */
workerDocuments: [{
comment: Text /* The additional comments associated with the Worker Document. */
fileName: Text /* The filename of the Worker Document. */
}]
}]
[{
descriptor: Text /* A preview of the instance */
location: { /* The country or country region for an Ethnicity. */
descriptor: Text /* A preview of the instance */
}
}]
[{
descriptor: Text /* A preview of the instance */
location: { /* The country or country region for an Ethnicity. */
descriptor: Text /* A preview of the instance */
}
}]
[{
begin: Date /* The Military Status Begin Date for the Military Service. */
descriptor: Text /* A preview of the instance */
discharge: Date /* The Discharge Date for the Military Service. */
militaryDischargeTypeReference: { /* The Military Service.has Military Discharge Type reference. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
militaryServiceReference: { /* The reference id for the military service entry. This is the unique identifier for the military service that is assigned at creation and then maintained throughout its life as it is edited. */
descriptor: Text /* A preview of the instance */
}
notes: Rich Text /* Notes associated with the Military Service. */
rank: { /* The Military Rank for the Military Service. */
descriptor: Text /* A preview of the instance */
}
status: { /* The \~Military Status\~ for the Military Service. */
code: Text /* The \~military status\~ code. */
country: { /* The country for the Military Status. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
description: Text /* The military status description. */
descriptor: Text /* A preview of the instance */
}
type: { /* Military Service Type for Military Service */
descriptor: Text /* A preview of the instance */
}
}]
[{
academicSuffix: { /* The academic suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
country: { /* The country from the relative name. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
descriptor: Text /* A preview of the instance */
firstName: Text /* The first or given name for a relative name. */
fullName: Text /* The Full Name for a relative name, where provided. Workday only tracks Full Name for countries where the Full Name name component is used. */
hereditarySuffix: { /* The hereditary suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
honorarySuffix: { /* The honorary suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
lastName: Text /* The family name for a relative name. */
localPersonName: { /* The Local Person Name instance for a relative name. */
descriptor: Text /* A preview of the instance */
first: Text /* The person's given name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
first2: Text /* The person's given name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
last: Text /* The person's last name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
last2: Text /* The person's last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
middle: Text /* The person's middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
middle2: Text /* The person's second middle name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
secondaryLast: Text /* The person's secondary family name in local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
secondaryLast2: Text /* The person's secondary last name in second local script. Workday only tracks local names for countries where a non-Latin script is commonly used. */
}
middleName: Text /* The middle name for a relative name. */
professionalSuffix: { /* The professional suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
relativeType: { /* The relative type for a relative name. */
descriptor: Text /* A preview of the instance */
}
religiousSuffix: { /* The religious suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
royalSuffix: { /* The royal suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
salutationSuffix: { /* The salutation from a relative name. */
descriptor: Text /* A preview of the instance */
}
secondaryLastName: Text /* The secondary family name for a relative name */
socialSuffix: { /* The social suffix for a relative name. */
descriptor: Text /* A preview of the instance */
}
title: { /* The prefix for a relative name. */
descriptor: Text /* A preview of the instance */
}
}]
[{
descriptor: Text /* A preview of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
inactive: Boolean /* The Inactive flag. */
militaryServicePreferenceCode: Text /* Military Service Preference Code */
militaryServicePreferenceDescription: Text /* Military Service Preference Description */
militaryServicePreferenceName: Text /* \~Veteran's Preference\~ Category */
}]
| Name | Type | Description |
| People_Id | String | The unique Workday ID (WID) assigned to a person, which links their personal records across the system. |
| AboriginalIndigenousIdentificationDetails_Aggregate | String | Provides detailed information about a person's self-identified aboriginal or indigenous status, including any supporting documentation or classifications. |
| AboriginalIndigenousIdentification_Descriptor | String | A textual representation or label for the person's aboriginal or indigenous identification details. |
| ActiveMilitaryUniformedService_Descriptor | String | A description or label indicating a person's active service in a military or uniformed service. |
| ActiveMilitaryUniformedService_Id | String | The unique identifier representing a specific military or uniformed service status in Workday. |
| AdditionalNationalities_Aggregate | String | A list of additional nationalities that a person holds, beyond their primary nationality. This can include dual or multiple citizenships. |
| BloodType_Descriptor | String | A textual representation of a person's blood type, typically used for medical records and emergency situations. |
| CitizenshipStatuses_Aggregate | String | Details regarding a person’s citizenship status, including residency and naturalization information. |
| DateOfBirth | Datetime | The official recorded birth date of the person, used for identification and age-based calculations. |
| DateOfDeath | Datetime | The official recorded date of death for a person, if applicable, used for records management and compliance tracking. |
| DisabilityStatuses_Aggregate | String | A collection of disability status records associated with a person, including official classifications and accommodations. |
| DisabledVeteranLeaveDate | Datetime | The effective date from which a veteran's disability-related leave or benefits take effect. |
| EthnicitiesForVisualSurvey_Ethnicities_Aggregate | String | A list of ethnicities a person has self-reported in a visual survey, used for demographic analysis and reporting. |
| EthnicitiesForVisualSurvey_HispanicOrLatinoForVisualSurvey | Bool | Indicates whether the person has self-identified as Hispanic or Latino for a visual survey. Returns 'true' if applicable. |
| Ethnicities_Aggregate | String | A list of ethnicities self-reported by a person, often used for compliance and demographic reporting. |
| Gender_Descriptor | String | A descriptive label indicating a person’s gender as recorded in the system. |
| HispanicOrLatino | Bool | Indicates whether the person has self-identified as Hispanic or Latino. Returns 'true' if applicable. |
| MaritalStatus_Date | Datetime | The date when a person’s marital status was last updated, reflecting significant life changes such as marriage or divorce. |
| MaritalStatus_Status_Descriptor | String | A descriptive label indicating the current marital status of a person, such as 'Single' or 'Married'. |
| MaritalStatus_Status_Location_Descriptor | String | A textual representation of the jurisdiction or location where the person's marital status was recorded or recognized. |
| MedicalExam_ExpirationDate | Datetime | The expiration date of the most recent medical examination, often relevant for employment or health compliance. |
| MedicalExam_LastExamDate | Datetime | The date on which the person's most recent medical examination was conducted. |
| MedicalExam_Notes | String | Additional notes and observations recorded during a person's medical examination. |
| MilitaryServices_Aggregate | String | A collection of military service records associated with a person, including service periods, branches, and statuses. |
| PlaceOfBirth_City | String | The name of the city where the person was born, as recorded in official documentation. |
| PlaceOfBirth_Country_Descriptor | String | A textual representation of the country where the person was born. |
| PlaceOfBirth_Country_Id | String | A unique identifier assigned to the country where the person was born. |
| PlaceOfBirth_Region_Descriptor | String | A textual representation of the region, state, or province where the person was born. |
| PlaceOfBirth_Region_Id | String | A unique identifier assigned to the region, state, or province where the person was born. |
| PoliticalAffiliation_Descriptor | String | A descriptive label representing the person’s political affiliation, if recorded. |
| PrimaryNationality_Descriptor | String | A textual representation of the primary nationality held by the person. |
| PrimaryNationality_Id | String | A unique identifier assigned to the person's primary nationality. |
| RelativeNames_Aggregate | String | A list of names of a person’s relatives, as recorded in the system for reference or contact purposes. |
| Religion_Aggregate | String | A collection of religious affiliations or beliefs that the person has recorded, if applicable. |
| SelectiveServiceRegistration_Descriptor | String | A textual representation of a person’s Selective Service registration status, relevant for military conscription or eligibility. |
| SelectiveServiceRegistration_Id | String | A unique identifier assigned to the person's Selective Service registration record. |
| SexualOrientationAndGenderIdentity_Aggregate | String | A collection of records detailing a person's self-reported sexual orientation and gender identity. |
| SocialBenefitsLocality_Code | String | The official code representing the locality where a person is eligible for social benefits. |
| SocialBenefitsLocality_Description | String | A detailed description of the locality where a person’s social benefits are applicable. |
| SocialBenefitsLocality_Descriptor | String | A textual representation of the social benefits locality associated with a person. |
| SocialBenefitsLocality_Inactive | Bool | Indicates whether the social benefits locality is currently inactive. Returns 'true' if the locality is no longer valid. |
| SocialBenefitsLocality_Location_Descriptor | String | A textual representation of the location associated with the person's social benefits locality. |
| SocialBenefitsLocality_Name | String | The name of the locality where a person’s social benefits apply. |
| UniformServiceReserveStatus_Descriptor | String | A textual representation of a person's reserve status in a uniformed service. |
| UniformServiceReserveStatus_Id | String | A unique identifier assigned to the person’s uniformed service reserve status record. |
| UniformServiceReserveStatus_Inactive | Bool | Indicates whether the person’s uniformed service reserve status is inactive. Returns 'true' if inactive. |
| UniformServiceReserveStatus_UniformServiceReserveStatusCode | String | The official code representing a specific uniformed service reserve status. |
| UniformServiceReserveStatus_UniformServiceReserveStatusDescription | String | A detailed description of the uniformed service reserve status assigned to a person. |
| UniformServiceReserveStatus_UniformServiceReserveStatusName | String | The official name of the uniformed service reserve status assigned to a person. |
| VeteransPreferenceForRIF_Descriptor | String | A textual representation of a person's veterans' preference for Reduction in Force (RIF) situations. |
| VeteransPreferenceForRIF_Id | String | A unique identifier assigned to the veteran's preference for RIF status. |
| VeteransPreference_Aggregate | String | A collection of records detailing a person’s veteran's preference status, including eligibility for hiring preferences. |
| Country_Prompt | String | Specifies the country for which personal information should be retrieved. If left blank, the most recently updated personal information set will be used. |
| Universal_ID_Prompt | String | The unique Universal ID associated with the person whose personal information is being requested. |
Manages employee profile pictures and identification images, supporting security, recognition, and workplace directories.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this photo entry, representing a specific instance of an image record in the Workday system. |
| People_Id [KEY] | String | The assigned unique Workday ID (WID) for the person associated with this photo, ensuring proper linkage between individuals and their image records. |
| ContentType_Descriptor | String | A textual representation of the type of image or media stored, providing human-readable context for classification. |
| ContentType_Href | String | A URL reference pointing to the specific content type definition, allowing for programmatic access to metadata about the image format. |
| ContentType_Id | String | A unique identifier (such as WID or reference ID) used to reference the image’s content type within the system. |
| FileLength | Decimal | The total size of the image file in bytes, used to determine storage and transmission requirements. |
| FileName | String | The original name of the uploaded image file, which can include file extensions and provide context about the image content. |
| Height | Decimal | The vertical dimension of the cropped image, measured in pixels, ensuring correct rendering in system interfaces. |
| Href | String | A direct URL or system-generated reference that provides access to this specific image instance for retrieval or display. |
| Width | Decimal | The horizontal dimension of the cropped image, measured in pixels, ensuring consistency with display requirements. |
| Universal_ID_Prompt | String | A prompt or reference field allowing users to input a universally unique identifier for retrieving a specific person’s photo within the Workday system. |
Stores the person's preferred name, which can differ from their legal name, ensuring inclusivity and personalization in workplace interactions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this specific record within the system. |
| People_Id [KEY] | String | The assigned unique Workday ID (WID) for the person associated with this record. |
| Country_Descriptor | String | A textual representation of the country associated with this name record, typically used for display purposes. |
| Country_Id | String | The unique identifier for the country associated with this name record. |
| Descriptor | String | A descriptive text field providing a summary or preview of this specific name record. |
| First | String | The person's given name, which is typically used as their first name in most naming conventions. |
| FirstLocal | String | The given name of the person in their native script. Workday tracks local names only for countries where a non-Latin script is commonly used. |
| FirstLocal2 | String | An additional local script version of the given name, applicable when a second local name script is required for a country. |
| Full | String | The full legal or preferred name of the person, as applicable in certain countries where full names are formally used. |
| Hereditary_Descriptor | String | A descriptor related to hereditary titles or inherited naming elements, if applicable. |
| Middle | String | The person's middle name, often used as an additional identifier between the first and last names. |
| MiddleLocal | String | The middle name in the native script of the person. Workday tracks local names only in regions where non-Latin scripts are used. |
| Primary | String | The person's primary family name, commonly referred to as the last name or surname in most naming conventions. |
| PrimaryLocal | String | The primary family name in the local script of the person. Workday tracks local names only in regions where non-Latin scripts are used. |
| PrimaryLocal2 | String | An additional local script version of the primary family name, applicable when a second local name script is required for a country. |
| Salutation_Descriptor | String | A descriptor for a formal salutation or honorific, such as 'Mr.', 'Ms.', or 'Dr.'. |
| SecondaryLast | String | An additional family name or surname used in cultures where multiple last names are common. |
| SecondaryLocal | String | The secondary family name in the local script of the person. Workday tracks local names only in regions where non-Latin scripts are used. |
| Social_Descriptor | String | A descriptor related to social titles or designations, such as professional or cultural identifiers. |
| TertiaryLast | String | A third last name component, applicable in cultures where three family names can be used. |
| Title_Descriptor | String | A descriptor for a formal title, such as 'Sir', 'Dame', or other honorifics associated with the person. |
| Universal_ID_Prompt | String | A globally unique identifier for the person being queried, used to retrieve their name record. |
Tracks publicly accessible contact details for employees or workers, supporting professional networking and corporate directories.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
addressLine1: Text /* Address Line 1 for the address. */
addressLine1Local: Text /* Local Address Line 1 for the address. */
addressLine2: Text /* Address Line 2 for the address. */
addressLine2Local: Text /* Local Address Line 2 for the address. */
addressLine3: Text /* Address Line 3 for the address. */
addressLine3Local: Text /* Local Address Line 3 for the address. */
addressLine4: Text /* Address Line 4 for the address. */
addressLine4Local: Text /* Local Address Line 4 for the address. */
addressLine5: Text /* Address Line 5 for the address. */
addressLine5Local: Text /* Local Address Line 5 for the address. */
addressLine6: Text /* Address Line 6 for the address. */
addressLine6Local: Text /* Local Address Line 6 for the address. */
addressLine7: Text /* Address Line 7 for the address. */
addressLine7Local: Text /* Local Address Line 7 for the address. */
addressLine8: Text /* Address Line 8 for the address. */
addressLine8Local: Text /* Local Address Line 8 for the address. */
addressLine9: Text /* Address Line 9 for the address. */
addressLine9Local: Text /* Local Address Line 9 for the address. */
city: Text /* City for the address. */
cityLocal: Text /* City - Local for the address. */
citySubdivision1: Text /* City Subdivision 1 for the address. */
citySubdivision1Local: Text /* City Subdivision 1 - Local for the address. */
citySubdivision2: Text /* City Subdivision 2 for the address. */
citySubdivision2Local: Text /* City Subdivision 2 - Local for the address. */
country: { /* Country for the address. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
countryCity: { /* Country city for the address. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
countryRegion: { /* Country region for the address. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
-effective: Date /* The Effective Date for the address. */
fullFormattedAddress: Text /* Full Formatted Address */
fullFormattedLocalAddress: Text /* Full Formatted Local Address */
id: Text /* Id of the instance */
postalCode: Text /* The postal code for the address. */
regionSubdivision1: Text /* Region Subdivision 1 for the address. */
regionSubdivision1Local: Text /* Region Subdivision 1 - Local for the address. */
regionSubdivision2: Text /* Region Subdivision 2 for the address. */
usage: { /* The address. */
primary: Boolean /* True if the communication method has any primary usage type. */
public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
usageType: { /* The usage type for the communication method, such as home or work. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
usedFor: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}
}]
[{
emailAddress: Text /* The email address. */
emailComment: Text /* Comment associated with the email. */
id: Text /* Id of the instance */
usage: { /* The current email. */
primary: Boolean /* True if the communication method has any primary usage type. */
public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
usageType: { /* The usage type for the communication method, such as home or work. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
usedFor: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}
}]
[{
comment: Text /* The comment associated with the instant messenger account. */
id: Text /* Id of the instance */
type: { /* The instant messenger account type. */
descriptor: Text /* A preview of the instance */
}
usage: { /* The instant messenger account. */
primary: Boolean /* True if the communication method has any primary usage type. */
public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
usageType: { /* The usage type for the communication method, such as home or work. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
usedFor: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}
userName: Text /* The instant messenger account username. */
}]
[{
completePhoneNumber: Text /* The complete phone number. */
countryPhoneCode: { /* The country phone code for the phone number. */
Country_Phone_Code_ID: Text /* Reference id of the instance */
country: { /* The country name for a country phone code. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
countryPhoneCode: Text /* The phone code for a country. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
descriptor: Text /* A preview of the instance */
deviceType: { /* The phone device type. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
extension: Text /* The phone extension. */
id: Text /* Id of the instance */
usage: { /* The current phone for the reference. */
primary: Boolean /* True if the communication method has any primary usage type. */
public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
usageType: { /* The usage type for the communication method, such as home or work. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
usedFor: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}
}]
[{
comment: Text /* The comment associated with the web address. */
id: Text /* Id of the instance */
url: Text /* The complete URL address for the web address. */
usage: { /* The web address. */
primary: Boolean /* True if the communication method has any primary usage type. */
public: Boolean /* True if the communication method is public. If no results are returned, the communication method is private. */
usageType: { /* The usage type for the communication method, such as home or work. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
usedFor: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}
}]
| Name | Type | Description |
| People_Id | String | The unique identifier assigned to an individual in Workday. This ID is used internally to track and manage personal records across various modules. |
| Addresses_Aggregate | String | A collection of all publicly available addresses associated with the person. This can include home, work, or additional contact addresses depending on the configured visibility settings. |
| Emails_Aggregate | String | A compiled list of all publicly visible email addresses linked to the individual. These email addresses can include work, personal, or other designated contact points. |
| InstantMessengers_Aggregate | String | A grouped set of instant messaging accounts that are publicly available for contacting the person. This could include platforms such as Skype, Slack, or Microsoft Teams. |
| PhoneNumbers_Aggregate | String | An aggregated set of publicly listed phone numbers for the individual. These can include mobile, work, or other designated contact numbers depending on accessibility settings. |
| WebAddresses_Aggregate | String | A collection of public web addresses associated with the individual. This could include personal websites, social media profiles, or other professional web links. |
| Universal_ID_Prompt | String | A universal identifier used to retrieve a person’s public contact information across different Workday environments. This ensures consistent referencing of records regardless of system variations. |
Captures and retrieves work location details for employees, supporting accurate office assignments and logistical planning.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this address record, used to distinguish it from other address entries. |
| People_Id [KEY] | String | The unique Workday ID (WID) for the person associated with this address. This links the address to an individual in the system. |
| AddressLine1 | String | The primary street address or building number for the location, typically the first line of a mailing address. |
| AddressLine1Local | String | The primary street address in a local or native language format, used in regions with different address structures. |
| AddressLine2 | String | Additional address information such as apartment number, suite, or floor designation. |
| AddressLine2Local | String | Additional address details in a local language format, ensuring proper address recognition in regional contexts. |
| AddressLine3 | String | Further address details, often used for complex addresses or extended location specifications. |
| AddressLine3Local | String | Extended address details in the native language format for regional use. |
| AddressLine4 | String | A supplementary field for address details, sometimes used for rural or specialized location information. |
| AddressLine4Local | String | Additional address information in a localized format for country-specific address conventions. |
| AddressLine5 | String | An optional line for additional address segmentation, typically used in large organizations or complex locations. |
| AddressLine5Local | String | Localized version of Address Line 5, ensuring accurate representation in the native language. |
| AddressLine6 | String | Extra space for specific address needs, often left blank unless required. |
| AddressLine6Local | String | Localized equivalent of Address Line 6 for regions with different address structures. |
| AddressLine7 | String | Additional optional line for highly detailed address configurations. |
| AddressLine7Local | String | Localized version of Address Line 7, used where regional address formats necessitate more fields. |
| AddressLine8 | String | Further extension of address information when needed for clarity. |
| AddressLine8Local | String | Native language version of Address Line 8 for better regional compatibility. |
| AddressLine9 | String | Last optional address field for special cases requiring detailed location information. |
| AddressLine9Local | String | Localized equivalent of Address Line 9, providing full address comprehension in native formatting. |
| City | String | The city in which the address is located, used for geographical identification. |
| CityLocal | String | The local language representation of the city name, ensuring consistency with regional address standards. |
| CitySubdivision1 | String | The first subdivision of the city, such as a district or borough, providing more precise location details. |
| CitySubdivision1Local | String | The localized name of the first city subdivision, ensuring alignment with regional naming conventions. |
| CitySubdivision2 | String | A secondary city subdivision, often used for further regional classification such as a neighborhood or sector. |
| CitySubdivision2Local | String | The native language equivalent of the secondary city subdivision for accurate local referencing. |
| CountryCity_Descriptor | String | A human-readable summary or preview of the associated city and country combination. |
| CountryCity_Id | String | A system-generated unique identifier for the specific country and city combination. |
| CountryRegion_Descriptor | String | A text-based preview of the country and its associated region, used for easy identification. |
| CountryRegion_Id | String | A unique identifier representing the country and its region in the system. |
| Country_Descriptor | String | A descriptive label for the country, making it easier to recognize in reports or selections. |
| Country_Id | String | A unique system-generated identifier for the country associated with the address. |
| Effective | Datetime | The date on which this address record takes effect, determining its validity in the system. |
| FullFormattedAddress | String | A fully formatted version of the address, combining all relevant fields into a structured layout suitable for display or mailing. |
| FullFormattedLocalAddress | String | The complete formatted address in the local language or region-specific format for accuracy in regional mailing. |
| PostalCode | String | The postal or ZIP code associated with this address, used for mail delivery and location identification. |
| RegionSubdivision1 | String | The primary administrative subdivision of a country, such as a state, province, or territory. |
| RegionSubdivision1Local | String | The localized name of the primary region subdivision, reflecting regional naming conventions. |
| RegionSubdivision2 | String | A secondary administrative subdivision, such as a county, district, or prefecture. |
| Usage_Primary | Bool | Indicates whether this address serves as the person's primary address. If true, this is the main address on record. |
| Usage_Public | Bool | Indicates whether this address is publicly visible. If the value is 'false,' the address is considered private. |
| Usage_UsageType_Descriptor | String | A preview or summary of the specific usage type associated with this address, such as 'Home' or 'Work'. |
| Usage_UsageType_Id | String | A unique system identifier for the specific usage type assigned to this address. |
| Effective_Prompt | Date | The effective date for the person's addresses, formatted as yyyy-mm-dd, used to determine which address records are valid at a given time. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' it only returns addresses designated as primary for the person. |
| PublicOnly_Prompt | Bool | If the value is 'true,' it only returns addresses marked as public, filtering out private addresses. |
| UsedFor_Prompt | String | Defines the intended usage of the address, such as for mailing, billing, or shipping purposes. |
| Universal_ID_Prompt | String | The universal unique identifier for the person whose addresses are being retrieved, ensuring correct association. |
Classifies the intended usage of work addresses, defining their function within HR and organizational processes.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this specific record within the PeopleWorkAddressesUsageUsedFor table. |
| PeopleWorkAddresses_Id [KEY] | String | The unique Workday ID (WID) for the associated PeopleWorkAddresses entry, linking this record to a specific address instance. |
| People_Id [KEY] | String | The unique WID for the individual associated with this address usage, establishing the relationship between a person and their recorded address usage. |
| Descriptor | String | A textual summary providing a brief, human-readable representation of this address usage instance. |
| Effective_Prompt | Date | The date when the specified address usage takes effect, formatted as yyyy-mm-dd, determining when the address is considered valid for its intended purpose. |
| PrimaryOnly_Prompt | Bool | Indicates whether only primary addresses should be returned. If the value is 'true,' it filters out all non-primary addresses and returns only the designated primary address instances. |
| PublicOnly_Prompt | Bool | Indicates whether only publicly available addresses should be returned. If the value is 'true,' it excludes private addresses and returns only those marked as public. |
| UsedFor_Prompt | String | Defines the purpose of the address within the system, such as mailing, billing, or shipping, ensuring correct categorization and usage in workflows. |
| Universal_ID_Prompt | String | The globally unique identifier for the person whose address usage information is being retrieved, facilitating cross-system consistency. |
Stores professional email addresses assigned to employees, ensuring secure and official work-related communication.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the email record within the Workday system. |
| People_Id [KEY] | String | The unique Workday ID associated with the person to whom this email address belongs. |
| EmailAddress | String | The complete email address associated with the individual, used for communication within Workday. |
| EmailComment | String | An optional comment or note providing additional context about this email address, such as its intended purpose or related details. |
| Usage_Primary | Bool | Indicates whether this email address is designated as the primary contact method for the individual. A value of 'true' means it is the primary email. |
| Usage_Public | Bool | Indicates whether this email address is publicly visible. If the value is 'true,' the email address is accessible to others, if the value is 'false,' it is considered private. |
| Usage_UsageType_Descriptor | String | A textual representation of the usage type associated with this email, such as 'Work', 'Personal', or 'Billing'. |
| Usage_UsageType_Id | String | A unique identifier for the specific usage type assigned to this email address. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' only the primary email addresses for individuals are included in the results. |
| PublicOnly_Prompt | Bool | If the value is 'true,' only email addresses marked as public are included in the results. |
| UsedFor_Prompt | String | Defines the intended use case for the email address, such as 'Mailing', 'Billing', or 'Shipping'. |
| Universal_ID_Prompt | String | The globally unique identifier used to retrieve specific individuals and their associated email addresses. |
Defines usage contexts for work email addresses, distinguishing them from personal or external email use cases.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this specific usage entry within the PeopleWorkEmails table. |
| PeopleWorkEmails_Id [KEY] | String | The unique Workday ID (WID) for the associated PeopleWorkEmails entry, linking this record to a specific email address. |
| People_Id [KEY] | String | The unique WID for the person associated with this email usage entry, establishing ownership of the email record. |
| Descriptor | String | A textual preview or summary of this email usage instance, typically used for display or reference purposes. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' this query filters results to include only the person's primary email addresses, ensuring secondary or alternative emails are excluded. |
| PublicOnly_Prompt | Bool | If the value is 'true,' this query filters results to include only the person's publicly visible email addresses, excluding private or internal emails. |
| UsedFor_Prompt | String | Defines the intended purpose of this email address within Workday, such as mailing, billing, shipping, or other organizational functions. |
| Universal_ID_Prompt | String | A globally unique identifier assigned to a person, enabling retrieval of their email usage details across Workday’s system. |
Manages work-related instant messaging account details, enabling internal communication through designated corporate messaging platforms.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the instant messenger entry, used to distinguish it from other records in the system. |
| People_Id [KEY] | String | The unique Workday identifier assigned to the person associated with this instant messenger account. |
| Comment | String | A free-text field allowing users to add additional notes or context about the instant messenger account. |
| Type_Descriptor | String | A textual representation that provides a descriptive label for this instant messenger account type. |
| Usage_Primary | Bool | Indicates whether this instant messenger account is designated as the primary method of communication for the person. |
| Usage_Public | Bool | Indicates whether this instant messenger account is publicly visible. If the value is 'false,' the account remains private and not disclosed to others. |
| Usage_UsageType_Descriptor | String | A descriptive label that categorizes the specific purpose or function of this instant messenger account. |
| Usage_UsageType_Id | String | A unique identifier associated with the specific usage type assigned to this instant messenger account. |
| UserName | String | The username or handle used for logging into the instant messenger platform. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' it filters the results to include only the primary instant messenger account associated with the person. |
| PublicOnly_Prompt | Bool | If the value is 'true,' it filters the results to include only publicly visible instant messenger accounts for the person. |
| UsedFor_Prompt | String | Defines the intended purpose of this instant messenger account, such as internal messaging, customer communication, or external collaboration. |
| Universal_ID_Prompt | String | A globally unique identifier that can be used to retrieve details about the person associated with this instant messenger account. |
Retrieves information about how work-related instant messenger accounts are utilized within the organization, providing context on their specific usage and communication purposes.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instant messenger usage record within the Workday system. |
| PeopleWorkInstantMessengers_Id [KEY] | String | The unique Workday ID (WID) of the instant messenger entry that this usage record belongs to. |
| People_Id [KEY] | String | The unique WID of the individual associated with this instant messenger usage record. |
| Descriptor | String | A short descriptive summary of this instant messenger usage entry, often used for display purposes. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' the dataset will only include the instant messenger usernames that have been designated as the person's primary contact method. |
| PublicOnly_Prompt | Bool | If the value is 'true,' only instant messenger usernames marked as publicly visible will be included in the dataset. |
| UsedFor_Prompt | String | Indicates the purpose for which this instant messenger is used, such as general communication, customer support, internal messaging, or external business contacts. |
| Universal_ID_Prompt | String | A globally unique identifier used to retrieve specific individuals, ensuring consistency across multiple Workday environments or integrations. |
Stores and retrieves work phone numbers associated with employees, enabling contact tracking and communication within the system.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this phone record instance within Workday. |
| People_Id [KEY] | String | The unique Workday ID (WID) associated with the person who owns this phone number. |
| CompletePhoneNumber | String | The full phone number, including the country code, area code, and local number, formatted as a single string. |
| CountryPhoneCode_CountryPhoneCode | String | The international dialing code assigned to the country where the phone number is registered. |
| CountryPhoneCode_CountryPhoneCodeID | String | Reference id of the instance |
| CountryPhoneCode_Country_Descriptor | String | A textual representation or preview of the country associated with the phone code, providing more context for the country of origin. |
| CountryPhoneCode_Country_Id | String | A unique identifier assigned to the country corresponding to the phone code, used for internal reference within Workday. |
| CountryPhoneCode_Descriptor | String | A preview or textual representation of the country phone code, providing additional context for easier identification. |
| CountryPhoneCode_Id | String | A unique identifier assigned to the country phone code, used for internal system reference. |
| Descriptor | String | A human-readable description or summary of this phone number instance within the Workday system. |
| DeviceType_Descriptor | String | A description or preview of the type of device associated with this phone number, such as mobile, landline, or VoIP. |
| DeviceType_Id | String | A unique identifier assigned to the type of device that this phone number is linked to, used internally within Workday. |
| Extension | String | The phone number extension, typically used in corporate or multi-line phone systems to route calls to a specific department or individual. |
| Usage_Primary | Bool | Indicates whether this phone number is marked as the primary contact method for the person. A value of 'true' means it is the primary number. |
| Usage_Public | Bool | Indicates whether this phone number is publicly accessible. A value of 'true' means it is visible to others, while 'false' means it is private. If no result is returned, the number is considered private by default. |
| Usage_UsageType_Descriptor | String | A preview or description of how this phone number is used, such as for business, personal, or emergency purposes. |
| Usage_UsageType_Id | String | A unique identifier for the specific usage type assigned to this phone number, used internally for categorization. |
| PrimaryOnly_Prompt | Bool | If the value is 'true,' it only retrieves phone numbers that are marked as primary for the person. |
| PublicOnly_Prompt | Bool | If the value is 'true,' it only retrieves phone numbers that are designated as public. Private phone numbers will not be included. |
| UsedFor_Prompt | String | Specifies the intended usage of this phone number, such as mailing, billing, or shipping purposes, to refine search results. |
| Universal_ID_Prompt | String | The Universal ID associated with the person whose phone number data is being retrieved, ensuring cross-system consistency. |
Extracts details on how work phone numbers are utilized within the organization, offering insights into their assigned purposes and communication workflows.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this specific record in the PeopleWorkPhonesUsageUsedFor table. This value helps distinguish each instance within the dataset. |
| PeopleWorkPhones_Id [KEY] | String | The unique Workday ID (WID) for the PeopleWorkPhones entity that this record is associated with. |
| People_Id [KEY] | String | The unique WID for the person to whom this work phone usage record belongs. |
| Descriptor | String | A human-readable label that describes the purpose or function of this specific phone usage instance within the Workday system. |
| PrimaryOnly_Prompt | Bool | Indicates whether only primary phone numbers should be retrieved. If the value is 'true,' only primary phone numbers will be returned. |
| PublicOnly_Prompt | Bool | Indicates whether only publicly visible phone numbers should be retrieved. If the value is 'true,' only phone numbers designated as public will be included. |
| UsedFor_Prompt | String | Defines the specific purpose of the phone number, such as mailing, billing, or shipping, to categorize its intended function. |
| Universal_ID_Prompt | String | The globally unique identifier used to retrieve a specific person's phone usage information across systems. |
Maintains and retrieves work-related web addresses linked to employees, such as corporate websites or personal work profiles, for streamlined access to online resources.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the web address entry, used as the primary key for reference within the Workday system. |
| People_Id [KEY] | String | The unique identifier assigned to an individual in Workday, used to track and reference a person across all Workday modules within the system. |
| Comment | String | A user-provided comment or annotation associated with the web address, typically used for additional context or clarification. |
| Url | String | The full web address (URL) associated with this entry, including the protocol (for example, https://), domain, and any specific path. |
| Usage_Primary | Bool | Indicates whether this web address is designated as the person's primary method of online communication. A value of 'true' means it is the primary address. |
| Usage_Public | Bool | Indicates whether the web address is publicly accessible. A value of 'true' means it is publicly available; if no results are returned, the communication method is private. |
| Usage_UsageType_Descriptor | String | A textual description providing insight into the category or role of this web address, such as 'Personal Website' or 'Company Portal'. |
| Usage_UsageType_Id | String | A unique identifier representing the specific usage type category for this web address within the Workday system. |
| PrimaryOnly_Prompt | Bool | If the value is 'true', only web addresses designated as primary will be returned in query results. |
| PublicOnly_Prompt | Bool | If the value is 'true', only web addresses marked as public will be included in query results. |
| UsedFor_Prompt | String | Specifies the intended function of the web address, such as for mailing, billing, or other designated purposes. |
| Universal_ID_Prompt | String | The universal identifier assigned to a person, used to retrieve web addresses specific to that individual. |
Identifies and retrieves data on the designated use cases of work-related web addresses, ensuring proper classification of online resources.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the specific instance of this record within the Workday system. |
| PeopleWorkWebAddresses_Id [KEY] | String | The unique Workday ID (WID) for the PeopleWorkWebAddresses record associated with this entry, linking web addresses to people-related records. |
| People_Id [KEY] | String | The unique WID for the individual to whom this web address usage record belongs, establishing ownership and association with a person. |
| Descriptor | String | A textual representation that provides a preview of this specific record instance, useful for search and display purposes. |
| PrimaryOnly_Prompt | Bool | Indicates whether only the primary web addresses associated with a person should be retrieved. If set the value is 'true,' only primary web addresses are included in the results. |
| PublicOnly_Prompt | Bool | Indicates whether only public web addresses should be retrieved. If the value is 'true,' only publicly accessible web addresses will be returned. |
| UsedFor_Prompt | String | Defines the intended usage of the web address, such as mailing, billing, shipping, or other predefined categories relevant to Workday processes. |
| Universal_ID_Prompt | String | A globally unique identifier for the individual whose web address data is being queried, allowing for cross-system data retrieval and integration. |
Retrieves the list of countries that are permitted for use in personal information records, ensuring compliance with organizational and regulatory policies.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the record, which can be a Workday ID (WID), a reference ID, or another system-generated ID. It is used to distinguish each instance within the dataset. |
| Descriptor | String | A human-readable label or summary that provides additional context about the specific instance. This can include key attributes or distinguishing characteristics. |
| CollectionToken | String | A token that represents a specific collection of related values, which is required when using the collection prompt input to retrieve the full list of values within the collection. |
| Collection_Prompt | String | An input value derived from the collection token column, which is useful for retrieving hierarchical or grouped data. |
| Person_Prompt | String |
Fetches the list of countries currently represented in the system based on existing personal information records, supporting analytics and reporting needs.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (WID, ID, or reference ID) assigned to this record, used for referencing the specific entry in Workday. |
| Descriptor | String | A human-readable description that provides context about the specific instance, making it easier to identify and interpret. |
| CollectionToken | String | A token used to retrieve all members of a collection when paired with the Collection_Prompt input. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Supplying this value allows retrieval of all child elements associated with the collection. |
| Person_Prompt | String | A placeholder for specifying a person-related identifier or input when querying data. The exact purpose depends on the context of the query. |
Holds records of educational programs offered within the organization or institution, allowing retrieval of program details based on unique ID.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the Program of Study instance, used to distinguish individual records within the system. |
| AcademicLevel_Descriptor | String | A textual representation of the academic level associated with this program of study, providing a human-readable preview. |
| AcademicLevel_Id | String | The unique identifier for the academic level associated with this program of study, linking it to its corresponding classification. |
| AcademicUnit_Id | String | The unique identifier for the academic unit overseeing this program of study, establishing its organizational hierarchy. |
| AcademicUnit_Inactive | Bool | Indicates whether the academic unit is currently inactive. If true, the academic unit is not operational as of the specified effective date. |
| AcademicUnit_Institution | Bool | Indicates whether the academic unit is classified as an institution. If true, it represents an accredited institution as of the effective date. |
| AcademicUnit_Name | String | The official name of the academic unit responsible for this program of study, reflecting its designation as of the effective date. |
| CipCode_Descriptor | String | A detailed description of the Classification of Instructional Programs (CIP) code associated with this program of study, specifying its academic discipline. |
| CipCode_Href | String | A direct link to additional information about the CIP code, which provides further details regarding its classification and relevance. |
| CipCode_Id | String | The unique identifier for the CIP code, which can include Workday ID (WID), reference ID, or external identification for cross-referencing. |
| Name | String | The official title of the Program of Study, reflecting its designation within the institution as of the effective date. |
| ProgramType_Descriptor | String | A textual description of the program type associated with this program of study, offering a general classification. |
| ProgramType_Href | String | A direct link to additional details about the program type, which provides further context on its categorization. |
| ProgramType_Id | String | The unique identifier for the program type, which can include WID, reference ID, or external ID for tracking. |
| AcademicLevel_Prompt | String | The WID corresponding to the academic level that owns the program of study, as of the effective date. This ID can be retrieved from the GET /academicLevels API. |
| AcademicUnit_Prompt | String | The WID corresponding to the academic unit that owns the program of study, as of the effective date. This ID can be retrieved from the GET /academicUnits API. |
| CipCode_Prompt | String | The WID representing the CIP code associated with the program of study, as of the effective date. This ID provides standardized classification for the program. |
| EducationalCredentials_Prompt | String | The WIDs representing the educational credentials that can be attained through this program of study, as of the effective date. |
| EffectiveDate_Prompt | Date | The date when the Program of Study becomes effective, formatted as YYYY-MM-DD. The default value is the current date. |
| ProgramType_Prompt | String | The WID representing the program type for this program of study, as of the effective date, enabling categorization within the system. |
Links educational credentials with programs of study, enabling retrieval of relevant degrees, certifications, or qualifications associated with each program.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this specific instance of an educational credential record. |
| ProgramsOfStudy_Id [KEY] | String | The unique Workday ID (WID) for the associated program of study to which this credential belongs. |
| Description | String | A detailed textual explanation of the specific educational credential being represented, including its relevance and scope. |
| Descriptor | String | A brief summary or preview providing a quick reference to the educational credential instance. |
| Name | String | The full official name of the educational credential, representing a specific degree, diploma, or certification awarded upon completion of a program of study. |
| Type_Descriptor | String | A human-readable description of the type of educational credential, offering contextual information on its classification. |
| Type_Href | String | A direct hyperlink to the Workday reference page for this specific type of educational credential. |
| Type_Id | String | A unique identifier (WID, ID, or reference ID) assigned to this credential type within Workday. |
| AcademicLevel_Prompt | String | The WID representing the academic level associated with this program of study, based on the effective date. This can be retrieved using GET /academicLevels. |
| AcademicUnit_Prompt | String | The WID referencing the academic unit that governs this program of study, as of the effective date. You can retrieve this using GET /academicUnits. |
| CipCode_Prompt | String | The WID assigned to the Classification of Instructional Programs (CIP) code for this program of study, effective as of the specified date. |
| EducationalCredentials_Prompt | String | A list of WIDs associated with the educational credentials linked to this program of study. This can be retrieved using GET /educationalCredentials. |
| EffectiveDate_Prompt | Date | The date when this Program of Study becomes effective, formatted as YYYY-MM-DD. Defaults to the current date if not specified. |
| ProgramType_Prompt | String | The WID representing the type or category of the program of study, based on the effective date. |
Stores predefined values related to different project plan phases, ensuring consistency in project phase classification and reporting.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the project phase, which can be a Workday ID (WID), reference ID, or another system-generated identifier. |
| Descriptor | String | A human-readable label or description that represents the project phase instance, helping users quickly understand its purpose or role. |
| CollectionToken | String | A token that represents a collection of related project phases. Use this value in conjunction with the Collection_Prompt input to retrieve all members of this collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Supplying this input allows users to fetch all child phases or sub-components of a project phase collection. |
| Project_Prompt | String | Identifier or reference for the specific project associated with the phase. Used to filter or locate project phases within a broader project plan. |
| TopLevelPhase_Prompt | Bool | A boolean indicator specifying whether the current project phase is a top-level phase. A value of 'true' means this phase is at the highest level of the hierarchy, while 'false' indicates it is a sub-phase or dependent phase. |
Captures standard values associated with project plan phases, supporting structured project planning and tracking.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier (WID, ID, or reference ID) for the project plan phase value. This is used to track and reference specific instances within Workday. |
| Descriptor | String | A textual representation that provides a human-readable description of the project plan phase value. This helps users identify the instance more easily. |
| CollectionToken | String | A system-generated token used to manage hierarchical collections of project plan phases. This token can be used as an input with the Collection_Prompt field to retrieve all members of a specific collection. |
| Collection_Prompt | String | An input value derived from the CollectionToken column. When provided, it retrieves all child elements associated with the specified collection, enabling hierarchical data retrieval. |
| Project_Prompt | String | An input parameter used to specify a particular project when retrieving relevant project plan phase values. If left blank, results may be broader and not project-specific. |
| TopLevelPhase_Prompt | Bool | A boolean flag indicating whether the project plan phase is a top-level phase. A value of 'true' means it has no parent, while 'false' means it is nested within another phase. |
Maintains predefined task values related to project plans, facilitating consistency in task categorization and workflow automation.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the project plan task. This ID is used as a reference across the Workday system to track and manage specific project tasks. |
| Descriptor | String | A human-readable description of the project plan task. This descriptor provides a summary or label that helps users quickly understand the nature of the task. |
| CollectionToken | String | A unique token used to reference a collection of related project plan tasks. This value can be used in conjunction with the Collection_Prompt input to retrieve all associated members of the collection. |
| Collection_Prompt | String | A reference value derived from the CollectionToken column. Supplying this input fetches all child elements associated with a specific collection. |
| Project_Prompt | String | A reference identifier for the associated project within the Workday system. This value helps in linking tasks to the correct project. |
| TopLevelPhase_Prompt | Bool | A boolean flag indicating whether the current task represents a top-level phase in the project plan. If the value is 'true,' this task is a primary phase; otherwise, it is a subtask or a lower-level component. |
Contains structured data on predefined project task values, improving reporting accuracy and project task standardization.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the project task, which can be referenced using the Workday ID (WID), internal ID, or reference ID. |
| Descriptor | String | A descriptive label for the project task instance, providing meaningful context about its purpose or role within the project. |
| CollectionToken | String | A token that serves as a reference to a collection of related project tasks. Use this value with the Collection_Prompt input to retrieve all associated members. |
| Collection_Prompt | String | A reference value derived from the CollectionToken column. Providing this input retrieves all child tasks associated with a collection, allowing for hierarchical project task retrieval. |
| Project_Prompt | String | A reference input used to specify or filter project-related data within the stored procedure. This helps in identifying the relevant project tasks tied to a particular project instance. |
| TopLevelPhase_Prompt | Bool | A boolean flag indicating whether the current project task represents a top-level phase. If the value is 'true,' it is a high-level phase, whereas if the value is 'false,' it is a sub-phase. |
Stores and retrieves purchase order details, including supplier information, order amounts, and transaction records.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the purchase order instance, used as a primary key reference. |
| BillToContactDetail | String | Full billing contact details associated with the purchase order, including name, address, phone number, and email. |
| BillToContact_Descriptor | String | A human-readable description of the billing contact associated with the purchase order, often including the name or department. |
| BillToContact_Href | String | A hyperlink reference to the detailed Workday record for the billing contact, allowing navigation to additional details. |
| BillToContact_Id | String | Unique identifier for the billing contact within Workday, which could be a Workday ID (WID), reference ID, or other system-generated ID. |
| Buyer_Descriptor | String | A textual description of the buyer associated with the purchase order, typically including the name of the individual or department responsible for the purchase. |
| Buyer_Href | String | A direct hyperlink to the Workday record for the buyer, providing quick access to related details. |
| Buyer_Id | String | Unique system identifier for the buyer, such as a WID or reference ID, used for relational mapping. |
| Company_Descriptor | String | A human-readable description of the company making the purchase, often including the legal entity name. |
| Company_Href | String | A hyperlink reference to the Workday record for the company associated with this purchase order, allowing for further details. |
| Company_Id | String | System-generated identifier for the company entity, which can be a WID or another reference key. |
| CreditCard_Descriptor | String | A description of the credit card, used for the purchase order, typically including the last four digits or cardholder name. |
| CreditCard_Href | String | A hyperlink reference to the Workday record for the credit card information associated with this purchase. |
| CreditCard_Id | String | Unique identifier for the credit card on file within Workday, which can be a WID or reference ID. |
| Currency_Descriptor | String | A human-readable description of the currency, used in this purchase order, such as 'US Dollar' or 'Euro.' |
| Currency_Href | String | A hyperlink reference to the Workday record for the currency, allowing access to exchange rates and additional financial details. |
| Currency_Id | String | System-generated identifier for the currency, which could be a WID or another reference value. |
| Descriptor | String | A brief preview or summary of the purchase order instance, often used for display purposes within the user interface. |
| DocumentDate | Datetime | The date when the purchase order was created. This field allows users to set or update the date to reflect when the order was officially recorded in the system. |
| DueDate | Datetime | The expected date by which the purchase order should be fulfilled. This is typically agreed upon by the buyer and supplier to ensure timely delivery of goods or services. |
| ExcludeFromMassClose | Bool | Indicates whether this purchase order should be excluded from mass close operations. If the value is 'true,' the order will not be automatically closed in bulk processing. |
| FreightAmount_Currency | String | The currency in which the freight charges for the taxable document are recorded. This ensures correct currency conversion and reporting. |
| FreightAmount_Value | Decimal | The total freight charges associated with this purchase order. This includes transportation costs for shipping goods to the designated location. |
| InternalMemo | String | An internal note attached to the purchase order, visible only to company employees. This memo can contain additional details, instructions, or references related to the order. |
| IssueOption_Descriptor | String | A textual representation providing details about the issue option associated with the purchase order, describing its function or selection criteria. |
| IssueOption_Href | String | A URL link pointing to the specific instance of the issue option, allowing users to access further details or perform actions related to the issue. |
| IssueOption_Id | String | A unique identifier (WID, ID, or reference ID), used to track the issue option associated with the purchase order in the system. |
| LineTotalAmount_Currency | String | The currency in which the total extended amount for all line items on the purchase order is denominated. This ensures consistency in financial transactions. |
| LineTotalAmount_Value | Decimal | The total amount for all line items on the purchase order, considering unit price and quantity. This value represents the overall cost before taxes and additional charges. |
| Memo | String | A general-purpose memo field for the purchase order, which can include notes, references, or any additional context provided by the user. |
| OrderFromConnection_Descriptor | String | A textual description of the connection from which the order originates, providing insight into the supplier or source system. |
| OrderFromConnection_Href | String | A URL link to the order's originating connection instance, allowing users to review related details or historical data. |
| OrderFromConnection_Id | String | A unique identifier (WID, ID, or reference ID) for the source connection of the order, enabling system tracking and integration. |
| OtherCharges_Currency | String | The currency in which additional charges applicable to the taxable document are recorded, ensuring clarity in financial calculations. |
| OtherCharges_Value | Decimal | The total amount of other charges applied to the purchase order, such as handling fees, special service charges, or other miscellaneous costs. |
| PaymentTerms_Descriptor | String | A description of the agreed-upon payment terms for the purchase order, such as net payment period or installment conditions. |
| PaymentTerms_Href | String | A URL link providing access to the payment terms instance, detailing conditions and policies for payment. |
| PaymentTerms_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the payment terms associated with this purchase order, enabling precise tracking and compliance. |
| PaymentType_Descriptor | String | A description of the payment type, used for the purchase order, specifying whether the transaction is handled via credit card, bank transfer, check, or another method. |
| PaymentType_Href | String | A URL link pointing to the payment type instance, offering additional details on the selected payment method. |
| PaymentType_Id | String | A unique identifier (WID, ID, or reference ID) representing the specific payment type associated with the purchase order. |
| ShipToAddress_Descriptor | String | A description of the shipping destination for the purchase order, typically including details such as recipient name or location type. |
| ShipToAddress_Href | String | A URL link directing users to the instance of the shipping address, providing further logistical details. |
| ShipToAddress_Id | String | A unique identifier (WID, ID, or reference ID), used to track and reference the shipping address within the system. |
| ShipToContactDetail | String | The full contact details for the designated recipient of the purchase order, including name, phone number, and email. |
| ShipToContact_Descriptor | String | A descriptive label identifying the specific ship-to contact for the purchase order, typically including name or role details. |
| ShipToContact_Href | String | A hyperlink reference to the specific ship-to contact record within the Workday system, allowing easy navigation to detailed contact information. |
| ShipToContact_Id | String | A unique identifier (WID, ID, or reference ID) associated with the ship-to contact, used for system tracking and integration. |
| ShippingInstructions | String | Instructions provided for shipping the purchase order, which can include preferred carriers, special handling requirements, or delivery timeframes. |
| ShippingMethod_Descriptor | String | A description of the shipping method selected for the purchase order, such as 'Standard Ground' or 'Express Air'. |
| ShippingMethod_Href | String | A hyperlink reference to the shipping method record in the system, allowing direct access to additional shipping details. |
| ShippingMethod_Id | String | A unique identifier (WID, ID, or reference ID) representing the selected shipping method in the Workday system. |
| ShippingTerms_Descriptor | String | A textual description of the shipping terms associated with the purchase order, such as 'FOB Destination' or 'Prepaid and Add'. |
| ShippingTerms_Href | String | A hyperlink reference directing users to the shipping terms documentation or system record for further details. |
| ShippingTerms_Id | String | A system-generated identifier (WID, ID, or reference ID) for the specific shipping terms applied to the purchase order. |
| Status_Descriptor | String | A human-readable description of the purchase order's current status, such as 'Pending Approval', 'Approved', or 'Partially Received'. |
| Status_Href | String | A hyperlink reference to the status record in the system, providing direct access to status history and updates. |
| Status_Id | String | A unique identifier (WID, ID, or reference ID) representing the purchase order status within the Workday system. |
| SubmittedBy_Descriptor | String | A descriptive name or role associated with the individual who submitted the purchase order for processing. |
| SubmittedBy_Href | String | A hyperlink reference to the submitter’s record within Workday, allowing for quick access to the submitter's details. |
| SubmittedBy_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the individual who submitted the purchase order. |
| SupplierContract_Descriptor | String | A description of the supplier contract associated with this purchase order, including contract terms and conditions. |
| SupplierContract_Href | String | A hyperlink reference to the supplier contract record within Workday, allowing users to view contract details and agreements. |
| SupplierContract_Id | String | A unique identifier (WID, ID, or reference ID) representing the specific supplier contract linked to this purchase order. |
| Supplier_Descriptor | String | A descriptive name or label for the supplier fulfilling this purchase order, such as the company name or vendor alias. |
| Supplier_Href | String | A hyperlink reference to the supplier’s record in Workday, providing access to supplier profile and transaction history. |
| Supplier_Id | String | A unique identifier (WID, ID, or reference ID) assigned to the supplier within the system. |
| TaxAmount_Currency | String | The currency code (for example, USD, EUR) representing the currency in which the total tax amount is denominated. |
| TaxAmount_Value | Decimal | The total tax amount applied to the purchase order, expressed in the designated currency. This includes applicable sales tax, VAT, or other relevant taxes. |
| TaxOption_Descriptor | String | A description of the tax option selected for the purchase order, such as 'Taxable' or 'Exempt'. |
| TaxOption_Href | String | A hyperlink reference to the tax option record in the system, providing access to tax settings and configurations. |
| TaxOption_Id | String | A system-generated identifier (WID, ID, or reference ID) representing the selected tax option for this purchase order. |
| TotalAmount_Currency | String | Represents the currency in which the total extended amount of all purchase order lines is calculated. This value aligns with the currency settings defined for the purchase order. |
| TotalAmount_Value | Decimal | Indicates the total monetary value of all purchase order lines combined, expressed in the currency specified by TotalAmount_Currency. |
| Buyer_Prompt | String | Allows filtering of purchase orders based on the designated buyer. Enter the WID of the worker assigned as the buyer for the purchase order. |
| Company_Prompt | String | Filters purchase orders by company. Enter the WID of the company associated with the purchase order. |
| ExcludeCanceled_Prompt | Bool | Determines whether purchase orders with a Canceled status should be excluded from the results. If the value is 'true,' purchase orders marked as Canceled will be omitted. The default value is 'false.' |
| ExcludeClosed_Prompt | Bool | Determines whether purchase orders with a Closed status should be excluded from the results. If the value is 'true,' purchase orders marked as Closed will be omitted. The default value is 'false.' |
| FromDate_Prompt | Date | Filters purchase orders by document date, returning only those with a date on or after the specified value. The date should be provided in the format YYYY-MM-DD. |
| OrderFromConnection_Prompt | String | Filters purchase orders based on the supplier's order-from connection. Enter the WID of the order-from connection to limit results. |
| Status_Prompt | String | Filters purchase orders by status. Enter the WID corresponding to the purchase order's current status. |
| SubmittedBy_Prompt | String | Filters purchase orders by the worker who submitted them. Enter the WID of the worker responsible for submitting the purchase order. |
| Supplier_Prompt | String | Filters purchase orders by supplier. Enter the WID of the supplier associated with the purchase order. |
| ToDate_Prompt | Date | Filters purchase orders by document date, returning only those with a date on or before the specified value. The date should be provided in the format YYYY-MM-DD. |
Maintains billing address details associated with purchase orders, ensuring accurate invoicing and financial processing.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the purchase order bill-to address instance. This ID is auto-generated and used internally for tracking purposes. |
| PurchaseOrders_Id [KEY] | String | The unique Workday ID (WID) for the purchase order to which this bill-to address record belongs. This ID helps associate the bill-to address with its corresponding purchase order. |
| Descriptor | String | A concise, human-readable representation of the bill-to address instance, often used in user interfaces or summary views. |
| Buyer_Prompt | String | Specifies a filter to return purchase orders associated with a specific buyer. Provide the WID of the worker assigned as the buyer for the purchase order. |
| Company_Prompt | String | Filters purchase orders based on the company responsible for them. Provide the WID of the company. Multiple companies can be specified using comma-separated values. |
| ExcludeCanceled_Prompt | Bool | Determines whether to exclude purchase orders that have been canceled. Set the value to 'true' to exclude canceled purchase orders from the results. The default value is 'false,' meaning canceled orders are included. |
| ExcludeClosed_Prompt | Bool | Determines whether to exclude purchase orders that have been closed. Set the value to 'true' to exclude closed purchase orders from the results. The default value is 'false,' meaning closed orders are included. |
| FromDate_Prompt | Date | Filters purchase orders based on the document date, returning only those with a date on or after the specified value. Enter the date in YYYY-MM-DD format. |
| OrderFromConnection_Prompt | String | Filters purchase orders based on supplier order-from connections. Provide the WID of the order-from connection. Multiple order-from connections can be specified using comma-separated values. |
| Status_Prompt | String | Filters purchase orders by their current status. Provide the WID of the status value to return only orders matching that status. Multiple statuses can be specified using comma-separated values. |
| SubmittedBy_Prompt | String | Filters purchase orders based on the worker who submitted them. Provide the WID of the worker responsible for submitting the purchase order. Multiple submittedBy values can be specified using comma-separated values. |
| Supplier_Prompt | String | Filters purchase orders based on the supplier associated with them. Provide the WID of the supplier. Multiple supplier IDs can be specified using comma-separated values. |
| ToDate_Prompt | Date | Filters purchase orders based on the document date, returning only those with a date on or before the specified value. Enter the date in YYYY-MM-DD format. |
Stores detailed line items for goods included in purchase orders, providing transparency into ordered products, quantities, and costs.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
amount: Currency /* The amount on the purchase order transaction line split. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
location: { /* The location worktag for a purchase order line split. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
memo: Text /* The memo for a purchase order line split. */
percent: Numeric /* The percentage for a purchase order line split. */
quantity: Numeric /* The quantity for the purchase order line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the purchase order goods line. This ID is system-generated and used for reference across Workday. |
| PurchaseOrders_Id [KEY] | String | The unique Workday ID (WID) for the purchase order that contains this line item. This ID is used to link the goods line to its parent purchase order. |
| DeliverTo_Descriptor | String | A textual representation or label describing the recipient of the delivery. This typically includes location or department details. |
| DeliverTo_Href | String | A hyperlink reference pointing to the full Workday record of the delivery recipient, allowing direct navigation within the system. |
| DeliverTo_Id | String | The identifier (WID, ID, reference ID) uniquely associating this record with a delivery recipient. |
| DeliveryType_Descriptor | String | A description of the delivery type, such as standard shipping, expedited, or in-store pickup, providing insight into how the goods will be delivered. |
| DeliveryType_Href | String | A hyperlink reference to the full Workday record of the delivery type, enabling direct access to additional details. |
| DeliveryType_Id | String | The identifier (WID, ID, reference ID) linking this purchase order line to a specific delivery type. |
| Descriptor | String | A brief summary of the purchase order goods line, providing a high-level preview of its contents or purpose. |
| DueDate | Datetime | The expected delivery date for this purchase order line, calculated based on the purchase order creation date and item lead time. Ensures timely receipt of goods. |
| ExtendedAmount_Currency | String | The currency used for the extended amount value of this purchase order line. This indicates the monetary unit for cost calculations. |
| ExtendedAmount_Value | Decimal | The total cost of this purchase order line, excluding tax-only invoices. This value is calculated by multiplying the unit cost by the quantity ordered. |
| ItemDescription | String | A detailed description of the item purchased, including specifications, model numbers, or other key identifiers to ensure clarity for procurement and inventory. |
| ItemName_Descriptor | String | A short, human-readable name identifying the item in the purchase order. This typically includes product name or category. |
| ItemName_Href | String | A hyperlink reference to the full Workday record of the item, allowing easy access to additional specifications and procurement details. |
| ItemName_Id | String | The identifier (WID, ID, reference ID) uniquely linking this purchase order line to an item record in the system. |
| LeadTime | Decimal | The number of days required for the item to be delivered from the time of purchase. This value helps in scheduling and inventory management. |
| Location_Descriptor | String | A textual representation of the delivery location, such as a warehouse, office, or specific department within the organization. |
| Location_Href | String | A hyperlink reference to the Workday record of the delivery location, providing additional details and context. |
| Location_Id | String | The identifier (WID, ID, reference ID) uniquely linking this record to a location in the system. |
| Memo | String | Internal notes or comments related to this purchase order line. Often used for justifications, special instructions, or tracking reference numbers. |
| Prepaid | Bool | Indicates whether this purchase order line was prepaid. If the value is 'true,' the payment was processed before goods were received. |
| QuantityInvoiced | Decimal | The total quantity of this item that has been invoiced across one or more supplier invoices. Helps track billing status and payment reconciliation. |
| QuantityOrdered | Decimal | The total number of units of this item ordered on the purchase order. |
| QuantityReceived | Decimal | The total quantity of this item received. If any returns exist, the returned quantity is subtracted from this value. |
| QuantityShipped | Decimal | The total quantity of this item shipped by the supplier, used to track delivery progress. |
| RequestedAsNoCharge | Bool | Indicates whether this item was requested as a no charge item, often used for internal transfers or promotional items. |
| Retention | Bool | Indicates whether this purchase order line has retention applied, meaning a portion of the payment is withheld until specific conditions are met. |
| ShipToAddress_Descriptor | String | A brief textual preview of the shipping address where the goods will be delivered. This typically includes city or site name. |
| ShipToAddress_Id | String | The identifier uniquely linking this purchase order line to a shipping address record. |
| ShipToContact_Descriptor | String | A brief textual representation of the contact person or department receiving the shipment. This typically includes name and role. |
| ShipToContact_Href | String | A hyperlink reference to the full Workday record of the ship-to contact, providing further details and contact information. |
| ShipToContact_Id | String | The identifier linking this record to the ship-to contact in the system. |
| SpendCategory_Descriptor | String | A description of the spend category associated with this purchase order line, such as office supplies, IT equipment, or professional services. |
| SpendCategory_Href | String | A hyperlink reference to the full Workday record of the spend category, enabling quick access to additional financial details. |
| SpendCategory_Id | String | The identifier linking this purchase order line to a spend category. |
| Splits_Aggregate | String | Detailed breakdown of line splits, showing how costs are allocated across multiple cost centers, departments, or funding sources. This field remains empty if no splits exist. |
| SupplierItemIdentifier | String | The unique identifier assigned to this item by the supplier. This value can differ for each supplier providing the same item. Helps in procurement tracking. |
| TaxApplicability_Descriptor | String | A description indicating whether this purchase order line is taxable and under what conditions. |
| TaxApplicability_Href | String | A hyperlink reference to the full Workday record for tax applicability, providing additional compliance details. |
| TaxApplicability_Id | String | The identifier linking this purchase order line to tax applicability details. |
| TaxCode_Descriptor | String | A brief textual preview of the tax code applied to this purchase order line, providing information on applicable tax rates and regulations. |
| TaxCode_Id | String | The identifier linking this purchase order line to a tax code record in the system. |
| TaxRecoverability_Aggregate | String | The percentage of tax that can be recovered for this taxable purchase order line, used for tax reporting and compliance. |
| UnitCost_Currency | String | The currency used for the unit cost of the item. Ensures accurate financial calculations and reporting. |
| UnitCost_Value | Decimal | The price per unit of this item in the specified currency, used for cost calculations and budgeting. |
| UnitOfMeasure_Descriptor | String | A textual representation of the unit of measure for this item, such as Each, Box, or Kilogram. |
| UnitOfMeasure_Href | String | A hyperlink reference to the Workday record for the unit of measure, allowing direct access to measurement details. |
| UnitOfMeasure_Id | String | The identifier linking this purchase order line to a unit of measure record. |
| Worktags_Aggregate | String | A collection of worktags associated with this purchase order line. Worktags are used for financial tracking and reporting. |
| Buyer_Prompt | String | Filters purchase orders by the buyer assigned in Workday. Accepts one or multiple WIDs of buyers. |
| Company_Prompt | String | Filters purchase orders by company. Accepts one or multiple WIDs of companies to refine results. |
| ExcludeCanceled_Prompt | Bool | If the value is 'true,' it excludes purchase orders with a Canceled status from the results. The default is 'false.' |
| ExcludeClosed_Prompt | Bool | If the value is 'true,' it excludes purchase orders with a Closed status from the results. The default is 'false.' |
| FromDate_Prompt | Date | Filters purchase orders with a document date on or after the specified date. Format: YYYY-MM-DD. |
| OrderFromConnection_Prompt | String | Filters purchase orders by supplier order-from connections. Accepts one or multiple WIDs. |
| Status_Prompt | String | Filters purchase orders by status. Accepts one or multiple WIDs for status. |
| SubmittedBy_Prompt | String | Filters purchase orders by submitter. Accepts one or multiple WIDs of workers who submitted the order. |
| Supplier_Prompt | String | Filters purchase orders by supplier. Accepts one or multiple WIDs of suppliers. |
| ToDate_Prompt | Date | Filters purchase orders with a document date on or before the specified date. Format: YYYY-MM-DD. |
Tracks service lines within project-based purchase orders, detailing services procured in connection with specific projects.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
amount: Currency /* The amount on the purchase order transaction line split. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
location: { /* The location worktag for a purchase order line split. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
memo: Text /* The memo for a purchase order line split. */
percent: Numeric /* The percentage for a purchase order line split. */
quantity: Numeric /* The quantity for the purchase order line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
}]
[{
amount: Currency /* The amount for the project subtask. The value can be negative and will be precise up to 6 decimal places. */
description: Text /* The description of a project subtask on the document line. The project subtasks are always on the
project based service lines for procurement transactions. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
task: { /* The project plan task associated with the project subtask. */
descriptor: Text /* A preview of the instance */
endDate: Date /* The project plan task end date. */
id: Text /* Id of the instance */
name: Text /* The project plan task name. */
phase: { /* The project plan phase for a project. The project plan phase is unique to the project and the project phase is unique to the tenant. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
name: Text /* The name of the phrase associated with a project plan. */
}
startDate: Date /* The project plan task start date. */
}
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for each instance of a project-based service line in the Purchase Orders module. This ID is used to track and reference specific service line entries within the system. |
| PurchaseOrders_Id [KEY] | String | The Workday system-generated unique identifier of the Purchase Order that this project-based service line is associated with. |
| AmountInvoiced_Currency | String | The currency in which the total amount invoiced for this project-based purchase order line is recorded. This includes all invoice lines linked to the purchase order line. |
| AmountInvoiced_Value | Decimal | The total monetary amount invoiced for this project-based purchase order line, represented in the specified currency. Includes the sum of all related invoice lines. |
| AmountReceived_Currency | String | The currency in which the total amount received for this project-based purchase order line is recorded. This includes all receipt lines associated with the purchase order line. |
| AmountReceived_Value | Decimal | The total monetary amount received for this project-based purchase order line, represented in the specified currency. Includes the sum of all related receipt lines. |
| Descriptor | String | A brief textual representation of this project-based purchase order line, typically used for display purposes. |
| ExtendedAmount_Currency | String | The currency in which the extended amount for this purchase order line is recorded. The extended amount reflects the full value of the purchase order line, excluding tax-only invoices. |
| ExtendedAmount_Value | Decimal | The total extended amount for this purchase order line, representing the agreed price before taxes and adjustments, excluding amounts specific to tax-only invoices. |
| Memo | String | Additional notes or comments recorded for this project-based purchase order line, typically entered by users for reference purposes. |
| Prepaid | Bool | Indicates whether the purchase order line has been prepaid. If the value is 'true,' the cost has been paid in advance rather than upon receipt of goods or services. |
| Project_Descriptor | String | A brief summary or identifier of the project instance, used for quick reference within the system. |
| Project_EndDate | Datetime | The officially approved end date for the project, marking the conclusion of its planned activities and commitments. |
| Project_Id | String | A unique identifier assigned to the project instance, ensuring distinct tracking and reference within the system. |
| Project_Name | String | The officially designated name of the project, approved for use in records, reports, and project-related documentation. |
| Project_Reference | String | An external or third-party reference identifier for the associated project, which can be used for integration with other systems. |
| Project_StartDate | Datetime | The scheduled or approved start date of the project associated with this purchase order line. |
| Retention | Bool | Indicates whether the retention checkbox is selected for this purchase order line. If the value is 'true,' retention can be applied, typically meaning a portion of the payment is withheld until project completion. |
| SpendCategory_Descriptor | String | A textual description of the spend category associated with this purchase order line, used for classification and reporting. |
| SpendCategory_Href | String | A URL link to the spend category instance, which provides additional details or navigation to the relevant Workday object. |
| SpendCategory_Id | String | The Workday unique identifier (WID), system ID, or reference ID for the spend category associated with this purchase order line. |
| Splits_Aggregate | String | A detailed breakdown of the line item splits for this project-based purchase order line. If the line has no splits, this field remains empty. |
| Subtasks_Aggregate | String | A collection of project-related subtasks associated with this purchase order line. Subtasks indicate task-level granularity within the project. |
| Worktags_Aggregate | String | The worktags assigned to this purchase order line, which help categorize and track financial transactions within Workday. |
| Buyer_Prompt | String | Filters purchase orders by the assigned buyer. Specify the Workday ID of the worker designated as the buyer on the purchase order. Multiple buyer IDs can be used. |
| Company_Prompt | String | Filters purchase orders based on the company they are associated with. Provide the Workday ID of the company. Multiple company IDs can be used. |
| ExcludeCanceled_Prompt | Bool | If the value is 'true,' this query excludes purchase orders that have been canceled. The default value is 'false,' meaning canceled orders are included. |
| ExcludeClosed_Prompt | Bool | If the value is 'true,' this query excludes purchase orders that have been closed. The default value is 'false,' meaning closed orders are included. |
| FromDate_Prompt | Date | Filters purchase orders to include only those with a document date on or after the specified date. Expected format: YYYY-MM-DD. |
| OrderFromConnection_Prompt | String | Filters purchase orders based on supplier order-from connections. Provide the Workday ID of the order-from connection. Multiple connection IDs can be used. |
| Status_Prompt | String | Filters purchase orders based on their status. Specify the Workday ID corresponding to the status. Multiple status IDs can be used. |
| SubmittedBy_Prompt | String | Filters purchase orders by the worker who submitted them. Provide the Workday ID of the submitting worker. Multiple worker IDs can be used. |
| Supplier_Prompt | String | Filters purchase orders by supplier. Provide the Workday ID of the supplier. Multiple supplier IDs can be used. |
| ToDate_Prompt | Date | Filters purchase orders to include only those with a document date on or before the specified date. Expected format: YYYY-MM-DD. |
Maintains records of service-based line items in purchase orders, supporting procurement tracking and contract management.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
amount: Currency /* The amount on the purchase order transaction line split. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
location: { /* The location worktag for a purchase order line split. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
memo: Text /* The memo for a purchase order line split. */
percent: Numeric /* The percentage for a purchase order line split. */
quantity: Numeric /* The quantity for the purchase order line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the purchase order service line instance within Workday. |
| PurchaseOrders_Id [KEY] | String | The unique Workday ID (WID) for the purchase order that includes this service line. Used to establish relationships between orders and their corresponding service lines. |
| AmountInvoiced_Currency | String | The currency in which the total extended line amount of all invoice lines for the purchase order line is denominated. This applies to both Goods and Service lines and follows the currency set for the purchase order. |
| AmountInvoiced_Value | Decimal | The total value of all invoice lines associated with this purchase order line, calculated based on the extended amounts. This field applies to both Goods and Service lines and is expressed in the purchase order's currency. |
| AmountOrdered_Currency | String | The currency in which the extended amount for the purchase order line is recorded. This excludes any tax amounts from Tax Only Invoices. |
| AmountOrdered_Value | Decimal | The extended monetary value for this purchase order line, excluding any tax-only amounts. This value represents the cost committed at the time of order placement. |
| AmountReceived_Currency | String | The currency of the total extended line amount for all receipt lines linked to this purchase order line. |
| AmountReceived_Value | Decimal | The cumulative extended amount of all receipt lines for the purchase order line, reflecting the received portion of the order. |
| DeliverTo_Descriptor | String | A textual representation describing the intended delivery recipient or location for the purchase order line. |
| DeliverTo_Href | String | A URL reference linking to detailed information about the delivery recipient or location for this purchase order line. |
| DeliverTo_Id | String | The unique identifier (WID, ID, or reference ID) associated with the delivery destination of the purchase order line. |
| Descriptor | String | A brief summary or preview text describing the purchase order service line instance. |
| DueDate | Datetime | The date when the items or services for this purchase order line are expected to be delivered, based on the order creation date and predefined lead time. |
| EndDate | Datetime | The final date applicable for the simple service order line, marking the completion of the service period. |
| ExtendedAmount_Currency | String | The currency in which the extended amount for the purchase order line is recorded. This excludes any tax amounts from tax-only invoices. |
| ExtendedAmount_Value | Decimal | The total cost for the purchase order line after factoring in quantity and unit price, excluding tax amounts from tax-only invoices. |
| ItemDescription | String | A detailed description of the item or service specified in the purchase order line, providing clarity on its nature and intended use. |
| ItemName_Descriptor | String | A textual representation describing the item or service associated with this purchase order line. |
| ItemName_Href | String | A hyperlink reference pointing to additional details about the item or service listed in the purchase order line. |
| ItemName_Id | String | The unique Workday identifier (WID, ID, or reference ID) assigned to the item or service in the purchase order line. |
| Location_Descriptor | String | A descriptive name or label for the physical or virtual location associated with this purchase order line. |
| Location_Href | String | A hyperlink pointing to more information about the location relevant to the purchase order line. |
| Location_Id | String | The Workday identifier (WID, ID, or reference ID) associated with the location specified for this purchase order line. |
| Memo | String | Additional notes or comments provided for this purchase order line, often used to include supplementary details or special instructions. |
| Prepaid | Bool | Indicates whether this purchase order line is prepaid. If the value is 'true,' the amount has been paid in advance. |
| Retention | Bool | Indicates whether a retention amount applies to this purchase order line. If the value is 'true,' a portion of the payment can be withheld until conditions are met. |
| ShipToAddress_Descriptor | String | A textual description of the shipping address where the goods or services should be delivered. |
| ShipToAddress_Href | String | A hyperlink reference to the detailed information regarding the shipping address for this purchase order line. |
| ShipToAddress_Id | String | The unique Workday identifier (WID, ID, or reference ID) associated with the shipping address. |
| ShipToContact_Descriptor | String | A textual representation of the designated contact person or entity for the shipping destination. |
| ShipToContact_Href | String | A hyperlink reference providing more details about the contact person or entity handling shipment reception. |
| ShipToContact_Id | String | The Workday identifier (WID, ID, or reference ID) associated with the shipping contact. |
| SpendCategory_Descriptor | String | A textual description of the spend category assigned to this purchase order line, which classifies expenditures. |
| SpendCategory_Href | String | A hyperlink leading to more details about the spend category associated with this purchase order line. |
| SpendCategory_Id | String | The Workday identifier (WID, ID, or reference ID) corresponding to the spend category for this purchase order line. |
| Splits_Aggregate | String | Contains information about the cost splits applied to this purchase order line. If empty, no splits exist for this line. |
| StartDate | Datetime | The beginning date for the simple service order line, marking when the service delivery starts. |
| TaxApplicability_Descriptor | String | A textual description of the tax applicability status for this purchase order line, indicating whether and how taxes apply. |
| TaxApplicability_Href | String | A hyperlink reference for additional details regarding the tax applicability of this purchase order line. |
| TaxApplicability_Id | String | The Workday identifier (WID, ID, or reference ID) associated with the tax applicability classification. |
| TaxCode_Descriptor | String | A summary description of the tax code applied to this purchase order line, specifying tax treatment. |
| TaxCode_Id | String | The unique identifier of the tax code applicable to this purchase order line. |
| TaxRecoverability_Aggregate | String | Indicates the recoverable tax percentage on taxable items within this purchase order line, affecting cost calculations. |
| Worktags_Aggregate | String | A collection of Worktags linked to this purchase order line, providing additional categorization and reporting attributes. |
| Buyer_Prompt | String | Filters purchase orders based on the buyer. Specify the WID of the buyer assigned to the purchase order. Multiple buyer IDs can be specified. |
| Company_Prompt | String | Filters purchase orders by company. Specify the WID of the company. Multiple company IDs can be provided. |
| ExcludeCanceled_Prompt | Bool | If the value is 'true,' it excludes purchase orders with a status of Canceled. The default value is 'false.' |
| ExcludeClosed_Prompt | Bool | If the value is 'true,' it excludes purchase orders that have been marked as Closed. The default value is 'false.' |
| FromDate_Prompt | Date | Filters purchase orders to include only those with a document date on or after the specified date. Format: YYYY-MM-DD. |
| OrderFromConnection_Prompt | String | Filters purchase orders based on supplier order-from connections. Specify the WID of the order-from connection. Multiple IDs can be used. |
| Status_Prompt | String | Filters purchase orders by their status. Specify the WID representing the status. Multiple status IDs can be included. |
| SubmittedBy_Prompt | String | Filters purchase orders based on the worker who submitted them. Specify the WID of the submitting worker. Multiple IDs can be provided. |
| Supplier_Prompt | String | Filters purchase orders by supplier. Specify the WID of the supplier. Multiple supplier IDs can be included. |
| ToDate_Prompt | Date | Filters purchase orders to include only those with a document date on or before the specified date. Format: YYYY-MM-DD. |
Stores tax codes applicable to purchase orders, ensuring correct tax calculations and compliance with financial regulations.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for this purchase order tax code instance within the Workday system. |
| PurchaseOrders_Id [KEY] | String | The unique Workday ID (WID) for the purchase order associated with this tax code. This links the tax code details to a specific purchase order record. |
| Descriptor | String | A human-readable summary or preview of the purchase order tax code instance, often used for quick identification within reports and queries. |
| Buyer_Prompt | String | A filter that retrieves purchase orders based on the assigned buyer. Specify the WID of the worker responsible for making the purchase. Multiple buyers can be specified using repeated query parameters. |
| Company_Prompt | String | A filter that retrieves purchase orders associated with a specific company. Provide the WID of the company to limit results to orders linked to that entity. Multiple company IDs can be specified. |
| ExcludeCanceled_Prompt | Bool | A flag that determines whether purchase orders with a 'Canceled' status should be excluded from the results. If the value is 'true,' canceled orders will not be included. The default value is 'false.' |
| ExcludeClosed_Prompt | Bool | A flag that determines whether purchase orders with a 'Closed' status should be excluded from the results. If the value is 'true,' closed orders will not be included. The default value is 'false.' |
| FromDate_Prompt | Date | A filter that retrieves purchase orders with a document date on or after the specified date. The date should be provided in the format YYYY-MM-DD to ensure proper filtering. |
| OrderFromConnection_Prompt | String | A filter that retrieves purchase orders associated with specific supplier order-from connections. Provide the WID of the supplier's order-from connection. Multiple connections can be specified. |
| Status_Prompt | String | A filter that retrieves purchase orders based on their status. Provide the WID of the status to refine search results. Multiple status values can be specified for broader queries. |
| SubmittedBy_Prompt | String | A filter that retrieves purchase orders submitted by a specific worker. Provide the WID of the worker to refine results. Multiple worker IDs can be specified. |
| Supplier_Prompt | String | A filter that retrieves purchase orders based on the supplier. Provide the WID of the supplier to narrow the search results. Multiple supplier IDs can be specified for broader filtering. |
| ToDate_Prompt | Date | A filter that retrieves purchase orders with a document date on or before the specified date. The date should be provided in the format YYYY-MM-DD to ensure accurate filtering. |
Stores relationships between various entities in the system to support data linking.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the record, used as a reference or primary key within the database. |
| Descriptor | String | A brief, human-readable description of the instance or record, providing context for what the record represents. |
| CollectionToken | String | A token that is used in conjunction with the Collection_Prompt input to fetch members of the associated collection. If the row represents a single value and not a collection, this will be NULL. |
| Collection_Prompt | String | An input value taken from the CollectionToken column. When provided, it fetches all child records or members belonging to the specified collection. |
| RelatesToTag_Prompt | String | The specific talent tag associated with the feedback question, indicating the context or category of feedback being captured. |
Tracks the survey targets linked to questionnaire responses in request records.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instance, typically used as the primary key to reference the record within the system. |
| Requests_Id [KEY] | String | The Workday ID of the request that contains this particular record or data. |
| Descriptor | String | A brief preview or summary description of the instance, used for quick reference or identification. |
| CompletedOnOrAfter_Prompt | Date | A prompt to filter records based on the date they were completed, retrieving records completed on or after the specified date. |
| CompletedOnOrBefore_Prompt | Date | A prompt to filter records based on the date they were completed, retrieving records completed on or before the specified date. |
| InitiatedOnOrAfter_Prompt | Date | A prompt to filter records based on the date the request was initiated, retrieving records initiated on or after the specified date. |
| InitiatedOnOrBefore_Prompt | Date | A prompt to filter records based on the date the request was initiated, retrieving records initiated on or before the specified date. |
| Initiator_Prompt | String | The Workday ID of the individual who initiated the request. This can be used to retrieve the worker's details via the /common service. |
| OnBehalfOf_Prompt | String | The Workday ID of the person on whose behalf the request is being initiated, indicating who will be affected by the request. |
| RequestId_Prompt | String | The unique identifier for the request, typically based on an ID generation format, used to track and reference the request. |
| RequestSubtype_Prompt | String | The Workday ID of the request subtype, allowing you to filter requests based on specific subcategories. Multiple requestSubtype parameters can be used for more refined filtering. |
| RequestType_Prompt | String | The Workday ID of the request type, helping to categorize the request. Multiple requestType parameters can be specified for filtering requests by type. |
| ResolutionDetails_Prompt | String | The Workday ID of the resolution details associated with the request. Multiple resolutionDetails query parameters can be used for filtering requests based on specific resolution data. |
| Resolution_Prompt | String | The Workday ID of the resolution associated with the request, helping to specify the final outcome. Multiple resolution query parameters can be used for more specific filtering. |
| WorkdayObjectValue_Prompt | String | The Workday ID of the business object related to the request, providing context about the object linked with the request. |
Stores and categorizes different types of requests available in the system.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instance, typically used as a primary reference ID within the system. |
| AllowRequestOnBehalfOf | Bool | Indicates whether the request allows for initiation on behalf of another person, enabling delegated requests. |
| Description | String | A detailed description of the request type, explaining its purpose and the actions it pertains to. |
| Descriptor | String | A brief preview or summary description of the instance, typically used for quick identification or reference. |
| IdGenerator_Descriptor | String | A description of the ID generator instance, which may be used to generate unique identifiers for requests or entities. |
| IdGenerator_Href | String | A URL link to the specific instance of the ID generator for detailed reference or interaction. |
| IdGenerator_Id | String | The unique Workday ID or reference ID for the ID generator instance. |
| Questionnaire_Descriptor | String | A description of the specific questionnaire instance, providing context for the associated questionnaire. |
| Questionnaire_Href | String | A URL link to the specific questionnaire instance for detailed reference or interaction. |
| Questionnaire_Id | String | The unique identifier for the questionnaire instance, typically a Workday ID or reference ID. |
| RequestDescriptionDisplay_Descriptor | String | A description of the display format for the request description, outlining how it is presented. |
| RequestDescriptionDisplay_Href | String | A URL link to the specific request description display instance for further reference or details. |
| RequestDescriptionDisplay_Id | String | The unique Workday ID or reference ID for the request description display instance. |
| RestrictQuestionnaireResponses | Bool | True if Questionnaire responses associated with this request type can only be viewed by security groups added to the Questionnaire results domain. |
| WorkdayObject_Descriptor | String | A description of the Workday object instance associated with the request, providing insight into the object involved. |
| WorkdayObject_Href | String | A URL link to the specific Workday object instance for further reference. |
| WorkdayObject_Id | String | The unique identifier for the Workday object instance, typically a Workday ID or reference ID. |
Defines the allowed resolution types for specific request categories.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instance, typically used as the primary reference ID within the system. |
| RequestTypes_Id [KEY] | String | The Workday ID of the request type that contains this specific record or data. |
| Descriptor | String | A brief preview or summary description of the instance, typically used for quick identification or reference. |
Associates commodity codes with requisitions for classification and reporting.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instance, typically used as the primary reference ID within the system. |
| Descriptor | String | A brief description or preview of the instance, summarizing its key attributes or purpose. |
| CollectionToken | String | A token value used with the Collection_Prompt input to retrieve all members of the associated collection. It will be NULL if the row represents a single value instead of a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included in the requisition or requisition line filtering. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they do not depend on other requisition types. |
| Collection_Prompt | String | An input value derived from the CollectionToken column. When provided, it retrieves all children of the collection associated with the token. |
| CommodityCode_Prompt | String | The Workday ID for the commodity code used to filter requisitions by the spend category associated with the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company associated with the requisition, used to filter requisitions by company. |
| Currency_Prompt | String | The Workday ID of the currency used in the requisition, helping to filter requisitions based on the specified currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag(s) that already exist on a requisition or requisition line. This parameter can be passed multiple times to include multiple worktags. |
| ItemDescription_Prompt | String | A brief description of the item being requisitioned, used to filter requisitions by item. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only, with additional filters applied based on other requisition type parameters. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment-based, with additional filters applied based on other requisition type parameters. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are focused on inventory replenishment, with additional filters applied based on other requisition type parameters. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are for just-in-time inventory, with additional filters applied based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types focused on par replenishment, with additional filters applied based on other requisition type parameters. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types regardless of specific parameters. If false, filters requisition types based on provided parameters. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are related to Supplier Contract Requests, with additional filters applied based on other requisition type parameters. |
| Requester_Prompt | String | The Workday ID of the worker requesting the requisition. This parameter can be used to filter requisitions based on the requester, with the format Employee_ID=sampleRefId. |
| RequisitionDate_Prompt | Date | Filters requisitions by the date they were created, using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of a specific requisition line, used to filter requisitions by the line item. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type, used to filter requisitions by specific requisition categories, such as Inventory Replenishment and Bill Only. |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract, used to filter requisitions by a specific contract with the resource provider. |
| SelectedWorktags_Prompt | String | The Workday ID of the newly selected worktags for a requisition or requisition line. This can be passed multiple times to select multiple worktags. |
| Supplier_Prompt | String | The Workday ID of the supplier associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, used to filter requisitions based on the requesting entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type used for filtering requisitions by a specific worktag category. |
Links requisitions to companies for organizational tracking.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| CompanyReferenceID | String | Reference id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005. |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieve all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Tracks the currencies used in grouped requisitions for international purchases.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be considered when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just in time and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Request and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format. Example: Employee_ID=21005. |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Stores delivery location details related to grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Links inventory sites to requisitions to manage stock and supply chain data.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Associates requisition line items with specific companies for cost allocation.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Tracks supplier ordering relationships for grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Defines Periodic Automatic Replenishment (PAR) locations for efficient inventory restocking.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Lists users who initiated requisitions within a grouped dataset.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqTypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Tracks entities that generate purchase requisitions within the system.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Categorizes requisitions based on their purchasing needs.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| Metadata_Descriptor | String | A preview of the instance |
| Metadata_Id | String | Id of the instance |
| Metadata_RequisitionTypeDetails_BillOnly | Bool | Bill Only flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_Consignment | Bool | Consignment flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_HasService | Bool | Does the requisition type have a service. |
| Metadata_RequisitionTypeDetails_Inactive | Bool | Inactive flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_InventoryReplenishment | Bool | Inventory Replenishment flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_JustInTime | Bool | Just In Time flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_ParReplenishment | Bool | Par Replenishment flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_ProcedureInformation | Bool | Procedure Information flag defined on Maintain Requisition Types Task. |
| Metadata_RequisitionTypeDetails_SupplierContractRequest | Bool | Supplier Contract Request flag defined on Maintain Requisition Types Task |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Stores resolved worktag values assigned to grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Links resource providers to grouped requisitions for procurement tracking.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Stores shipping addresses linked to grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Associates sourcing buyers with grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Tracks spending categories for requisitions to facilitate financial analysis.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| SpendCategoryID | String | Reference id of the instance |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Links supplier contracts to requisitions for contract-based purchasing.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Defines units of measurement used in grouped requisitions.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Descriptor | String | A preview of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| UnCefactCommonCode | String | The UN CEFACT Common Code associated with the unit of measure. Units of measure can have both a UN CEFACT Common Code and EDI Code. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Associates worktags with grouped requisitions for financial tracking.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A description of the instance, summarizing key attributes or purpose. |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| AdditionalWorktags_Prompt | Bool | Indicates whether additional worktags should be included when filtering requisitions or requisition lines. |
| AllStandaloneTypes_Prompt | Bool | If true, retrieves requisition types that are standalone, meaning they are not associated with other requisition types. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| CommodityCode_Prompt | String | The Workday ID of the Commodity Code. Used in the spendCategory resource to retrieve spend categories from the specified commodity code. |
| Company_Prompt | String | The Workday ID of the company, used to filter requisitions by the specified company. |
| Currency_Prompt | String | The Workday ID of the currency, used to filter requisitions by their currency. |
| ExistingWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that already exist on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| ItemDescription_Prompt | String | The description of an item, used to filter requisitions by the description of the items being requisitioned. |
| ItemSpendCategory_Prompt | String | The Workday ID of the spend category associated with the item being requisitioned. |
| ProcurementItem_Prompt | String | The Workday ID of the procurement item related to the requisition, used to filter requisitions by the item. |
| ReqTypeBillOnly_Prompt | Bool | If true, retrieves requisition types that are bill-only and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeConsignment_Prompt | Bool | If true, retrieves requisition types that are consignment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeInvReplenishment_Prompt | Bool | If true, retrieves requisition types that are inventory replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeJustInTime_Prompt | Bool | If true, retrieves requisition types that are just-in-time inventory, with additional filters based on other requisition type parameters. |
| ReqTypeParReplenishment_Prompt | Bool | If true, retrieves requisition types that are par replenishment and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| ReqTypeShowAllTypes_Prompt | Bool | If true, retrieves all requisition types. If false, the requisitionType parameter will be used to filter results. |
| ReqTypeSupplierContract_Prompt | Bool | If true, retrieves requisition types that are Supplier Contract Requests and whose other reqType parameters (except reqtypeShowAllTypes) are also true. |
| Requester_Prompt | String | The Workday ID of the worker for whom the requisition is requested. The reference ID uses the Employee_ID=sampleRefId format (for example, Employee_ID=21005). |
| RequisitionDate_Prompt | Date | Filters requisitions by the requisition date using the yyyy-mm-dd format. |
| RequisitionLine_Prompt | String | The Workday ID of the requisition line, used to filter requisitions by line. |
| RequisitionType_Prompt | String | The Workday ID of the requisition type. If populated, retrieves all requisition types that exactly match the combination of usages of the requisition type passed (for example, Inventory Replenishment and Bill Only). |
| Requisition_Prompt | String | The Workday ID of the requisition, used to filter requisitions by their unique identifier. |
| ResourceProviderContract_Prompt | String | The Workday ID of the supplier contract associated with the requisition, used to filter requisitions by supplier contract. |
| SelectedWorktags_Prompt | String | The Workday ID of the worktag. Represents worktags that are newly selected on a requisition or requisition line. This parameter can be passed multiple times with different values. |
| Supplier_Prompt | String | The Workday ID of the resource provider (supplier) associated with the requisition. Used to filter requisitions by supplier. |
| TypesWithoutService_Prompt | Bool | If true, retrieves requisition types that do not involve any service components. |
| ValidForRequestingEntity_Prompt | Bool | This parameter holds a true value when the Requesting Entity is selected, indicating that the requisition is valid for the specified entity. |
| WorktagType_Prompt | String | The Workday ID of the worktag type, used to filter requisitions by a specific worktag category. |
Retrieves purchase orders that were generated from requisitions.
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Requisitions_Id [KEY] | String | The Workday ID of the Requisitions that contains this. |
| Descriptor | String | A preview of the instance, summarizing the key attributes. |
| DocumentStatus_Descriptor | String | A description of the document's current status, providing additional context. |
| DocumentStatus_Href | String | A link to the document status instance, providing more details. |
| DocumentStatus_Id | String | wid / id / reference id of the document status. |
| Href | String | A link to the instance, providing direct access to the requisition. |
| PoDocumentDate | Datetime | The date for the purchase order, indicating when the order was created or finalized. |
| PoNumber | String | The document number for the purchase order, used for identification and reference. |
| ExternalSourceableId_Prompt | String | The external sourceable ID related to the requisition, used for integration with external systems. |
| ExternalSystemId_Prompt | String | The external system ID, used to reference the requisition from an external system. |
| FromDate_Prompt | Date | Filters the requisitions with document date on or after the specified date. Use the yyyy-mm-dd format. |
| Requester_Prompt | String | Filters the requisitions by requester. Specify the Workday ID of the worker who requested the requisition. |
| RequisitionType_Prompt | String | Filters the requisitions by type. Specify the Workday ID of the requisition type. You can specify multiple requisitionType query parameters. |
| SubmittedByPerson_Prompt | String | Filters the requisitions by the person who submitted the requisition. Specify the Workday ID or the reference ID of the person. |
| SubmittedBySupplier_Prompt | String | Filters the requisitions by the supplier who submitted the requisition. Specify the Workday ID or the reference ID of the supplier. You can specify multiple submittedBySupplier query parameters. |
| SubmittedBy_Prompt | String | Filters the requisitions by the worker who submitted the requisition. Specify the Workday ID or the reference ID of the worker. You can use a returned id from GET /workers in the Staffing REST web service. |
| ToDate_Prompt | Date | Filters the requisitions with document date on or before the specified date. Use the yyyy-mm-dd format. |
Contains predefined requisition templates for streamlined purchasing processes.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the requisition template instance. |
| CreatedOnDate | Datetime | The date when the requisition template was created, serving as its document date. |
| Currency_Descriptor | String | A brief description of the currency used in the template, including its name and symbol. |
| Currency_Href | String | A link to the detailed record of the currency associated with the template. |
| Currency_Id | String | The unique identifier for the currency. |
| Descriptor | String | A short preview of the requisition template, useful for quick identification. |
| LineCount | Decimal | The total number of line items included in the requisition template. |
| Name | String | The name assigned to the requisition template for easy reference and selection. |
| OwnedByCurrentUser | Bool | True if the current processing worker is the owner of the template; indicates whether the template is private or shared. |
| Owner_Descriptor | String | A brief description of the owner, such as the worker's name and role. |
| Owner_Href | String | A link to the owner's profile or record in Workday. |
| Owner_Id | String | The unique identifier for the owner of the requisition template. |
Links requisition templates to specific companies.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this requisition template instance. |
| RequisitionTemplates_Id [KEY] | String | The Workday ID of the RequisitionTemplates record that owns this instance. |
| Descriptor | String | A brief preview of the requisition template, summarizing its key details. |
Stores details of goods line items within requisition templates.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
amount: Currency /* The amount on the Requisition line split. This value displays in the same currency of the Requisition. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
memo: Text /* The memo for a Requisition Line split on the requisition or purchase order. */
percent: Numeric /* The Percentage specified for the Requisition Line distribution line split. */
quantity: Numeric /* The Quantity specified for the Requisition Line distribution line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this requisition template goods line instance. |
| RequisitionTemplates_Id [KEY] | String | Workday-generated unique ID linking this record to the associated requisition template. |
| DeliverTo_Descriptor | String | Human-readable description of the designated delivery location. |
| DeliverTo_Href | String | A URL or reference link to the designated delivery location instance. |
| DeliverTo_Id | String | Unique identifier associated with the designated delivery location. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| ExtendedAmount_Currency | String | The currency of the extended amount for the goods line on the requisition, excluding tax-only invoices. |
| ExtendedAmount_Value | Decimal | The total extended cost for the goods line on the requisition, excluding tax-only invoices. |
| FulfillmentSource_Descriptor | String | Human-readable description of the fulfillment source. |
| FulfillmentSource_Href | String | A URL or reference link to the fulfillment source instance. |
| FulfillmentSource_Id | String | Unique identifier associated with the fulfillment source. |
| InventorySite_Descriptor | String | Human-readable description of the inventory site. |
| InventorySite_Href | String | A URL or reference link to the inventory site instance. |
| InventorySite_Id | String | Unique identifier associated with the inventory site. |
| ItemDescription | String | Text description of the item in the goods line on the requisition. |
| ItemIdentifiers_Aggregate | String | Alternative item identifiers associated with the inventory item in the requisition's goods line. |
| ItemName_Descriptor | String | Human-readable description of the item. |
| ItemName_Href | String | A URL or reference link to the item instance. |
| ItemName_Id | String | Unique identifier associated with the item. |
| ItemTags_Aggregate | String | Tags assigned to the item in the requisition's goods line, often used for categorization. |
| Memo | String | Additional notes or comments associated with the goods line in the requisition. |
| OrderFromConnection_Descriptor | String | Human-readable description of the ordering connection. |
| OrderFromConnection_Href | String | A URL or reference link to the ordering connection instance. |
| OrderFromConnection_Id | String | Unique identifier associated with the ordering connection. |
| Quantity | Decimal | The number of units requested for the item in the requisition's goods line. |
| ShipToAddress_Descriptor | String | Human-readable description of the shipping address. |
| ShipToAddress_Href | String | A URL or reference link to the shipping address instance. |
| ShipToAddress_Id | String | Unique identifier associated with the shipping address. |
| ShipToContact_Descriptor | String | Human-readable description of the shipping contact person. |
| ShipToContact_Href | String | A URL or reference link to the shipping contact instance. |
| ShipToContact_Id | String | Unique identifier associated with the shipping contact. |
| SpendCategory_Descriptor | String | Human-readable description of the spend category for this requisition. |
| SpendCategory_Href | String | A URL or reference link to the spend category instance. |
| SpendCategory_Id | String | Unique identifier associated with the spend category. |
| Splits_Aggregate | String | Line splits associated with the goods line in the requisition, used for cost allocation. |
| SupplierItemIdentifier | String | The unique identifier assigned to the item by the supplier, distinct from the manufacturer ID. |
| Supplier_Aggregate | String | The supplier or resource provider associated with the goods line in the requisition, determining the vendor for purchase orders. |
| UnitCost_Currency | String | The currency of the unit cost for the goods line in the requisition. |
| UnitCost_Value | Decimal | The per-unit cost of the item in the requisition's goods line. |
| UnitOfMeasure_Descriptor | String | Human-readable description of the unit of measure (e.g., Each, Box, Pack). |
| UnitOfMeasure_Href | String | A URL or reference link to the unit of measure instance. |
| UnitOfMeasure_Id | String | Unique identifier associated with the unit of measure. |
| Worktags_Aggregate | String | Accounting worktags associated with the goods line in the requisition for financial tracking and reporting. |
Tracks location-based data for requisition templates.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this requisition template instance. |
| RequisitionTemplates_Id [KEY] | String | The Workday ID of the RequisitionTemplates record that owns this template. |
| Descriptor | String | A brief preview of the requisition template, highlighting its key features and purpose. |
Manages service-related requisition line items within templates.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
amount: Currency /* The amount on the Requisition line split. This value displays in the same currency of the Requisition. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
memo: Text /* The memo for a Requisition Line split on the requisition or purchase order. */
percent: Numeric /* The Percentage specified for the Requisition Line distribution line split. */
quantity: Numeric /* The Quantity specified for the Requisition Line distribution line split. */
worktags: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this service line instance. |
| RequisitionTemplates_Id [KEY] | String | The Workday ID of the requisition template that contains this service line. |
| DeliverTo_Descriptor | String | A description of the delivery destination for this service line, detailing where the service will be provided. |
| DeliverTo_Href | String | A URL link to the delivery destination record associated with this service line. |
| DeliverTo_Id | String | The unique identifier for the delivery destination. |
| Descriptor | String | A brief preview of the service line, highlighting key details such as service type and item information. |
| EndDate | Datetime | The requested end date for the service on this requisition line, marking the conclusion of the service contract as specified by the user. |
| ExtendedAmount_Currency | String | The currency code for the extended amount on the service line, excluding amounts from tax-only invoices. |
| ExtendedAmount_Value | Decimal | The total extended amount for the service line (expressed as a decimal), excluding tax-only invoice amounts. |
| FulfillmentSource_Descriptor | String | A description of the source from which the service is fulfilled. |
| FulfillmentSource_Href | String | A link to the fulfillment source record associated with this service line. |
| FulfillmentSource_Id | String | The unique identifier for the fulfillment source. |
| ItemDescription | String | A detailed description of the item or service provided on this requisition line. |
| ItemName_Descriptor | String | A descriptive name for the item or service on this service line. |
| ItemName_Href | String | A link to the detailed record of the item or service. |
| ItemName_Id | String | The unique identifier for the item or service. |
| Memo | String | Any additional notes or instructions provided for this service line. |
| OrderFromConnection_Descriptor | String | A description of the connection or source from which the order originates for this service line. |
| OrderFromConnection_Href | String | A link to the record detailing the order-from connection for this service line. |
| OrderFromConnection_Id | String | The unique identifier for the order-from connection. |
| ShipToAddress_Descriptor | String | A description of the shipping address designated for this service line. |
| ShipToAddress_Href | String | A link to the record containing the shipping address details for this service line. |
| ShipToAddress_Id | String | The unique identifier for the shipping address. |
| ShipToContact_Descriptor | String | A description of the contact information associated with the shipping address for this service line. |
| ShipToContact_Href | String | A link to the contact record for the shipping address. |
| ShipToContact_Id | String | The unique identifier for the shipping contact. |
| SpendCategory_Descriptor | String | A description of the spend category used to classify this service line for accounting purposes. |
| SpendCategory_Href | String | A link to the spend category record associated with this service line. |
| SpendCategory_Id | String | The unique identifier for the spend category. |
| Splits_Aggregate | String | A concatenated list of line split details for this service line, indicating how costs are distributed across segments. |
| StartDate | Datetime | The requested start date for the service on this requisition line, marking the beginning of the service contract as specified by the user. |
| Supplier_Aggregate | String | A concatenated list of suppliers or resource providers associated with this service line, useful when multiple suppliers are involved. |
| Worktags_Aggregate | String | A concatenated list of accounting worktags applied to this service line for tracking and reporting purposes. |
Classifies requisition templates based on type and purpose.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this instance. |
| RequisitionTemplates_Id [KEY] | String | The Workday ID of the RequisitionTemplates record that owns this instance. |
| Descriptor | String | A brief preview of the instance, highlighting its key attributes. |
Links worktags to requisition templates for financial reporting.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this instance. |
| RequisitionTemplates_Id [KEY] | String | The Workday ID of the RequisitionTemplates record that contains this instance. |
| Descriptor | String | A brief preview of the instance, summarizing key details. |
| WorktagType_Descriptor | String | A description of the associated worktag type, outlining its purpose and usage. |
| WorktagType_Href | String | A URL link to the detailed record of the worktag type. |
| WorktagType_Id | String | The unique identifier for the worktag type. |
Tracks projected resource allocations for planning and budgeting purposes.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for this instance. |
| Descriptor | String | A brief preview of the instance, highlighting its key attributes. |
| ProjectPlanTask_Descriptor | String | A description of the project plan task, outlining its purpose and scope. |
| ProjectPlanTask_Href | String | A link to the detailed record of the project plan task. |
| ProjectPlanTask_Id | String | The unique identifier for the project plan task. |
| ProjectResource_Descriptor | String | A description of the project resource, providing context about its role or assignment. |
| ProjectResource_Href | String | A link to the project resource record for further details. |
| ProjectResource_Id | String | The unique identifier for the project resource. |
| ProjectRole_Descriptor | String | A description of the project role, explaining its responsibilities and relevance. |
| ProjectRole_Href | String | A link to the project role record for additional information. |
| ProjectRole_Id | String | The unique identifier for the project role. |
| ResourcePlanLine_Descriptor | String | A description of the resource plan line, detailing the allocation or planned resource usage. |
| ResourcePlanLine_Href | String | A link to the resource plan line record for further details. |
| ResourcePlanLine_Id | String | The unique identifier for the resource plan line. |
| ProjectResource_Prompt | String | The Workday ID of the project resource to filter results by. This can be used to query specific resources assigned to projects. |
| ProjectRole_Prompt | String | The Workday ID of the project role to filter results by. Use this to narrow down data by role. |
| Project_Prompt | String | The Workday ID of the project to filter results by. Use this parameter to target data for a specific project. |
Defines status values for resource plan bookings.
| Name | Type | Description |
| Id [KEY] | String | wid / id / reference id for uniquely identifying the instance. |
| Descriptor | String | A textual description of the instance. |
| CollectionToken | String | A token value used with the Collection_Prompt input to retrieve collection members. NULL indicates a standalone value. |
| Collection_Prompt | String | A token value from the CollectionToken column. When provided, it retrieves all children of the specified collection. |
| RequirementCategory_Prompt | String | The Workday ID of the requirement category, used to specify or filter requirement types within a project resource plan. |
| ResourcePlanLine_Prompt | String | The Workday ID of the resource plan line associated with the project resource. |
Lists currency types used in cost rate calculations for resource planning.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID for this instance. |
| Descriptor | String | A textual description providing insight into the instance. |
| CollectionToken | String | A token value used with the Collection_Prompt input to retrieve associated collection members. NULL indicates the row is a standalone value and not part of a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column, used to retrieve all children belonging to a specified collection. |
| RequirementCategory_Prompt | String | The Workday ID of the requirement category, which helps specify or filter requirement types related to the project resource. |
| ResourcePlanLine_Prompt | String | The Workday ID of the resource plan line that links to the project resource, helping in resource planning and allocation. |
Lists workers pending confirmation within resource plans.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID of the resource plan instance. |
| ResourcePlanLines_Id [KEY] | String | Workday ID of the Resource Plan Line that contains this instance. |
| Descriptor | String | General preview or description of the resource plan instance. |
| ProjectResourcePlan_Prompt | String | Input reference to retrieve the associated Project Resource Plan. |
| Project_Prompt | String | Input reference to retrieve the associated Project. |
Links resource plan lines to specific project resource assignments.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance, used as a primary key. |
| ResourcePlanLines_Id [KEY] | String | Workday-generated unique ID linking this record to a specific Resource Plan Line. |
| Descriptor | String | A brief human-readable summary of this instance for quick identification. |
| ProjectResourcePlan_Prompt | String | Reference prompt for selecting a Project Resource Plan within Workday. |
| Project_Prompt | String | Reference prompt for selecting a Project within Workday. |
Categorizes different types of resource plan requirements based on project needs.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier used to track this instance. |
| Descriptor | String | Human-readable description providing context about this instance. |
| CollectionToken | String | Token used with Collection_Prompt to retrieve members of a collection; NULL if this row represents a value rather than a collection. |
| Collection_Prompt | String | Token from the CollectionToken column. Supplying this input retrieves all child elements within the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a specific requirement category within Workday. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the associated resource plan line for a project resource. |
Defines different types of resource plan requirements based on project needs.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier assigned to this instance for tracking. |
| Descriptor | String | Human-readable summary providing context about this instance. |
| CollectionToken | String | Token used with Collection_Prompt to retrieve members of a collection; NULL if this row represents an individual value rather than a collection. |
| Collection_Prompt | String | Token from the CollectionToken column. Providing this input retrieves all child elements belonging to the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a specific requirement category within Workday. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the associated resource plan line within the project resource. |
Stores classifications of resources available for planning and allocation.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier assigned to this instance for tracking within Workday. |
| Descriptor | String | A human-readable description that provides context for this instance. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve all members of a collection. NULL if this row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements within the specified collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category related to the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the associated resource plan line within the project resource. |
Categorizes roles assigned to resources in project planning.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance within Workday. |
| Descriptor | String | A human-readable summary describing this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents an individual value instead of a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements within the specified collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a specific requirement category associated with the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the corresponding resource plan line within the project resource. |
Tracks specific job roles within resource plans, detailing their responsibilities.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier assigned to this instance for tracking within Workday. |
| Descriptor | String | A human-readable summary providing context for this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements within the specified collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category related to the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the associated resource plan line within the project resource. |
Manages unnamed resources within planning scenarios where exact assignments are not defined.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance in Workday. |
| Descriptor | String | A brief, human-readable description of this instance for easy identification. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements associated with the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category linked to the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the specific resource plan line within the project resource. |
Groups workers together based on project or organizational criteria for planning.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance in Workday. |
| Descriptor | String | A human-readable description providing context for this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents an individual value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements associated with the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category related to the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the associated resource plan line within the project resource. |
Stores information about workers assigned to resource plans.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier assigned to this instance for tracking within Workday. |
| Descriptor | String | A human-readable description providing context for this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents a single value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements associated with the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category linked to the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the specific resource plan line within the project resource. |
Tracks workers intended to replace unnamed resources in project plans.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier used to track this instance in Workday. |
| Descriptor | String | A human-readable description providing context for this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents a single value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements associated with the collection. |
| RequirementCategory_Prompt | String | Reference prompt for selecting a requirement category associated with the resource plan. |
| ResourcePlanLine_Prompt | String | Reference prompt linking to the relevant resource plan line within the project resource. |
Defines available options for sending back items in approval workflows.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier used to track this instance in Workday. |
| Descriptor | String | A human-readable description providing context for this instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if this row represents a single value rather than a collection. |
| Collection_Prompt | String | A reference value from the CollectionToken column. Providing this input retrieves all child elements associated with the collection. |
| EventStep_Prompt | String | Reference prompt for selecting a specific event step within a business process. |
Stores student records, including enrollment and academic details.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| FirstGeneration | Bool | Indicates whether the student is a first-generation college student (true/false). |
| InternationalStudent | Bool | Indicates whether the student is a non-U.S. citizen or non-permanent resident (true/false). |
| Location_Descriptor | String | A human-readable description of the student's location. |
| Location_Href | String | A URL or reference link to the location instance. |
| Location_Id | String | Unique identifier associated with the student's location. |
| MilitaryRelationship | Bool | Indicates whether the student has a military affiliation (for example, veteran, military spouse). |
| Person_Descriptor | String | A human-readable description of the person instance. |
| Person_Href | String | A URL or reference link to the person instance. |
| Person_Id | String | Unique identifier associated with the person. |
| PreferredName | String | The student's fully formatted preferred name. |
| StudentID | String | The unique student ID assigned to the student. |
| AcademicLevel_Prompt | String | Reference prompt for selecting an academic level associated with the student. |
| AcademicUnit_Prompt | String | Reference prompt for selecting an academic unit linked to the student. |
| ActiveOnly_Prompt | Bool | Filters results to return only active students (true/false). |
| ProgramOfStudy_Prompt | String | For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | A search string that performs fuzzy matching on student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
DEPRECATED. Managed student holds assigned to specific student IDs.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| Students_Id [KEY] | String | Workday-generated unique ID linking this record to the associated student. |
| CreatedBy | String | The user who assigned the hold to the student. |
| CreatedOn | Datetime | The date when the hold was created. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| OverrideEvent_AppliedOn | Datetime | The date when the hold override was applied. |
| OverrideEvent_CreatedBy | String | The user who applied the hold override. |
| OverrideEvent_EndDate | Datetime | The date when the hold override expires. |
| OverrideEvent_Id | String | Unique identifier for the hold override event. |
| OverrideEvent_StartDate | Datetime | The date when the hold override becomes active. |
| Reason_Description | String | A detailed description of the reason for the hold. |
| Reason_Descriptor | String | A brief, human-readable summary of the hold reason. |
| Reason_Id | String | Unique identifier for the hold reason. |
| Reason_ResolutionInstructions | String | Instructions for resolving the hold, as defined by the institution. |
| RemovedOn | Datetime | The date when the hold will be removed from the student's record. |
| HoldType_Prompt | String | Filter to retrieve holds that match the specified hold types. |
| Reason_Prompt | String | Filter to retrieve holds that match the specified hold reason. |
| ShowInactive_Prompt | Bool | If true, returns both active and inactive holds; if false, returns only active holds. |
| AcademicLevel_Prompt | String | Reference prompt for selecting an academic level associated with the student. |
| AcademicUnit_Prompt | String | Reference prompt for selecting an academic unit associated with the student. |
| ActiveOnly_Prompt | Bool | If true, returns only active students. |
| ProgramOfStudy_Prompt | String | For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | A search string that performs fuzzy matching on student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
Stores override events related to student hold types.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| StudentsHolds_Id [KEY] | String | Workday-generated unique ID linking this record to a specific student hold instance. |
| Students_Id [KEY] | String | Workday-generated unique ID linking this record to the associated student. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| HoldType_Prompt | String | Filter to retrieve holds that match the specified hold types. |
| Reason_Prompt | String | Filter to retrieve holds that match the specified hold reason. |
| ShowInactive_Prompt | Bool | If true, returns both active and inactive holds; if false, returns only active holds. |
| AcademicLevel_Prompt | String | Reference prompt for selecting an academic level associated with the student. |
| AcademicUnit_Prompt | String | Reference prompt for selecting an academic unit associated with the student. |
| ActiveOnly_Prompt | Bool | If true, returns only active students. |
| ProgramOfStudy_Prompt | String | For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | A search string that performs fuzzy matching on student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
Links student holds to their respective type contexts.
| Name | Type | Description |
| StudentsHolds_Id | String | Workday-generated unique ID linking this record to a specific student hold instance. |
| Students_Id | String | Workday-generated unique ID linking this record to the associated student. |
| AcademicPeriod_Descriptor | String | A human-readable description of the academic period. |
| AcademicPeriod_Href | String | A URL or reference link to the academic period instance. |
| AcademicPeriod_Id | String | Unique identifier associated with the academic period. |
| AcademicRecord_Descriptor | String | A brief description of the student's academic record. |
| AcademicRecord_Href | String | A URL or reference link to the academic record instance. |
| AcademicRecord_Id | String | Unique identifier associated with the academic record. |
| FederalSchoolCodeRuleSet_Descriptor | String | A description of the federal school code rule set applied to the student. |
| FederalSchoolCodeRuleSet_Href | String | A URL or reference link to the federal school code rule set instance. |
| FederalSchoolCodeRuleSet_Id | String | Unique identifier associated with the federal school code rule set. |
| FinancialAidAwardYear_Descriptor | String | A description of the financial aid award year. |
| FinancialAidAwardYear_Href | String | A URL or reference link to the financial aid award year instance. |
| FinancialAidAwardYear_Id | String | Unique identifier associated with the financial aid award year. |
| HoldType_Descriptor | String | A brief, human-readable summary of the hold type. |
| HoldType_Id | String | Unique identifier for the hold type instance. |
| Institution_Descriptor | String | A description of the institution associated with the student's record. |
| Institution_Href | String | A URL or reference link to the institution instance. |
| Institution_Id | String | Unique identifier associated with the institution. |
| HoldType_Prompt | String | Filter to retrieve holds that match the specified hold types. |
| Reason_Prompt | String | Filter to retrieve holds that match the specified hold reason. |
| ShowInactive_Prompt | Bool | If true, returns both active and inactive holds; if false, returns only active holds. |
| AcademicLevel_Prompt | String | Reference prompt for selecting an academic level associated with the student. |
| AcademicUnit_Prompt | String | Reference prompt for selecting an academic unit associated with the student. |
| ActiveOnly_Prompt | Bool | If true, returns only active students. |
| ProgramOfStudy_Prompt | String | For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | A search string that performs fuzzy matching on student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
Retrieves the primary student record associated with an individual.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| Students_Id [KEY] | String | Workday-generated unique ID linking this record to the associated student. |
| AcademicLevel_Descriptor | String | A human-readable description of the student's academic level. |
| AcademicLevel_Href | String | A URL or reference link to the academic level instance. |
| AcademicLevel_Id | String | Unique identifier associated with the academic level. |
| AcademicUnit_Descriptor | String | A human-readable description of the academic unit. |
| AcademicUnit_Href | String | A URL or reference link to the academic unit instance. |
| AcademicUnit_Id | String | Unique identifier associated with the academic unit. |
| ClassStanding_Descriptor | String | A human-readable description of the student's class standing. |
| ClassStanding_Href | String | A URL or reference link to the class standing instance. |
| ClassStanding_Id | String | Unique identifier associated with the class standing. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| ProgramOfStudy_Descriptor | String | A human-readable description of the student's program of study. |
| ProgramOfStudy_Href | String | A URL or reference link to the program of study instance. |
| ProgramOfStudy_Id | String | Unique identifier associated with the program of study. |
| Status_Descriptor | String | A human-readable description of the student's current status. |
| Status_Href | String | A URL or reference link to the status instance. |
| Status_Id | String | Unique identifier associated with the student's status. |
| AcademicLevel_Prompt | String | Reference prompt for selecting an academic level associated with the student. |
| AcademicUnit_Prompt | String | Reference prompt for selecting an academic unit associated with the student. |
| ActiveOnly_Prompt | Bool | If true, only returns active students. |
| ProgramOfStudy_Prompt | String | For non-matriculated students, the program they applied to or were admitted to; for matriculated students, their primary program of study. |
| Search_Prompt | String | A search string for fuzzy matching student IDs and names. Example: 'bri%20book' returns the student Brian Booker. |
Stores data related to supervisory organizations and their hierarchies.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| Code | String | The unique identifier assigned to the organization. |
| Descriptor | String | A brief, human-readable summary of the organization. |
| Href | String | A URL or reference link to the organization instance. |
| Manager_Descriptor | String | A human-readable description of the organization's manager. |
| Manager_Href | String | A URL or reference link to the manager instance. |
| Manager_Id | String | Unique identifier associated with the organization's manager. |
| Name | String | The official name of the organization. |
| Workers | String | A list of workers associated with the organization. |
Tracks individual members within a supervisory organization.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| SupervisoryOrganizations_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization. |
| BusinessTitle | String | The business title associated with the position. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| JobProfile_Descriptor | String | A human-readable description of the job profile. |
| JobProfile_Id | String | Unique identifier for the job profile instance. |
| JobType_Descriptor | String | A human-readable description of the job type. |
| Location_Country_Descriptor | String | A human-readable description of the country where the job is located. |
| Location_Descriptor | String | A human-readable description of the job location. |
| Location_Id | String | Unique identifier for the job location instance. |
| NextPayPeriodStartDate | Datetime | The start date of the next pay period for the job. |
| SupervisoryOrganization_Descriptor | String | A human-readable description of the associated supervisory organization. |
| SupervisoryOrganization_Id | String | Unique identifier for the supervisory organization instance. |
| Worker_Descriptor | String | A human-readable description of the worker assigned to the position. |
| Worker_Id | String | Unique identifier for the worker instance. |
Stores organizational chart details for a supervisory organization.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| SupervisoryOrganizations_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Superior_Code | String | The unique identifier assigned to the superior organization. |
| Superior_Descriptor | String | A human-readable description of the superior organization. |
| Superior_Id | String | Unique identifier for the superior organization instance. |
| Superior_Inactive | Bool | Indicates whether the superior organization is inactive (true/false). |
| Superior_Name | String | The name of the superior organization as of the processing effective date. |
Retrieves subordinates linked to a supervisory organization's org chart.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| SupervisoryOrganizationsOrgChart_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization chart. |
| SupervisoryOrganizations_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization. |
| Code | String | The unique identifier assigned to the organization. |
| Descriptor | String | A brief, human-readable summary of the organization. |
| Inactive | Bool | Indicates whether the organization is inactive (true/false). |
| Managers_Aggregate | String | A list of managers assigned to the supervisory organization. |
| Name | String | The name of the organization as of the processing effective date. |
Tracks superior managers within a supervisory organization's hierarchy.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| SupervisoryOrganizationsOrgChart_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization chart. |
| SupervisoryOrganizations_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization. |
| Descriptor | String | A brief, human-readable summary of the instance. |
Stores worker details within specific supervisory organizations.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this instance. |
| SupervisoryOrganizations_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supervisory organization. |
| BusinessTitle | String | The business title for the worker's primary position. If no business title is defined, the position title is returned. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Href | String | A URL or reference link to the instance. |
| IsManager | Bool | Indicates whether the worker holds a managerial role (true/false). |
| PrimarySupervisoryOrganization_Descriptor | String | A human-readable description of the worker's primary supervisory organization. |
| PrimarySupervisoryOrganization_Href | String | A URL or reference link to the primary supervisory organization instance. |
| PrimarySupervisoryOrganization_Id | String | Unique identifier associated with the primary supervisory organization. |
| PrimaryWorkEmail | String | The worker's primary work email address. |
| PrimaryWorkPhone | String | The worker's primary work phone number, including the area code and country code. |
Manages supplier contracts, including agreements, terms, and conditions.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract instance. |
| AllowAllSuppliers | Bool | Indicates whether the 'Allow All Suppliers' option is enabled for a multi-supplier contract (true/false). |
| AutomaticallyRenew | Bool | Indicates whether the supplier contract is automatically renewed (true/false). |
| BillToAddress_Descriptor | String | A human-readable description of the billing address. |
| BillToAddress_Href | String | A URL or reference link to the billing address instance. |
| BillToAddress_Id | String | Unique identifier associated with the billing address. |
| BillToContactDetail | String | The billing contact details that populate on purchase orders for contract installments. |
| Buyer_Descriptor | String | A human-readable description of the buyer. |
| Buyer_Href | String | A URL or reference link to the buyer instance. |
| Buyer_Id | String | Unique identifier associated with the buyer. |
| CatalogDiscountPercent | Decimal | The discount percentage applied to all catalog items on the supplier contract unless overridden by contract line pricing. |
| CompanyOrHierarchy_Descriptor | String | A human-readable description of the associated company or hierarchy. |
| CompanyOrHierarchy_Id | String | Unique identifier for the company or hierarchy instance. |
| CompanyOrHierarchy_OrganizationReferenceID | String | Reference id of the instance |
| ContractReferenceNumber | String | The reference number that identifies the supplier contract. |
| ContractSpecialist_Descriptor | String | A human-readable description of the contract specialist. |
| ContractSpecialist_Href | String | A URL or reference link to the contract specialist instance. |
| ContractSpecialist_Id | String | Unique identifier associated with the contract specialist. |
| ContractType_Descriptor | String | A human-readable description of the contract type. |
| ContractType_Id | String | Unique identifier for the contract type instance. |
| ContractType_SupplierContractTypeID | String | Reference id of the instance |
| Currency_Descriptor | String | A human-readable description of the currency used in the contract. |
| Currency_Href | String | A URL or reference link to the currency instance. |
| Currency_Id | String | Unique identifier associated with the currency. |
| DefaultOrderFromConnection_Descriptor | String | A description of the default order-from connection. |
| DefaultOrderFromConnection_Href | String | A URL or reference link to the default order-from connection instance. |
| DefaultOrderFromConnection_Id | String | Unique identifier associated with the default order-from connection. |
| Descriptor | String | A brief, human-readable summary of the supplier contract instance. |
| DocumentLink | String | A link to an external document related to the supplier contract. |
| EndDate | Datetime | The expiration date of the supplier contract. |
| ExternalReferenceID | String | The external identifier associated with the supplier contract, requisition, or supplier invoice. |
| ExternalSystemReference_Descriptor | String | A description of the external system reference. |
| ExternalSystemReference_Href | String | A URL or reference link to the external system reference. |
| ExternalSystemReference_Id | String | Unique identifier associated with the external system reference. |
| FromSupplierList | Bool | Indicates whether the contract is associated with a supplier list (true/false). |
| GpoReference | String | The Group Purchase Organization (GPO) contract reference associated with the supplier contract. |
| InvoicedPOAmount_Currency | String | The total amount of supplier invoices attached to purchase orders, in the contract currency. |
| InvoicedPOAmount_Value | Decimal | The total invoiced amount from purchase orders, excluding canceled or denied invoices. |
| MarkupPercent | Decimal | The markup percentage applied to the unit cost of supplier items in the contract. |
| Name | String | The name of the supplier contract. |
| NonPOInvoiceAmount_Currency | String | The total amount of invoices not associated with purchase orders, in the contract currency, excluding canceled or denied invoices. |
| NonPOInvoiceAmount_Value | Decimal | The total value of non-PO invoices, excluding canceled or denied invoices. |
| NoticePeriod | Decimal | The number of days or months before contract expiration when a notice is sent. |
| NoticePeriodFrequency_Descriptor | String | A description of the notice period frequency. |
| NoticePeriodFrequency_Href | String | A URL or reference link to the notice period frequency instance. |
| NoticePeriodFrequency_Id | String | Unique identifier associated with the notice period frequency. |
| Number | String | The automatically generated supplier contract number. |
| OnHold | Bool | Indicates whether the supplier contract is on hold (true/false). |
| OriginalTotalAmount_Currency | String | The original total contract amount in the contract currency. |
| OriginalTotalAmount_Value | Decimal | The original total contract value in the contract currency. |
| OverridePaymentType_Descriptor | String | A description of the override payment type. |
| OverridePaymentType_Href | String | A URL or reference link to the override payment type instance. |
| OverridePaymentType_Id | String | Unique identifier associated with the override payment type. |
| Overview | String | A detailed description or summary of the supplier contract. |
| PaymentTerms_Descriptor | String | A human-readable description of the payment terms. |
| PaymentTerms_Href | String | A URL or reference link to the payment terms instance. |
| PaymentTerms_Id | String | Unique identifier associated with the payment terms. |
| PaymentType_Descriptor | String | A human-readable description of the payment type. |
| PaymentType_Href | String | A URL or reference link to the payment type instance. |
| PaymentType_Id | String | Unique identifier associated with the payment type. |
| PurchaseOrderAmount_Currency | String | The total amount from purchase orders linked to the contract, in the contract currency. |
| PurchaseOrderAmount_Value | Decimal | The total purchase order value linked to the contract, excluding canceled or denied orders. |
| PurchaseOrderDefaultCompany_Descriptor | String | A brief, human-readable summary of the default company for purchase orders. |
| PurchaseOrderDefaultCompany_Id | String | Unique identifier for the default company associated with purchase orders. |
| PurchaseOrderIssueOption_Descriptor | String | A human-readable description of the purchase order issue option. |
| PurchaseOrderIssueOption_Href | String | A URL or reference link to the purchase order issue option instance. |
| PurchaseOrderIssueOption_Id | String | Unique identifier associated with the purchase order issue option. |
| ReceiptAmount_Currency | String | The total received amount for the supplier contract in the contract currency, excluding canceled or draft receipts. |
| ReceiptAmount_Value | Decimal | The total value of received goods/services for the supplier contract, excluding canceled or draft receipts. |
| RenewalTerm | Decimal | The number of days, months, or years the supplier contract is renewed for. |
| RenewalTermFrequency_Descriptor | String | A description of the renewal term frequency. |
| RenewalTermFrequency_Href | String | A URL or reference link to the renewal term frequency instance. |
| RenewalTermFrequency_Id | String | Unique identifier associated with the renewal term frequency. |
| SendExpiryNotification | Bool | Indicates whether expiry notifications are sent for the supplier contract (true/false). |
| ShipToAddress_Descriptor | String | A human-readable description of the shipping address. |
| ShipToAddress_Href | String | A URL or reference link to the shipping address instance. |
| ShipToAddress_Id | String | Unique identifier associated with the shipping address. |
| ShipToContactDetail | String | The shipping contact details that populate on purchase orders for contract installments. |
| SignedDate | Datetime | The date the supplier contract was signed. This field is optional and does not affect contract execution. |
| StartDate | Datetime | The effective start date of the supplier contract. |
| Status_Descriptor | String | A human-readable description of the supplier contract status. |
| Status_Href | String | A URL or reference link to the supplier contract status instance. |
| Status_Id | String | Unique identifier associated with the contract status. |
| SupplierForSupplierInvoice_Descriptor | String | A human-readable description of the supplier for the supplier invoice. |
| SupplierForSupplierInvoice_Href | String | A URL or reference link to the supplier for the supplier invoice instance. |
| SupplierForSupplierInvoice_Id | String | Unique identifier associated with the supplier for the supplier invoice. |
| SupplierInvoiceDefaultCompany_Descriptor | String | A brief, human-readable summary of the default company for supplier invoices. |
| SupplierInvoiceDefaultCompany_Id | String | Unique identifier for the default company associated with supplier invoices. |
| SupplierInvoiceReferenceNumber | String | The supplier invoice reference number associated with the supplier contract. |
| Supplier_Descriptor | String | A human-readable description of the supplier. |
| Supplier_Href | String | A URL or reference link to the supplier instance. |
| Supplier_Id | String | Unique identifier associated with the supplier. |
| TotalAmount_Currency | String | The total contract amount in the contract currency. |
| TotalAmount_Value | Decimal | The total contract value, which must be equal to or greater than the extended line amount. |
| CompanyOrHierarchy_Prompt | String | Filter for contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter for contracts by supplier contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter for contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter for contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter for contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter for contracts by external system reference ID. |
| OnHold_Prompt | Bool | Filter for contracts that are on hold. |
| StartDateOnOrAfter_Prompt | Date | Filter for contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter for contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter for contracts by status using the Workday ID of the status. |
| Supplier_Prompt | String | Filter for contracts by supplier using the Workday ID of the supplier. |
Links supplier contracts to associated product or service catalogs.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract instance. |
| SupplierContracts_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier contract. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| CompanyOrHierarchy_Prompt | String | Filter supplier contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter supplier contracts by contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter supplier contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter supplier contracts using the external system reference ID. |
| OnHold_Prompt | Bool | Filter supplier contracts that are on hold (true/false). |
| StartDateOnOrAfter_Prompt | Date | Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter supplier contracts by status using the Workday ID. |
| Supplier_Prompt | String | Filter supplier contracts by supplier using the Workday ID of the supplier. |
Tracks charge control policies for supplier contracts.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract instance. |
| SupplierContracts_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier contract. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| MaximumAmount_Currency | String | The currency of the maximum charge control amount for the charge control rule on the source transaction or transaction line. |
| MaximumAmount_Value | Decimal | The maximum charge control amount for the charge control rule on the source transaction or transaction line. Used in condition rules to control spending on target transactions. |
| MinimumAmount_Currency | String | The currency of the minimum charge control amount for the charge control rule on the source transaction or transaction line. |
| MinimumAmount_Value | Decimal | The minimum charge control amount for the charge control rule on the source transaction or transaction line. Used in condition rules to control spending on target transactions. |
| CompanyOrHierarchy_Prompt | String | Filter supplier contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter supplier contracts by contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter supplier contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter supplier contracts using the external system reference ID. |
| OnHold_Prompt | Bool | Filter supplier contracts that are on hold (true/false). |
| StartDateOnOrAfter_Prompt | Date | Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter supplier contracts by status using the Workday ID. |
| Supplier_Prompt | String | Filter supplier contracts by supplier using the Workday ID of the supplier. |
Manages multiple participant entries within supplier contracts.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract instance. |
| SupplierContracts_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier contract. |
| Company_Descriptor | String | A human-readable description of the company associated with the contract. |
| Company_Id | String | Unique identifier for the company instance. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Inactive | Bool | Indicates whether the entry on the participant list for a multi-participant contract is inactive (true/false). |
| CompanyOrHierarchy_Prompt | String | Filter supplier contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter supplier contracts by contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter supplier contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter supplier contracts using the external system reference ID. |
| OnHold_Prompt | Bool | Filter supplier contracts that are on hold (true/false). |
| StartDateOnOrAfter_Prompt | Date | Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter supplier contracts by status using the Workday ID. |
| Supplier_Prompt | String | Filter supplier contracts by supplier using the Workday ID of the supplier. |
Stores multi-supplier contract details, linking contracts to multiple vendors.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract instance. |
| SupplierContracts_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier contract. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Inactive | Bool | Indicates whether the supplier entry on the Supplier List for a Multi-Supplier Contract is inactive (true/false). |
| MarkupPercent | Decimal | The markup percentage applied to the unit cost of supplier items associated with the supplier. |
| Supplier_Descriptor | String | A human-readable description of the supplier. |
| Supplier_Href | String | A URL or reference link to the supplier instance. |
| Supplier_Id | String | Unique identifier associated with the supplier. |
| CompanyOrHierarchy_Prompt | String | Filter supplier contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter supplier contracts by contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter supplier contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter supplier contracts using the external system reference ID. |
| OnHold_Prompt | Bool | Filter supplier contracts that are on hold (true/false). |
| StartDateOnOrAfter_Prompt | Date | Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter supplier contracts by status using the Workday ID. |
| Supplier_Prompt | String | Filter supplier contracts by supplier using the Workday ID of the supplier. |
Tracks service line details within supplier contracts.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
maximumAmount: Currency /* The \~maximum charge control amount\~ of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. */
minimumAmount: Currency /* The \~minimum charge control amount\~ of the charge control rule for the source transaction or transaction line. The amount can be used in condition rules to control spending on target transactions or transaction lines. */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
percentRecoverable: Numeric /* The tax recoverable percentage for tax recoverability. */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
worktagType: { /* The worktag type for the worktag. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier contract line instance. |
| SupplierContracts_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier contract. |
| ChargeControls_Aggregate | String | A list of charge control rules applied to the transaction or transaction line. |
| CompanyForInvoice_Descriptor | String | A human-readable description of the company associated with the invoice. |
| CompanyForInvoice_Id | String | Unique identifier for the company associated with the invoice. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| DoNotAutoRenew | Bool | Indicates whether the supplier contract line is marked as 'Do Not Auto Renew' (true/false). Editable only when the contract type allows renewal terms. |
| ExtendedAmount_Currency | String | The currency of the extended amount for the document line, excluding tax-only invoices. |
| ExtendedAmount_Value | Decimal | The extended amount for the document line, excluding tax-only invoices. |
| Item_Descriptor | String | A human-readable description of the item associated with the contract line. |
| Item_Href | String | A URL or reference link to the item instance. |
| Item_Id | String | Unique identifier associated with the item. |
| LineDescription | String | The description of the supplier contract line item. |
| LineEndDate | Datetime | The end date of the supplier contract line. |
| LineIsCanceled | Bool | Indicates whether the supplier contract line is canceled (true/false). Canceled lines cannot be ordered, received, or invoiced. |
| LineNumber | String | The line number of the supplier contract line. |
| LineOnHold | Bool | Indicates whether the supplier contract line is on hold (true/false). On-hold lines cannot be added to purchase orders, supplier invoices, or installments. |
| LineStartDate | Datetime | The start date of the supplier contract line. |
| Location_Descriptor | String | A human-readable description of the location associated with the contract line. |
| Location_Href | String | A URL or reference link to the location instance. |
| Location_Id | String | Unique identifier associated with the location. |
| Memo | String | The memo associated with the document line. |
| RenewalAmount_Currency | String | The currency of the renewal amount for this supplier contract line. |
| RenewalAmount_Value | Decimal | The amount to be renewed for the supplier contract line when auto-renewed. |
| Retention | Bool | Indicates whether the retention checkbox is selected for the line (true/false). |
| ShipToAddress_Descriptor | String | A human-readable description of the shipping address. |
| ShipToAddress_Href | String | A URL or reference link to the shipping address instance. |
| ShipToAddress_Id | String | Unique identifier associated with the shipping address. |
| ShipToContact_Descriptor | String | A human-readable description of the shipping contact. |
| ShipToContact_Href | String | A URL or reference link to the shipping contact instance. |
| ShipToContact_Id | String | Unique identifier associated with the shipping contact. |
| SpendCategory_Descriptor | String | A human-readable description of the spend category. |
| SpendCategory_Href | String | A URL or reference link to the spend category instance. |
| SpendCategory_Id | String | Unique identifier associated with the spend category. |
| TaxApplicability_Descriptor | String | A human-readable description of the tax applicability. |
| TaxApplicability_Href | String | A URL or reference link to the tax applicability instance. |
| TaxApplicability_Id | String | Unique identifier associated with the tax applicability. |
| TaxCode_Descriptor | String | A human-readable description of the tax code. |
| TaxCode_Href | String | A URL or reference link to the tax code instance. |
| TaxCode_Id | String | Unique identifier associated with the tax code. |
| TaxRecoverabilities_Aggregate | String | A list of tax recoverabilities on a taxable document line. |
| Worktags_Aggregate | String | All worktags associated with the related business object. |
| CompanyOrHierarchy_Prompt | String | Filter supplier contracts by company or company hierarchy using the Workday ID. |
| ContractSpecialist_Prompt | String | Filter supplier contracts by contract specialist using the Workday ID or reference ID. |
| ContractType_Prompt | String | Filter supplier contracts by type using the Workday ID of the contract type. |
| EndDateOnOrAfter_Prompt | Date | Filter supplier contracts with an end date on or after the specified date (yyyy-mm-dd). |
| EndDateOnOrBefore_Prompt | Date | Filter supplier contracts with an end date on or before the specified date (yyyy-mm-dd). |
| ExternalSystemReference_Prompt | String | Filter supplier contracts using the external system reference ID. |
| OnHold_Prompt | Bool | Filter supplier contracts that are on hold (true/false). |
| StartDateOnOrAfter_Prompt | Date | Filter supplier contracts with a start date on or after the specified date (yyyy-mm-dd). |
| StartDateOnOrBefore_Prompt | Date | Filter supplier contracts with a start date on or before the specified date (yyyy-mm-dd). |
| Status_Prompt | String | Filter supplier contracts by status using the Workday ID. |
| Supplier_Prompt | String | Filter supplier contracts by supplier using the Workday ID of the supplier. |
Tracks individual line items within supplier invoice requests.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier invoice request line instance. |
| SupplierInvoiceRequests_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request. |
| Billable | Bool | Indicates whether the supplier invoice request line or line split is billable (true/false). |
| Descriptor | String | A brief, human-readable summary of the instance. |
| ExtendedAmount_Currency | String | The currency of the extended amount for the document line, excluding tax-only invoices. |
| ExtendedAmount_Value | Decimal | The extended amount for the document line, excluding tax-only invoices. |
| InternalMemo | String | The internal memo associated with the supplier invoice request line. |
| ItemDescription | String | The text-only description of the item on the document line. |
| Item_Descriptor | String | A human-readable description of the item associated with the document line. |
| Item_Href | String | A URL or reference link to the item instance. |
| Item_Id | String | Unique identifier associated with the item. |
| Memo | String | The memo associated with the document line. |
| Quantity | Decimal | The quantity of items on the transaction line, precise to two decimal places. Can be a negative value. |
| SpendCategory_Descriptor | String | A human-readable description of the spend category. |
| SpendCategory_Href | String | A URL or reference link to the spend category instance. |
| SpendCategory_Id | String | Unique identifier associated with the spend category. |
| SplitBy_Descriptor | String | A human-readable description of how the supplier invoice request line is split. |
| SplitBy_Href | String | A URL or reference link to the split method instance. |
| SplitBy_Id | String | Unique identifier associated with the split method. |
| Type | String | The type of the supplier invoice request line (for example, item, service, charge). |
| UnitCost_Currency | String | The currency of the unit cost for the document line. |
| UnitCost_Value | Decimal | The unit cost for the document line. |
| UnitOfMeasure_Descriptor | String | A human-readable description of the unit of measure. |
| UnitOfMeasure_Href | String | A URL or reference link to the unit of measure instance. |
| UnitOfMeasure_Id | String | Unique identifier associated with the unit of measure. |
| Company_Prompt | String | Filter supplier invoice requests by company. Used for internal REST API purposes. |
| FromDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | Filter supplier invoice requests by requester using the Workday ID. |
| Status_Prompt | String | Filter supplier invoice requests by status. Used for internal REST API purposes. |
| Supplier_Prompt | String | Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Stores item identifier data for supplier invoice request line items.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier invoice request line instance. |
| SupplierInvoiceRequestsLines_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request line. |
| SupplierInvoiceRequests_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Company_Prompt | String | Filter supplier invoice requests by company. Used for internal REST API purposes. |
| FromDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | Filter supplier invoice requests by requester using the Workday ID. |
| Status_Prompt | String | Filter supplier invoice requests by status. Used for internal REST API purposes. |
| Supplier_Prompt | String | Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Links item tags to supplier invoice request line items.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier invoice request line instance. |
| SupplierInvoiceRequestsLines_Id [KEY] | String | Workday-generated unique ID linking this record to the supplier invoice request line. |
| SupplierInvoiceRequests_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Company_Prompt | String | Filter supplier invoice requests by company. Used internally for REST API purposes. |
| FromDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | Filter supplier invoice requests by the requester using the Workday ID. |
| Status_Prompt | String | Filter supplier invoice requests by status. Used internally for REST API purposes. |
| Supplier_Prompt | String | Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Manages cost distribution across split line items within supplier invoices.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier invoice request line split instance. |
| SupplierInvoiceRequestsLines_Id [KEY] | String | Workday-generated unique ID linking this record to the supplier invoice request line. |
| SupplierInvoiceRequests_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request. |
| Amount_Currency | String | The currency of the amount on the transaction line split. This value matches the business document currency. |
| Amount_Value | Decimal | The amount allocated to the transaction line split, displayed in the business document currency. |
| Billable | Bool | Indicates whether the supplier invoice request line or line split is billable (true/false). |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Memo | String | A memo or additional note for the line split. |
| Percent | Decimal | The percentage allocated to this distribution line split of the business document. |
| Quantity | Decimal | The quantity allocated to this distribution line split of the business document. |
| Worktags_Aggregate | String | A list of worktags associated with the document line split. |
| Company_Prompt | String | Filter supplier invoice requests by company. Used internally for REST API purposes. |
| FromDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | Filter supplier invoice requests by the requester using the Workday ID. |
| Status_Prompt | String | Filter supplier invoice requests by status. Used internally for REST API purposes. |
| Supplier_Prompt | String | Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Associates worktags with supplier invoice request line items.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for this supplier invoice request line instance. |
| SupplierInvoiceRequestsLines_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request line. |
| SupplierInvoiceRequests_Id [KEY] | String | Workday-generated unique ID linking this record to the associated supplier invoice request. |
| Descriptor | String | A brief, human-readable summary of the instance. |
| Company_Prompt | String | Filter supplier invoice requests by company. Used internally for REST API purposes. |
| FromDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or after this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is based on the invoice date. |
| FromInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or after this date (MM/DD/YYYY format). |
| Requester_Prompt | String | Filter supplier invoice requests by the requester using the Workday ID. |
| Status_Prompt | String | Filter supplier invoice requests by status. Used internally for REST API purposes. |
| Supplier_Prompt | String | Filter supplier invoice requests by supplier using the Workday ID. |
| ToDueDate_Prompt | Date | Filter supplier invoice requests with a payment due date on or before this date (MM/DD/YYYY format). Example: If payment terms are Net 30, the due date is 30 days from the invoice date. |
| ToInvoiceDate_Prompt | Date | Filter supplier invoice requests created on or before this date (MM/DD/YYYY format). |
Retrieves real-time system metrics, including active sessions, queued tasks, and performance data.
| Name | Type | Description |
| ActiveUserSessions | Decimal | The current number of active user sessions in the system. |
| QueuedTasks | Decimal | The number of tasks currently queued in the system awaiting execution. |
| RunningTasks | Decimal | The number of tasks actively running in the system. |
Fetches company-specific tax rate values, including applicable tax jurisdictions and employer-specific rates.
| Name | Type | Description |
| Id [KEY] | String | The unique identifier for the instance. |
| Descriptor | String | A brief description or preview of the instance. |
| CollectionToken | String | A token representing a collection of related records. Use this value with Collection_Prompt to retrieve collection members. NULL if the row represents a single value rather than a collection. |
| Collection_Prompt | String | Provides a value from the CollectionToken column to retrieve all child elements within the specified collection. |
Provides a list of state-level tax rate values applicable to an organization’s payroll processing.
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the instance, also known as Workday ID, used for tracking and referencing specific records. |
| Descriptor | String | A brief description or label providing context about the instance. |
| CollectionToken | String | A token representing a collection of related records. Use this value with Collection_Prompt to retrieve all members of the collection. If NULL, the row represents a single value rather than a collection. |
| Collection_Prompt | String | An input parameter that accepts a CollectionToken value to fetch all child elements within a specified collection. |
Lists possible status values for time-off requests, including pending, approved, denied, and processed states.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance (Workday ID). |
| Descriptor | String | A descriptive label for the instance, providing a human-readable name or summary. |
| CollectionToken | String | A reference token used to identify and retrieve members of a collection. NULL if the instance is a standalone value and not part of a collection. |
| Collection_Prompt | String | Provides the CollectionToken value to retrieve all child elements of a specified collection. |
Retrieves the default time entry codes mapped to different time types, ensuring correct classification of recorded time.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance (Workday ID). |
| Descriptor | String | A descriptive label for the instance, providing a human-readable name or summary. |
| CollectionToken | String | A reference token used to identify and retrieve members of a collection. NULL if the instance is a standalone value and not part of a collection. |
| Collection_Prompt | String | Provides the CollectionToken value to retrieve all child elements of a specified collection. |
| Date_Prompt | Date | Specifies the effective date to retrieve time types for a given worker, using the yyyy-mm-dd format. |
| InOutCodeOnly_Prompt | Bool | If true, retrieves only Time Entry Codes of the type In/Out, which must be used with POST Time Clock Event. |
| Project_Prompt | String | Filters project plan tasks to those associated with a given project using its Workday ID. |
| Worker_Prompt | String | Filters time types by the Workday ID of a specified worker. |
Links time types to specific project plan tasks, enabling accurate tracking of billable and non-billable work hours.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance (Workday ID). |
| Descriptor | String | A descriptive label for the instance, providing a human-readable name or summary. |
| CollectionToken | String | A reference token used to retrieve members of a collection. NULL if the instance is a standalone value and not part of a collection. |
| Collection_Prompt | String | Provides the CollectionToken value to retrieve all child elements of a specified collection. |
| Date_Prompt | Date | Specifies the effective date for retrieving applicable time types for a worker, using the yyyy-mm-dd format. |
| InOutCodeOnly_Prompt | Bool | If true, returns only Time Entry Codes of type 'In/Out', which must be used with the POST Time Clock Event request. |
| Project_Prompt | String | Filters project plan tasks by a specific project using its Workday ID. |
| Worker_Prompt | String | Filters time types by the Workday ID of the specified worker. |
Maps time types to projects, ensuring correct assignment of hours worked within Workday’s project management framework.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance (Workday ID). |
| Descriptor | String | A descriptive label for the instance, providing a human-readable name or summary. |
| CollectionToken | String | A reference token used to retrieve members of a collection. NULL if the instance is a standalone value and not part of a collection. |
| Collection_Prompt | String | Specifies the CollectionToken value to retrieve all child elements within a collection. |
| Date_Prompt | Date | Filters time types based on an effective date for a given worker, using the yyyy-mm-dd format. |
| InOutCodeOnly_Prompt | Bool | If true, returns only Time Entry Codes classified as 'In/Out', which are required for use with the POST Time Clock Event request. |
| Project_Prompt | String | Filters project plan tasks by the specified project's Workday ID. |
| Worker_Prompt | String | Filters time types by the Workday ID of the specified worker. |
Provides a list of valid time entry codes associated with different time types used in Workday’s time-tracking module.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance (Workday ID). |
| Descriptor | String | A descriptive label providing a human-readable name or summary of the instance. |
| CollectionToken | String | A reference token used to retrieve members of a collection. NULL if the instance is a standalone value and not part of a collection. |
| Collection_Prompt | String | Specifies a CollectionToken value to retrieve all child elements within the corresponding collection. |
| Date_Prompt | Date | Filters time types based on an effective date for a given worker, formatted as yyyy-mm-dd. |
| InOutCodeOnly_Prompt | Bool | If true, returns only Time Entry Codes classified as 'In/Out', required for use with the POST Time Clock Event request. |
| Project_Prompt | String | Filters project plan tasks by the specified project's Workday ID. |
| Worker_Prompt | String | Filters time types by the Workday ID of the specified worker. |
Retrieves a collection of validation rules applied to time entry submissions, ensuring compliance with business policies.
| Name | Type | Description |
| CriticalValidations | String | A list of critical validation messages, separated by line feed characters (hex code in JSON). These messages indicate that the requested objects failed configured critical custom validations. |
| WarningValidations | String | A list of warning validation messages, separated by line feed characters (hex code in JSON). These messages indicate that the requested objects failed configured warning custom validations. |
| Date_Prompt | Date | Specifies the required date to determine applicable time entry validations. The method validates time entries within the week or time period of the specified date. |
| Worker_Prompt | String | The required Workday ID of the worker who entered the time entries. |
Lists the reasons associated with an employee's time-out entries, such as break periods, end-of-shift, or off-site work.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the instance. |
| Descriptor | String | A brief description of the instance. |
| CollectionToken | String | A token used with the Collection_Prompt input to retrieve members of this collection. NULL if the row represents a single value instead of a collection. |
| Collection_Prompt | String | A reference to a CollectionToken value. When provided, it retrieves all child elements within the specified collection. |
| Date_Prompt | Date | The effective date for retrieving time values associated with a given worker. |
| Worker_Prompt | String | The Workday ID of the worker for whom time values are being retrieved. |
Usage information for the operation TimeValuesPositionsValues.rsd.
| Name | Type | Description |
| Id [KEY] | String | wid / id / reference id |
| Descriptor | String | A description of the instance |
| CollectionToken | String | Use this value with the Collection_Prompt input to retrieve members of this collection. NULL if the row is a value and not a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| Date_Prompt | Date | The effective date to look up time values for a given worker. |
| Worker_Prompt | String | The Workday ID of the worker to look up time values for. |
Retrieves a list of valid time zones associated with workers to support accurate time-tracking and reporting.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the instance. |
| Descriptor | String | A brief description of the instance. |
| CollectionToken | String | A token used with Collection_Prompt to retrieve all members of a collection. NULL if the row represents a single value instead of a collection. |
| Collection_Prompt | String | A reference to a CollectionToken value. Providing this input retrieves all child elements within the specified collection. |
| Date_Prompt | Date | The effective date for retrieving time values associated with a given worker. |
| Worker_Prompt | String | The Workday ID of the worker for whom time values are being retrieved. |
Retrieves detailed worker records, including employment history, job assignments, and organizational roles.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the instance. |
| Descriptor | String | A preview of the worker instance. |
| Person_Email | String | The primary public work email address of the worker. |
| Person_Id | String | The Workday ID of the worker instance. |
| Person_Phone | String | The primary public work phone number of the worker. |
| PrimaryJob_BusinessTitle | String | The business title associated with the worker’s primary job. |
| PrimaryJob_Descriptor | String | A preview of the worker’s primary job instance. |
| PrimaryJob_Id | String | The Workday ID of the worker’s primary job. |
| PrimaryJob_JobProfile_Descriptor | String | A preview of the job profile associated with the worker’s primary job. |
| PrimaryJob_JobProfile_Id | String | The Workday ID of the job profile for the primary job. |
| PrimaryJob_JobType_Descriptor | String | A preview of the job type associated with the worker’s primary job. |
| PrimaryJob_Location_Country_Descriptor | String | A preview of the country where the worker’s primary job is located. |
| PrimaryJob_Location_Descriptor | String | A preview of the specific location of the worker’s primary job. |
| PrimaryJob_Location_Id | String | The Workday ID of the location associated with the worker’s primary job. |
| PrimaryJob_SupervisoryOrganization_Descriptor | String | A preview of the supervisory organization managing the worker’s primary job. |
| PrimaryJob_SupervisoryOrganization_Id | String | The Workday ID of the supervisory organization. |
| PrimaryJob_WorkSpace_Descriptor | String | A preview of the workspace associated with the worker’s primary job. |
| PrimaryJob_WorkSpace_Id | String | The Workday ID of the workspace. |
| PrimaryJob_WorkSpace_LocationChain | String | The full location hierarchy (breadcrumb) of the worker’s workspace. |
| WorkerId | String | The unique Employee ID or Contingent Worker ID assigned to the worker. |
| WorkerType_Descriptor | String | A description of the worker type (for example, employee, contingent worker). |
| WorkerType_Href | String | A link to the worker type instance. |
| WorkerType_Id | String | The Workday ID of the worker type instance. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches for workers by name or Worker ID. Case-insensitive and allows space-delimited OR searches. |
Fetches additional job assignments linked to workers who hold multiple positions within an organization.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the job instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this job. |
| BusinessTitle | String | The official business title for the worker’s position. |
| Descriptor | String | A preview of the job instance, typically including key identifying details. |
| JobProfile_Descriptor | String | A preview of the job profile associated with this position. |
| JobProfile_Id | String | The Workday ID of the job profile linked to the position. |
| JobType_Descriptor | String | A description of the type of job (for example, full-time, part-time, contract). |
| Location_Country_Descriptor | String | A preview of the country where the worker’s position is located. |
| Location_Descriptor | String | A preview of the specific location associated with the worker’s position. |
| Location_Id | String | The Workday ID of the location instance. |
| SupervisoryOrganization_Descriptor | String | A preview of the supervisory organization responsible for this position. |
| SupervisoryOrganization_Id | String | The Workday ID of the supervisory organization. |
| WorkSpace_Descriptor | String | A preview of the workspace associated with the worker’s position. |
| WorkSpace_Id | String | The Workday ID of the workspace instance. |
| WorkSpace_LocationChain | String | The full location hierarchy (breadcrumb navigation) of the workspace. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches for workers by name or Worker ID. The search is case-insensitive and supports space-delimited OR searches. |
Retrieves comments linked to anytime feedback events recorded as part of Workday's business process workflow.
| Name | Type | Description |
| WorkersAnytimeFeedbackEvents_Id | String | The Workday ID of the Anytime Feedback event that contains this comment. |
| Workers_Id | String | The Workday ID of the worker associated with this comment. |
| Comment | String | The feedback comment provided in the Anytime Feedback event. |
| CommentDate | Datetime | The date and time when the comment was originally created. |
| Person_Descriptor | String | A description of the person who provided the feedback. |
| Person_Href | String | A link to the person instance in Workday. |
| Person_Id | String | The Workday ID of the person who provided the feedback. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Searches workers by name or worker ID. The search is case-insensitive and supports space-delimited OR searches. |
Lists categories associated with a worker’s development items, such as leadership training or technical skill development.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the development item instance. |
| WorkersDevelopmentItems_Id [KEY] | String | The Workday ID of the development item container associated with this record. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this development item. |
| Descriptor | String | A brief preview or description of the development item. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Links development items to broader career goals, helping employees align training with job expectations.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the development item instance. |
| WorkersDevelopmentItems_Id [KEY] | String | The Workday ID of the development item collection that includes this instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker to whom this development item belongs. |
| Descriptor | String | A brief preview or summary of the development item. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves specific skills associated with a worker’s development plan, aiding in competency tracking.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the development item instance. |
| WorkersDevelopmentItems_Id [KEY] | String | The Workday ID of the development item collection that includes this instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker to whom this development item belongs. |
| Descriptor | String | A brief preview or summary of the development item. |
| RemoteID | String | The external system's unique identifier for a skill associated with this development item. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a list of direct reports for a worker, providing insight into hierarchical relationships.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the worker instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this record. |
| BusinessTitle | String | The worker's business title for their primary position. If no business title is set, the position title is used. |
| Descriptor | String | A brief preview or summary of the worker's record. |
| Href | String | A direct link to the worker's instance in Workday. |
| IsManager | Bool | Indicates whether the worker holds a managerial role. |
| PrimarySupervisoryOrganization_Descriptor | String | A description of the worker's primary supervisory organization. |
| PrimarySupervisoryOrganization_Href | String | A direct link to the worker's primary supervisory organization. |
| PrimarySupervisoryOrganization_Id | String | The Workday ID of the primary supervisory organization. |
| PrimaryWorkEmail | String | The worker’s primary work email address. |
| PrimaryWorkPhone | String | The worker’s primary work phone number, including the country and area code. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a list of absence types available to a worker, such as vacation, sick leave, or parental leave, based on their eligibility and company policies.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the absence type instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this absence type. |
| AbsenceTypeGroup_Descriptor | String | A brief preview or summary of the absence type group. |
| AbsenceTypeGroup_DisplayOrder | String | The display order of the absence type group. |
| AbsenceTypeGroup_Id | String | The Workday ID of the absence type group. |
| CalculateQuantityBasedOnStartAndEndTime | Bool | Indicates whether the quantity is calculated based on start and end times for the time off type. |
| Category_Descriptor | String | A description of the absence category. |
| Category_Href | String | A direct link to the absence category instance. |
| Category_Id | String | The Workday ID of the absence category. |
| DailyDefaultQuantity | Decimal | The default daily quantity for the absence type. |
| Descriptor | String | A preview of the coordinated absence type. |
| DisplayStartAndEndTime | Bool | Indicates whether start and end times are enabled for this time off type. |
| EntryOption_Descriptor | String | A description of the entry option for this absence type. |
| EntryOption_Href | String | A direct link to the entry option instance. |
| EntryOption_Id | String | The Workday ID of the entry option. |
| PositionBased | Bool | Indicates whether the time off type or leave type is position-based. |
| ReasonRequired | Bool | Indicates whether a reason is required for the time off type, absence table, or leave type. |
| StartAndEndTimeRequired | Bool | Indicates whether start and end times are required for this time off type. |
| UnitOfTime_Descriptor | String | A description of the unit of time associated with the absence type. |
| UnitOfTime_Href | String | A direct link to the unit of time instance. |
| UnitOfTime_Id | String | The Workday ID of the unit of time. |
| Category_Prompt | String | The Workday ID of the absence type category. Valid values depend on the Workday configuration. |
| Effective_Prompt | Date | The effective date for retrieving eligible absence types for the worker. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches the predefined reasons associated with each eligible absence type, ensuring proper classification and compliance with leave policies.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the eligible absence type instance. |
| WorkersEligibleAbsenceTypes_Id [KEY] | String | The Workday ID of the parent instance containing this eligible absence type. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this eligible absence type. |
| Descriptor | String | A brief preview or summary of the absence type. |
| Category_Prompt | String | The Workday ID of the absence type category. Valid values depend on the Workday configuration. |
| Effective_Prompt | Date | The effective date used to determine eligible absence types for the worker. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves any additional fields linked to absence types, such as required approvals, supporting documentation, or specific absence conditions.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the eligible absence type instance. |
| WorkersEligibleAbsenceTypes_Id [KEY] | String | The Workday ID of the parent instance that contains this eligible absence type. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this eligible absence type. |
| Descriptor | String | A brief preview or summary of the absence type. |
| Required | Bool | Indicates if additional leave fields are required for this absence type. True if required. |
| Category_Prompt | String | The Workday ID of the absence type category. Valid values depend on the Workday configuration. |
| Effective_Prompt | Date | The effective date used to determine eligible absence types for the worker. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Provides details on how eligible absence types vary by worker position, ensuring position-based leave eligibility is correctly managed.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the eligible absence type instance. |
| WorkersEligibleAbsenceTypes_Id [KEY] | String | The Workday ID of the parent entity containing this eligible absence type. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this eligible absence type. |
| Descriptor | String | A brief preview or summary of the absence type. |
| Category_Prompt | String | Filters absence types by category. Specify the Workday ID of the absence type category. |
| Effective_Prompt | Date | Filters eligible absence types based on the specified effective date (yyyy-mm-dd format). |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the results. |
| Search_Prompt | String | Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a worker’s personal and professional goals, including development plans and performance objectives.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the goal record. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this goal. |
| CompletedOn | Datetime | The date when the goal was marked as completed. |
| CreatedBy_Descriptor | String | The name or description of the user who created the goal. |
| CreatedBy_Href | String | A URL link to the profile of the user who created the goal. |
| CreatedBy_Id | String | The Workday ID of the user who created the goal. |
| Description | String | A detailed description of the goal. |
| DueDate | Datetime | The deadline for completing the goal. |
| Name | String | The title or name of the goal. |
| State | String | Indicates the current state of the goal and whether it is editable or requires action. Possible states: Pending approval, Associated with In Progress Review, Pending archival, Pending restore, Saved for later, and Needs revising. |
| Status_Descriptor | String | The name or description of the current status of the goal. |
| Status_Href | String | A URL link to the status details of the goal. |
| Status_Id | String | The Workday ID associated with the status of the goal. |
| Supports_Descriptor | String | The name or description of another goal or initiative that this goal supports. |
| Supports_Href | String | A URL link to the related goal or initiative that this goal supports. |
| Supports_Id | String | The Workday ID of the goal or initiative that this goal supports. |
| Worker_Descriptor | String | The name or description of the worker who owns this goal. |
| Worker_Href | String | A URL link to the worker's profile. |
| Worker_Id | String | The Workday ID of the worker associated with this goal. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Searches for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches activities associated with a worker’s goals, such as milestones, progress updates, or feedback related to goal completion.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the goal instance. |
| WorkersGoals_Id [KEY] | String | The Workday ID of the goal record associated with the worker. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this goal. |
| Descriptor | String | A brief summary or preview of the goal instance. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Links worker goals to associated performance reviews, providing insights into progress and evaluation alignment.
| Name | Type | Description |
| Id [KEY] | String | Unique Workday ID for the goal instance. |
| WorkersGoals_Id [KEY] | String | The Workday ID of the goal record associated with the worker. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this goal. |
| Descriptor | String | A brief summary or preview of the goal instance. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves the categories assigned to worker goals, such as career growth, leadership development, or compliance training.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the goal instance. |
| WorkersGoals_Id [KEY] | String | The Workday ID of the goal record linked to the worker. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this goal. |
| Descriptor | String | A summary or preview of the goal instance. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Links worker goals to broader initiatives, such as department objectives or company-wide targets, for performance tracking.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the goal instance. |
| WorkersGoals_Id [KEY] | String | The Workday ID of the goal record associated with the worker. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this goal. |
| Descriptor | String | A summary or preview of the goal instance. |
| Type | String | Specifies the type of talent tag associated with the goal. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves historical employment records for a worker, including job changes, salary adjustments, and departmental transfers.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the business process instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this business process. |
| Descriptor | String | A summary or preview of the business process instance. |
| Due | Datetime | The deadline by which the business process must be completed. |
| Effective | Datetime | The date on which this business process takes effect. |
| Href | String | A direct link to the business process instance in Workday. |
| Initiated | Datetime | The date and time when this business process was initiated. |
| Initiator_Descriptor | String | A preview of the person who initiated the business process. |
| Initiator_Href | String | A direct link to the initiator's Workday profile. |
| Initiator_Id | String | The Workday ID of the person who initiated this business process. |
| Subject_Descriptor | String | A preview of the subject related to this business process. |
| Subject_Href | String | A direct link to the subject's Workday profile. |
| Subject_Id | String | The Workday ID of the subject related to this business process. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches pending and completed tasks from a worker's Workday inbox, such as approvals, performance evaluations, and training assignments.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the event record. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this event record. |
| Assigned | Datetime | The date when the event record was last updated. |
| Descriptor | String | A summary or preview of the event record. |
| Due | Datetime | The due date for this step in the business process. |
| Href | String | A direct link to the event record in Workday. |
| Initiator_Descriptor | String | A preview of the person who initiated the event. |
| Initiator_Href | String | A direct link to the initiator's Workday profile. |
| Initiator_Id | String | The Workday ID of the person who initiated this event. |
| OverallProcess_Descriptor | String | A preview of the overall business process associated with this step. |
| OverallProcess_Href | String | A direct link to the overall process in Workday. |
| OverallProcess_Id | String | The Workday ID of the overall business process. |
| Status_Descriptor | String | A summary of the current status of this event. |
| Status_Href | String | A direct link to the status details in Workday. |
| Status_Id | String | The Workday ID of the status associated with this event. |
| StepType_Descriptor | String | A preview of the type of step in the business process. |
| StepType_Href | String | A direct link to the step type details in Workday. |
| StepType_Id | String | The Workday ID of the step type. |
| Subject_Descriptor | String | A preview of the subject related to this event. |
| Subject_Href | String | A direct link to the subject's Workday profile. |
| Subject_Id | String | The Workday ID of the subject related to this event. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the search results. |
| Search_Prompt | String | Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves detailed information on leaves of absence taken by a worker, including duration, type of leave, and status.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the leave of absence record. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this leave of absence. |
| ActualLastDayOfLeave | Datetime | The actual last day of work for the leave of absence (yyyy-mm-dd format). |
| AdditionalFields_AdoptionNotificationDate | Datetime | The date the adoption was notified (yyyy-mm-dd format). |
| AdditionalFields_AdoptionPlacementDate | Datetime | The date the adopted child was placed (yyyy-mm-dd format). |
| AdditionalFields_AgeOfDependent | Decimal | The age of the dependent at the time of the leave. |
| AdditionalFields_CaesareanSectionBirth | Bool | Indicates whether the leave is due to a caesarean birth, which may affect leave entitlements. |
| AdditionalFields_ChildDisabilityIndicator | Bool | Indicates whether the leave is related to a child with a disability, which may affect leave entitlements. |
| AdditionalFields_ChildsBirthDate | Datetime | The birth date of the child (yyyy-mm-dd format). |
| AdditionalFields_ChildsDateOfDeath | Datetime | The date of the child’s death (yyyy-mm-dd format). |
| AdditionalFields_DateBabyArrivedHomeFromHospital | Datetime | The date the baby arrived home from the hospital (yyyy-mm-dd format). |
| AdditionalFields_DateChildEnteredCountry | Datetime | The date the adopted child entered the country (yyyy-mm-dd format). |
| AdditionalFields_DateOfRecall | Datetime | The recall date for the leave (yyyy-mm-dd format). |
| AdditionalFields_Dependent_Descriptor | String | A summary of the dependent associated with the leave. |
| AdditionalFields_Dependent_Href | String | A link to the dependent's details in Workday. |
| AdditionalFields_Dependent_Id | String | The Workday ID of the dependent. |
| AdditionalFields_ExpectedDueDate | Datetime | The expected due date for the leave (yyyy-mm-dd format). |
| AdditionalFields_LastDateForWhichPaid | Datetime | The last date for which the worker received paid leave (yyyy-mm-dd format). |
| AdditionalFields_LeaveEntitlementOverride | Decimal | Custom leave entitlement override amount. |
| AdditionalFields_LeavePercentage | Decimal | Percentage of leave entitlement used. |
| AdditionalFields_LocationDuringLeave | String | The location where the worker will be during the leave. |
| AdditionalFields_MultipleChildIndicator | Bool | Indicates whether the leave is for multiple children (for example, twins, triplets). |
| AdditionalFields_NeonatalCareDischargeDate | Datetime | Neonatal Care Discharge Date. |
| AdditionalFields_NeonatalCareStartDate | Datetime | Neonatal Care Start Date. |
| AdditionalFields_NumberOfBabiesAdoptedChildren | Decimal | The number of babies or adopted children associated with this leave. |
| AdditionalFields_NumberOfChildDependents | Decimal | The number of child dependents relevant to the leave. |
| AdditionalFields_NumberOfPreviousBirths | Decimal | The number of previous births recorded for the worker. |
| AdditionalFields_NumberOfPreviousMaternityLeaves | Decimal | The number of previous maternity leaves taken. |
| AdditionalFields_SingleParentIndicator | Bool | Indicates whether the worker is a single parent, which may affect leave entitlements. |
| AdditionalFields_SocialSecurityDisabilityCode | String | The social security disability code associated with the leave. |
| AdditionalFields_StillbirthBabyDeceased | Bool | Indicates whether the leave is related to a stillbirth or deceased baby. |
| AdditionalFields_StopPaymentDate | Datetime | The date when payments stop for this leave (yyyy-mm-dd format). |
| AdditionalFields_WeekOfConfinement | Datetime | The week of confinement related to maternity leave (yyyy-mm-dd format). |
| AdditionalFields_WorkRelated | Bool | Indicates whether the leave is work-related, which may impact certain legal and payroll considerations. |
| BusinessProcessStepStatus | String | Current step status of the business process associated with the leave. |
| EstimatedLastDayOfLeave | Datetime | The estimated last day of the leave (yyyy-mm-dd format). |
| FirstDayOfLeave | Datetime | The first day of the leave (yyyy-mm-dd format). |
| LastDayOfWork | Datetime | The last working day before the leave started (yyyy-mm-dd format). |
| LatestLeaveComment | String | The most recent comment related to the leave request. |
| LeaveImpactFields_AbsenceAccrualEffect | Bool | Indicates whether this leave impacts the worker's absence accrual balance. |
| LeaveImpactFields_BenefitEffect | Bool | Indicates whether this leave affects the worker’s benefits eligibility. |
| LeaveImpactFields_ContinuousServiceAccrualEffect | Bool | Indicates whether this leave affects the worker’s continuous service accrual. |
| LeaveImpactFields_InactivateWorker | Bool | If true, the worker will be inactivated in the Workday system for the duration of the leave. |
| LeaveImpactFields_PayrollEffect | Bool | Indicates whether this leave has an impact on payroll processing. |
| LeaveImpactFields_ProfessionalLeaveEffect | Bool | Indicates whether this leave is classified as a professional leave. |
| LeaveImpactFields_SabbaticalEffect | Bool | Indicates whether this leave affects sabbatical eligibility. |
| LeaveImpactFields_SchedulingEffect | Bool | Indicates whether the worker can still be scheduled to work during the leave. |
| LeaveImpactFields_StockVestingEffect | Bool | Indicates whether this leave affects stock vesting schedules. |
| LeaveImpactFields_TalentEffect | Bool | Indicates whether this leave affects the worker’s participation in talent-related processes. |
| LeaveImpactFields_TenureEffect | Bool | Indicates whether this leave affects the worker’s tenure record. |
| LeaveType_Descriptor | String | A summary of the type of leave taken. |
| LeaveType_Href | String | A link to the leave type details in Workday. |
| LeaveType_Id | String | The Workday ID of the leave type. |
| Position_Descriptor | String | A summary of the worker's position at the time of leave. |
| Position_Href | String | A link to the position details in Workday. |
| Position_Id | String | The Workday ID of the position. |
| PriorLeaveEvent_Descriptor | String | A summary of the prior leave event, if applicable. |
| PriorLeaveEvent_Href | String | A link to the prior leave event details in Workday. |
| PriorLeaveEvent_Id | String | The Workday ID of the prior leave event. |
| Reason_Descriptor | String | A summary of the reason for the leave. |
| Reason_Href | String | A link to the leave reason details in Workday. |
| Reason_Id | String | The Workday ID of the leave reason. |
| Status_Descriptor | String | A summary of the leave status. |
| Status_Href | String | A link to the leave status details in Workday. |
| Status_Id | String | The Workday ID of the leave status. |
| Worker_Descriptor | String | A summary of the worker taking the leave. |
| Worker_Href | String | A link to the worker’s profile in Workday. |
| Worker_Id | String | The Workday ID of the worker taking the leave. |
| FromDate_Prompt | Date | The start date for filtering leave records (yyyy-mm-dd format). |
| LeaveType_Prompt | String | The Workday ID of the leave type being filtered. |
| Status_Prompt | String | The Workday ID of the leave status being filtered (for example, Completed, In Progress, Canceled). |
| ToDate_Prompt | Date | The end date for filtering leave records (yyyy-mm-dd format). |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Allows searching workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves details about the organizations or departments a worker is associated with, including hierarchical structure and reporting relationships.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this organization. |
| Descriptor | String | A brief preview of the instance. |
| Href | String | A direct link to the instance in Workday. |
| OrganizationType_Descriptor | String | A description of the organization type. |
| OrganizationType_Href | String | A link to the organization type details in Workday. |
| OrganizationType_Id | String | The Workday ID of the organization type. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves pay slips for a worker, detailing earnings, deductions, tax information, and net pay over different pay periods.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the payslip instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this payslip. |
| Date | Datetime | The payment date for the payslip. |
| Descriptor | String | A brief preview of the payslip instance. |
| Gross | Decimal | Total gross pay amount for the payslip. |
| Href | String | A direct link to view the payslip instance in Workday. |
| Net | Decimal | Total net pay amount for the payslip after deductions. |
| Status_Descriptor | String | A description of the payslip status. |
| Status_Href | String | A link to detailed status information in Workday. |
| Status_Id | String | The Workday ID associated with the payslip status. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Fetches details about the worker’s applicable pay periods, leave cycles, or reporting periods based on their employment schedule.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the time entry period instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this time entry period. |
| CloseTimeEntry | Datetime | Timestamp when the time entry period is closed for submissions. |
| Descriptor | String | A brief preview of the time entry period instance. |
| LockTimeEntry | Datetime | Timestamp when the time entry period is locked from further modifications. |
| OpenTimeEntry | Datetime | Timestamp when the time entry period is open for worker submissions. |
| PaymentDate | Datetime | The scheduled payment date for the payroll period or time tracking. |
| PeriodEndDate | Datetime | The end date of the payroll or absence subperiod. |
| PeriodStartDate | Datetime | The start date of the payroll or absence subperiod. |
| UnlockTimeEntry | Datetime | Timestamp when the time entry period is unlocked for adjustments. |
| Date_Prompt | Date | Filters results by eligibility date in yyyy-mm-dd format. Defaults to the current date if not provided. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Allows searching for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves comments related to feedback requests initiated by a worker, providing additional context to the request.
| Name | Type | Description |
| WorkersRequestedFeedbackOnSelfEvents_Id | String | The Workday ID of the feedback request event initiated by the worker. |
| Workers_Id | String | The Workday ID of the worker who owns this feedback request. |
| Comment | String | The comment provided for the feedback request. |
| CommentDate | Datetime | Timestamp indicating when the feedback request instance was originally created. |
| Person_Descriptor | String | Description of the person related to the feedback request. |
| Person_Href | String | A link to the person’s instance in Workday. |
| Person_Id | String | Unique identifier of the person associated with the feedback request. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves comments provided in feedback requests related to a worker’s performance.
| Name | Type | Description |
| WorkersRequestedFeedbackOnWorkerEvents_Id | String | The Workday ID of the feedback event that contains this instance. |
| Workers_Id | String | The Workday ID of the worker associated with this feedback event. |
| Comment | String | The comment provided in the feedback. |
| CommentDate | Datetime | The timestamp when the feedback comment was created. |
| Person_Descriptor | String | A description of the person who provided the feedback. |
| Person_Href | String | A link to the profile of the person who provided the feedback. |
| Person_Id | String | Workday ID of the person who provided the feedback. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Search for workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves key service dates for a worker, including hire date, tenure milestones, and eligibility dates for benefits.
| Name | Type | Description |
| Workers_Id | String | The Workday ID of the worker who owns this record. |
| ContinuousServiceDate | Datetime | The worker's service start date, accounting for any breaks in service. |
| HireDate | Datetime | The most recent hire date of the worker. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Search workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Retrieves a collection of supervisory organizations that a worker manages, providing insight into their leadership responsibilities.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this record. |
| Code | String | The unique organization ID. |
| Descriptor | String | A preview of the instance. |
| Href | String | A link to the instance. |
| Manager_Descriptor | String | The manager's name or title. |
| Manager_Href | String | A link to the manager's profile. |
| Manager_Id | String | The Workday ID of the manager. |
| Name | String | The name of the organization. |
| Workers | String | A list of workers in the organization. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. The search is case-insensitive and supports space-separated OR searches. |
Provides a detailed breakdown of a worker’s time off, including leave type, usage, and remaining balance.
| Name | Type | Description |
| Workers_Id | String | The Workday ID of the worker who owns this time off entry. |
| Comment | String | A comment associated with the time off entry. |
| Date | Datetime | The date of the time off entry (format: yyyy-mm-dd). |
| Position_Descriptor | String | A preview of the worker's position. |
| Position_Href | String | A link to the position instance. |
| Position_Id | String | The Workday ID of the position. |
| Quantity | Decimal | The amount of time off taken, in units specified by the Unit response field. |
| Reason_Descriptor | String | A preview of the reason for the time off. |
| Reason_Href | String | A link to the reason instance. |
| Reason_Id | String | The Workday ID of the reason. |
| Status_Descriptor | String | A preview of the time off entry's status. |
| Status_Href | String | A link to the status instance. |
| Status_Id | String | The Workday ID of the status. |
| TimeOffType_Descriptor | String | The name of the time off type or absence category. |
| TimeOffType_Id | String | The Workday ID of the time off type. |
| Unit_Descriptor | String | A preview of the unit type for the time off entry. |
| Unit_Href | String | A link to the unit instance. |
| Unit_Id | String | The Workday ID of the unit type. |
| Worker_Descriptor | String | A preview of the worker associated with this entry. |
| Worker_Href | String | A link to the worker instance. |
| Worker_Id | String | The Workday ID of the worker. |
| FromDate_Prompt | Date | Filters time off entries from this start date (format: yyyy-mm-dd). |
| Status_Prompt | String | Filters entries by status using Workday IDs. Supports multiple statuses. |
| TimeOffType_Prompt | String | Filters entries by time off type using Workday IDs. Supports multiple types. |
| ToDate_Prompt | Date | Filters time off entries up to this end date (format: yyyy-mm-dd). |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. Case-insensitive and supports space-delimited OR searches. |
Retrieves individual time-off entries for a worker, including the request date, approval status, and duration.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the time off request line item. |
| Workers_Id [KEY] | String | The Workday ID of the worker who owns this request. |
| Date | Datetime | The specific date requested for paid time off (format: yyyy-mm-dd). |
| Descriptor | String | A preview of the time off request line item. |
| Employee_Descriptor | String | A preview of the employee requesting time off. |
| Employee_Href | String | A link to the employee's Workday profile. |
| Employee_Id | String | The Workday ID of the employee. |
| Href | String | A direct link to the time off request instance. |
| TimeOffRequest_Descriptor | String | A preview of the overall time off request. |
| TimeOffRequest_Href | String | A link to the time off request instance. |
| TimeOffRequest_Id | String | The Workday ID of the time off request. |
| TimeOffRequest_Status | String | The current status of the request (for example, Successfully Completed, Denied, Terminated). |
| TimeOff_Descriptor | String | A preview of the specific time off entry within the request. |
| TimeOff_Href | String | A link to the specific time off instance. |
| TimeOff_Id | String | The Workday ID of the time off entry. |
| TimeOff_Plan_Descriptor | String | A description of the associated time off plan. |
| TimeOff_Plan_Href | String | A link to the time off plan instance. |
| TimeOff_Plan_Id | String | The Workday ID of the time off plan. |
| UnitOfTime_Descriptor | String | A preview of the unit of time used (for example, Hours, Days). |
| UnitOfTime_Href | String | A link to the unit of time instance. |
| UnitOfTime_Id | String | The Workday ID of the unit of time. |
| Units | Decimal | The number of units (for example, hours/days) requested for time off, excluding adjustments. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. Case-insensitive and supports space-delimited OR searches. |
Retrieves the specific time-off plan a worker is enrolled in, outlining accrual rules and available balances.
| Name | Type | Description |
| Id [KEY] | String | The unique Workday ID of the time off balance instance. |
| Workers_Id [KEY] | String | The Workday ID of the worker associated with this balance. |
| Descriptor | String | A preview of the time off balance instance. |
| Href | String | A direct link to the time off balance instance. |
| TimeOffBalance | Decimal | The worker's current time off balance, including pending requests. Used within calculated fields. |
| UnitOfTime_Descriptor | String | A description of the unit of time used (for example, Hours, Days). |
| UnitOfTime_Href | String | A link to the unit of time instance. |
| UnitOfTime_Id | String | The Workday ID of the unit of time instance. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. The search is case-insensitive and supports space-delimited OR searches. |
Provides a summary of the total hours reported by a worker over a given period, including overtime and adjustments.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
label: Text /* Contains the label for this total calculation. */
quantity: Numeric /* Contains the calculated sum for this total. */
totalNumber: Numeric /* Contains the ordered number of this total calculation. */
}]
| Name | Type | Description |
| Workers_Id | String | The Workday ID of the worker associated with this time entry certification. |
| CertifyText | String | Legal text the worker must agree to when certifying hours worked. |
| PeriodLabel | String | A summary of the date range and total reported hours for the time entry period. |
| SubmitText | String | Legal text the worker must agree to when submitting hours for review. |
| Totals_Aggregate | String | A list of all total hours defined in the Time Entry Template. |
| PeriodDate_Prompt | Date | The specific date used to match a time entry period. Defaults to today's date if not specified. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the output. |
| Search_Prompt | String | Searches workers by name or Workday ID. The search is case-insensitive and supports space-delimited OR searches. |
Retrieves a list of workers who need to be notified about specific tasks, events, or updates related to time tracking or HR activities.
| Name | Type | Description |
| Id [KEY] | String | The Workday ID of the instance. |
| Descriptor | String | A brief description of the instance. |
| CollectionToken | String | A token used to retrieve members of this collection. NULL if the row represents a value and not a collection. |
| Collection_Prompt | String | A value from the CollectionToken column. Providing this input retrieves all children of the collection. |
| Workers_Prompt | String | A Workday ID or reference used to filter collections by worker. |
Lists valid time-off dates for a worker based on company policies, blackout periods, and accrual rules.
| Name | Type | Description |
| Workers_Id | String | The Workday ID of the worker who owns this time off entry. |
| DailyDefaultQuantity | Decimal | The daily default quantity configured on the Time Off Plan or overridden on the Time Off entry. |
| Date | Datetime | The date(s) of the time off entry. |
| Unit_Descriptor | String | A brief description of the unit of time used for the time off. |
| Unit_Id | String | The Workday ID of the unit associated with the time off entry. |
| Date_Prompt | Date | The date(s) being requested for validation in yyyy-mm-dd format. |
| Position_Prompt | String | The Workday ID of the worker’s position. |
| TimeOff_Prompt | String | The Workday ID of the specific time off entry. |
| IncludeTerminatedWorkers_Prompt | Bool | If true, includes terminated workers in the results. |
| Search_Prompt | String | Searches workers by name or worker ID. The search is case-insensitive and supports multiple space-delimited terms. |
Retrieves individual worker time blocks, detailing specific periods of reported work hours or absences.
| Name | Type | Description |
| Id [KEY] | String | Unique identifier for the reported time block instance. |
| AllocationPool_Descriptor | String | Description of the allocation pool associated with the reported time. |
| AllocationPool_Href | String | A link to the allocation pool instance. |
| AllocationPool_Id | String | Workday ID of the allocation pool. |
| Appropriation_Descriptor | String | Description of the appropriation tied to this time block. |
| Appropriation_Href | String | A link to the appropriation instance. |
| Appropriation_Id | String | Workday ID of the appropriation. |
| BusinessUnit_Descriptor | String | Description of the business unit linked to the reported time. |
| BusinessUnit_Href | String | A link to the business unit instance. |
| BusinessUnit_Id | String | Workday ID of the business unit. |
| CalendarDate | Datetime | The date for which the time block is reported. |
| Comment | String | The comment associated with the reported time block. |
| CostCenter_Descriptor | String | Description of the cost center assigned to this time block. |
| CostCenter_Href | String | A link to the cost center instance. |
| CostCenter_Id | String | Workday ID of the cost center. |
| Currency_Descriptor | String | Currency used in transactions related to this time block. |
| Currency_Href | String | A link to the currency instance. |
| Currency_Id | String | Workday ID of the currency. |
| CustomOrganization01_Descriptor | String | Description of the first custom organization. |
| CustomOrganization01_Href | String | A link to the first custom organization instance. |
| CustomOrganization01_Id | String | Workday ID of the first custom organization. |
| CustomOrganization02_Descriptor | String | Description of the second custom organization. |
| CustomOrganization02_Href | String | A link to the second custom organization instance. |
| CustomOrganization02_Id | String | Workday ID of the second custom organization. |
| CustomOrganization03_Descriptor | String | Description of the third custom organization. |
| CustomOrganization03_Href | String | A link to the third custom organization instance. |
| CustomOrganization03_Id | String | Workday ID of the third custom organization. |
| CustomOrganization04_Descriptor | String | Description of the fourth custom organization. |
| CustomOrganization04_Href | String | A link to the fourth custom organization instance. |
| CustomOrganization04_Id | String | Workday ID of the fourth custom organization. |
| CustomOrganization05_Descriptor | String | Description of the fifth custom organization. |
| CustomOrganization05_Href | String | A link to the fifth custom organization instance. |
| CustomOrganization05_Id | String | Workday ID of the fifth custom organization. |
| CustomOrganization06_Descriptor | String | Description of the sixth custom organization. |
| CustomOrganization06_Href | String | A link to the sixth custom organization instance. |
| CustomOrganization06_Id | String | Workday ID of the sixth custom organization. |
| CustomOrganization07_Descriptor | String | Description of the seventh custom organization. |
| CustomOrganization07_Href | String | A link to the seventh custom organization instance. |
| CustomOrganization07_Id | String | Workday ID of the seventh custom organization. |
| CustomOrganization08_Descriptor | String | Description of the eighth custom organization. |
| CustomOrganization08_Href | String | A link to the eighth custom organization instance. |
| CustomOrganization08_Id | String | Workday ID of the eighth custom organization. |
| CustomOrganization09_Descriptor | String | Description of the ninth custom organization. |
| CustomOrganization09_Href | String | A link to the ninth custom organization instance. |
| CustomOrganization09_Id | String | Workday ID of the ninth custom organization. |
| CustomOrganization10_Descriptor | String | Description of the tenth custom organization. |
| CustomOrganization10_Href | String | A link to the tenth custom organization instance. |
| CustomOrganization10_Id | String | Workday ID of the tenth custom organization. |
| CustomWorktag01_Descriptor | String | Description of the first custom worktag. |
| CustomWorktag01_Href | String | A link to the first custom worktag instance. |
| CustomWorktag01_Id | String | Workday ID of the first custom worktag. |
| CustomWorktag02_Descriptor | String | Description of the second custom worktag. |
| CustomWorktag02_Href | String | A link to the second custom worktag instance. |
| CustomWorktag02_Id | String | Workday ID of the second custom worktag. |
| CustomWorktag03_Descriptor | String | Description of the third custom worktag. |
| CustomWorktag03_Href | String | A link to the third custom worktag instance. |
| CustomWorktag03_Id | String | Workday ID of the third custom worktag. |
| CustomWorktag04_Descriptor | String | Description of the fourth custom worktag. |
| CustomWorktag04_Href | String | A link to the fourth custom worktag instance. |
| CustomWorktag04_Id | String | Workday ID of the fourth custom worktag. |
| CustomWorktag05_Descriptor | String | Description of the fifth custom worktag. |
| CustomWorktag05_Href | String | A link to the fifth custom worktag instance. |
| CustomWorktag05_Id | String | Workday ID of the fifth custom worktag. |
| CustomWorktag06_Descriptor | String | Description of the sixth custom worktag. |
| CustomWorktag06_Href | String | A link to the sixth custom worktag instance. |
| CustomWorktag06_Id | String | Workday ID of the sixth custom worktag. |
| CustomWorktag07_Descriptor | String | Description of the seventh custom worktag. |
| CustomWorktag07_Href | String | A link to the seventh custom worktag instance. |
| CustomWorktag07_Id | String | Workday ID of the seventh custom worktag. |
| CustomWorktag08_Descriptor | String | Description of the eighth custom worktag. |
| CustomWorktag08_Href | String | A link to the eighth custom worktag instance. |
| CustomWorktag08_Id | String | Workday ID of the eighth custom worktag. |
| CustomWorktag09_Descriptor | String | Description of the ninth custom worktag. |
| CustomWorktag09_Href | String | A link to the ninth custom worktag instance. |
| CustomWorktag09_Id | String | Workday ID of the ninth custom worktag. |
| CustomWorktag10_Descriptor | String | Description of the tenth custom worktag. |
| CustomWorktag10_Href | String | A link to the tenth custom worktag instance. |
| CustomWorktag10_Id | String | Workday ID of the tenth custom worktag. |
| CustomWorktag11_Descriptor | String | Description of the eleventh custom worktag. |
| CustomWorktag11_Href | String | A link to the eleventh custom worktag instance. |
| CustomWorktag11_Id | String | Workday ID of the eleventh custom worktag. |
| CustomWorktag12_Descriptor | String | Description of the twelfth custom worktag. |
| CustomWorktag12_Href | String | A link to the twelfth custom worktag instance. |
| CustomWorktag12_Id | String | Workday ID of the twelfth custom worktag. |
| CustomWorktag13_Descriptor | String | Description of the thirteenth custom worktag. |
| CustomWorktag13_Href | String | A link to the thirteenth custom worktag instance. |
| CustomWorktag13_Id | String | Workday ID of the thirteenth custom worktag. |
| CustomWorktag14_Descriptor | String | Description of the fourteenth custom worktag. |
| CustomWorktag14_Href | String | A link to the fourteenth custom worktag instance. |
| CustomWorktag14_Id | String | Workday ID of the fourteenth custom worktag. |
| CustomWorktag15_Descriptor | String | Description of the fifteenth custom worktag. |
| CustomWorktag15_Href | String | A link to the fifteenth custom worktag instance. |
| CustomWorktag15_Id | String | Workday ID of the fifteenth custom worktag. |
| Descriptor | String | A human-readable preview of the instance, providing a brief description or summary to aid in identification and context within reports or UI displays. |
| DoNotBill | Bool | Indicates if this reported time block is non-billable. |
| Fund_Descriptor | String | Description of the fund associated with this time block. |
| Fund_Href | String | A link to the fund instance. |
| Fund_Id | String | Workday ID of the fund. |
| Gift_Descriptor | String | Description of the gift associated with this time block. |
| Gift_Href | String | A link to the gift instance. |
| Gift_Id | String | Workday ID of the gift. |
| Grant_Descriptor | String | Description of the grant associated with this time block. |
| Grant_Href | String | A link to the grant instance. |
| Grant_Id | String | Workday ID of the grant. |
| InTime | Datetime | The clock-in time for this reported time block. |
| InTimeZone_Descriptor | String | Description of the time zone for clock-in. |
| InTimeZone_Href | String | A link to the time zone instance. |
| InTimeZone_Id | String | Workday ID of the time zone. |
| JobProfile_Descriptor | String | Description of the job profile associated with this time block. |
| JobProfile_Href | String | A link to the job profile instance. |
| JobProfile_Id | String | Workday ID of the job profile. |
| Location_Descriptor | String | Description of the location linked to this time block. |
| Location_Href | String | A link to the location instance. |
| Location_Id | String | Workday ID of the location. |
| OutReason_Descriptor | String | A human-readable description of the reason why a worker clocked out, providing context for reporting and analysis. |
| OutReason_Href | String | A URL link to the instance of the out reason record in Workday, enabling direct navigation to its details. |
| OutReason_Id | String | A unique identifier for the out reason, used to reference this instance programmatically. |
| OutTime | Datetime | The exact timestamp when the worker clocked out, recorded for payroll and attendance tracking. |
| OutTimeZone_Descriptor | String | A human-readable description of the time zone in which the out time was recorded. |
| OutTimeZone_Href | String | A URL link to the time zone instance associated with the out time. |
| OutTimeZone_Id | String | A unique identifier for the time zone associated with the out time. |
| OverrideRate | Decimal | A manually overridden pay rate applicable to this reported time block, if different from the default rate. |
| Position_Descriptor | String | A human-readable description of the worker's position at the time of the reported event. |
| Position_Href | String | A URL link to the instance of the worker's position in Workday. |
| Position_Id | String | A unique identifier for the position, used for reference in Workday transactions. |
| Program_Descriptor | String | A description of the program associated with the reported time block, used for financial and project tracking. |
| Program_Href | String | A URL link to the Workday instance of the program. |
| Program_Id | String | A unique identifier for the program, used for reference in system queries. |
| ProjectPlanPhase_Descriptor | String | A human-readable description of the phase within a project plan to which the time block is linked. |
| ProjectPlanPhase_Href | String | A URL link to the Workday instance of the project plan phase. |
| ProjectPlanPhase_Id | String | A unique identifier for the project plan phase. |
| ProjectPlanTask_Descriptor | String | A human-readable description of the project task associated with the time block. |
| ProjectPlanTask_Href | String | A URL link to the Workday instance of the project plan task. |
| ProjectPlanTask_Id | String | A unique identifier for the project plan task. |
| ProjectRole_Descriptor | String | A description of the worker’s role within the project, providing insight into their assigned duties. |
| ProjectRole_Href | String | A URL link to the Workday instance of the project role. |
| ProjectRole_Id | String | A unique identifier for the project role. |
| Project_Descriptor | String | A human-readable description of the project associated with the reported time block. |
| Project_Href | String | A URL link to the Workday instance of the project. |
| Project_Id | String | A unique identifier for the project. |
| Region_Descriptor | String | A human-readable description of the region associated with the reported time block, useful for geographic tracking. |
| Region_Href | String | A URL link to the Workday instance of the region. |
| Region_Id | String | A unique identifier for the region. |
| ReportedQuantity | Decimal | The number of hours or units entered for a reported time block, used for payroll and resource tracking. |
| Status_Descriptor | String | A description of the status of the reported time block, such as 'Approved' or 'Pending Approval'. |
| Status_Href | String | A URL link to the Workday instance of the status. |
| Status_Id | String | A unique identifier for the time block status. |
| TimeEntryCode_Descriptor | String | A description of the time entry code applied to this reported time block, indicating the type of work performed. |
| TimeEntryCode_Href | String | A URL link to the Workday instance of the time entry code. |
| TimeEntryCode_Id | String | A unique identifier for the time entry code. |
| Unit_Descriptor | String | A human-readable description of the unit of time (for example, hours, days) used for the reported time block. |
| Unit_Href | String | A URL link to the Workday instance of the unit. |
| Unit_Id | String | A unique identifier for the unit. |
| Worker_Descriptor | String | A human-readable description of the worker associated with the reported time block, typically their name. |
| Worker_Href | String | A URL link to the Workday instance of the worker. |
| Worker_Id | String | A unique identifier for the worker. |
| FromDate_Prompt | Date | The start date of the time block date range filter, formatted as yyyy-mm-dd, used for querying records. |
| Phase_Prompt | String | The Workday ID of the project plan phase associated with the time block, used for filtering results. |
| ProjectPlanTask_Prompt | String | The Workday ID of the project plan task associated with the time block, used for filtering results. |
| Project_Prompt | String | The Workday ID of the project associated with the time block, used for filtering results. |
| Status_Prompt | String | The Workday ID of the approval status of the worker's time block, used to filter records. Valid IDs include: 'Approved', 'Pending', 'Denied'. |
| ToDate_Prompt | Date | The end date of the time block date range filter, formatted as yyyy-mm-dd, used for querying records. |
| Worker_Prompt | String | The Workday ID of the worker associated with the time block, specifying which worker’s records to retrieve. |
Fetches detailed calculations applied to worker time blocks, including adjustments for overtime, breaks, and pay rate variations.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| Id [KEY] | String | A unique identifier for the time block instance, used for system reference and reporting. |
| WorkerTimeBlocks_Id [KEY] | String | The Workday ID of the parent WorkerTimeBlocks instance that contains this time block, linking the time block to its worker. |
| CalculatedDate | Datetime | The system-calculated date for a time block, based on business rules such as shift start times and adjustments. |
| CalculatedInTimeZone_Descriptor | String | A human-readable description of the time zone where the in-time for the time block was calculated. |
| CalculatedInTimeZone_Href | String | A URL link to the Workday instance of the in-time time zone. |
| CalculatedInTimeZone_Id | String | A unique identifier for the in-time time zone associated with the calculated time block. |
| CalculatedOutTimeZone_Descriptor | String | A human-readable description of the time zone where the out-time for the time block was calculated. |
| CalculatedOutTimeZone_Href | String | A URL link to the Workday instance of the out-time time zone. |
| CalculatedOutTimeZone_Id | String | A unique identifier for the out-time time zone associated with the calculated time block. |
| CalculatedQuantity | Decimal | The system-generated number of hours or units worked within the time block, accounting for break periods and rounding rules. |
| CalculationTags_Aggregate | String | A collection of calculation tags applied to the time block, typically generated by time calculation rules in Workday. This is blank if the time block is not a calculated entry. |
| CalendarDate | Datetime | The actual date associated with the time block entry, often used for payroll processing and compliance tracking. |
| Currency_Descriptor | String | A human-readable description of the currency used for calculations related to this time block, if applicable. |
| Currency_Href | String | A URL link to the Workday instance of the currency used in this time block. |
| Currency_Id | String | A unique identifier for the currency associated with this time block. |
| OverrideRate | Decimal | The manually entered or system-calculated override rate applied to this time block, different from the worker’s standard rate. |
| ShiftDate | Datetime | The date the worker's shift started for this time block, used for scheduling and payroll reconciliation. |
| FromDate_Prompt | Date | The start date of the time block date range filter, formatted as yyyy-mm-dd, used for querying records within a specific period. |
| Phase_Prompt | String | The Workday ID of the project plan phase associated with the time block, used for filtering project-related time blocks. |
| ProjectPlanTask_Prompt | String | The Workday ID of the specific project plan task linked to the time block, helping track hours worked on tasks. |
| Project_Prompt | String | The Workday ID of the project associated with the time block, used for tracking work performed on specific projects. |
| Status_Prompt | String | The Workday ID of the approval status of the worker's time block, used to filter records. Valid IDs include statuses such as 'Approved', 'Pending', 'Denied'. |
| ToDate_Prompt | Date | The end date of the time block date range filter, formatted as yyyy-mm-dd, used to retrieve records within a specific period. |
| Worker_Prompt | String | The Workday ID of the worker associated with the time block, used for filtering records by individual worker. |
The Workday REST API contains different types of entities, each of which must each be accessed separately. The performance, structure, and requirements for inserting and modifying roles varies depending on the category of the table.
Each type of table has its own rules for determining primary and foreign keys. Foreign keys are always prefixed with the name of the table they refer to. For example, the Requisitions_Id column on the RequisitionsWorktags child table refers to the Id column of the Requisitions parent table.
In addition, each type of table exposes different prompt columns. The next section goes into detail on when these prompts take effect.
Each type of table handles filters on its Id columns differently:
Each type of table also has its own behaviors around prompts:
Owned and owned child tables have the additional requirement that their owner's Id must be given in order to read from them.
This can be done in several ways:
-- Provide one or multiple owner Id values
SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id = '...'
SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id IN ('...', '...')
--- Provide a collection of owner Ids via subquery
SELECT * FROM RequisitionsRequisitionLines WHERE Requisitions_Id IN (SELECT Id FROM Requisitions)
-- If no subquery or values are given, the Cloud automatically adds the appropriate subquery
SELECT * FROM RequisitionsRequisitionLines
Prompts are also considered when the Cloud generates subqueries for owned and owned child entities.
For example, if this query is executed:
SELECT * FROM RequisitionsRequisitionLines WHERE FromDate_Prompt = 'January 1 2020' AND ToDate_Prompt = 'March 31 2020'
The Cloud includes the date prompts in the generated subquery because they are inherited from the Requisitions table:
SELECT * FROM RequisitionsRequisitionLines WHERE Requisisions_Id IN ( SELECT Id FROM Requisitions WHERE FromDate_Prompt = 'January 1 2020' AND ToDate_Prompt = 'March 31 2020' )
Note that some owned tables include prompts with a _Prompt_For_ suffix. This means that both the owned table and the owner table have a prompt with the same name. For example, DataSourcesDataSourceFilters includes a prompt called Alias_Prompt which accepts the alias of the filter, as well as a prompt called Alias_Prompt_For_DataSources which accepts the alias of the data source that owns the filter.
Some REST entities are tables that can be used with INSERT, UPDATE, or DELETE. However, note that not every table supports every operation.
To perform an INSERT, the query must specify owner and parent Ids (when the table has them) in addition to writable data fields.
An INSERT must never include values for the Id column or any prompts.
For example, all of these queries are valid INSERTs:
-- No Id on a base table
INSERT INTO ExpenseEntries(Amount_Currency, Amount_Value, Date) VALUES ('USD', 185.67, 'June 1 2021')
-- Parent Id on a child table
INSERT INTO ExpenseEntriesAttachments(ExpenseEntries_Id, ContentType_Id, FileName) VALUES ('...', '...', 'receipt.jpg')
-- Owner Id on an owned table
INSERT INTO WorkersBusinessTitleChanges(Workers_Id, ProposedBusinessTitle) VALUES ('...', 'Head of Security')
Ids are not required to perform an UPDATE or a DELETE.
If the Id, parent Id or owner Id is missing the Cloud will first find all matching rows and then update or delete them individually:
-- Delete a single row by Id DELETE FROM ExpenseEntries WHERE Id = '...' -- Delete a single child row by Id DELETE FROM ExpenseEntriesAttachments WHERE Id = '...' AND ExpenseEntries_Id = '...' -- Delete all children belonging to the same parent DELETE FROM ExpenseEntriesAttachments WHERE Id = '...'
The Workday REST API exposes several resources that allow you to discover ID values, which can be used for certain fields. All value tables have names ending in Values and share the same basic structure:
CollectionToken column and Collection_Prompt are used for hierarchical resources like location data or organizations. You must issue multiple queries to get prompt values out of these resources:
For example, the Change Organization Assignment business process has two stored procedures, BeginOrganizationAssignmentChange and SubmitOrganizationAssignmentChange, along with several tables that control the parameters of the business process. At a high level, the procedure for invoking these business processes is as follows:
The Cloud exposes two types of change tables: collection change tables and single-value change tables.
Collection change tables support SELECT, INSERT, UPDATE, and DELETE.
They represent bulk changes that are applied to an entity, such as adding multiple addresses or phone numbers to a single worker.
SELECT * FROM WorkContactInformationChangesWebAddresses WHERE WorkContactInformationChange_Id = 'abcxyz123'
INSERT INTO WorkContactInformationChangesWebAddresses( WorkContactInformationChange_Id, Url, Usage_Primary, Usage_UsageType_Id)
VALUES ('abcxyz123', 'https://www.company.com/~bobsmith', true, '...')
UPDATE WorkContactInformationChangesWebAddresses
SET Usage_Comment = 'Worker home page'
WHERE WorkContactInformationChange_Id = 'abcxyz123'
AND Id = '...'
DELETE FROM WorkContactInformationChangesWebAddresses
WHERE WorkContactInformationChange_Id = 'abcxyz123'
Single-value change tables support only SELECT and UPDATE.
They represent parameters that can have only a single value in the entire business process.
For example, when changing a job's organization, the job can only be moved to a single target company.
SELECT * FROM OrganizationAssignmentChangesCompany WHERE OrganizationAssignmentChange_Id = 'abcxyz123' UPDATE OrganizationAssignmentChangesCompany SET Company_Id = '...' WHERE OrganizationAssignmentChange_Id = 'abcxyz123'
For details on supported operations for each change table, see its documentation.
The Workday REST API exposes several resources that allow you to discover ID values, which can be used for certain fields. All value tables have names ending in Values and share the same basic structure:
CollectionToken column and Collection_Prompt are used for hierarchical resources like location data or organizations. You must issue multiple queries to get prompt values out of these resources:
The Workday REST API has a concept of change resources, which are used to configure and execute certain business processes. The Cloud supports these change resources by providing a family of tables and stored procedures that act on each business process.
For example, the Change Organization Assignment business process has two stored procedures, BeginOrganizationAssignmentChange and SubmitOrganizationAssignmentChange, along with several tables that control the parameters of the business process. At a high level, the procedure for invoking these business processes is as follows:
The Cloud exposes two types of change tables: collection change tables and single-value change tables.
Collection change tables support SELECT, INSERT, UPDATE, and DELETE.
They represent bulk changes that are applied to an entity, such as adding multiple addresses or phone numbers to a single worker.
SELECT * FROM WorkContactInformationChangesWebAddresses WHERE WorkContactInformationChange_Id = 'abcxyz123'
INSERT INTO WorkContactInformationChangesWebAddresses( WorkContactInformationChange_Id, Url, Usage_Primary, Usage_UsageType_Id)
VALUES ('abcxyz123', 'https://www.company.com/~bobsmith', true, '...')
UPDATE WorkContactInformationChangesWebAddresses
SET Usage_Comment = 'Worker home page'
WHERE WorkContactInformationChange_Id = 'abcxyz123'
AND Id = '...'
DELETE FROM WorkContactInformationChangesWebAddresses
WHERE WorkContactInformationChange_Id = 'abcxyz123'
Single-value change tables support only SELECT and UPDATE.
They represent parameters that can have only a single value in the entire business process.
For example, when changing a job's organization, the job can only be moved to a single target company.
SELECT * FROM OrganizationAssignmentChangesCompany WHERE OrganizationAssignmentChange_Id = 'abcxyz123' UPDATE OrganizationAssignmentChangesCompany SET Company_Id = '...' WHERE OrganizationAssignmentChange_Id = 'abcxyz123'
For details on supported operations for each change table, see its documentation.
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Workday.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Workday, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| Authorizations | Check subjectId permissions against featureId for each target Id |
| BeginHomeContactInformationChange | Usage information for the operation BeginHomeContactInformationChange.rsb. |
| BeginJobChange | Initiates a job change request for a specific worker |
| BeginOrganizationAssignmentChange | Retrieves a single organization assignment change event instance. |
| BeginWorkContactInformationChange | Usage information for the operation BeginWorkContactInformationChange.rsb. |
| CasesReopen | Updates an existing resolved case instance |
| CreateMentorshipForMe | Creates a mentorship for the current processing worker where the user is also the mentee. |
| CreateMentorshipForWorker | Creates a mentorship between two workers. |
| CreateWQLSchema | Creates a custom schema file that executes a specific WQL query. |
| DefinitionsActivate | Usage information for the operation DefinitionsActivate.rsb. |
| ElectronicReportingRuns | The Electronic Reporting service enables applications to create information on electronic reporting of customer and supplier invoice documents. |
| EventsCancel | Cancels a business process event. |
| EventStepsApprove | Approves a business process event step. |
| EventStepsDeny | Denies a business process event step. |
| EventStepsQuestionnaire | Post an action for a Complete Questionnaire step in a business process. |
| EventStepsSendBack | Sends back a business process event step. |
| EventStepsToDo | Post an action for a To Do step in a business process. |
| ExecuteSOAPOperation | Sends a request to directly invoke a SOAP operation. |
| ExpenseEntriesAttachments | Creates new attachments for the existing expense entry. |
| ExpenseReportsLines | Creates a collection of expense report lines. |
| ExpenseReportsSubmit | Usage information for the operation ExpenseReportsSubmit.rsb. |
| MentorshipsClose | Closes the mentorship. |
| MentorshipsEdit | Edit the mentorship. |
| Notifications | POST Inbound Notifications request. |
| PhoneValidation | Validates phone number data to ensure it is valid for Workday. |
| Programs | Creates a single benefit program instance. |
| ProjectsEdit | Creates Project Edit Events and initiates the associated workflow to update the project. |
| RequestsClose | Closes a request. |
| RequisitionsCancel | Cancels an existing requisition. |
| RequisitionsClose | Closes a specified completed requisition. |
| RequisitionsRequisitionEvents | Submit Requisition to Business Process |
| ResourcePlanLinesEdit | Creates a Resource Plan Line Edit event and initiates the Project Resource Plan Line business process. |
| RunBudgetCheck | Creates a budget check for transactions. |
| SendMessage | Usage information for the operation SendMessage.rsb. |
| SubmitHomeContactInformationChange | Submit the specified contact change ID. |
| SubmitJobChange | Submit the specified change job ID. |
| SubmitOrganizationAssignmentChange | Submits the organization changes request for the specified ID, and initiates the Change Organization Assignment business process. |
| SubmitWorkContactInformationChange | Submit the specified contact change ID. |
| SupplierInvoiceRequestsSubmit | Submits a single supplier invoice instance. |
| ValidateWorktags | Validates worktags. |
| WorkersOrganizationAssignmentChanges | Initiates an organization assignment change for a specific worker. |
| WorkersRequestOneTimePayment | Request a one-time payment for a worker with the specified ID. |
| WorkersRequestTimeOff | Creates a time off request for the specified worker ID and initiates the business process. |
| WorkersTimeReviewEvents | Creates a Time Review Event or Time Review Events. |
Check subjectId permissions against featureId for each target Id
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 /* Target ID */
-permissions: [{
-id: Text /* Permission ID */
}]
}]
| Name | Type | Description |
| FeatureId | String | Identifier for the external payroll feature being evaluated for authorization. |
| SubjectId | String | Identifier for the entity (e.g., user, role) being evaluated for authorization. |
| Targets_Aggregate | String | List of targets for which the subject's authorization is being checked. |
| Name | Type | Description |
| FeatureId | String | Identifier for the external payroll feature being evaluated for authorization. |
| SubjectId | String | Identifier for the entity (e.g., user, role) being evaluated for authorization. |
| Targets_Aggregate | String | List of targets for which the subject's authorization is being checked. |
Usage information for the operation BeginHomeContactInformationChange.rsb.
| Name | Type | Description |
| Worker_Id | String | Unique identifier for the worker whose home contact information is being updated. |
| Descriptor | String | A brief preview or summary of the instance for reference. |
| EffectiveDate | Datetime | The date when the home contact information change takes effect. |
| Href | String | The URL linking to the REST resource where this event can be managed. |
| Id | String | Unique identifier for the specific instance of the change process. |
| Name | Type | Description |
| HomeContactInformationChange_Id | String | Unique identifier for the home contact information change process, used for updating and submitting changes. |
Initiates a job change request for a specific worker
| Name | Type | Description |
| Worker_Id | String | Unique identifier for the worker undergoing the job change. |
| Date | Datetime | The effective date when the job change process is implemented. |
| Descriptor | String | A brief preview or summary of the job change instance. |
| Id | String | Unique identifier for the job change process instance. |
| Job_Id | String | Unique identifier or reference ID for the new job position. |
| Location_Id | String | Unique identifier or reference ID for the worker’s new job location. |
| Reason_Id | String | Unique identifier or reference ID for the reason behind the job change. |
| SupervisoryOrganization_Id | String | Unique identifier or reference ID for the new supervisory organization. |
| Template_Id | String | Unique identifier or reference ID for the job change template applied. |
| Name | Type | Description |
| JobChange_Id | String | Unique identifier for the job change process, used for updating and submitting changes. |
Retrieves a single organization assignment change event instance.
| Name | Type | Description |
| Date | Datetime | The effective date of the organization assignment change event in yyyy-mm-dd format. |
| Descriptor | String | A brief preview or summary of the organization assignment change instance. |
| Id | String | Unique identifier for the organization assignment change process instance. |
| MassActionHeader_Id | String | Unique identifier or reference ID for the mass action header associated with this change. |
| MassActionWorksheet_Id | String | Unique identifier or reference ID for the mass action worksheet used in this process. |
| Position_Id | String | Unique identifier or reference ID for the worker’s position in the organization. |
| Name | Type | Description |
| OrganizationAssignmentChange_Id | String | Unique identifier for the organization assignment change process, used for updating and submitting changes. |
Usage information for the operation BeginWorkContactInformationChange.rsb.
| Name | Type | Description |
| Worker_Id | String | Unique identifier for the worker whose work contact information is being updated. |
| Descriptor | String | A brief preview or summary of the work contact information change instance. |
| EffectiveDate | Datetime | The date when the work contact information change takes effect. |
| Href | String | The URL linking to the REST resource where this work contact change event can be managed. |
| Id | String | Unique identifier for the specific instance of the work contact change process. |
| Name | Type | Description |
| WorkContactInformationChange_Id | String | Unique identifier for the work contact information change process, used for updating and submitting changes. |
Updates an existing resolved case instance
| Name | Type | Description |
| Cases_Id | String | Unique identifier for the case being reopened. |
| Comment_Content | String | Rich text comment associated with the case reopening process. |
| Comment_TextBody | String | Plain text comment associated with the case reopening process. |
| Id | String | Unique identifier for the specific instance of the case reopening process. |
| Name | Type | Description |
| Comment_Content | String | Rich text comment associated with the case reopening process. |
| Comment_TextBody | String | Plain text comment associated with the case reopening process. |
| Id | String | Unique identifier for the specific instance of the case reopening process. |
Creates a mentorship for the current processing worker where the user is also the mentee.
| Name | Type | Description |
| Comment | String | Comment entered by the processing person for the last event record, without security filtering. If empty, no comment was entered. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the mentorship instance. |
| MentorType_Id | String | Unique identifier or reference ID for the mentor type. |
| Mentor_Id | String | Unique identifier or reference ID for the assigned mentor. |
| Purpose | String | The proposed purpose or objective of the mentorship. |
| StartDate | Datetime | The proposed start date of the mentorship. |
| Name | Type | Description |
| Comment | String | Comment entered by the processing person for the last event record, without security filtering. If empty, no comment was entered. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the mentorship instance. |
| MentorType_Descriptor | String | Descriptive label for the mentor type. |
| MentorType_Href | String | URL link to the mentor type instance. |
| MentorType_Id | String | Unique identifier or reference ID for the mentor type. |
| Mentor_Descriptor | String | Descriptive label for the mentor. |
| Mentor_Href | String | URL link to the mentor instance. |
| Mentor_Id | String | Unique identifier or reference ID for the assigned mentor. |
| Purpose | String | The proposed purpose or objective of the mentorship. |
| StartDate | Datetime | The proposed start date of the mentorship. |
Creates a mentorship between two workers.
| Name | Type | Description |
| Comment | String | Comment entered by the processing person for the last event record, without security filtering. If empty, no comment was entered. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the mentorship instance. |
| Mentee_Id | String | Unique identifier or reference ID for the assigned mentee. |
| MentorType_Id | String | Unique identifier or reference ID for the mentor type. |
| Mentor_Id | String | Unique identifier or reference ID for the assigned mentor. |
| Purpose | String | The proposed purpose or objective of the mentorship. |
| StartDate | Datetime | The proposed start date of the mentorship. |
| Name | Type | Description |
| Comment | String | Comment entered by the processing person for the last event record, without security filtering. If empty, no comment was entered. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the mentorship instance. |
| Mentee_Descriptor | String | Descriptive label for the mentee. |
| Mentee_Href | String | URL link to the mentee instance. |
| Mentee_Id | String | Unique identifier or reference ID for the assigned mentee. |
| MentorType_Descriptor | String | Descriptive label for the mentor type. |
| MentorType_Href | String | URL link to the mentor type instance. |
| MentorType_Id | String | Unique identifier or reference ID for the mentor type. |
| Mentor_Descriptor | String | Descriptive label for the mentor. |
| Mentor_Href | String | URL link to the mentor instance. |
| Mentor_Id | String | Unique identifier or reference ID for the assigned mentor. |
| Purpose | String | The proposed purpose or objective of the mentorship. |
| StartDate | Datetime | The proposed start date of the mentorship. |
Creates a custom schema file that executes a specific WQL query.
The Cloud allows you to create tables from WQL queries using the CreateWQLSchema stored procedure.
With this stored procedure, you can take the output from the Convert Report to WQL task in Workday and pass it to the Cloud:
EXEC CreateWQLSchema TableName = 'FirstTenReports', WQL = 'SELECT reportName FROM myCustomReports LIMIT 10'
The table can be queried once the stored procedure completes.
By default the table is saved to a file and can be queried on other connections with the same Location setting.
SELECT * FROM FirstTenReports
Note that tables created this way do not support any server-side query optimizations. Operations that would normally be executed by Workday, such as GROUP BY, ORDER BY, and aggregations, are instead executed within the Cloud. This limits their performance compared to querying WQL sources through SQL.
Workday reports support filtering data sources using dynamic values, but Workday does not support converting these reports directly to WQL.
For example, if you create a report that limits the createdDate field to the last month, Convert Report to WQL will output WQL that contains the computed date.
The results from this query will not change if you execute it again next month:
SELECT reportName FROM myCustomReports WHERE createdDate > '2024-06-26'
The Cloud supports WQL parameters which lift this restriction.
When you create the table using a parameter, the Cloud exposes additional extra columns that you can use to provide dynamic values.
For example:
EXEC CreateWQLSchema TableName = 'ReportsCreatedDuring',
WQL = 'SELECT reportName FROM myCustomReports WHERE createdDate >= <<from_date>> AND createdDate <= <<to_date>>',
Parameters = 'from_date:DATE,to_date:DATE';
SELECT * FROM ReportsCreatedSince WHERE from_date_Prompt = DATEADD('month', -1, GETDATE()) AND to_date_Prompt = GETDATE()
The parameters are given as a comma-separated list, where each entry is the parameter name and parameter type separated by a colon. The Cloud supports the following parameter types. Make sure that the parameter type is the same as the type of the relevant field. The Cloud formats the value from the WHERE clause as needed (for example, dates are converted to the YYYY-mm-dd format)
| Name | Type | Description |
| TableName | String | Name of the table being created as part of the WQL schema. |
| WQL | String | The WQL (Workday Query Language) query that defines the schema execution. |
| Parameters | String | List of parameter names and data types required by the WQL query. Refer to documentation for details. |
| WriteToFile | String | Boolean flag indicating whether the schema should be written to a file. If false, it writes to FileStream or FileData output. |
| Name | Type | Description |
| Result | String | Indicates whether the schema creation process was successful. |
| FileData | String | Base64-encoded string representing the generated schema. Returned only if WriteToFile is false and FileStream is not set. |
Usage information for the operation DefinitionsActivate.rsb.
| Name | Type | Description |
| Definitions_Id | String | Unique identifier for the definition being activated. |
| Descriptor | String | A brief preview or summary of the definition instance. |
| Href | String | URL link to the definition instance. |
| Id | String | Unique identifier for the specific instance of the activation process. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the definition instance. |
| Href | String | URL link to the definition instance. |
| Id | String | Unique identifier for the specific instance of the activation process. |
The Electronic Reporting service enables applications to create information on electronic reporting of customer and supplier invoice documents.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| FileName | String | Name of the electronic reporting file created for tax authorities. |
| Id | String | Unique identifier for the electronic reporting instance. |
| IntegrationEvent | String | Event that triggered the electronic reporting process. |
| IntegrationEventEndDate | Datetime | End date of the reporting period covered by the file. |
| IntegrationEventStartDate | Datetime | Start date of the reporting period covered by the file. |
| InvoiceDocuments_Aggregate | String | List of customer or supplier invoice documents included in the electronic reporting file. |
| Name | Type | Description |
| FileName | String | Name of the electronic reporting file created for tax authorities. |
| Id | String | Unique identifier for the electronic reporting instance. |
| IntegrationEvent | String | Event that triggered the electronic reporting process. |
| IntegrationEventEndDate | Datetime | End date of the reporting period covered by the file. |
| IntegrationEventStartDate | Datetime | Start date of the reporting period covered by the file. |
| InvoiceDocuments_Aggregate | String | List of customer or supplier invoice documents included in the electronic reporting file. |
Cancels a business process event.
| Name | Type | Description |
| Events_Id | String | Unique identifier for the event being canceled. |
| Comment | String | Optional comment provided for the event cancellation. |
| Descriptor | String | A brief preview or summary of the event instance. |
| Id | String | Unique identifier for the specific instance of the cancellation process. |
| Status | String | Current status of the event after cancellation. |
| Name | Type | Description |
| Comment | String | Optional comment provided for the event cancellation. |
| Descriptor | String | A brief preview or summary of the event instance. |
| Id | String | Unique identifier for the specific instance of the cancellation process. |
| Status | String | Current status of the event after cancellation. |
Approves a business process event step.
| Name | Type | Description |
| EventSteps_Id | String | Unique identifier for the event step being approved. |
| Comment | String | User's comment regarding the event approval process. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| EventStatus_Id | String | Unique identifier or reference ID for the event status. |
| Id | String | Unique identifier for the specific instance of the event step approval process. |
| Name | Type | Description |
| Comment | String | User's comment regarding the event approval process. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| EventStatus_Descriptor | String | Descriptive label for the event status. |
| EventStatus_Href | String | URL link to the event status instance. |
| EventStatus_Id | String | Unique identifier or reference ID for the event status. |
| Id | String | Unique identifier for the specific instance of the event step approval process. |
Denies a business process event step.
| Name | Type | Description |
| EventSteps_Id | String | Unique identifier for the event step being denied. |
| Comment | String | User's comment explaining the reason for denying the event step. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| EventStatus_Id | String | Unique identifier or reference ID for the event status after denial. |
| Id | String | Unique identifier for the specific instance of the event step denial process. |
| StepAction_Id | String | Unique identifier or reference ID for the action taken when denying the event step. |
| Name | Type | Description |
| Comment | String | User's comment explaining the reason for denying the event step. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| EventStatus_Descriptor | String | Descriptive label for the event status after denial. |
| EventStatus_Href | String | URL link to the event status instance. |
| EventStatus_Id | String | Unique identifier or reference ID for the event status after denial. |
| Id | String | Unique identifier for the specific instance of the event step denial process. |
| StepAction_Descriptor | String | Descriptive label for the step action taken. |
| StepAction_Href | String | URL link to the step action instance. |
| StepAction_Id | String | Unique identifier or reference ID for the action taken when denying the event step. |
Post an action for a Complete Questionnaire step in a business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
answerDate: Date /* The answer in a date format. */
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. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
questionnaireAttachments: [{
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
}]
}]
| Name | Type | Description |
| EventSteps_Id | String | Unique identifier for the event step associated with the questionnaire. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the questionnaire process. |
| QuestionnaireResponse_Descriptor | String | A brief preview or summary of the questionnaire response instance. |
| QuestionnaireResponse_Id | String | Unique identifier for the questionnaire response instance. |
| QuestionnaireResponse_QuestionnaireAnswers_Aggregate | String | Collection of answers provided in response to the questionnaire. |
| QuestionnaireResponse_QuestionnaireTargetContext_Id | String | Unique identifier or reference ID for the questionnaire target context. |
| QuestionnaireResponse_QuestionnaireTarget_Id | String | Unique identifier or reference ID for the questionnaire target. |
| StepAction_Id | String | Unique identifier or reference ID for the action taken in response to the questionnaire. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the questionnaire process. |
| QuestionnaireResponse_Descriptor | String | A brief preview or summary of the questionnaire response instance. |
| QuestionnaireResponse_Id | String | Unique identifier for the questionnaire response instance. |
| QuestionnaireResponse_QuestionnaireAnswers_Aggregate | String | Collection of answers provided in response to the questionnaire. |
| QuestionnaireResponse_QuestionnaireTargetContext_Descriptor | String | Descriptive label for the questionnaire target context. |
| QuestionnaireResponse_QuestionnaireTargetContext_Href | String | URL link to the questionnaire target context instance. |
| QuestionnaireResponse_QuestionnaireTargetContext_Id | String | Unique identifier or reference ID for the questionnaire target context. |
| QuestionnaireResponse_QuestionnaireTarget_Descriptor | String | Descriptive label for the questionnaire target. |
| QuestionnaireResponse_QuestionnaireTarget_Href | String | URL link to the questionnaire target instance. |
| QuestionnaireResponse_QuestionnaireTarget_Id | String | Unique identifier or reference ID for the questionnaire target. |
| StepAction_Descriptor | String | Descriptive label for the action taken in response to the questionnaire. |
| StepAction_Href | String | URL link to the step action instance. |
| StepAction_Id | String | Unique identifier or reference ID for the action taken in response to the questionnaire. |
Sends back a business process event step.
| Name | Type | Description |
| EventSteps_Id | String | Unique identifier for the event step being sent back. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the event step send-back process. |
| Reason | String | User's comment explaining the reason for sending back the event step. |
| Status_Id | String | Unique identifier or reference ID for the event status after send-back. |
| To_Id | String | Unique identifier or reference ID for the person or entity receiving the sent-back event step. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the event step send-back process. |
| Reason | String | User's comment explaining the reason for sending back the event step. |
| Status_Descriptor | String | Descriptive label for the event status after send-back. |
| Status_Href | String | URL link to the event status instance. |
| Status_Id | String | Unique identifier or reference ID for the event status after send-back. |
| To_Descriptor | String | Descriptive label for the recipient of the sent-back event step. |
| To_Href | String | URL link to the recipient instance. |
| To_Id | String | Unique identifier or reference ID for the person or entity receiving the sent-back event step. |
Post an action for a To Do step in a business process.
| Name | Type | Description |
| EventSteps_Id | String | Unique identifier for the event step that needs to be completed. |
| Comment | String | Most recent comment related to the event step. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the event step. |
| StepAction_Id | String | Unique identifier or reference ID for the step action that needs to be completed. |
| Name | Type | Description |
| Comment | String | Most recent comment related to the event step. |
| Descriptor | String | A brief preview or summary of the event step instance. |
| Id | String | Unique identifier for the specific instance of the event step. |
| StepAction_Descriptor | String | Descriptive label for the step action. |
| StepAction_Href | String | URL link to the step action instance. |
| StepAction_Id | String | Unique identifier or reference ID for the step action that needs to be completed. |
Sends a request to directly invoke a SOAP operation.
| Name | Type | Description |
| Service | String | Name of the Workday SOAP service being called. |
| Request | String | The XML request payload sent to the SOAP API. |
| Name | Type | Description |
| Response | String | The XML response body from the SOAP API, or NULL if an error occurred. |
| FaultCode | String | SOAP error code if an error occurred, otherwise NULL. |
| FaultString | String | SOAP error message if an error occurred, otherwise NULL. |
Creates new attachments for the existing expense entry.
| Name | Type | Description |
| ExpenseEntries_Id | String | Unique identifier for the expense entry associated with the attachment. |
| ContentType_Id | String | Unique identifier or reference ID for the content type of the attachment. |
| Descriptor | String | A brief preview or summary of the expense entry attachment instance. |
| FileLength | Decimal | Size of the attachment file in bytes. |
| FileName | String | Name of the attached file. |
| Href | String | URL link to the attachment instance. |
| Id | String | Unique identifier for the specific instance of the expense entry attachment. |
| Name | Type | Description |
| ContentType_Descriptor | String | Descriptive label for the content type of the attachment. |
| ContentType_Href | String | URL link to the content type instance. |
| ContentType_Id | String | Unique identifier or reference ID for the content type of the attachment. |
| Descriptor | String | A brief preview or summary of the expense entry attachment instance. |
| FileLength | Decimal | Size of the attachment file in bytes. |
| FileName | String | Name of the attached file. |
| Href | String | URL link to the attachment instance. |
| Id | String | Unique identifier for the specific instance of the expense entry attachment. |
Creates a collection of expense report lines.
| Name | Type | Description |
| ExpenseReports_Id | String | Unique identifier for the expense report associated with the line item. |
| CreditCardTransaction_Id | String | Unique identifier or reference ID for the credit card transaction linked to this expense. |
| Date | Datetime | Date when the expense report line was created. |
| Descriptor | String | A brief preview or summary of the expense report line instance. |
| ExpenseItem_Id | String | Unique identifier or reference ID for the expense item associated with this line. |
| Id | String | Unique identifier for the specific instance of the expense report line. |
| Memo | String | Additional notes or details related to the expense report line. |
| QuickExpense_Id | String | Unique identifier or reference ID for the quick expense entry, if applicable. |
| TotalAmount_Currency | String | Currency of the total amount to be reimbursed. |
| TotalAmount_Value | Decimal | Total amount to be reimbursed to the requestee. |
| TravelBookingRecord_Id | String | Unique identifier or reference ID for the travel booking record associated with this expense. |
| Name | Type | Description |
| CreditCardTransaction_Descriptor | String | Descriptive label for the credit card transaction. |
| CreditCardTransaction_Href | String | URL link to the credit card transaction instance. |
| CreditCardTransaction_Id | String | Unique identifier or reference ID for the credit card transaction linked to this expense. |
| Date | Datetime | Date when the expense report line was created. |
| Descriptor | String | A brief preview or summary of the expense report line instance. |
| ExpenseItem_Descriptor | String | Descriptive label for the expense item. |
| ExpenseItem_Href | String | URL link to the expense item instance. |
| ExpenseItem_Id | String | Unique identifier or reference ID for the expense item associated with this line. |
| Id | String | Unique identifier for the specific instance of the expense report line. |
| Memo | String | Additional notes or details related to the expense report line. |
| QuickExpense_Descriptor | String | Descriptive label for the quick expense entry. |
| QuickExpense_Href | String | URL link to the quick expense entry instance. |
| QuickExpense_Id | String | Unique identifier or reference ID for the quick expense entry, if applicable. |
| TotalAmount_Currency | String | Currency of the total amount to be reimbursed. |
| TotalAmount_Value | Decimal | Total amount to be reimbursed to the requestee. |
| TravelBookingRecord_Descriptor | String | Descriptive label for the travel booking record. |
| TravelBookingRecord_Href | String | URL link to the travel booking record instance. |
| TravelBookingRecord_Id | String | Unique identifier or reference ID for the travel booking record associated with this expense. |
Usage information for the operation ExpenseReportsSubmit.rsb.
| Name | Type | Description |
| ExpenseReports_Id | String | Unique identifier for the expense report being submitted. |
| Descriptor | String | A brief preview or summary of the expense report instance. |
| ExpenseReport_Id | String | Unique identifier or reference ID for the specific expense report. |
| Id | String | Unique identifier for the specific instance of the expense report submission process. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the expense report instance. |
| ExpenseReport_Descriptor | String | Descriptive label for the submitted expense report. |
| ExpenseReport_Href | String | URL link to the submitted expense report instance. |
| ExpenseReport_Id | String | Unique identifier or reference ID for the specific expense report. |
| Id | String | Unique identifier for the specific instance of the expense report submission process. |
Closes the mentorship.
| Name | Type | Description |
| Mentorships_Id | String | Unique identifier for the mentorship being closed. |
| CloseMentorshipReason_Id | String | Unique identifier or reference ID for the reason the mentorship is being closed. |
| Comment | String | User's comment regarding the closure of the mentorship. If no comment was entered, the result is empty. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the specific instance of the mentorship closure process. |
| StartDate | Datetime | The proposed start date of the mentorship. |
| Name | Type | Description |
| CloseMentorshipReason_Descriptor | String | Descriptive label for the reason the mentorship was closed. |
| CloseMentorshipReason_Href | String | URL link to the close mentorship reason instance. |
| CloseMentorshipReason_Id | String | Unique identifier or reference ID for the reason the mentorship is being closed. |
| Comment | String | User's comment regarding the closure of the mentorship. If no comment was entered, the result is empty. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The proposed end date of the mentorship. |
| Id | String | Unique identifier for the specific instance of the mentorship closure process. |
| StartDate | Datetime | The proposed start date of the mentorship. |
Edit the mentorship.
| Name | Type | Description |
| Mentorships_Id | String | Unique identifier for the mentorship being edited. |
| Comment | String | User's comment regarding the changes made to the mentorship. If no comment was entered, the result is empty. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The updated end date for the mentorship. |
| Id | String | Unique identifier for the specific instance of the mentorship edit process. |
| Purpose | String | The proposed purpose for the mentorship after editing. |
| StartDate | Datetime | The updated start date for the mentorship. |
| Name | Type | Description |
| Comment | String | User's comment regarding the changes made to the mentorship. If no comment was entered, the result is empty. |
| Descriptor | String | A brief preview or summary of the mentorship instance. |
| EndDate | Datetime | The updated end date for the mentorship. |
| Id | String | Unique identifier for the specific instance of the mentorship edit process. |
| Purpose | String | The proposed purpose for the mentorship after editing. |
| StartDate | Datetime | The updated start date for the mentorship. |
POST Inbound Notifications request.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 /* The property id. */
value: Text /* The property value. */
}]
[{
*body: Text /* The body of the Global Payroll Notification Translation. */
*languages: [{
id: Text /* Id of the instance */
}]
*title: Text /* The title of the Global Payroll Notification Translation. */
}]
[{
*organization: { /* The Organization that will receive the Global Payroll Notification. */
id: Text /* Id of the instance */
}
*roles: [{
id: Text /* Id of the instance */
}]
}]
[{
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| FeatureConfiguration_Feature_Id | String | Unique identifier for the feature configuration related to the notification event. |
| FeatureConfiguration_Properties_Aggregate | String | Properties associated with the incoming Global Payroll Notification Event Feature. |
| Id | String | Unique identifier for the specific instance of the notification. |
| Message_Body | String | The content of the Global Payroll Notification message. |
| Message_Link | String | An external link associated with the Global Payroll Notification message. |
| Message_Title | String | The title of the Global Payroll Notification message. |
| Message_Translations_Aggregate | String | List of language translations available for the Global Payroll Notification message. |
| Recipient_OrganizationRecipients_Aggregate | String | List of organizations receiving the Global Payroll Notification. |
| Recipient_WorkerRecipients_Aggregate | String | List of workers receiving the Global Payroll Notification. |
| Name | Type | Description |
| FeatureConfiguration_Feature_Id | String | Unique identifier for the feature configuration related to the notification event. |
| FeatureConfiguration_Properties_Aggregate | String | Properties associated with the incoming Global Payroll Notification Event Feature. |
| Id | String | Unique identifier for the specific instance of the notification. |
| Message_Body | String | The content of the Global Payroll Notification message. |
| Message_Link | String | An external link associated with the Global Payroll Notification message. |
| Message_Title | String | The title of the Global Payroll Notification message. |
| Message_Translations_Aggregate | String | List of language translations available for the Global Payroll Notification message. |
| Recipient_OrganizationRecipients_Aggregate | String | List of organizations receiving the Global Payroll Notification. |
| Recipient_WorkerRecipients_Aggregate | String | List of workers receiving the Global Payroll Notification. |
Validates phone number data to ensure it is valid for Workday.
| Name | Type | Description |
| CompletePhoneNumber | String | The full phone number, including the country code and area code. |
| CountryPhoneCode_CountryPhoneCode | String | The numeric phone code assigned to a country. |
| CountryPhoneCode_CountryPhoneCodeID | String | Reference id of the instance |
| CountryPhoneCode_Country_Descriptor | String | Descriptive label for the country associated with the phone code. |
| CountryPhoneCode_Country_Id | String | Unique identifier for the country associated with the phone code. |
| CountryPhoneCode_Descriptor | String | Descriptive label for the phone code entry. |
| CountryPhoneCode_Id | String | Unique identifier for the phone code entry. |
| DeviceType_Descriptor | String | Descriptive label for the type of device associated with the phone number. |
| DeviceType_Id | String | Unique identifier for the device type associated with the phone number. |
| Name | Type | Description |
| CompletePhoneNumber | String | The full phone number, including the country code and area code. |
| CountryPhoneCode_CountryPhoneCode | String | The numeric phone code assigned to a country. |
| CountryPhoneCode_CountryPhoneCodeID | String | Reference id of the instance |
| CountryPhoneCode_Country_Descriptor | String | Descriptive label for the country associated with the phone code. |
| CountryPhoneCode_Country_Id | String | Unique identifier for the country associated with the phone code. |
| CountryPhoneCode_Descriptor | String | Descriptive label for the phone code entry. |
| CountryPhoneCode_Id | String | Unique identifier for the phone code entry. |
| DeviceType_Descriptor | String | Descriptive label for the type of device associated with the phone number. |
| DeviceType_Id | String | Unique identifier for the device type associated with the phone number. |
Creates a single benefit program instance.
| Name | Type | Description |
| AdminNotes | String | Notes from the benefit program partner to Workday administrators regarding the program. |
| Description | String | Text description of the benefit program visible on the program card (maximum 375 characters). |
| EndDate | Datetime | Date when the benefit program ends. Must be after the start date. |
| Id | String | Unique identifier for the program instance. |
| Image_AlternativeText | String | Description of the image for users of assistive technology. |
| Image_ContentType_Id | String | Unique identifier or reference ID for the image content type. |
| Image_FileLength | Decimal | Size of the image file in bytes. |
| Image_FileName | String | Filename of the image associated with the benefit program. |
| Image_Id | String | Unique identifier for the image instance. |
| ProgramPartner_Id | String | Unique identifier or reference ID for the program partner. |
| StartDate | Datetime | Date when the benefit program starts. Must be before the end date. |
| Title | String | Title of the benefit program card (maximum 40 characters). |
| Url | String | External or internal web link to the benefit program (must begin with http or https). |
| UrlAlias | String | Custom text to simplify or shorten the URL for the benefit program. |
| WellbeingInterest_Id | String | Unique identifier or reference ID for the wellbeing interest. |
| Name | Type | Description |
| AdminNotes | String | Notes from the benefit program partner to Workday administrators regarding the program. |
| Description | String | Text description of the benefit program visible on the program card (maximum 375 characters). |
| EndDate | Datetime | Date when the benefit program ends. Must be after the start date. |
| Id | String | Unique identifier for the program instance. |
| Image_AlternativeText | String | Description of the image for users of assistive technology. |
| Image_ContentType_Descriptor | String | Descriptive label for the image content type. |
| Image_ContentType_Href | String | URL link to the image content type instance. |
| Image_ContentType_Id | String | Unique identifier or reference ID for the image content type. |
| Image_FileLength | Decimal | Size of the image file in bytes. |
| Image_FileName | String | Filename of the image associated with the benefit program. |
| Image_Id | String | Unique identifier for the image instance. |
| ProgramPartner_Descriptor | String | Descriptive label for the program partner. |
| ProgramPartner_Href | String | URL link to the program partner instance. |
| ProgramPartner_Id | String | Unique identifier or reference ID for the program partner. |
| StartDate | Datetime | Date when the benefit program starts. Must be before the end date. |
| Title | String | Title of the benefit program card (maximum 40 characters). |
| Url | String | External or internal web link to the benefit program (must begin with http or https). |
| UrlAlias | String | Custom text to simplify or shorten the URL for the benefit program. |
| WellbeingInterest_Descriptor | String | Descriptive label for the wellbeing interest. |
| WellbeingInterest_Href | String | URL link to the wellbeing interest instance. |
| WellbeingInterest_Id | String | Unique identifier or reference ID for the wellbeing interest. |
Creates Project Edit Events and initiates the associated workflow to update the project.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
awaitingPersons: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
businessEventValidation: [{
conditionRule: Text /* The condition rule as a text expression. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
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. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
comments: [{
comment: Text /* Comment */
conmentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
completedByPerson: { /* The person that completed the step as Assignee */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
completedOn: Date /* The date when this step was completed */
creationDate: Date /* The date when the event record was created. */
delayedDate: Date /* The date the delayed step will trigger. */
descriptor: Text /* A preview of the instance */
due: Date /* Returns the due date for this step. */
event: { /* The business process associated with the project you're editing. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
status: { /* The status of this business process step. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| Projects_Id | String | Unique identifier for the project being edited. |
| Billable | Bool | Indicates whether the project is billable. When True, the project is considered billable. |
| BusinessEventRecords_Aggregate | String | List of all event records for the most recent project edit. |
| Capital | Bool | Indicates whether the project is classified as capital. |
| Company_Id | String | Unique identifier or reference ID for the company associated with the project. |
| Currency_Descriptor | String | Descriptive label for the currency used in the project. |
| Currency_Id | String | Unique identifier for the currency associated with the project. |
| Customer_Id | String | Unique identifier or reference ID for the customer associated with the project. |
| Description | String | Detailed description of the project. |
| EndDate | Datetime | The planned or approved end date of the project. |
| EstimatedBudget_Currency | String | Currency for the estimated budget allocated to the project. |
| EstimatedBudget_Value | Decimal | Estimated budget amount allocated to the project, expressed in the project currency. |
| EstimatedRevenueSavings_Currency | String | Currency for the estimated revenue (billable project) or savings (non-billable project). |
| EstimatedRevenueSavings_Value | Decimal | Estimated revenue (billable project) or savings (non-billable project), expressed in project currency. |
| ExternalLink | String | URL linking to an external site relevant to the project. |
| ExternalProjectReference | String | Reference to an external project related to this project. |
| Groups_Aggregate | String | List of project groups associated with the project, used for organizing worktags. |
| Href | String | URL linking to the project instance. |
| Id | String | Unique identifier for the specific instance of the project. |
| ImportanceRating_Id | String | Unique identifier or reference ID for the importance rating of the project. |
| InScope | String | Description of elements considered within the project's scope. |
| Inactive | Bool | Indicates whether the project or project hierarchy is inactive. |
| IncludeProjectIDInName | Bool | Determines whether the project ID is displayed in the project name. |
| MeasuresOfSuccess | String | Description of criteria used to determine project success. |
| Name | String | The approved name of the project. |
| Objective | String | Description of the project's intended outcome. |
| OutOfScope | String | Description of elements considered outside the project's scope. |
| Overview | String | Additional details describing the project's purpose and execution. |
| Owner_Id | String | Unique identifier or reference ID for the project owner. |
| PercentComplete | Decimal | Percentage of the project that has been completed. |
| Priority_Id | String | Unique identifier or reference ID for the project's priority level. |
| ProbabilityOfSuccess | Decimal | Estimated probability that the project will be successful. |
| ProblemStatement | String | Description of the issue the project aims to resolve. |
| ProjectDependencies_Aggregate | String | List of projects defined as dependencies for this project. |
| RealizedRevenueSavings_Currency | String | Currency for actual revenue (billable project) or savings (non-billable project). |
| RealizedRevenueSavings_Value | Decimal | Actual revenue (billable project) or savings (non-billable project), expressed in project currency. |
| RiskLevel_Id | String | Unique identifier or reference ID for the risk level assigned to the project. |
| StartDate | Datetime | The planned or approved start date of the project. |
| Status_Id | String | Unique identifier or reference ID for the current status of the project. |
| SuccessRating_Id | String | Unique identifier or reference ID for the success rating of the project. |
| Worktags_Aggregate | String | Key words for projects to categorize transactions, such as Cost, Organization, etc. |
| Name | Type | Description |
| Billable | Bool | Indicates whether the project is billable. When True, the project is considered billable. |
| BusinessEventRecords_Aggregate | String | List of all event records for the most recent project edit. |
| Capital | Bool | Indicates whether the project is classified as capital. |
| Company_Descriptor | String | Descriptive label for the company associated with the project. |
| Company_Href | String | URL linking to the company instance. |
| Company_Id | String | Unique identifier or reference ID for the company associated with the project. |
| Currency_Descriptor | String | Descriptive label for the currency used in the project. |
| Currency_Id | String | Unique identifier for the currency associated with the project. |
| Customer_Descriptor | String | Descriptive label for the customer associated with the project. |
| Customer_Href | String | URL linking to the customer instance. |
| Customer_Id | String | Unique identifier or reference ID for the customer associated with the project. |
| Description | String | Detailed description of the project. |
| EndDate | Datetime | The planned or approved end date of the project. |
| EstimatedBudget_Currency | String | Currency for the estimated budget allocated to the project. |
| EstimatedBudget_Value | Decimal | Estimated budget amount allocated to the project, expressed in the project currency. |
| EstimatedRevenueSavings_Currency | String | Currency for the estimated revenue (billable project) or savings (non-billable project). |
| EstimatedRevenueSavings_Value | Decimal | Estimated revenue (billable project) or savings (non-billable project), expressed in project currency. |
| ExternalLink | String | URL linking to an external site relevant to the project. |
| ExternalProjectReference | String | Reference to an external project related to this project. |
| Groups_Aggregate | String | List of project groups associated with the project, used for organizing worktags. |
| Href | String | URL linking to the project instance. |
| Id | String | Unique identifier for the specific instance of the project. |
| ImportanceRating_Descriptor | String | Descriptive label for the project's importance rating. |
| ImportanceRating_Href | String | URL link to the importance rating instance. |
| ImportanceRating_Id | String | Unique identifier or reference ID for the project's importance rating. |
| InScope | String | Description of elements considered within the project's scope. |
| Inactive | Bool | Indicates whether the project or project hierarchy is inactive. |
| IncludeProjectIDInName | Bool | Determines whether the project ID is displayed in the project name. |
| MeasuresOfSuccess | String | Description of criteria used to determine project success. |
| Name | String | The approved name of the project. |
| Objective | String | Description of the project's intended outcome. |
| OutOfScope | String | Description of elements considered outside the project's scope. |
| Overview | String | Additional details describing the project's purpose and execution. |
| Owner_Descriptor | String | Descriptive label for the project owner. |
| Owner_Href | String | URL link to the project owner instance. |
| Owner_Id | String | Unique identifier or reference ID for the project owner. |
| PercentComplete | Decimal | Percentage of the project that has been completed. |
| Priority_Descriptor | String | Descriptive label for the project's priority level. |
| Priority_Href | String | URL link to the priority level instance. |
| Priority_Id | String | Unique identifier or reference ID for the project's priority level. |
| ProbabilityOfSuccess | Decimal | Estimated probability that the project will be successful. |
| ProblemStatement | String | Description of the issue the project aims to resolve. |
| ProjectDependencies_Aggregate | String | List of projects defined as dependencies for this project. |
| RealizedRevenueSavings_Currency | String | Currency for actual revenue (billable project) or savings (non-billable project). |
| RealizedRevenueSavings_Value | Decimal | Actual revenue (billable project) or savings (non-billable project), expressed in project currency. |
| RiskLevel_Descriptor | String | Descriptive label for the project's risk level. |
| RiskLevel_Href | String | URL link to the risk level instance. |
| RiskLevel_Id | String | Unique identifier or reference ID for the project's risk level. |
| StartDate | Datetime | The planned or approved start date of the project. |
| Status_Descriptor | String | Descriptive label for the project's current status. |
| Status_Href | String | URL link to the status instance. |
| Status_Id | String | Unique identifier or reference ID for the current status of the project. |
| SuccessRating_Descriptor | String | Descriptive label for the project's success rating. |
| SuccessRating_Href | String | URL link to the success rating instance. |
| SuccessRating_Id | String | Unique identifier or reference ID for the project's success rating. |
| TotalSavingsRemaining_Currency | String | Currency for the total amount of savings remaining in the project. |
| TotalSavingsRemaining_Value | Decimal | Total amount of savings remaining in project currency. |
| Worktags_Aggregate | String | Key words for projects to categorize transactions, such as Cost, Organization, etc. |
Closes a request.
| Name | Type | Description |
| Requests_Id | String | Unique identifier for the request being closed. |
| Comment | String | Latest comment added for the request event. |
| Descriptor | String | A brief preview or summary of the request instance. |
| Id | String | Unique identifier for the specific instance of the request. |
| RequestID | String | Unique identifier assigned to the request. |
| RequestSubtype_Descriptor | String | Descriptive label for the request subtype. |
| RequestSubtype_Id | String | Unique identifier for the request subtype. |
| ResolutionDetails_Descriptor | String | Descriptive label for the resolution details associated with the request. |
| ResolutionDetails_Id | String | Unique identifier for the resolution details associated with the request. |
| Resolution_Id | String | Unique identifier for the resolution instance. |
| WorkdayObjectValue_Id | String | Unique identifier for the related Workday object. |
| Name | Type | Description |
| Comment | String | Latest comment added for the request event. |
| Descriptor | String | A brief preview or summary of the request instance. |
| Id | String | Unique identifier for the specific instance of the request. |
| RequestID | String | Unique identifier assigned to the request. |
| RequestSubtype_Descriptor | String | Descriptive label for the request subtype. |
| RequestSubtype_Id | String | Unique identifier for the request subtype. |
| ResolutionDetails_Descriptor | String | Descriptive label for the resolution details associated with the request. |
| ResolutionDetails_Id | String | Unique identifier for the resolution details associated with the request. |
| Resolution_Descriptor | String | Descriptive label for the resolution instance. |
| Resolution_Href | String | URL link to the resolution instance. |
| Resolution_Id | String | Unique identifier for the resolution instance. |
| WorkdayObjectValue_Descriptor | String | Descriptive label for the associated Workday object. |
| WorkdayObjectValue_Href | String | URL link to the associated Workday object. |
| WorkdayObjectValue_Id | String | Unique identifier for the associated Workday object. |
Cancels an existing requisition.
| Name | Type | Description |
| Requisitions_Id | String | Unique identifier for the requisition being canceled. |
| Comments | String | Additional comments explaining the reason for canceling the requisition. |
| Descriptor | String | A brief preview or summary of the requisition instance. |
| Id | String | Unique identifier for the specific instance of the requisition. |
| ReasonCode_Id | String | Unique identifier or reference ID for the reason code associated with the cancellation. |
| Name | Type | Description |
| Comments | String | Additional comments explaining the reason for canceling the requisition. |
| Descriptor | String | A brief preview or summary of the requisition instance. |
| Id | String | Unique identifier for the specific instance of the requisition. |
| ReasonCode_Descriptor | String | Descriptive label for the reason code associated with the cancellation. |
| ReasonCode_Href | String | URL link to the reason code instance. |
| ReasonCode_Id | String | Unique identifier or reference ID for the reason code associated with the cancellation. |
Closes a specified completed requisition.
| Name | Type | Description |
| Requisitions_Id | String | Unique identifier for the requisition being closed. |
| Comments | String | Additional comments explaining the reason for closing or canceling the requisition. |
| Descriptor | String | A brief preview or summary of the requisition instance. |
| Id | String | Unique identifier for the specific instance of the requisition. |
| ReasonCode_Id | String | Unique identifier or reference ID for the reason code associated with closing the requisition. |
| Name | Type | Description |
| Comments | String | Additional comments explaining the reason for closing or canceling the requisition. |
| Descriptor | String | A brief preview or summary of the requisition instance. |
| Id | String | Unique identifier for the specific instance of the requisition. |
| ReasonCode_Descriptor | String | Descriptive label for the reason code associated with closing the requisition. |
| ReasonCode_Href | String | URL link to the reason code instance. |
| ReasonCode_Id | String | Unique identifier or reference ID for the reason code associated with closing the requisition. |
Submit Requisition to Business Process
| Name | Type | Description |
| Requisitions_Id | String | Unique identifier for the requisition related to the event. |
| AutoComplete | Bool | Indicates if the event was automatically completed via a web service or business process configuration. |
| Comment | String | The last recorded comment for the requisition event, without security filtering. If no comment was entered, this will be empty. |
| Descriptor | String | A brief preview or summary of the requisition event instance. |
| Id | String | Unique identifier for the specific instance of the requisition event. |
| Name | Type | Description |
| AutoComplete | Bool | Indicates if the event was automatically completed via a web service or business process configuration. |
| Comment | String | The last recorded comment for the requisition event, without security filtering. If no comment was entered, this will be empty. |
| Descriptor | String | A brief preview or summary of the requisition event instance. |
| Id | String | Unique identifier for the specific instance of the requisition event. |
Creates a Resource Plan Line Edit event and initiates the Project Resource Plan Line business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
awaitingPersons: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
businessEventValidation: [{
conditionRule: Text /* The condition rule as a text expression. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
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. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
comments: [{
comment: Text /* Comment */
conmentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
completedByPerson: { /* The person that completed the step as Assignee */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
completedOn: Date /* The date when this step was completed */
creationDate: Date /* The date when the event record was created. */
delayedDate: Date /* The date the delayed step will trigger. */
descriptor: Text /* A preview of the instance */
due: Date /* Returns the due date for this step. */
event: { /* The business process associated with the project you're editing. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
id: Text /* Id of the instance */
status: { /* The status of this business process step. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
[{
category: { /* The requirement category for the \~project role\~. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
optional: Boolean /* The optional status of a requirement. */
values: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
}]
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
unnamedResource: { /* Unnamed Resource */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
worker: { /* Worker */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| ResourcePlanLines_Id | String | Unique identifier for the resource plan line. |
| BookingStatus_Id | String | Unique identifier for the booking status of the resource. |
| BusinessEventRecords_Aggregate | String | List of business events related to project resource planning. |
| CostRateCurrencyOverride_Id | String | Unique identifier for the currency override applied to cost rate. |
| CostRateOverride_Currency | String | Currency used for overriding the cost rate. |
| CostRateOverride_Value | Decimal | The value of the cost rate override. |
| Descriptor | String | A brief preview or summary of the resource plan line. |
| EndDate | Datetime | The planned end date for the resource plan line. |
| EstimatedHours | Decimal | Total estimated hours required for this role in the project. |
| ExcludedWorkers_Aggregate | String | List of workers excluded from assignment to the resource plan line. |
| Id | String | Unique identifier for the specific instance of the resource plan line. |
| JobRequisition_Id | String | Unique identifier for the job requisition linked to the resource plan. |
| Memo | String | Additional notes or comments related to the resource plan line. |
| PercentAllocation | Decimal | Percentage of a worker’s time allocated to the project for the resource plan line. |
| ProjectResources_Aggregate | String | The workers and unnamed resources assigned to the resource plan line. |
| Requirements_Aggregate | String | Contains the specific requirements by category for the project role. |
| ResourceType_Id | String | Unique identifier for the type of resource associated with the role. |
| RoleCategory_Id | String | Unique identifier for the category of role in the project. |
| Role_Id | String | Unique identifier for the specific role within the project. |
| StartDate | Datetime | The planned start date for the resource plan line. |
| ToBeHired | Bool | Indicates whether a new worker is still required for the resource plan line. |
| UnnamedResourceWorkerSwap_Aggregate | String | Details about unnamed resource worker swaps within the project. |
| UnnamedResources | Decimal | Placeholder for unnamed resources assigned to the resource plan. |
| WorkerGroup_Id | String | Unique identifier for the worker group associated with the plan. |
| Name | Type | Description |
| BookingStatus_Descriptor | String | Description of the booking status for the resource. |
| BookingStatus_Href | String | URL link to the booking status instance. |
| BookingStatus_Id | String | Unique identifier for the booking status of the resource. |
| BusinessEventRecords_Aggregate | String | List of business events related to project resource planning. |
| CostRateCurrencyOverride_Descriptor | String | Description of the cost rate currency override. |
| CostRateCurrencyOverride_Href | String | URL link to the cost rate currency override. |
| CostRateCurrencyOverride_Id | String | Unique identifier for the currency override applied to cost rate. |
| CostRateOverride_Currency | String | Currency used for overriding the cost rate. |
| CostRateOverride_Value | Decimal | The value of the cost rate override. |
| Descriptor | String | A brief preview or summary of the resource plan line. |
| EndDate | Datetime | The planned end date for the resource plan line. |
| EstimatedHours | Decimal | Total estimated hours required for this role in the project. |
| ExcludedWorkers_Aggregate | String | List of workers excluded from assignment to the resource plan line. |
| Id | String | Unique identifier for the specific instance of the resource plan line. |
| JobRequisition_Descriptor | String | Description of the job requisition associated with the resource plan. |
| JobRequisition_Href | String | URL link to the job requisition instance. |
| JobRequisition_Id | String | Unique identifier for the job requisition linked to the resource plan. |
| Memo | String | Additional notes or comments related to the resource plan line. |
| PendingWorkers_Aggregate | String | List of workers pending approval to be added to the resource plan line. |
| PercentAllocation | Decimal | Percentage of a worker’s time allocated to the project for the resource plan line. |
| ProjectResources_Aggregate | String | The workers and unnamed resources assigned to the resource plan line. |
| Requirements_Aggregate | String | Contains the specific requirements by category for the project role. |
| ResourceType_Descriptor | String | Description of the type of resource assigned to the project. |
| ResourceType_Href | String | URL link to the resource type instance. |
| ResourceType_Id | String | Unique identifier for the type of resource associated with the role. |
| RoleCategory_Descriptor | String | Description of the role category in the project. |
| RoleCategory_Href | String | URL link to the role category instance. |
| RoleCategory_Id | String | Unique identifier for the category of role in the project. |
| Role_Descriptor | String | Description of the role within the project. |
| Role_Href | String | URL link to the role instance. |
| Role_Id | String | Unique identifier for the specific role within the project. |
| StartDate | Datetime | The planned start date for the resource plan line. |
| ToBeHired | Bool | Indicates whether a new worker is still required for the resource plan line. |
| UnnamedResourceWorkerSwap_Aggregate | String | Details about unnamed resource worker swaps within the project. |
| UnnamedResources | Decimal | Placeholder for unnamed resources assigned to the resource plan. |
| WorkerGroup_Descriptor | String | Description of the worker group associated with the resource plan. |
| WorkerGroup_Href | String | URL link to the worker group instance. |
| WorkerGroup_Id | String | Unique identifier for the worker group associated with the plan. |
Creates a budget check for transactions.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
accountingWorktags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
bookCode: { /* The Transaction Book Code for the budget check transaction. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
currency: { /* The company base Currency for the budget check transaction. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
ledgerAccount: { /* The Transaction Ledger Account for the budget check transaction. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
planInformation: [{
accountingWorktagsOrAggregationDimension: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
aggregatedTransactionAmount: Currency /* The Aggregated Transaction Amount for the \~plan\~ line with budget check enabled. */
availableAmount: Currency /* The Available Amount for the \~plan\~ with budget check enabled. */
currency: { /* The company base Currency for the transaction amount. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
ledgerAccountOrLedgerSummary: { /* The Ledger Account or Ledger Account Summary for the \~plan\~ with budget check enabled. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
lineStatus: { /* The budget check status for each \~plan\~ with budget check enabled, for each transaction line. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
plan: { /* The \~Plan\~ with budget check enabled. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
planAmount: Currency /* The Current \~Plan\~ Amount from the \~plan\~ with budget check enabled. */
spendAmount: Currency /* The Current Spend Amount for the \~plan\~ with budget check enabled. */
}]
transactionAmount: Currency /* The Transaction Amount for the budget check transaction. */
}]
| Name | Type | Description |
| Company_Descriptor | String | Description of the company associated with the budget check transaction. |
| Company_Id | String | Unique identifier for the company involved in the budget check transaction. |
| InflightTransactionDate | Datetime | Date of the budget check transaction. |
| OverallStatus_Descriptor | String | Description of the overall status of the budget check transaction. |
| OverallStatus_Id | String | Unique identifier for the overall status of the budget check transaction. |
| TransactionLines_Aggregate | String | List of transaction lines included in the budget check transaction. |
| Name | Type | Description |
| Company_Descriptor | String | Description of the company associated with the budget check transaction. |
| Company_Id | String | Unique identifier for the company involved in the budget check transaction. |
| InflightTransactionDate | Datetime | Date of the budget check transaction. |
| OverallStatus_Descriptor | String | Description of the overall status of the budget check transaction. |
| OverallStatus_Id | String | Unique identifier for the overall status of the budget check transaction. |
| TransactionLines_Aggregate | String | List of transaction lines included in the budget check transaction. |
Usage information for the operation SendMessage.rsb.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| CommID_Id | String | Unique identifier for the communication instance. |
| EmailDetail_Body | String | The main content of the email message. |
| EmailDetail_Name | String | Configuration name of the email used in the REST API. |
| EmailDetail_ReplyTo | String | The email address for replies to the message. |
| EmailDetail_Subject | String | The subject line of the email message. |
| MessageTemplate_Id | String | Unique identifier for the message template used. |
| NotificationType_Id | String | Unique identifier for the type of notification. |
| PushDetail_Id | String | Unique identifier for the push notification instance. |
| PushDetail_Message | String | The main content of the push notification message. |
| PushDetail_RedirectURL | String | URL to launch the mobile app upon message acknowledgment. |
| Recipients_Contacts_Aggregate | String | List of recipients for the message. |
| SenderOverride_Id | String | Unique identifier for the sender override. |
| Name | Type | Description |
| CommID_Descriptor | String | Description of the communication instance. |
| CommID_Href | String | URL link to the communication instance. |
| CommID_Id | String | Unique identifier for the communication instance. |
| EmailDetail_Body | String | The main content of the email message. |
| EmailDetail_Name | String | Configuration name of the email used in the REST API. |
| EmailDetail_ReplyTo | String | The email address for replies to the message. |
| EmailDetail_Subject | String | The subject line of the email message. |
| MessageTemplate_Descriptor | String | Description of the message template instance. |
| MessageTemplate_Href | String | URL link to the message template instance. |
| MessageTemplate_Id | String | Unique identifier for the message template used. |
| NotificationType_Descriptor | String | Description of the notification type instance. |
| NotificationType_Href | String | URL link to the notification type instance. |
| NotificationType_Id | String | Unique identifier for the type of notification. |
| PushDetail_Id | String | Unique identifier for the push notification instance. |
| PushDetail_Message | String | The main content of the push notification message. |
| PushDetail_RedirectURL | String | URL to launch the mobile app upon message acknowledgment. |
| Recipients_Contacts_Aggregate | String | List of recipients for the message. |
| SenderOverride_Descriptor | String | Description of the sender override instance. |
| SenderOverride_Href | String | URL link to the sender override instance. |
| SenderOverride_Id | String | Unique identifier for the sender override. |
Submit the specified contact change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| HomeContactInformationChange_Id | String | Unique identifier for the home contact information change request. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action performed in the business process. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments related to the business process, uploaded by the user. |
| BusinessProcessParameters_Comment | String | Comment field associated with the business process (returns null if not applicable). |
| BusinessProcessParameters_For_Id | String | Unique identifier for the person or entity the business process is related to. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall business process. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the business process. |
| Descriptor | String | A brief preview or summary of the change request instance. |
| Id | String | Unique identifier for the specific change request instance. |
| Name | Type | Description |
| BusinessProcessParameters_CriticalValidations | String | Critical validation messages triggered by the action event. |
| BusinessProcessParameters_OverallStatus | String | The current status of the business process (e.g., Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_WarningValidations | String | Warning validation messages triggered by the action event. |
Submit the specified change job ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| JobChange_Id | String | Unique identifier for the job change process request. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action performed in the business process. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments related to the job change request, uploaded by the user. |
| BusinessProcessParameters_Comment | String | Comment field associated with the job change process (returns null if not applicable). |
| BusinessProcessParameters_For_Id | String | Unique identifier for the person or entity the job change process is related to. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall job change business process. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the job change process. |
| Descriptor | String | A brief preview or summary of the job change request instance. |
| Id | String | Unique identifier for the specific job change request instance. |
| Status_Id | String | Unique identifier for the status of the job change request. |
| Validation | String | Validation message generated for the job change event triggered by a condition. |
| Name | Type | Description |
| BusinessProcessParameters_CriticalValidations | String | Critical validation messages triggered by the job change action. |
| BusinessProcessParameters_OverallStatus | String | The current status of the job change process (e.g., Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_WarningValidations | String | Warning validation messages triggered by the job change process. |
Submits the organization changes request for the specified ID, and initiates the Change Organization Assignment business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| OrganizationAssignmentChange_Id | String | Unique identifier for the organization assignment change request. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action performed in the business process. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments related to the organization assignment change, uploaded by the user. |
| BusinessProcessParameters_Comment | String | Comment field associated with the organization assignment change process (returns null if not applicable). |
| BusinessProcessParameters_For_Id | String | Unique identifier for the person or entity the organization assignment change is related to. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall organization assignment change business process. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the organization assignment change. |
| Descriptor | String | A brief preview or summary of the organization assignment change request instance. |
| Id | String | Unique identifier for the specific organization assignment change request instance. |
| Name | Type | Description |
| BusinessProcessParameters_CriticalValidations | String | Critical validation messages triggered by the organization assignment change action. |
| BusinessProcessParameters_OverallStatus | String | The current status of the organization assignment change process (e.g., Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_WarningValidations | String | Warning validation messages triggered by the organization assignment change process. |
Submit the specified contact change ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| WorkContactInformationChange_Id | String | Unique identifier for the work contact information change request. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action performed in the business process. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments related to the work contact information change, uploaded by the user. |
| BusinessProcessParameters_Comment | String | Comment field associated with the work contact information change process (returns null if not applicable). |
| BusinessProcessParameters_For_Id | String | Unique identifier for the person or entity the work contact information change is related to. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall work contact information change business process. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the work contact information change. |
| Descriptor | String | A brief preview or summary of the work contact information change request instance. |
| Id | String | Unique identifier for the specific work contact information change request instance. |
| Name | Type | Description |
| BusinessProcessParameters_CriticalValidations | String | Critical validation messages triggered by the work contact information change action. |
| BusinessProcessParameters_OverallStatus | String | The current status of the work contact information change process (e.g., Successfully Completed, Denied, Terminated). |
| BusinessProcessParameters_WarningValidations | String | Warning validation messages triggered by the work contact information change process. |
Submits a single supplier invoice instance.
| Name | Type | Description |
| SupplierInvoiceRequests_Id | String | Unique identifier for the supplier invoice request being processed. |
| Descriptor | String | A brief preview or summary of the supplier invoice request instance. |
| Id | String | Unique identifier for the specific supplier invoice request instance. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the supplier invoice request instance. |
| Id | String | Unique identifier for the specific supplier invoice request instance. |
Validates worktags.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
invalidRestrictedToValues: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
worktagWithRestrictedToValues: { /* For REST API responses only. Worktags that are configured with Restricted To values. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
invalidWorktagValues: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
worktagWithAllowedValues: { /* For REST API responses only. Worktags that are configured with allowed values. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
missingWorktagTypes: [{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
worktagWithRequiredWorktags: { /* For REST API responses only. Worktags configured with required worktag types in their related worktags. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
[{
descriptor: Text /* A preview of the instance */
href: Text /* A link to the instance */
id: Text /* Id of the instance */
}]
| Name | Type | Description |
| AllowBuiltInWorktags | String | When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. |
| InvalidRestrictionsForWorktags_Aggregate | String | Indicates invalid restrictions for a worktag configured with Restricted To values. |
| InvalidWorktagCombinations_Aggregate | String | Indicates that at least one combination of worktag values isn't allowed together. |
| MissingRequiredWorktagTypesAfterDefaulting_Aggregate | String | Indicates that at least one required worktag type is missing after defaulting. |
| MissingRequiredWorktagTypesForTaggableConfig_Aggregate | String | Indicates that at least one required worktag type is missing from the request. |
| MissingRequiredWorktagTypesForWorktags_Aggregate | String | Indicates that at least one required worktag type is missing from related worktags. |
| NonAllowedInactiveWorktagValues_Aggregate | String | Indicates that at least one inactive worktag was included that isn't allowed. |
| NonAllowedWorktagTypesForTaggableConfig_Aggregate | String | Indicates that at least one worktag type isn't allowed in the Taggable Configuration. |
| OnlyOneProjectOrPhaseOrTaskAllowed | String | Indicates that multiple project-related worktags were provided, but only one is allowed. |
| Restrictions_Aggregate | String | Validated values for worktag types configured with 'Restricted To' values. |
| Status | String | Indicates whether the worktags in the request have validation errors. |
| TaggableConfiguration_Id | String | wid / id / reference id |
| ValidationTypes_Aggregate | String | The validation types included in the response. |
| Worktags_Aggregate | String | The worktags to be validated based on configuration rules. |
| Name | Type | Description |
| AllowBuiltInWorktags | String | When true, REST API requests can include values in the Worktags field that aren't configurable worktag types for the Taggable Type but are valid for validation purposes. |
| InvalidRestrictionsForWorktags_Aggregate | String | Indicates invalid restrictions for a worktag configured with Restricted To values. |
| InvalidWorktagCombinations_Aggregate | String | Indicates that at least one combination of worktag values isn't allowed together. |
| MissingRequiredWorktagTypesAfterDefaulting_Aggregate | String | Indicates that at least one required worktag type is missing after defaulting. |
| MissingRequiredWorktagTypesForTaggableConfig_Aggregate | String | Indicates that at least one required worktag type is missing from the request. |
| MissingRequiredWorktagTypesForWorktags_Aggregate | String | Indicates that at least one required worktag type is missing from related worktags. |
| NonAllowedInactiveWorktagValues_Aggregate | String | Indicates that at least one inactive worktag was included that isn't allowed. |
| NonAllowedWorktagTypesForTaggableConfig_Aggregate | String | Indicates that at least one worktag type isn't allowed in the Taggable Configuration. |
| OnlyOneProjectOrPhaseOrTaskAllowed | String | Indicates that multiple project-related worktags were provided, but only one is allowed. |
| Restrictions_Aggregate | String | Validated values for worktag types configured with 'Restricted To' values. |
| Status | String | Indicates whether the worktags in the request have validation errors. |
| TaggableConfiguration_Descriptor | String | A description of the instance. |
| TaggableConfiguration_Href | String | A link to the instance. |
| TaggableConfiguration_Id | String | wid / id / reference id. |
| ValidationTypes_Aggregate | String | The validation types included in the response. |
| Worktags_Aggregate | String | The worktags to be validated based on configuration rules. |
Initiates an organization assignment change for a specific worker.
| Name | Type | Description |
| Workers_Id | String | Unique identifier for the worker whose organization assignment is being changed. |
| Date | Datetime | The effective date of the organization assignment change. |
| Descriptor | String | A brief preview or summary of the organization assignment change instance. |
| Id | String | Unique identifier for the specific organization assignment change instance. |
| Position_Id | String | Unique identifier for the worker's new position assignment. |
| Name | Type | Description |
| Date | Datetime | The effective date of the organization assignment change. |
| Descriptor | String | A brief preview or summary of the organization assignment change instance. |
| Id | String | Unique identifier for the specific organization assignment change instance. |
| Position_Descriptor | String | A brief description of the new position assigned. |
| Position_Href | String | A link to the new position instance. |
| Position_Id | String | Unique identifier for the worker's new position assignment. |
Request a one-time payment for a worker with the specified ID.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
additionalInformation: Text /* Additional information for this compensation payment */
coverageEndDate: Date /* The end date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements. */
coverageStartDate: Date /* The start date of the Coverage Period for the payment, which enables Workday Payroll or Payroll Integration to associate dates with the one-time payment for Fair Labor Standards Act (FLSA) reporting requirements. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
oneTimePaymentPlan: { /* The one-time payment plan name for this one-time payment. Displays only if the payment is a one-time payment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
paymentAmount: Currency /* Amount of compensation payment */
paymentCurrency: { /* The currency for this compensation payment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
paymentPercent: Numeric /* The actual amount for the \~bonus\~ payment represented as a percentage. The percentage is usually calculated as a percentage of base pay, but on the \~bonus\~ plan setup it is possible to override the calculation basis to calculate as a percentage of a set of compensation elements. */
payrollWorktags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
scheduledPaymentDate: Date /* The payment date scheduled for the one-time payment request. */
sendToPayroll: Boolean /* This is true if you selected Send to Payroll on the \~bonus\~ payment, future payment, or one-time payment. If false, Workday Payroll doesn't process the payment. */
}]
| Name | Type | Description |
| Workers_Id | String | Unique identifier for the worker requesting a one-time payment. |
| Descriptor | String | A brief preview or summary of the one-time payment request instance. |
| EffectiveDate | Datetime | The date when the one-time payment takes effect. |
| EmployeeVisibilityDate | Datetime | The date when the worker can see the compensation change. |
| Id | String | Unique identifier for the specific one-time payment request instance. |
| OneTimePayments_Aggregate | String | A collection of all one-time payments linked to the request. |
| Position_Id | String | Unique identifier for the worker's position related to the payment request. |
| Reason_Id | String | Unique identifier for the reason behind the one-time payment request. |
| Name | Type | Description |
| Descriptor | String | A brief preview or summary of the one-time payment request instance. |
| EffectiveDate | Datetime | The date when the one-time payment takes effect. |
| EmployeeVisibilityDate | Datetime | The date when the worker can see the compensation change. |
| Id | String | Unique identifier for the specific one-time payment request instance. |
| OneTimePayments_Aggregate | String | A collection of all one-time payments linked to the request. |
| Position_Descriptor | String | A brief description of the position associated with the payment request. |
| Position_Href | String | A link to the position instance. |
| Position_Id | String | Unique identifier for the worker's position related to the payment request. |
| Reason_Descriptor | String | A brief description of the reason for the one-time payment. |
| Reason_Href | String | A link to the reason instance. |
| Reason_Id | String | Unique identifier for the reason behind the one-time payment request. |
Creates a time off request for the specified worker ID and initiates the business process.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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.
[{
category: { /* Returns the category of a Business Process Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
contentType: { /* Content type of the attachment */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
description: Text /* Event attachment description */
fileLength: Numeric /* File length of the attachment */
fileName: Text /* File name of the attachment */
id: Text /* Id of the instance */
-uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
comment: Text /* Comment */
commentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
[{
comment: Text /* The comment on the time off entry. */
dailyQuantity: Numeric /* Time Off Entry hours */
date: Date /* Time Off Entry date */
descriptor: Text /* A preview of the instance */
end: Date /* The end time of the time off entry. */
id: Text /* Id of the instance */
position: { /* The position of the time off entry. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
reason: { /* The reason for the time off entry. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
start: Date /* The start time of the time off entry. */
timeOffType: { /* The time off type name or absence table name. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
}]
| Name | Type | Description |
| Workers_Id | String | Unique identifier for the worker requesting time off. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action related to the time-off request. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments uploaded during the time-off request process. |
| BusinessProcessParameters_Comment | String | A comment related to the time-off request. |
| BusinessProcessParameters_For_Id | String | Unique identifier for the worker the time-off request applies to. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall business process managing the time-off request. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the request. |
| Days_Aggregate | String | All time-off entries associated with the request. |
| Name | Type | Description |
| BusinessProcessParameters_Action_Descriptor | String | A brief description of the action related to the time-off request. |
| BusinessProcessParameters_Action_Href | String | A link to the action instance. |
| BusinessProcessParameters_Action_Id | String | Unique identifier for the action related to the time-off request. |
| BusinessProcessParameters_Attachments_Aggregate | String | Attachments uploaded during the time-off request process. |
| BusinessProcessParameters_Comment | String | A comment related to the time-off request. |
| BusinessProcessParameters_Comments_Aggregate | String | Comments provided as part of the time-off request process. |
| BusinessProcessParameters_CriticalValidations | String | Validation messages triggered by conditions during the process. |
| BusinessProcessParameters_For_Descriptor | String | A description of the worker associated with the request. |
| BusinessProcessParameters_For_Href | String | A link to the worker instance. |
| BusinessProcessParameters_For_Id | String | Unique identifier for the worker the time-off request applies to. |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | A description of the overall business process for the time-off request. |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | A link to the overall business process instance. |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | Unique identifier for the overall business process managing the time-off request. |
| BusinessProcessParameters_OverallStatus | String | Current status of the business process (e.g., Completed, Denied, Terminated). |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | A description of the transaction status. |
| BusinessProcessParameters_TransactionStatus_Href | String | A link to the transaction status instance. |
| BusinessProcessParameters_TransactionStatus_Id | String | Unique identifier for the transaction status of the request. |
| BusinessProcessParameters_WarningValidations | String | Warning messages triggered by conditions during the process. |
| Days_Aggregate | String | All time-off entries associated with the request. |
Creates a Time Review Event or Time Review Events.
The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
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 */
position: { /* Contains Position for Time Review Event if Independent Events for Multiple Jobs is enabled on the Time Entry Template. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
project: { /* Contains \~Project\~ for Time Review Event if Independent Events for \~Project\~ is enabled on the Time Entry Template. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
status: { /* Contains the current status of the business process. For example: Successfully Completed, Denied, Terminated. */
-descriptor: Text /* A description of the instance */
-href: Text /* A link to the instance */
*id: Text /* wid / id / reference id */
}
}]
| Name | Type | Description |
| Workers_Id | String | Unique identifier for the worker associated with the time review event. |
| Comment | String | Business process comment associated with the time review event. |
| Date | Datetime | User-specified date for submitting time, used to determine the submission range based on configuration. |
| TimeReviewEvents_Aggregate | String | Collection of time review events generated during the time submission request. |
| Name | Type | Description |
| Comment | String | Business process comment associated with the time review event. |
| Date | Datetime | User-specified date for submitting time, used to determine the submission range based on configuration. |
| TimeReviewEvents_Aggregate | String | Collection of time review events generated during the time submission request. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Workday:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the [CData].[Human_Resources].Workers table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Workers' AND CatalogName='CData' AND SchemaName='Human_Resources'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Workday procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the [CData].[Human_Resources].Workers table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Workers' AND CatalogName='CData' AND SchemaName='Human_Resources'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| ConnectionType | Specifies the types of Workday data that the provider exposes as SQL tables and views. |
| AuthScheme | The type of authentication to use when connecting to Workday. |
| Tenant | The name of a tenant tied to your Workday account. |
| BaseURL | Your Workday account's base URL for the Workday API REST Endpoint. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Service | The specific SOAP service or services to retrieve data from. Enter as a comma-separated list. |
| UseSplitTables | Split WQL data sources into multiple tables. |
| CustomReportURL | The URL of the report that shows all Reports as a Service (RaaS) reports. |
| SSOProperties | A list of additional properties required to connect to an identity provider. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAuthorizationURL | The OAuth authorization endpoint associated with your Workday account. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| EnforceWQLRowLimit | Restricts queries to returning only 1 million rows. |
| ExpandIDTypes | Display one column per ID type when a report contains multiple ID types. |
| ExpandMultiValueLimit | Specifies the maximum number of output rows that can be expanded from a single input row (applies when ExpandMultiValues is set to True). |
| ExpandMultiValues | Determines if multi-instance fields are expanded into separate rows. |
| IgnoreHardcodedIncludes | For the SOAP API, ignores the hardcoded includes for the specified (comma seperated) tables. |
| IncludeChildTableAggregates | Include aggregate columns for child tables (applies when ConnectionType is set to SOAP). |
| IncludeIDInDescriptor | Includes the ID in descriptor fields (applies when ConnectionType is set to WQL). |
| IncludeRESTTenantFields | Includes tenant-specific columns in REST metadata (applies when ConnectionType is set to REST). |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MetadataFilters | A comma-separated list of column types to exclude from query results. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Workday. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SingleEntryTables | A list of tables for which SOAP API collections are displayed as one row entry per collection entry. |
| SOAPRequestDates | The method used by the provider to assign the As_Of_Effective_Date and As_Of_Entry_DateTime request parameters (applies when ConnectionType is set to SOAP). |
| SplitSingleValuePrompts | Split lists of prompt values when Workday only allows one. |
| TablePageSizes | A list of per-table overrides for the default page size (applies when ConnectionType is set to SOAP). |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseDefaultIncludes | For the SOAP API, disables requesting any field includes for the specified (comma separated) tables. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| WQLDataSourceFilters | A comma-separated list of data sources paired with filters, used to override the default filter used by the provider when querying the specified WQL data sources. |
| WSDLURL | The URL to the WSDL. Only applies when ConnectionType is set to SOAP. |
| WSDLVersion | The version of the WSDL to use for the service(s) specified in the Service connection property. Only applies when ConnectionType is set to SOAP. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| ConnectionType | Specifies the types of Workday data that the provider exposes as SQL tables and views. |
| AuthScheme | The type of authentication to use when connecting to Workday. |
| Tenant | The name of a tenant tied to your Workday account. |
| BaseURL | Your Workday account's base URL for the Workday API REST Endpoint. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Service | The specific SOAP service or services to retrieve data from. Enter as a comma-separated list. |
| UseSplitTables | Split WQL data sources into multiple tables. |
| CustomReportURL | The URL of the report that shows all Reports as a Service (RaaS) reports. |
| SSOProperties | A list of additional properties required to connect to an identity provider. |
Specifies the types of Workday data that the provider exposes as SQL tables and views.
string
"WQL"
The available values are:
The type of authentication to use when connecting to Workday.
string
"OAuth"
The available authentication methods are:
The name of a tenant tied to your Workday account.
string
""
To obtain the Tenant, log into Workday, type "View API Clients" in the search box, and select the resulting View API Clients report.
You are redirected to the View API Clients page. Near the top of this page, the Workday REST API Endpoint is displayed.
Set this connection property to the portion of the Workday REST API Endpoint after the last forward slash (/).
For example, if you had a Workday REST API Endpoint of https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the value of this property should be set to "mycompany".
Your Workday account's base URL for the Workday API REST Endpoint.
string
""
To obtain the BaseURL, log into Workday, type "View API Clients" in the search box, and select the resulting View API Clients report.
You are redirected to the View API Clients page. Near the top of this page, the Workday REST API Endpoint is displayed.
Set this connection property to the portion of the Workday REST API Endpoint from the beginning to the top-level domain, without the subdirectories or company name.
For example, if you had a Workday REST API Endpoint of https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the value of this property should be set to "https://wd3-impl-services1.workday.com"
Specifies the authenticating user's user ID.
string
""
The authenticating server requires both User and Password to validate the user's identity.
Specifies the authenticating user's password.
string
""
The authenticating server requires both User and Password to validate the user's identity.
The specific SOAP service or services to retrieve data from. Enter as a comma-separated list.
string
""
When using the Workday SOAP API, the Cloud exposes SOAP services as separate schemas. By default, the Cloud exposes the most common Workday services.
You can find the default list of services below. For the value of this connection property, copy and paste the following value and add or removing entries from this list (see the full list of available services in the table below):
Absence_Management,Academic_Advising,Academic_Foundation,Admissions,Adoption,Benefits_Administration,Campus_Engagement,Cash_Management,Compensation,Compensation_Review,Dynamic_Document_Generation,Financial_Aid,Financial_Management,Human_Resources,Identity_Management,Integrations,Inventory,Learning,Payroll,Payroll_CAN,Payroll_GBR,Payroll_Interface,Performance_Management,Recruiting,Resource_Management,Revenue_Management,Scheduling,Settlement_Services,Staffing,Student_Core,Student_Finance,Student_Recruiting,Talent,Time_Tracking,Workday_Connect,Workday_Extensibility,Workforce_Planning
If you want to use an older version, the WSDLVersion connection property allows you to set the specific version of the specified service(s) the Cloud uses.
The table below lists all the services exposed by the current WSDL version and whether or not the Cloud exposes each service by default. If you are using a different WSDL version, this list may not include all available services. For more information, please refer to the Web Services Directory page for your specific WSDL version.
| Service Name | Included By Default? |
| ACA_Partner_Integrations | No |
| Absence_Management | Yes |
| Academic_Advising | Yes |
| Academic_Foundation | Yes |
| Admissions | Yes |
| Adoption | Yes |
| Benefits_Administration | Yes |
| Benefits_Partner_Program_Integrations | No |
| Campus_Engagement | Yes |
| Cash_Management | Yes |
| Compensation | Yes |
| Compensation_Review | Yes |
| Drive | No |
| Dynamic_Document_Generation | Yes |
| External_Integrations | Yes |
| Financial_Aid | Yes |
| Financial_Management | Yes |
| Human_Resources | Yes |
| Identity_Management | Yes |
| Integrations | Yes |
| Interview_Feedback__Do_Not_Use_ | No |
| Inventory | Yes |
| Learning | Yes |
| Metadata_Translations | No |
| Moments | No |
| Notification | No |
| Org_Studio | No |
| Payroll | Yes |
| Payroll_AUS | No |
| Payroll_CAN | Yes |
| Payroll_FRA | No |
| Payroll_GBR | Yes |
| Payroll_Interface | Yes |
| Performance_Management | Yes |
| Professional_Services_Automation | No |
| Recruiting | Yes |
| Resource_Management | Yes |
| Revenue_Management | Yes |
| Scheduling | Yes |
| Settlement_Services | Yes |
| Staffing | Yes |
| Student_Core | Yes |
| Student_Finance | Yes |
| Student_Records | No |
| Student_Recruiting | Yes |
| Student_Transfer_Credit | No |
| Talent | Yes |
| Tenant_Data_Translation | No |
| Time_Tracking | Yes |
| Workday_Connect | Yes |
| Workday_Extensibility | Yes |
| Workforce_Planning | Yes |
Split WQL data sources into multiple tables.
bool
false
Workday data sources often have several hundred fields, with some data sources like allWorkers having thousands of fields.
Many database and reporting tools do not support tables with this many columns.
By default, the Cloud exposes all of a data source's fields, so tools with these limitations cannot use larger data sources.
When this connection property is set to True, the Cloud creates multiple tables for complex Workday data sources, allowing tools with limitations on the total column number to display all of the data source columns.
Each split table contains between 50-100 columns, along with the primary key, last modified timestamp and effective and entry inputs.
JOINs can be used if data is required from columns that are part of different split tables. For example:
SELECT a.academicDegree, b.yearsExperience FROM allWorkers_1 a INNER JOIN allWorkers_60 b ON a.workdayID = b.workdayID
The URL of the report that shows all Reports as a Service (RaaS) reports.
string
""
Workday does not have a built-in way of finding all the reports which can be used with RaaS.
In order to discover these reports automatically, the Cloud uses a custom report that lists all reports enabled for RaaS.
See Fine-Tuning Data Access for instructions on how to create the report and retrieve its URL.
A list of additional properties required to connect to an identity provider.
string
""
Applies when AuthScheme is set to AzureAD
AzureAD has properties to control which Azure resource is used to authenticate the user.
AzureAD SSO uses two applications, the SSO application registered to Workday and a separate OAuth application for the Cloud.
The Cloud must know the resource ID of the SSO application so that it can ask that application to authenticate your user.
This connection properties allows you to enter a list of SSO-related values, entered in this format: Resource=value;AzureTenant=value;AzureClientID=value;AzureClientSecret=value;
Values that you can set via this connection property include:
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAuthorizationURL | The OAuth authorization endpoint associated with your Workday account. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
The OAuth authorization endpoint associated with your Workday account.
string
""
Workday uses different base URLs for the website and API endpoints. For most operations, the Cloud uses the API base URL as given in the BaseURL property. However, when using AuthScheme=OAuth, the Cloud directs users to a website URL to authenticate to Workday.
If your BaseURL follows one of the following patterns, the Cloud discovers the OAuth authorization URL automatically, in which case you do not need to set this connection property.
The X and Y in these patterns are internal Workday service numbers. For example, the BaseURL https://wd1-services2.workday.com matches the pattern https://wdX-servicesY.workday.com.
If your OAuth authorization endpoint does not follow one of these patters, or if you are unsure whether your BaseURL matches a pattern, set this connection property directly.
To obtain the value manually, log into Workday, type "View API Clients" in the search box, and select the resulting View API Clients report.
You are redirected to the View API Clients page. Near the top of this page, the Authorization Endpoint is displayed. Copy this value and set it as the value of this connection property.
The value set in this connection property takes priority over any automatic value.
Specifies the OAuth refresh token used to request a new access token after the original has expired.
string
""
The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.
The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessTokenproc; stored procedure if you prefer to manage the refresh manually.
When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.
Note: The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
string
""
The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.
To determine how long the user has before the Access Token will expire, check OAuthTokenTimestamp.
Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created.
string
""
The OAuth access token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.
An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.
This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
Supplies the name of the client certificate's JWT Certificate store.
string
""
The OAuthJWTCertType field specifies the type of the certificate store specified in OAuthJWTCert. If the store is password-protected, use OAuthJWTCertPassword to supply the password..
OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, the CData Cloud initiates a search for a certificate. For further information, see OAuthJWTCertSubject.
Designations of certificate stores are platform-dependent.
Notes
Identifies the type of key store containing the JWT Certificate.
string
"PEMKEY_BLOB"
| Value | Description | Notes |
| USER | A certificate store owned by the current user. | Only available in Windows. |
| MACHINE | A machine store. | Not available in Java or other non-Windows environments. |
| PFXFILE | A PFX (PKCS12) file containing certificates. | |
| PFXBLOB | A string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. | |
| JKSFILE | A Java key store (JKS) file containing certificates. | Only available in Java. |
| JKSBLOB | A string (base-64-encoded) representing a certificate store in Java key store (JKS) format. | Only available in Java. |
| PEMKEY_FILE | A PEM-encoded file that contains a private key and an optional certificate. | |
| PEMKEY_BLOB | A string (base64-encoded) that contains a private key and an optional certificate. | |
| PUBLIC_KEY_FILE | A file that contains a PEM- or DER-encoded public key certificate. | |
| PUBLIC_KEY_BLOB | A string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. | |
| SSHPUBLIC_KEY_FILE | A file that contains an SSH-style public key. | |
| SSHPUBLIC_KEY_BLOB | A string (base-64-encoded) that contains an SSH-style public key. | |
| P7BFILE | A PKCS7 file containing certificates. | |
| PPKFILE | A file that contains a PPK (PuTTY Private Key). | |
| XMLFILE | A file that contains a certificate in XML format. | |
| XMLBLOB | Astring that contains a certificate in XML format. | |
| BCFKSFILE | A file that contains an Bouncy Castle keystore. | |
| BCFKSBLOB | A string (base-64-encoded) that contains a Bouncy Castle keystore. |
Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank.
string
""
This property specifies the password needed to open a password-protected certificate store. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.
Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
string
"*"
The value of this property is used to locate a matching certificate in the store. The search process works as follows:
You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected].
Common fields include:
| Field | Meaning |
| CN | Common Name. This is commonly a host name like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".
The issuer of the Java Web Token.
string
""
The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.
The user subject for which the application is requesting delegated access.
string
""
The user subject for which the application is requesting delegated access. Typically, the user account name or email address.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| EnforceWQLRowLimit | Restricts queries to returning only 1 million rows. |
| ExpandIDTypes | Display one column per ID type when a report contains multiple ID types. |
| ExpandMultiValueLimit | Specifies the maximum number of output rows that can be expanded from a single input row (applies when ExpandMultiValues is set to True). |
| ExpandMultiValues | Determines if multi-instance fields are expanded into separate rows. |
| IgnoreHardcodedIncludes | For the SOAP API, ignores the hardcoded includes for the specified (comma seperated) tables. |
| IncludeChildTableAggregates | Include aggregate columns for child tables (applies when ConnectionType is set to SOAP). |
| IncludeIDInDescriptor | Includes the ID in descriptor fields (applies when ConnectionType is set to WQL). |
| IncludeRESTTenantFields | Includes tenant-specific columns in REST metadata (applies when ConnectionType is set to REST). |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MetadataFilters | A comma-separated list of column types to exclude from query results. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Workday. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| SingleEntryTables | A list of tables for which SOAP API collections are displayed as one row entry per collection entry. |
| SOAPRequestDates | The method used by the provider to assign the As_Of_Effective_Date and As_Of_Entry_DateTime request parameters (applies when ConnectionType is set to SOAP). |
| SplitSingleValuePrompts | Split lists of prompt values when Workday only allows one. |
| TablePageSizes | A list of per-table overrides for the default page size (applies when ConnectionType is set to SOAP). |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseDefaultIncludes | For the SOAP API, disables requesting any field includes for the specified (comma separated) tables. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |
| WQLDataSourceFilters | A comma-separated list of data sources paired with filters, used to override the default filter used by the provider when querying the specified WQL data sources. |
| WSDLURL | The URL to the WSDL. Only applies when ConnectionType is set to SOAP. |
| WSDLVersion | The version of the WSDL to use for the service(s) specified in the Service connection property. Only applies when ConnectionType is set to SOAP. |
Restricts queries to returning only 1 million rows.
bool
true
By default, the Cloud adds a LIMIT 1000000 to any WQL query it executes.
This prevents Workday from raising an error if the query would return too many values.
When this connection property is set to False, the Cloud does not add the LIMIT clause.
Any queries that would return more rows than the Workday row limit instead raise an error.
Display one column per ID type when a report contains multiple ID types.
bool
false
Note: This connection property only applies when ConnectionType is set to Reports.
Every Workday entity is identified by a unique ID (generated by Workday) called a Workday ID (WID), but some types of entities have other types of identifiers.
For example, a Workday country record for the United States is identified using the "US" country code in addition to its WID.
By default, the Cloud collects all these IDs under one column and produce an aggregate.
For example, this is the value of the Country_Reference.ID column for the US record:
<wd:Country_Reference>
<wd:ID type="WID">abcdef1234567890</wd:ID>
<wd:ID type="Country_Code">US</wd:ID>
</wd:Country_Reference>
If this connection property is set to True, the Cloud instead produces a separate column for each ID type. The aggregate value above is expanded into these two columns:
Specifies the maximum number of output rows that can be expanded from a single input row (applies when ExpandMultiValues is set to True).
int
500
When using ExpandMultiValues, the Cloud can generate multiple output rows for each input row from Workday.
Each multi-value column included in the query increases the number of output rows exponentially.
For example, if a table has five array columns and has one row has three values for each, then rows are generated in this pattern:
| Number of Array Columns Selected | Number of Output Rows |
| 0 | 1 |
| 1 | 3 |
| 2 | 9 |
| 3 | 27 |
| 4 | 81 |
| 5 | 243 |
Realistic queries can output thousands of rows which can be expanded into hundreds of thousands of output rows.
Generating these rows reduces the Cloud's performance and can potentially cause the Cloud to run out of memory. To avoid this, the Cloud counts the number of output rows before actually generating them.
If any input row would generate more rows than the ExpandMultiValueLimit, the Cloud reports an error instead. When this happens, you should carefully evaluate the query and remove any array columns that are not required.
Only increase this limit if there is no way to simplify your query.
Determines if multi-instance fields are expanded into separate rows.
bool
false
The behavior of this option depends upon the service you are connecting to.
Refer to ExpandMultiValueLimit to understand the performance implications of enabling this connection property.
The following applies when ConnectionType is set to WQL.
WQL uses multi-value columns to reference multiple rows from another table, such one journal entry referencing multiple journal line items.
By default, the Cloud displays these as an array of JSON dictionaries, each representing a single row from another table, which must be parsed to get individual values.
| workdayID | orderNumber | lineItem |
| 01234 | 1 | [{"id": "123abc", "descriptor": "..."}, {"id": "234bcd", ...}, {"id": "345cde", ...}] |
| 56789 | 2 | [{"id": "456def", "descriptor": "..."}, {"id": "567fea", ...}] |
When this connection property is set to True, the Cloud returns one row for each comma-separated JSON dictionary in the array.
Each of these rows splits the JSON dictionary into an ID column and a descriptor column. It also generates a new field called workdayIDIndex that counts the number of rows expanded from one WQL row.
The workdayID and workdayIDIndex form a composite primary key, instead of the workdayID being the primary key on its own.
| workdayID | workdayIDIndex | orderNumber | lineItem.id | lineItem.descriptor |
| 01234 | 1 | 1 | 123abc | ... |
| 01234 | 2 | 1 | 234bcd | ... |
| 01234 | 3 | 1 | 345cde | ... |
| 56789 | 1 | 2 | 456def | ... |
| 56789 | 2 | 2 | 567fea | ... |
The Cloud only expands rows that are included in the SELECT clause of the query.
If more than one multi-value column is selected, its values are combined with the other multi-value fields using a CROSS JOIN. This ensures that all combinations are included in the output so they can be used in WHERE or JOIN conditions.
The following applies when ConnectionType is set to Reports.
The reporting API behaves similarly to the WQL API, with three main differences:
Most types of reports only include fields from their primary business object, with related business objects included using their IDs.
When reading a non-advanced report with this connection property set to True, the Cloud expands ID values across multiple rows the same way it does when ConnectionType is set to WQL.
Advanced reports can include fields from both the primary business object and directly related business objects. Setting this connection property to True only expands one level of repeated values.
For example, the expenses reports object has the following structure. An advanced report includes fields from both the expense reports themselves as well as the related line items and approver:
With this connection property set to True, the Cloud exposes this report as a view with these columns. Notice that Tax_Codes is left as an aggregate containing all ID types, while Approver.Related_Workers.ID is expanded and includes one type per row.
The following applies when ConnectionType is set to SOAP.
The SOAP API exposes a more complex data model with different types of repeated values:
This connection property only applies to the first two types because complex repeated structures are always exposed as child tables. The other two types behave similarly to WQL and reporting APIs with a few exceptions:
For the SOAP API, ignores the hardcoded includes for the specified (comma seperated) tables.
string
""
We have some hardcoded includes used during the retrieval of data. These are done primarily to correct the specified data we request back when names cannot be figured out automatically. But also in some cases to decrease the amount of data that comes back (such as the case for Workers) to improve performance. Set the value to just the table names in a comma seperated list. Ex: IgnoreHardcodedIncludes=Workers,Payees
This option can be applied to all tables by setting the value to an asterik: IncludeHardcodedIncludes=*
Include aggregate columns for child tables (applies when ConnectionType is set to SOAP).
bool
true
By default, the Cloud exposes child tables as both XML aggregate columns on their parent table, as well as separate tables.
For example, information on parties involved in reported safety incidents is available in two places:
If this connection property is set to False, the aggregate column is not exposed and only the child table is available.
Note that this option does not affect aggregate columns on child tables. The Cloud does not expose second-level child tables, so these aggregates are the only way to access deeply nested data.
Includes the ID in descriptor fields (applies when ConnectionType is set to WQL).
bool
true
Rows in WQL that reference other rows store data in two parts: an internal Workday ID and a descriptor that is a human-readable name for the row being referenced.
For example, a country may have the internal ID 86bc49361cf911ee9f2d00155d17ccfc with the descriptor "Canada".
The Cloud exposes these as two columns, for example, [visaCountry.id] and [visaCountry.descriptor].
This connection property determines the values of the descriptor column:
The Cloud performs the following optimizations when this connection property is set to True:
SELECT * FROM foreignWorkers WHERE [visaCountry.descriptor] = 'Canada / 86bc49361cf911ee9f2d00155d17ccfc'
-- WQL: The ID value is extracted and filtered directly
SELECT ... FROM foreignWorkers WHERE visaCountry = '86bc49361cf911ee9f2d00155d17ccfc'
SELECT [visaCountry.descriptor], COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.descriptor]
-- WQL: The ID value is used for aggregation and combined with the descriptor when reading.
SELECT visaCountry, COUNT(*) FROM foreignWorkers GROUP BY visaCountry
-- Doing this with IncludeIDInDescriptor=false requires aggregating by the ID and looking up the descriptor
-- SELECT t2.descriptor, t1.COUNT FROM (SELECT [visaCountry.id] AS id, COUNT(*) FROM foreignWorkers GROUP BY [visaCountry.id]) t1
-- INNER JOIN foreignWorkers t2 ON t1.id = t2.id
Includes tenant-specific columns in REST metadata (applies when ConnectionType is set to REST).
bool
false
Most of the Workday REST API uses a shared schema that defines columns that are available on all tenants.
The Cloud embeds this shared schema and uses it for most columns in REST tables and views. By default, the Cloud uses only this shared schema.
When you set this connection property to True, the Cloud fetches an additional tenant-specific schema that might contain extra columns. The tenant-specific schema is merged with the shared schema to obtain a complete column list.
Note that the Cloud does not support tenant-specific schemas on owned tables like WorkersCheckIns. Workday requires an owner identifier (Id) to read the schemas from these resources, which is not available when the Cloud discovers column metadata.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
A comma-separated list of column types to exclude from query results.
string
""
Several types of columns in Workday are slow to read or cause errors (see below) when they are queried.
Excluding these column types at the Cloud level allows for faster and more reliable queries without manually excluding these columns from every query.
If a column type is included in this property, it does not show up in table metadata and it cannot be used in queries.
This property can be set to a comma-separated list containing any combination of the following column types.
Specifies the maximum number of records per page the provider returns when requesting data from Workday.
int
500
When processing a query, instead of requesting all of the queried data at once from Workday, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
A list of tables for which SOAP API collections are displayed as one row entry per collection entry.
string
"Payments"
This connection property applies when the ConnectionType connection property is set to SOAP.
When tools like the Cloud request certain data from the Workday SOAP API, the API returns this data in the form of a multi-valued collection, rather than returning individual values.
By default, the Cloud displays each entry in the collection as a separate row and ignores the reference ID(s) that associate the collection entry with the collection it belongs to.
For example, these are the columns visible in the CommitteeDefinition table by default:
However, the Workday SOAP API sometimes lists data as a collection even when only one value is actually allowed inside the collection.
When this happens, you can add the table to this connection property. The Cloud then treats the collection as if it only has one value:
There are three ways to set this property:
The method used by the provider to assign the As_Of_Effective_Date and As_Of_Entry_DateTime request parameters (applies when ConnectionType is set to SOAP).
string
"FutureEffectiveAndEntry"
The following options are available:
Split lists of prompt values when Workday only allows one.
bool
false
When a table or view has a prompt, the Cloud normally requires that the query value be compatible with the prompt type.
Prompts that support multiple values can be set using either equals or IN:
SELECT * FROM workersByOrganization WHERE organizationsForWorker_Prompt = '...';
SELECT * FROM workersByOrganization WHERE organizationsForWorker_Prompt IN ('...', '...', '...');
Prompts that support only one value must be set using equals.
The Cloud reports an error if more than one value is given using IN:
-- OK SELECT * FROM workersByOrganization WHERE includeManagers_Prompt = TRUE; -- Fails SELECT * FROM workersByOrganization WHERE includeManagers_Prompt IN (TRUE, FALSE);
When this connection property is set to True, the Cloud does not report errors when multiple values are given to single value prompts.
Instead, the Cloud splits the query into individual pieces that Workday can execute, and combines the results client-side. This may lead to duplicate results if the same row appears in two or more of the split queries. To avoid this, make sure to include all of the table's primary key columns in the SELECT clause.
Note that this is noticeably slower than the multi-value prompts that are natively supported by Workday. Each additional prompt that the Cloud expands requires exponentially more queries to cover all combinations of values:
-- When this is sent to the Cloud
SELECT * FROM workersByOrganization
WHERE includeManagers_Prompt IN (TRUE, FALSE)
AND includeSubordinateOrganizations_Prompt IN (TRUE, FALSE)
-- These four queries are executed
SELECT * FROM workersByOrganization
WHERE includeManagers_Prompt = TRUE
AND includeSubordinateOrganizations_Prompt = TRUE;
SELECT * FROM workersByOrganization
WHERE includeManagers_Prompt = TRUE
AND includeSubordinateOrganizations_Prompt = FALSE;
SELECT * FROM workersByOrganization
WHERE includeManagers_Prompt = FALSE
AND includeSubordinateOrganizations_Prompt = TRUE;
SELECT * FROM workersByOrganization
WHERE includeManagers_Prompt = FALSE
AND includeSubordinateOrganizations_Prompt = FALSE;
A list of per-table overrides for the default page size (applies when ConnectionType is set to SOAP).
string
""
By default, the Cloud uses a page size of 100 (as recommended by Workday), meaning data is requested from the Workday SOAP API 100 items at a time. In most cases this offers a good balance between performance and stability.
However, in some situations, a different page size is required.
You can set the page size for a specific table using the table's name, an equals sign, and the page size (TableName=50). You can do this multiple times to override the page size for multiple tables (each TableName=PageSize statement is comma-separated). For example, Workers=10,MessageTemplate=250 changes the Workers table's page size to 10 and the MessageTemplate table's page size to 250.
The Cloud also allows you to override the page size for all tables that don't have an existing explicit override by using an asterisk as the table name. For example, to set the Workers page size to 20 and every other table's page size to 500: Workers=20,*=500.
The page size for each table can be any number between 1 and 999 inclusive. The best page size value depends upon the table and the exact data you are querying, and needs to be determined through testing. The following are guidelines for determining how to adjust the page size:
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
For the SOAP API, disables requesting any field includes for the specified (comma separated) tables.
string
""
By default the Cloud will use a hard-coded list of field includes. This can be desirable because some tables don't retrieve certain includes for performance reasons. But that option will send every field include when requesting data for a table, when the Workday default may be better instead.
Including the table in this property makes the Cloud not send any field includes and use the Workday defaults instead. If any tables are included in this option and IgnoreHardcodedIncludes, this option takes priority and no includes will be sent.
This option can be applied to all tables by setting the value to an asterik: UseDefaultIncldues=*
Note that this option does not apply to child tables. The Cloud calculates child table includes based on the specific collection that the child table reads from. The default includes do not contain these collections so the Cloud's calculated includes must be used instead.
Specifies whether or not simple names should be used for tables and columns.
bool
false
Workday tables can include special characters in their names that are typically not allowed in standard databases. This property makes the Cloud easier to use with traditional database tools.
Setting UseSimpleNames to True simplifies the names of the columns that are returned. It enforces a naming scheme where only alphanumeric characters and underscores are valid for displayed column names.
Notes:
A comma-separated list of data sources paired with filters, used to override the default filter used by the provider when querying the specified WQL data sources.
string
""
A WQL data source can have one or more data source filters. Each filter has its own set of prompts which determine the rows that are returned from the query. The fields included in each record are the same between filters.
The Cloud exposes one view per data source and determines the filter to use automatically. If the data source does not require a filter, the Cloud view queries the data source directly. Otherwise, the Cloud uses the first filter for the data source.
You can use this connection property to bypass this process for specific data sources.
This property accepts a comma-separated list of dataSource=filter values. The data source is the WQL alias of the data source, while the filter is the WQL alias of the filter. These values are displayed on the View Data Source and View Data Source Filter screens, respectively.
Note that the data source name is not always the same as the view name. If UseSplitTables is enabled, the Cloud makes multiple views (journalLines_1, journalLines_2, ...) from the same data source (journalLines). All of these split views query the same data source.
For example, this value makes the journalLines view query the journalLinesFind filter, and the projectPortfolio view query the projectPortfolioDefaultFilter filter:
journalLines=journalLinesFind,projectPortfolio=projectPortfolioDefaultFilter
The URL to the WSDL. Only applies when ConnectionType is set to SOAP.
string
""
As an alternative to entering Service and WSDLVersion, the WSDL URL for a particular service may be entered directly.
To retrieve this value, from the Workday Web Services Directory, right-click one of the "WSDL" links in the Definitions column and copy the link address. Set this connection property to the copied value. For example:
https://community.workday.com/sites/default/files/file-hosting/productionapi/Human_Resources/v44.0/Human_Resources.wsdl
The version of the WSDL to use for the service(s) specified in the Service connection property. Only applies when ConnectionType is set to SOAP.
string
"v44.1"
The Cloud can only connect to a single version of the Workday SOAP API. Use this property to change what version of the API the Cloud uses. This property affects all SOAP services specified in the Service property.
The latest version of the Workday SOAP API's WSDL changes often.
If you would like to use the latest version, the version may be set to a higher value in this connection property to match the latest release.
Alternatively, you can set the WSDLURL directly and this property will be ignored.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.