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.

Connecting to Workday

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 CData Cloud Services

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.

Connecting to Workday

This section describes how to set the connection parameters for the four Workday APIs, and how to obtain the Tenant and BaseURL. Each service (WQL, Reports, REST, and SOAP) has its own ConnectionType, and only one connection type can be used per connection.

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.

Connection Prerequisites

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

Obtaining the BaseURL and Tenant

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:

• https://domain.com/subdirectories/ is the BaseURL.
• mycompany (the portion of the url after the very last slash) is the Tenant.

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.

Enabling WQL Service

To connect through the Workday WQL API, you must first enable the WQL Service:

1. Open Workday.
2. In the search bar, search for View Domain.
3. At the prompt, enter Workday Query Language.
4. Check the Allowed Security Group Types to see if one of them includes the user you are connecting with.

Authenticating to Workday

Most Workday connections require the creation of an OAuth-based custom API Client application to authenticate. This includes enterprise installations where users connect via their Azure AD credentials. If you want to connect via SOAP, you can use Basic authentication, which doesn't require a custom OAuth application.

This section describes both methods of authentication.

OAuth

This section describes how to authenticate in an environment without SSO, using the OAuth standard. Before you can authenticate in this environment, you must first create a custom OAuth application, as described in Creating a Custom API Client Application.

Note: Because they facilitate authentication to Workday APIs, this document frequently refers to custom OAuth applications as custom API Clients.

Authenticating as a Normal User

To authenticate as a normal user in Workday, you must first create an API Client, as described in Creating a Custom API Client Application.

After you have an API client configured, set the following properties to connect using Workday credentials:

Standard OAuth User

• ConnectionType and related properties.
• AuthScheme: OAuth.
• OAuthClientId: The Client ID obtained from the View API Client page.
• OAuthClientSecret: The Client Secret obtained from the View API Client page. If you are using a public client, leave this blank.
• Tenant: The tenant for the account.
• BaseURL: The base URL for the REST API Endpoint in the View API Clients page.
• OAuthAuthorizationURL: Optional but recommended. The Authorization URL in the View API Clients page.

AzureAD User

• ConnectionType and related properties.
• AuthScheme: AzureAD.
• OAuthClientId: The Client ID obtained from the View API Client page.
• Tenant: The tenant for the account.
• BaseURL: The base URL for the REST API Endpoint in the View API Clients page.
• SSOProperties: The Azure-specific properties used for SSO, including the AzureTenant, AzureClientId, AzureClientSecret and Resource.

Authenticating as an ISU

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

• ConnectionType and related properties.
• AuthScheme: OAuthISU.
• OAuthClientId: The Client ID obtained from the View API Client page.
• OAuthClientSecret: The Client Secret obtained from the View API Client page.
• OAuthRefreshToken: The refresh token obtained from the Manage Refresh Tokens for Integrations page.
• Tenant: The tenant for the account.
• BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

API Client (JWT)

• ConnectionType and related properties.
• AuthScheme: OAuthJWT.
• OAuthJWTCertType: The certificate type. If you created the certificate with keytool or openssl pkcs12, this should be PFXFILE.
• OAuthJWTCert: The path of the certificate file you created.
• OAuthJWTCertPassword: The password of the certificate file you created.
• OAuthJWTIssuer: The Client ID obtained from the View API Client page.
• OAuthJWTSubject: The username of the ISU you are using.
• Tenant: The tenant for the account.
• BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

SOAP API

Connections using the SOAP API support all the same authentication schemes that the WQL and reporting services do. They also support Basic authentication, which does not require configuring a custom API client.

To use Basic authentication, set these connection parameters:

• ConnectionType: SOAP.
• AuthScheme: Basic.
• User: The Workday user account name.
• Password: The Workday user's password.
• Tenant: The tenant for the account.
• BaseURL: The base URL for the REST API Endpoint in the View API Clients page.

Other authentication methods are configured the same way as for the WQL and reporting services.

Required Scopes and Endpoint Domains for Workday

When integrating with Workday, your application needs specific permissions to interact with the API.

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.

Understanding Scopes

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.

Required Scopes for Workday

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.

Understanding Endpoint Domains

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.

Required Endpoint Domains for Workday

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

Fine Tuning Data Access

SOAP API

When connecting with ConnectionType set to SOAP, the following properties will determine what tables are exposed:

• Service: A comma-separated list of Workday WSDLs to load. Each WSDL contains one schema which exposes multiple tables.
• WSDLURL: The URL to load a Workday WSDLs from. If provided, this will override Service and present WSDLs tables under the Workday schema.
• WSDLVersion: The version of the Workday API to load the WSDLs for. This can be used to request a newer or older version of the Workday data model.

Accessing Reports as a Service

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:

1. Open the Create Custom Report form.
2. Name the report Reports as a Service.
3. Enter Advanced for the report type.
4. Select Enable As Web Service.
5. Clear Optimized for Performance.
6. Enter All Custom Reports for the Data Source.

After the report is created, you need to add a few columns and filters:

1. In Fields
   • For the first column, enter Report Name.
   • Add a second colum and enter Web Service Namespace.
   • Add a third colum and enter Report Owner.
   • Add a fourth colum and enter Brief Description.
2. Make sure all columns have the primary business object as their Business Object. The primary business object has the name Custom Report and should have a box-and-arrow icon beside it. If the icon is an ellipsis (...) instead, then click menu , select Primary Business Object and then Custom Field.
3. Open the Filter tab and create a new filter. Enter Web Service Namespace as the field and is not blank as the Operator.
4. Add a second filter. Enter Current User as the field, in the selection list as the Operator, Value from Another Field as the comparison type, and Authorized Users as the comparison value.
5. Click OK to save the report. If Workday displays any warnings then click OK again to dismiss them.

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.

1. Open the newly created report.
2. Click the ellipsis (...) button beside the report title in the upper-left corner of the screen
3. Find the Web Services tab within the pop-up. You may have to scroll down inside the pop-up to see it.
4. Hover over it and select View URLs.
5. Copy the Workday XML link.

Change Process Permissions (REST API)

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:

1. Open the Edit Business Process Security Policy task. Provide the name of the business process at the prompt.
2. In the Who Can Start the Business Process section, find the initiating action containing the text REST.
3. Add a security group that covers the user or integration service user configured with the Cloud.
4. Execute the Activate Pending Security Policy Changes task to apply the change.

Reports

No Valid RaaS Reports

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:

1. The schema of the catalog report is incorrect. You should check that the report has all the columns described by Fine-Tuning Data Access. In addition, make sure that the Column XML Alias is empty on each field. A missing field or invalid alias prevents the Cloud from processing the data in the catalog report.
2. The user does not have access to any reports. For each report you want the user to access, you should check that the user can access the data source used to create the report. The report itself must also be accessible to the user. The user should either own the report, or have access through the options listed in the Share tab in the report definition.
3. The report is not web service enabled. To verify this, run the catalog report by hand and check that the Web Service Namespace column is not empty. If it is, go to the report definition, open the Advanced tab, and activate the Enable As Web Service option. Note that this option is not available for all types of reports.

SOAP

Invalid Request

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.

The Task Submitted is not Authorized

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.

Customizing the SSL Configuration

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.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

WQL APIs

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:

• Prism data sources provide access to published tables and dataset defined within Prism Analytics. All Prism data sources start with the prefix cds_. These data sources are easy to consume because they do not require providing values for prompts. They are also the most performant because they are served from dedicated Prism services. However, they must be created explicitly within the Prism Data Catalog, and are only updated when they are refreshed within Prism.
• Core data sources provide access to built-in Workday data sources like Workers and Journals. Workday does not recommend using these sources directly, as they are both more difficult to query and slower than data sources from Prism. They use the same resources as the rest of your Workday tenant and complex queries (or queries returning many rows) can slow down your tenant for other users. The main behefit of these data sources is that they always contain live data instead of needing to be refreshed.

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.

Reports

When ConnectionType is set to Reports, the Cloud also grants access to reports that are exposed using Reports as a Service (RaaS). These reports are exposed as views within the Reports schema. Accessing these reports requires extra connection setup beyond the basic settings for WQL access. For details on what it required, see Fine-Tuning Data Access.

REST APIs

The data model included in the REST section is only available when ConnectionType is set to REST.

SOAP APIs

The data models listed in Service are only available in the SOAP API. To use them, set ConnectionType SOAP.

Prompts

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'

Request References

In addition to _Prompt columns, the SOAP data model also includes columns with the _RequestRef suffix. Request references are parameters that normally correspond to a data field that stores an ID. These parameters increase read performance by allowing the Cloud to request individual records, instead of requesting all records and filtering internally.

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 _RequestRef column. These columns are used exactly the same way as _Prompt columns within queries.

Response Filters

The Cloud's SOAP data model includes one other type of input column that uses the _RespFilter suffix. These columns control the two date inputs within the response filter:

• As_Of_Effective_Date_RespFilter tells Workday to retrieve records as they appeared on a given date. This allows you to either exclude changes after that date (if set to the past), or include changes before that date (if set to the future). By default the Cloud uses an effective date two years in the future.
• As_Of_Entry_DateTime_RespFilter tells Workday to retrieve records that were created as of the given timestamp. At the start of a query, Workday determines what records should be returned and caches them on the current session. The Cloud provides the same entry timestamp for each page so that Workday returns consistent results from the cache. Setting this field is not recommended as most SOAP tables have data fields that store the created and last modified timestamp for each record. This field is included for cases where the default entry datetime causes the request to fail.

Aggregate Prompts

The SOAP data model includes endpoints with more complex prompts than other services. SOAP includes structured prompt values that the Cloud typically flattens into individual prompts. These can be provided as simple values (like text and timestamps) which the Cloud uses to build the XML for the SOAP request.

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:

• The Cloud inserts namespace prefixes on all elements and attributes. Your aggregate must not include any namespaces.
• The Cloud does not change the text content of elements or the values of attributes. Workday rejects requests that have incorrectly formatted data, so you must be careful to format values according to Workday requirements. In this example, providing the value "May 28 2024" in the As_Of_Effective_Date element would cause the request to fail.

This section contains examples of views that may be accessible when ConnectionType is set to WQL. All the data sources used by these views are part of core Workday and the HCM module.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - Workday Views

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.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_CompensationPlanEqualToHourly	Bool		Compensation Plan = Hourly
cf_FrequencyForCompensationPlan_id	String		Frequency for Compensation Plan id
cf_FrequencyForCompensationPlan_descriptor	String		Frequency for Compensation Plan descriptor
cf_CompensationPlanEqualToAllowance	Bool		Compensation Plan = Allowance
cf_CompensationPlanEqualToBonus	Bool		Compensation Plan = Bonus
cf_CompensationPlanTypeEqualToMerit	Bool		Compensation Plan Type = Merit
cf_CompensationPlanEqualToCommission	Bool		Compensation Plan = Commission
cf_CompensationPlanEqualToStock	Bool		Compensation Plan = Stock
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary	Bool		Compensation Plan = Salary Plan (Unit, Period or Salary)
compensationPlanName	String		Compensation Plan Name
description	String		Description
compensationPlanDefaults_id	String		Compensation Plan Defaults id
compensationPlanDefaults_descriptor	String		Compensation Plan Defaults descriptor
compensationPlanProcessHistory	String		Compensation Plan Process History
compensationPackages	String		Compensation Packages
eligibilityRules	String		Eligibility Rules
compensationPlan_id	String		Compensation Plan id
compensationPlan_descriptor	String		Compensation Plan descriptor
positionsInCompensationPlan	String		Positions in Compensation Plan
employeesInCompensationPlan	String		Employees in Compensation Plan
calculationType_id	String		Calculation Type id
calculationType_descriptor	String		Calculation Type descriptor
calculation_id	String		Calculation id
calculation_descriptor	String		Calculation descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Bonus Plan as the primary object and returns one row per bonus plan. Includes all active bonus plans. Does not contain built-in prompts. The data source delivers the additions and removals for bonus plans over time.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_CompensationPlanEqualToHourly	Bool		Compensation Plan = Hourly
cf_FrequencyForCompensationPlan_id	String		Frequency for Compensation Plan id
cf_FrequencyForCompensationPlan_descriptor	String		Frequency for Compensation Plan descriptor
cf_CompensationPlanEqualToAllowance	Bool		Compensation Plan = Allowance
cf_CompensationPlanEqualToBonus	Bool		Compensation Plan = Bonus
cf_CompensationPlanTypeEqualToMerit	Bool		Compensation Plan Type = Merit
cf_CompensationPlanEqualToCommission	Bool		Compensation Plan = Commission
cf_CompensationPlanEqualToStock	Bool		Compensation Plan = Stock
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary	Bool		Compensation Plan = Salary Plan (Unit, Period or Salary)
compensationPlanName	String		Compensation Plan Name
description	String		Description
compensationPlanDefaults_id	String		Compensation Plan Defaults id
compensationPlanDefaults_descriptor	String		Compensation Plan Defaults descriptor
compensationPlanProcessHistory	String		Compensation Plan Process History
compensationPackages	String		Compensation Packages
eligibilityRules	String		Eligibility Rules
compensationPlan_id	String		Compensation Plan id
compensationPlan_descriptor	String		Compensation Plan descriptor
positionsInCompensationPlan	String		Positions in Compensation Plan
employeesInCompensationPlan	String		Employees in Compensation Plan
calculationType_id	String		Calculation Type id
calculationType_descriptor	String		Calculation Type descriptor
calculation_id	String		Calculation id
calculation_descriptor	String		Calculation descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Compensation Plan as the primary object and returns one row per plan. Includes all active plans. Does not contain built-in prompts. This data source delivers the additions and removals for plans over time.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_CompensationPlanEqualToHourly	Bool		Compensation Plan = Hourly
cf_FrequencyForCompensationPlan_id	String		Frequency for Compensation Plan id
cf_FrequencyForCompensationPlan_descriptor	String		Frequency for Compensation Plan descriptor
cf_CompensationPlanEqualToAllowance	Bool		Compensation Plan = Allowance
cf_CompensationPlanEqualToBonus	Bool		Compensation Plan = Bonus
cf_CompensationPlanTypeEqualToMerit	Bool		Compensation Plan Type = Merit
cf_CompensationPlanEqualToCommission	Bool		Compensation Plan = Commission
cf_CompensationPlanEqualToStock	Bool		Compensation Plan = Stock
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary	Bool		Compensation Plan = Salary Plan (Unit, Period or Salary)
compensationPlanName	String		Compensation Plan Name
description	String		Description
compensationPlanDefaults_id	String		Compensation Plan Defaults id
compensationPlanDefaults_descriptor	String		Compensation Plan Defaults descriptor
compensationPlanProcessHistory	String		Compensation Plan Process History
compensationPackages	String		Compensation Packages
eligibilityRules	String		Eligibility Rules
compensationPlan_id	String		Compensation Plan id
compensationPlan_descriptor	String		Compensation Plan descriptor
positionsInCompensationPlan	String		Positions in Compensation Plan
employeesInCompensationPlan	String		Employees in Compensation Plan
workdayID	String		Workday ID
referenceID1	String		Reference ID
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Compensation Rule as its primary object. The Compensation Rule object returns one row per Compensation Rule. Includes all Compensation Rules. Does not contain any built-in prompts.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
positionsAndPositionGroupsSelectedByCompensationRule	String		Positions and Position Groups Selected by Compensation Rule
compensationRuleName	String		Compensation Rule Name
compensationRuleAssignment_id	String		Compensation Rule Assignment id
compensationRuleAssignment_descriptor	String		Compensation Rule Assignment descriptor
compensationComponents	String		Compensation Components
employeesSelectedByCompensationRule	String		Employees Selected by Compensation Rule
compensationGradeProfiles	String		Compensation Grade Profiles
compensationGrades	String		Compensation Grades
compensationPlans	String		Compensation Plans
compensationPackages	String		Compensation Packages
workdayID	String		Workday ID
compensationEligibilityRule_id	String		Compensation Eligibility Rule id
compensationEligibilityRule_descriptor	String		Compensation Eligibility Rule descriptor
referenceID	String		Reference ID
createdMoment	Date		Created Moment
lastFunctionallyUpdated	Date		Last Functionally Updated
currentOMSVersion_id	String		Current OMS Version id
currentOMSVersion_descriptor	String		Current OMS Version descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses Job Profile as the primary object and returns one row per job profile. Includes all active and inactive job profiles. Does not contain built-in prompts.

Columns

Name	Type	References	Description
cf_JobProfileDegrees	String		Job Profile Degrees
cf_CompensationSurvey	String		Compensation Survey
cf_JobEvaluationScore	String		Job Evaluation Score
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_countriesWherePayRateTypeEqualToSalaried	String		Countries where Pay Rate Type = Salaried
cf_countriesWherePayRateTypeEqualToHourly	String		Countries where Pay Rate Type = Hourly
cf_CompensationGroup_id	String		Compensation Group id
cf_CompensationGroup_descriptor	String		Compensation Group descriptor
jobProfileName	String		Job Profile Name
jobFamilyGroupAndFamily	String		All Job Families and Groups for Job Profile
jobProfileSummary	String		Job Profile Summary
jobProfile_id	String		Job Profile id
jobProfile_descriptor	String		Job Profile descriptor
jobClassifications	String		Job Classifications
managementLevel_id	String		Management Level id
managementLevel_descriptor	String		Management Level descriptor
ID	String		ID
compensationGradesImpactedByRules	String		Compensation Grades impacted by rules
jobExempt	Bool		Job Exempt
averagePay_Amount_value	Decimal		Average Pay - Amount value
averagePay_Amount_currency	String		Average Pay - Amount currency
employeeCount	Int		Employee Count
highestPay_Amount_value	Decimal		Highest Pay - Amount value
highestPay_Amount_currency	String		Highest Pay - Amount currency
lowestPay_Amount_value	Decimal		Lowest Pay - Amount value
lowestPay_Amount_currency	String		Lowest Pay - Amount currency
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Merit Plan as the primary object and returns one row per plan. Includes all active and inactive plans. Does not contain any built-in prompts. The data source delivers the additions and removals for plans over time.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_CompensationPlanEqualToHourly	Bool		Compensation Plan = Hourly
cf_FrequencyForCompensationPlan_id	String		Frequency for Compensation Plan id
cf_FrequencyForCompensationPlan_descriptor	String		Frequency for Compensation Plan descriptor
cf_CompensationPlanEqualToAllowance	Bool		Compensation Plan = Allowance
cf_CompensationPlanEqualToBonus	Bool		Compensation Plan = Bonus
cf_CompensationPlanTypeEqualToMerit	Bool		Compensation Plan Type = Merit
cf_CompensationPlanEqualToCommission	Bool		Compensation Plan = Commission
cf_CompensationPlanEqualToStock	Bool		Compensation Plan = Stock
cf_CompensationPlanEqualToSalaryPlanUnitPeriodOrSalary	Bool		Compensation Plan = Salary Plan (Unit, Period or Salary)
compensationPlanName	String		Compensation Plan Name
description	String		Description
compensationPlanDefaults_id	String		Compensation Plan Defaults id
compensationPlanDefaults_descriptor	String		Compensation Plan Defaults descriptor
compensationPlanProcessHistory	String		Compensation Plan Process History
compensationPackages	String		Compensation Packages
eligibilityRules	String		Eligibility Rules
compensationPlan_id	String		Compensation Plan id
compensationPlan_descriptor	String		Compensation Plan descriptor
positionsInCompensationPlan	String		Positions in Compensation Plan
employeesInCompensationPlan	String		Employees in Compensation Plan
workdayID	String		Workday ID
referenceID1	String		Reference ID
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Position as its primary object. The Position object returns one row per position. Includes only open positions that are in supervisory organizations that the user has access. Does not contain any built-in prompts.

Columns

Name	Type	References	Description
cf_SupervisoryOrganizationHierarchy_id	String		Supervisory Organization Hierarchy id
cf_SupervisoryOrganizationHierarchy_descriptor	String		Supervisory Organization Hierarchy descriptor
cf_EarliestHireDate_Quarter	String		Earliest Hire Date - Quarter
cf_MonthsFromEarliestHireDate	Int		Months from Earliest Hire Date
cf_TimeToFill1	Int		Time to Fill
cf_OpenPositionCountAtEndOfLastQuarter	Int		Open Position Count at End of Last Quarter
cf_ExecutiveGroup1_id	String		Executive Group id
cf_ExecutiveGroup1_descriptor	String		Executive Group descriptor
cf_AnnualPositionBurdenInUSD1_value	Decimal		Annual Position Burden in USD value
cf_AnnualPositionBurdenInUSD1_currency	String		Annual Position Burden in USD currency
cf_DaysFromEarliestHireDate	Int		Days from Earliest Hire Date
cf_NumberOfMonthsPositionUnfilled	Int		# of Months Position Unfilled
cf_PositionCount_Frozen	Int		Position Count - Frozen
cf_AnnualPositionBurdenInUSDOpenPositionsOnly_value	Decimal		Annual Position Burden in USD (Open Positions Only) value
cf_AnnualPositionBurdenInUSDOpenPositionsOnly_currency	String		Annual Position Burden in USD (Open Positions Only) currency
cf_IsPositionOpenAndEarliestHireDateCurrent	Bool		Is Position Open and Earliest Hire Date Current
cf_EarliestHireDate9Months1	Date		Earliest Hire Date + 9 Months
cf_CompensationRangeMidpointInUSD_value	Decimal		Compensation Range Midpoint in USD value
cf_CompensationRangeMidpointInUSD_currency	String		Compensation Range Midpoint in USD currency
cf_EarliestHireDate6Months1	Date		Earliest Hire Date + 6 Months
cf_OpenPositionCount_GAndA	Int		Open Position Count - G and A
cf_TimeInPositionRange_id	String		Time in Position Range id
cf_TimeInPositionRange_descriptor	String		Time in Position Range descriptor
cf_IsInGAndA	Bool		Is in G and A
cf_AvailableYearQuarter	String		Available Year Quarter
cf_EarliestHireDate3Months1	Date		Earliest Hire Date + 3 Months
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses Pre-Hire as the primary object and returns one row per pre-hire. Includes all pre-hires as well as pre-hires converted to hires. Does not contain built-in prompts.

Columns

Name	Type	References	Description
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
cf_WorkerCountryISOCodeOnExpensePayee	String		Worker Country ISO Code on Expense Payee
pre_Hire_id	String		Pre-Hire id
pre_Hire_descriptor	String		Pre-Hire descriptor
source_id	String		Source id
source_descriptor	String		Source descriptor
referredBy	String		Referred by
pre_HirePools	String		Pre-Hire Pools
datePre_HireAddedToSystem	Date		Date Pre-Hire Added to System
notEligibleForHireComment	String		Eligible for Rehire Comment
comment	String		Comment
resume	String		Resume
pre_HireConsideration	String		Pre-Hire Consideration
availableForHire	Bool		Available For Hire
roleName	String		Role Name
email_Primary	String		Email - Primary
phone_Primary	String		Phone - Primary
organizationRoleAssignments	String		Organization Role Assignments
integrationIdentifier	String		Integration Identifier
organizationRoles	String		Organization Roles
externalIDForSystemID	String		External ID for System ID
raceEthnicity_id	String		Race/Ethnicity id
raceEthnicity_descriptor	String		Race/Ethnicity descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Workday Account object and returns one row per Workday account. Includes all Workday accounts ever created, either currently enabled or not. Does not contain built-in prompts. This data source will show settings of the user login information and preferences in Workday.

Columns

Name	Type	References	Description
forUnitTestingMulti	String		For Unit Testing Multi
cf_ClickableAddedRoleAssignments	String		Clickable Added Role Assignments
cf_ClickableRemovedRoleAssignments	String		Clickable Removed Role Assignments
cf_SecurityGroupsWithAccessToSettlePayments_Payroll	String		Security Groups with Access to Settle Payments - Payroll
cf_SecurityGroupsWithAccessToInputEditOrProcessPayroll	String		Security Groups with Access to Input , Edit or Process Payroll
cf_SecurityGroupsWithAccessToRefundCustomers	String		Security Groups with access to refund customers
cf_SecurityGroupsWithAccessToCreateModifyCustomers	String		Security Groups with access to create / modify customers
cf_ReportsAndTasks_View	String		Reports and Tasks - View
cf_SecurityGroupsWithAccessToCreateModifySuppliers	String		Security Groups with access to create / modify suppliers
cf_ReportsAndTasks_Modify	String		Reports and Tasks - Modify
cf_SecurityGroupsWithAccessToCreateEditSupplierInvoices	String		Security Groups with access to create / edit supplier invoices
cf_BusinessProcessPolicy_Approve	String		Business Process Policy - Approve
cf_BusinessProcessPolicy_Cancel	String		Business Process Policy - Cancel
cf_SecurityGroupsWithAccessToSettlePayments_Suppliers	String		Security Groups with Access to Settle Payments - Suppliers
cf_BusinessProcessPolicy_Rescind	String		Business Process Policy - Rescind
cf_SecurityGroupsWithAccessToCreateModifyExpenseReports	String		Security Groups with access to create / modify expense reports
cf_BusinessProcessPolicy_Initiate	String		Business Process Policy - Initiate
cf_SecurityGroupsWithAccessToSettlePayments_Expenses	String		Security Groups with Access to Settle Payments - Expenses
cf_BusinessProcessPolicy_View	String		Business Process Policy - View
cf_BusinessProcessPolicy_ViewCompleted	String		Business Process Policy - View Completed
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Worker as its primary object and returns one row per worker. Includes all workers even workers to be hired in the future. Does not contain any built-in prompts. This data source can be used to build reports on all workers. Helpful Tips - 1) If the worker is hired in the future, all fields will be returned based on the effective date. 2) If no effective date is specified, the system will use the current date as the effective date. 3) If the effective date is less than the worker's hire date, no effective dated information (such as position information, compensation information and so on) will be returned. 4) If effective dated behavior is desired, use the "All Active and Terminated workers" data source instead.

Columns

Name	Type	References	Description
cf_ContractPayRateAnnualized_value	Decimal		Contract Pay Rate Annualized value
cf_ContractPayRateAnnualized_currency	String		Contract Pay Rate Annualized currency
cf_NumberOfTerminations	Int		# of Terminations
cf_DisciplinaryActions_Completed	String		Disciplinary Actions - Completed
cf_RetirementEligibility_id	String		Retirement Eligibility id
cf_RetirementEligibility_descriptor	String		Retirement Eligibility descriptor
cf_LocationSiteHierarchyLevel2_id	String		Location Site Hierarchy (Level 2) id
cf_LocationSiteHierarchyLevel2_descriptor	String		Location Site Hierarchy (Level 2) descriptor
cf_TotalBasePayAnnualizedInCAD_Amount_value	Decimal		Total Base Pay Annualized in CAD - Amount value
cf_TotalBasePayAnnualizedInCAD_Amount_currency	String		Total Base Pay Annualized in CAD - Amount currency
cf_TotalBasePayHourly_Amount_value	Decimal		Total Base Pay Hourly - Amount value
cf_TotalBasePayHourly_Amount_currency	String		Total Base Pay Hourly - Amount currency
cf_PrimaryAddressHomeStateText	String		Primary Address Home State (Text)
cf_NumberOfHires	Int		# of Hires
cf_SpendAuthorizationsNotInUseByActiveExpenseReports	String		Spend Authorizations Not In Use by Active Expense Reports
cf_FormatPercentOfExpenseReportsWithWarningValidations	String		Format Percent of Expense Reports with Warning Validations
cf_LegalName_LastNameUppercase	String		Legal Name - Last Name (Uppercase)
cf_Apparel	String		Apparel
cf_TopLevelSupervisoryOrganizationGMS_id	String		Top Level Supervisory Organization (GMS) id
cf_TopLevelSupervisoryOrganizationGMS_descriptor	String		Top Level Supervisory Organization (GMS) descriptor
cf_HireDate90Days	Date		Hire Date + 90 Days
cf_TotalBasePayAnnualizedInEUR_Amount_value	Decimal		Total Base Pay Annualized in EUR - Amount value
cf_TotalBasePayAnnualizedInEUR_Amount_currency	String		Total Base Pay Annualized in EUR - Amount currency
cf_TotalBasePayMonthly_Amount_value	Decimal		Total Base Pay Monthly - Amount value
cf_TotalBasePayMonthly_Amount_currency	String		Total Base Pay Monthly - Amount currency
cf_PerformanceImprovementPlans_InProgressOrCompleted	String		Performance Improvement Plans - In Progress or Completed
cf_ExternalPayrollActualHoursWorkedInLast12Months	Int		External Payroll Actual Hours Worked in Last 12 Months
cf_PreferredName_LastNameUppercase	String		Preferred Name - Last Name (Uppercase)
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Returns all classes accessible by the current user

Columns

Name	Type	References	Description
class1_id	String		Class id
class1_descriptor	String		Class descriptor
classOfInstance1_id	String		Class of Instance id
classOfInstance1_descriptor	String		Class of Instance descriptor
superclasses	String		Superclasses
instanceSet1_id	String		Instance Set id
instanceSet1_descriptor	String		Instance Set descriptor
name1	String		Name
metadata	Bool		Metadata
countClassReportFieldForClass	Int		Count Class Report Field for Class
totalInstancesOfClassIncludingSubclasses	Int		Total Instances of Class Including Subclasses
comment	String		Comment
classReportFieldsForClassAndSuperClasses	String		Class Report Fields for Class and Super Classes
DEPRECATED	Bool		DEPRECATED
translatableDataForClassOrSupersOrSubs	String		Translatable Data for Class or Supers or Subs
securityGroups1	String		Security Groups
iManSetupDataClass_id	String		iMan Setup Data class id
iManSetupDataClass_descriptor	String		iMan Setup Data class descriptor
setupDataClass_id	String		Setup Data class id
setupDataClass_descriptor	String		Setup Data class descriptor
workdayID	String		Workday ID
businessObjectName	String		Business Object Name
customerAccessibleReportFields	String		Customer Accessible Report Fields
customerAccessibleDataSources	String		Customer Accessible Data Sources
secured_id	String		Secured id
secured_descriptor	String		Secured descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Organization as its primary object. The Organization object returns one row per organization. Only includes supervisory organizations that the user manages. Prompts the user at run-time for Supervisory Organization to automatically filter the report results.

Columns

Name	Type	References	Description
cf_BusinessUnitManager_id	String		Business Unit Manager id
cf_BusinessUnitManager_descriptor	String		Business Unit Manager descriptor
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Terminations Count - Including Subordinate Organizations
cf_CompanyCostingManager_id	String		Company Costing Manager id
cf_CompanyCostingManager_descriptor	String		Company Costing Manager descriptor
cf_CostCenterManager_id	String		Cost Center Manager id
cf_CostCenterManager_descriptor	String		Cost Center Manager descriptor
cf_ManagerCount_IncludingSubordinateOrganizations	Int		Manager Count - Including Subordinate Organizations
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations	Int		Beginning Employee Count - Including Subordinate Organizations
cf_RegionCostingManager_id	String		Region Costing Manager id
cf_RegionCostingManager_descriptor	String		Region Costing Manager descriptor
cf_MidYearReviewPercentCompleteRange_id	String		Mid Year Review Percent Complete Range id
cf_MidYearReviewPercentCompleteRange_descriptor	String		Mid Year Review Percent Complete Range descriptor
cf_EmployeeVoluntaryTerminationsCount	Int		Employee Voluntary Terminations Count
cf_EndingEmployeeCount_IncludingSubordinateOrganizations	Int		Ending Employee Count - Including Subordinate Organizations
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Voluntary Terminations Count - including Subordinate Organizations
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations	Int		Ending Contingent Worker Count - Including Subordinate Organizations
cf_AverageHeadcount_IncludingSubordinateOrganizations	Int		Average Headcount - Including Subordinate Organizations
cf_SupervisoryOrganizationHierarchy_id	String		Supervisory Organization Hierarchy id
cf_SupervisoryOrganizationHierarchy_descriptor	String		Supervisory Organization Hierarchy descriptor
cf_BeginningContingentWorkerCountInclSubOrgs	Int		Beginning Contingent Worker Count (incl Sub Orgs)
cf_TurnoverPercent_IncludingSubordinateOrganizations	Int		Turnover Percent - Including Subordinate Organizations
cf_OrgHierarchy_id	String		Org Hierarchy id
cf_OrgHierarchy_descriptor	String		Org Hierarchy descriptor
cf_EmployeeToManagerRatio	Int		Employee to Manager Ratio
cf_TopPerformerEmployeeCount	Int		Top Performer Employee Count
cf_BeginningEmployeeCount	Int		Beginning Employee Count
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Position Group as its primary object. The Position Group object returns one row per Position Group. Includes all unfilled and filled Positions. Prompts the user at run-time for a Compensation Rule to automatically filter the report results.

Columns

Name	Type	References	Description
cf_SupervisoryOrganizationHierarchy_id	String		Supervisory Organization Hierarchy id
cf_SupervisoryOrganizationHierarchy_descriptor	String		Supervisory Organization Hierarchy descriptor
cf_TimeInPositionRange_id	String		Time in Position Range id
cf_TimeInPositionRange_descriptor	String		Time in Position Range descriptor
cf_PositionsFrozen	Int		Positions Frozen
cf_QuarterAvailable	String		Quarter Available
cf_PositionText	String		Position Text
cf_AnnualPositionBurdenInUSD_value	Decimal		Annual Position Burden in USD value
cf_AnnualPositionBurdenInUSD_currency	String		Annual Position Burden in USD currency
cf_NumberOfMonthsUnfilledRange_id	String		Number of Months Unfilled Range id
cf_NumberOfMonthsUnfilledRange_descriptor	String		Number of Months Unfilled Range descriptor
cf_EarliestHireDate9Months	Date		Earliest Hire Date + 9 Months
cf_TimeInPosition_Days	Int		Time in Position - Days
cf_AnnualEmployeeBurdenInUSD_value	Decimal		Annual Employee Burden in USD value
cf_AnnualEmployeeBurdenInUSD_currency	String		Annual Employee Burden in USD currency
cf_DefaultCompensationRangeMidpointInUSD_value	Decimal		Default Compensation Range Midpoint in USD value
cf_DefaultCompensationRangeMidpointInUSD_currency	String		Default Compensation Range Midpoint in USD currency
cf_EarliestHireDate6Months	Date		Earliest Hire Date + 6 Months
cf_AnnualContingentWorkerBurdenInUSD_value	Decimal		Annual Contingent Worker Burden in USD value
cf_AnnualContingentWorkerBurdenInUSD_currency	String		Annual Contingent Worker Burden in USD currency
cf_EarliestHireDate3Months	Date		Earliest Hire Date + 3 Months
cf_MyOrganizations_id	String		My Organizations id
cf_MyOrganizations_descriptor	String		My Organizations descriptor
cf_PositionCount_AllStatuses	Int		Position Count - All Statuses
cf_AnnualCompensationPayWithBurdenInUSD_value	Decimal		Annual Compensation / Pay with Burden in USD value
cf_AnnualCompensationPayWithBurdenInUSD_currency	String		Annual Compensation / Pay with Burden in USD currency
cf_Worker_id	String		Worker id
cf_Worker_descriptor	String		Worker descriptor
cf_AnnualCompensationPayInUSD_value	Decimal		Annual Compensation / Pay in USD value
cf_AnnualCompensationPayInUSD_currency	String		Annual Compensation / Pay in USD currency
cf_WorkerType_id	String		Worker Type id
cf_WorkerType_descriptor	String		Worker Type descriptor
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Organization object and returns one row per organization. Includes all active and inactive organizations with no superior. Does not contain built-in prompts.

Columns

Name	Type	References	Description
cf_BusinessUnitManager_id	String		Business Unit Manager id
cf_BusinessUnitManager_descriptor	String		Business Unit Manager descriptor
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Terminations Count - Including Subordinate Organizations
cf_CompanyCostingManager_id	String		Company Costing Manager id
cf_CompanyCostingManager_descriptor	String		Company Costing Manager descriptor
cf_CostCenterManager_id	String		Cost Center Manager id
cf_CostCenterManager_descriptor	String		Cost Center Manager descriptor
cf_ManagerCount_IncludingSubordinateOrganizations	Int		Manager Count - Including Subordinate Organizations
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations	Int		Beginning Employee Count - Including Subordinate Organizations
cf_RegionCostingManager_id	String		Region Costing Manager id
cf_RegionCostingManager_descriptor	String		Region Costing Manager descriptor
cf_MidYearReviewPercentCompleteRange_id	String		Mid Year Review Percent Complete Range id
cf_MidYearReviewPercentCompleteRange_descriptor	String		Mid Year Review Percent Complete Range descriptor
cf_EmployeeVoluntaryTerminationsCount	Int		Employee Voluntary Terminations Count
cf_EndingEmployeeCount_IncludingSubordinateOrganizations	Int		Ending Employee Count - Including Subordinate Organizations
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Voluntary Terminations Count - including Subordinate Organizations
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations	Int		Ending Contingent Worker Count - Including Subordinate Organizations
cf_AverageHeadcount_IncludingSubordinateOrganizations	Int		Average Headcount - Including Subordinate Organizations
cf_SupervisoryOrganizationHierarchy_id	String		Supervisory Organization Hierarchy id
cf_SupervisoryOrganizationHierarchy_descriptor	String		Supervisory Organization Hierarchy descriptor
cf_BeginningContingentWorkerCountInclSubOrgs	Int		Beginning Contingent Worker Count (incl Sub Orgs)
cf_TurnoverPercent_IncludingSubordinateOrganizations	Int		Turnover Percent - Including Subordinate Organizations
cf_OrgHierarchy_id	String		Org Hierarchy id
cf_OrgHierarchy_descriptor	String		Org Hierarchy descriptor
cf_EmployeeToManagerRatio	Int		Employee to Manager Ratio
cf_TopPerformerEmployeeCount	Int		Top Performer Employee Count
cf_BeginningEmployeeCount	Int		Beginning Employee Count
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

Accesses the Organization as its primary object. The Organization object returns one row per organization.

Columns

Name	Type	References	Description
cf_BusinessUnitManager_id	String		Business Unit Manager id
cf_BusinessUnitManager_descriptor	String		Business Unit Manager descriptor
cf_EmployeeTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Terminations Count - Including Subordinate Organizations
cf_CompanyCostingManager_id	String		Company Costing Manager id
cf_CompanyCostingManager_descriptor	String		Company Costing Manager descriptor
cf_CostCenterManager_id	String		Cost Center Manager id
cf_CostCenterManager_descriptor	String		Cost Center Manager descriptor
cf_ManagerCount_IncludingSubordinateOrganizations	Int		Manager Count - Including Subordinate Organizations
cf_BeginningEmployeeCount_IncludingSubordinateOrganizations	Int		Beginning Employee Count - Including Subordinate Organizations
cf_RegionCostingManager_id	String		Region Costing Manager id
cf_RegionCostingManager_descriptor	String		Region Costing Manager descriptor
cf_MidYearReviewPercentCompleteRange_id	String		Mid Year Review Percent Complete Range id
cf_MidYearReviewPercentCompleteRange_descriptor	String		Mid Year Review Percent Complete Range descriptor
cf_EmployeeVoluntaryTerminationsCount	Int		Employee Voluntary Terminations Count
cf_EndingEmployeeCount_IncludingSubordinateOrganizations	Int		Ending Employee Count - Including Subordinate Organizations
cf_EmployeeVoluntaryTerminationsCount_IncludingSubordinateOrganizations	Int		Employee Voluntary Terminations Count - including Subordinate Organizations
cf_EndingContingentWorkerCount_IncludingSubordinateOrganizations	Int		Ending Contingent Worker Count - Including Subordinate Organizations
cf_AverageHeadcount_IncludingSubordinateOrganizations	Int		Average Headcount - Including Subordinate Organizations
cf_SupervisoryOrganizationHierarchy_id	String		Supervisory Organization Hierarchy id
cf_SupervisoryOrganizationHierarchy_descriptor	String		Supervisory Organization Hierarchy descriptor
cf_BeginningContingentWorkerCountInclSubOrgs	Int		Beginning Contingent Worker Count (incl Sub Orgs)
cf_TurnoverPercent_IncludingSubordinateOrganizations	Int		Turnover Percent - Including Subordinate Organizations
cf_OrgHierarchy_id	String		Org Hierarchy id
cf_OrgHierarchy_descriptor	String		Org Hierarchy descriptor
cf_EmployeeToManagerRatio	Int		Employee to Manager Ratio
cf_TopPerformerEmployeeCount	Int		Top Performer Employee Count
cf_BeginningEmployeeCount	Int		Beginning Employee Count
effectiveAsOfDate	Date		Pseudo-column used to filter the data source
effectiveAsOfMoment	Datetime		Pseudo-column used to filter the data source
entryDate	Date		Pseudo-column used to filter the data source
entryMoment	Datetime		Pseudo-column used to filter the data source

REST

This section lists all the tables and views supported when ConnectionType is set to REST.

Entity Relationships

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.

Base entities

Base entities are entities that can be read directly, such as Requisitions.

Child entities

Child entities are entities that are children of other entities. For example, RequisitionsWorktags is a child entity of Requisitions. If the Cloud needs to read RequisitionsWorktags, it must first look up Requisitions (the parent table), then extract the list of worktags.

Owned entities

Owned entities are entities that can only be read by going through another entity. For example, RequisitionRequisitionLines is owned by the Requisitions table. If the Cloud needs to read line items from RequisitionsRequisitionLines, it must go through a specific Requisition.

Owned child entities

Owned child entities are a combination of both Owned and Child entities. For example, RequisitionsRequisitionLinesWorktags is both a child of the RequisitionsRequisitionLines table and owned by the Requisitions table. If the Cloud needs to read RequisitionsRequisitionLinesWorktags, it must look up a specific Requisition, then look up its RequisitionsRequisitionLines, finally extracting the worktags from each line.

Schema Differences

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.

• Base entities have one primary key column called Id.
• Child entities have a compound primary key containing Id and another column that references the parent Id column.
• Owned entities have a compound primary key containing Id and another column that references the owner Id column.
• Owned child entities have a compound primary key containing Id and two reference columns, one to the parent and one to the parent's owner.

In addition, each type of table exposes different prompt columns. The next section goes into detail on when these prompts take effect.

• Base entities expose their own prompt columns.
• Child entities expose their parent's prompt columns.
• Owned entities expose their prompt columns and their owner's prompt columns.
• Owned child entities expose their parent's prompt columns and their owner's prompt columns.

Filtering Support

Each type of table handles filters on its Id columns differently:

• If a base entity includes an Id filter like WHERE Id = 'abcdef123456', the Id value is pushed down so that Workday only returns that specific row.
• Child entities only push down filters on the parent Id. Workday does not support filtering on child Ids directly.
• Owned entities and owned child tables only push down filters on the owner Id.

Each type of table also has its own behaviors around prompts:

• Base entity prompts are sent to Workday unless an Id filter is also provided. This means that a filter like WHERE Id = '...' AND Search_Prompt = 'Logan' will return the row with that Id, even if it is not reported with the prompt only: WHERE Search_Prompt = 'Logan'.
• An owned entity contains its own prompts and inherits the prompts from its owner. The owner prompts are sent to Workday as long as there is no parent Id filter. Other prompts are always sent to Workday.
• Child and owned child entity prompts are all inherited from the parent (and owner) and follow the same rules.

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.

Modifying Data

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 = '...'

Prompt Value Tables

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:

• An Id column that contains the Workday ID which may be used for the field or prompt.
• A Descriptor column that gives a human-readable description of the entity.
• A CollectionToken column and Collection_Prompt input, discussed below.
• Some value tables contain additional prompts.

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:

1. Query the table as normal while providing any prompt values. For example, SELECT * FROM JobChangesGroupWorkersValues WHERE EffectiveDate_Prompt = '2020-01-01' returns a list of categories that contain workers organized by different attributes (such as location, organization, or manager).
2. Read the CollectionToken value from the row representing the category you are interested in. In this example, the CollectionToken for the "Workers By Manager Hierarchy" category has the value abcxyz123.
3. Query the same table while providing a value for Collection_Prompt using the token from step 2. This returns a list of entities that belong to the category with that token. For example, SELECT * FROM JobChangesGroupWorkersValues WHERE Collection_Prompt = 'abcxyz123' returns a list of entites in the "Workers By Manager Hierarchy" category.
4. If the row you are interested has a NULL value for CollectionToken, you have reached the last level and can use the ID value for the prompt. Otherwise repeat steps 2-4 to navigate all the levels of the hierarchy until you reach the bottom.

Change Tables

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:

1. Execute the Begin procedure. Refer to the documentation for the specific Begin procedure for the list of available inputs.
2. If it is successful, the Begin procedure outputs a change ID. This value must be provided for all queries to the change tables as well as the Submit stored procedure.
3. Modify the change tables using the change ID from step 2.
4. Execute the Submit procedure. Only the change ID is required, although other inputs may be set to control how Workday applies the process. For example, the action ID input controls whether Workday executes the process immediately or saves it for later review.

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 Cloud models the data in Workday as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Workday Tables

Name	Description
AdHocProjectTimeTransactions	Retrieves a collection of ad hoc project time transactions.
Attachments	Uploads an attachment when creating a case.
AttributeAttributeValues	No description available.
AttributeAttributeValuesRestrictToEnvironments	Reads /restrictToEnvironments entries from the AttributeAttributeValues table.
BillableTransactions	Retrieves a single billable transaction instance.
Cases	Retrieves a list of cases that the user is secured to view.
CasesTimeline	Retrieves a list of comment timeline items for a case.
CasesTimelineAttachments	Reads /attachments entries from the CasesTimeline table.
Configurations	No description available.
ConfigurationsAttributes	No description available.
ConfigurationsAttributesValues	Reads /values entries from the ConfigurationsAttributes table.
Definitions	Retrieves a custom object definition.
DefinitionsConditionRules	Retrieves a collection of condition rules in a custom object definition.
DefinitionsFields	Retrieves a field in a custom object definition.
DefinitionsFieldsAuthorizedUsages	Reads /authorizedUsages entries from the DefinitionsFields table.
DefinitionsFieldsCategories	Reads /categories entries from the DefinitionsFields table.
DefinitionsFieldsDisplayOptions	Reads /displayOptions entries from the DefinitionsFields table.
DefinitionsFieldsPrompts	Reads /prompts entries from the DefinitionsFields table.
DefinitionsFieldsValidations	Reads /validations entries from the DefinitionsFields table.
DefinitionsValidations	Retrieves a collection of validations in a custom object definition.
EffectiveChanges	Generates effective change data for organizations or workers based on request parameters.
EffectiveChangesRequestCriteriaOrganizations	Reads /requestCriteria/organizations entries from the EffectiveChanges table.
EffectiveChangesRequestCriteriaResponseFilterAdditionalNameTypes	Reads /requestCriteria/responseFilter/additionalNameTypes entries from the EffectiveChanges table.
EffectiveChangesRequestCriteriaResponseFilterOrganizationRoles	Reads /requestCriteria/responseFilter/organizationRoles entries from the EffectiveChanges table.
EffectiveChangesRequestCriteriaResponseFilterOrganizationTypes	Reads /requestCriteria/responseFilter/organizationTypes entries from the EffectiveChanges table.
EffectiveChangesRequestCriteriaResponseFilterPaymentElectionRules	Reads /requestCriteria/responseFilter/paymentElectionRules entries from the EffectiveChanges table.
EffectiveChangesRequestCriteriaWorkerOverrides	Reads /requestCriteria/workerOverrides entries from the EffectiveChanges table.
EffectiveChangesResponseDataDocuments	Reads /responseData/documents entries from the EffectiveChanges table.
EventDrivenIntegrationVendorResponse	Updates a specific vendor response instance of Event-Driven Integration with the specified data after the third-party payroll system completes processing of the worker changes.
EventDrivenIntegrationVendorResponseErrorMessageSetErrors	Reads /errorMessageSet/errors entries from the EventDrivenIntegrationVendorResponse table.
ExpenseEntries	Retrieves a single instance of a Quick Expense.
ExpenseEntriesAttachments	Reads /attachments entries from the ExpenseEntries table.
ExpenseReports	Retrieves a single instance of an Expense Report.
ExternalCreators	Retrieves contact details for a single external case contact instance.
FieldTypes	Retrieves a collection of custom field types.
FieldTypesListInfoValues	Reads /listInfo/values entries from the FieldTypes table.
FieldTypesListValues	Retrieves a list value for a custom lists in a custom object definition.
GiveRequestedFeedbackEvents	Retrieves a collection of feedback given events about the user that responded to the feedback request.
GiveRequestedFeedbackEventsBusinessProcessParametersAttachments	Reads /businessProcessParameters/attachments entries from the GiveRequestedFeedbackEvents table.
GiveRequestedFeedbackEventsFeedbackComments	Reads /feedbackComments entries from the GiveRequestedFeedbackEvents table.
HomeContactInformationChangesAddresses	Retrieve all existing addresses staged for update by the parent business process
HomeContactInformationChangesEmailAddresses	Retrieve all existing addresses staged for update by the parent business process
HomeContactInformationChangesInstantMessengers	An instant messenger as it exists staged for update by the parent business process.
HomeContactInformationChangesPhoneNumbers	Retrieve all existing phone numbers staged for update by the parent business process
HomeContactInformationChangesWebAddresses	Retrieve all existing web addresses staged for update by the parent business process
ImmigrationEventsDependentImmigrationData	Retrieves a dependent immigration data instance for the specified student ID.
ImmigrationEventsImmigrationData	Retrieves an immigration data instance for the specified immigration event.
InterviewsFeedback	Usage information for the operation InterviewsFeedback.rsd.
JobChangesAdministrative	Retrieves the administrative options for the specified job change ID.
JobChangesBusinessTitle	Retrieves a business title for the specified job change ID.
JobChangesComment	Returns the comment information for the specified job change ID.
JobChangesContract	Retrieves the contract options for the specified change job ID.
JobChangesJobClassification	Retrieves a job classification for the specified job change ID.
JobChangesJobProfile	Retrieves a job profile for the specified job change ID.
JobChangesLocation	Returns the location information for the specified job change ID.
JobChangesMoveTeam	Retrieves a move team option from the specified job change ID.
JobChangesOpening	Retrieves the opening options for the specified job change ID.
JobChangesPosition	Retrieves a position for the specified job change ID.
JobChangesStartDetails	Retrieves the start details for the specified job change ID.
MessageTemplates	Retrieves a message template with the specific ID.
OrganizationAssignmentChangesBusinessUnit	Retrieves a business unit for the specified organization assignment change ID.
OrganizationAssignmentChangesComment	Retrieves the comment information for the specified organization assignment change ID.
OrganizationAssignmentChangesCompany	Retrieves a company for the specified organization assignment change ID.
OrganizationAssignmentChangesCostCenter	Retrieves a cost center for the specified organization assignment change ID.
OrganizationAssignmentChangesCosting	Retrieves the costing organizations for the specified organization assignment change ID.
OrganizationAssignmentChangesCustomOrganizations	Retrieves the custom organizations for the specified organization assignment change ID.
OrganizationAssignmentChangesRegion	Retrieves a region for the specified organization assignment change ID.
OrganizationAssignmentChangesStartDetails	Retrieves the start details for the specified organization assignment change ID.
PayGroupsPeriods	Retrieves a collection of payroll periods for the specified Payroll Interface pay group ID.
Payments	Retrieves a single customer invoice payment instance.
PaymentsRemittanceDetails	Retrieves a single customer invoice payment remittance line instance.
PayrollInputs	Retrieves a single payroll input instance.
PayrollInputsInputDetails	Reads /inputDetails entries from the PayrollInputs table.
PayrollInputsRunCategories	Reads /runCategories entries from the PayrollInputs table.
PayrollInputsWorktags	Reads /worktags entries from the PayrollInputs table.
PlanPhases	Retrieves a single project plan phase instance.
PlanTasks	Retrieves a collection of Project Plan Tasks for a specified Project or Project Plan Phase.
Projects	Retrieves a collection of Projects.
ProjectsBusinessEventRecords	Reads /businessEventRecords entries from the Projects table.
ProjectsGroups	Reads /groups entries from the Projects table.
ProjectsOptionalHierarchies	Reads /optionalHierarchies entries from the Projects table.
ProjectsProjectDependencies	Reads /projectDependencies entries from the Projects table.
ProjectsWorktags	Reads /worktags entries from the Projects table.
Prospects	Create prospects.
ProspectsCandidatePools	Reads /candidatePools entries from the Prospects table.
ProspectsCandidateTags	Reads /candidateTags entries from the Prospects table.
ProspectsEducations	Retrieves the education of a single prospect instance.
ProspectsExperiences	Retrieves a single experience instance for a prospect.
ProspectsLanguages	Retrieves a single language instance for a prospect.
ProspectsLanguagesAbilities	Reads /abilities entries from the ProspectsLanguages table.
ProspectsResumeAttachments	Retrieves a single resume attachment instance for a prospect.
ProspectsSkills	Retrieves a single skill instance for a prospect.
Requests	Retrieves the request with the specified ID.
RequestsQuestionnaireResponsesQuestionnaireAnswers	Reads /questionnaireResponses/questionnaireAnswers entries from the Requests table.
Requisitions	Retrieves a collection of requisitions.
RequisitionsAttachments	Retrieves the metadata or the attachment content of the specified requisition.
RequisitionsRequisitionLines	Retrieves a requisition line for the specified requisition.
RequisitionsRequisitionLinesWorktags	Reads /worktags entries from the RequisitionsRequisitionLines table.
RequisitionsWorktags	Reads /worktags entries from the Requisitions table.
ResourceForecastLinesAllocations	Retrieves a Resource Forecast Line Allocation for the specified ID.
ResourcePlanLines	Retrieves a single resource plan line instance.
ResourcePlanLinesExcludedWorkers	Reads /excludedWorkers entries from the ResourcePlanLines table.
ResourcePlanLinesRequirements	Reads /requirements entries from the ResourcePlanLines table.
ScorecardResults	Provides the ability to set up and retrieve Scores on Scorecard Results.
ScorecardResultsDefaultScorecardGoalsResultPerformanceScores	Reads /defaultScorecardGoalsResult/performanceScores entries from the ScorecardResults table.
ScorecardResultsProfileScorecardGoalsResult	Reads /profileScorecardGoalsResult entries from the ScorecardResults table.
Scorecards	Retrieves Compensation Scorecard information.
ScorecardsDefaultScorecardGoals	Reads /defaultScorecardGoals entries from the Scorecards table.
ScorecardsScorecardProfiles	Reads /scorecardProfiles entries from the Scorecards table.
StudentsPayments	Retrieves a single student payment instance for the specified student ID.
SupplierInvoiceRequests	Retrieves a collection of supplier invoices.
SupplierInvoiceRequestsAttachments	Retrieves a single attachment instance.
TaskResources	Retrieves a collection of Task Resources.
TaskResourcesProjectResources	Reads /projectResources entries from the TaskResources table.
TaxRates	Retrieves a single or a collection of company SUI rates.
TimeClockEvents	Retrieves a collection of time clock events for a worker for a date range.
WorkContactInformationChangesAddresses	An address as it exists staged for update by the parent business process.
WorkContactInformationChangesEmailAddresses	Retrieve all existing addresses staged for update by the parent business process
WorkContactInformationChangesInstantMessengers	An instant messenger as it exists staged for update by the parent business process.
WorkContactInformationChangesPhoneNumbers	A phone number as it exists staged for update by the parent business process.
WorkContactInformationChangesWebAddresses	A web address as it exists staged for update by the parent business process.
WorkersAnytimeFeedbackEvents	Retrieves a feedback given event instance with the specified ID.
WorkersAnytimeFeedbackEventsBusinessProcessParametersAttachments	Reads /businessProcessParameters/attachments entries from the WorkersAnytimeFeedbackEvents table.
WorkersAnytimeFeedbackEventsFeedbackAlsoAbout	Reads /feedbackAlsoAbout entries from the WorkersAnytimeFeedbackEvents table.
WorkersAnytimeFeedbackEventsWorkersToNotify	Reads /workersToNotify entries from the WorkersAnytimeFeedbackEvents table.
WorkersBusinessTitleChanges	Retrieves a business title change instance for a specific worker.
WorkersCheckIns	Retrieves a single Check-In instance.
WorkersCheckInsAssociatedTopics	Reads /associatedTopics entries from the WorkersCheckIns table.
WorkersCheckInsCheckInAttachments	Reads /checkInAttachments entries from the WorkersCheckIns table.
WorkersCheckInTopics	Retrieves a collection of Check-Ins topics.
WorkersCheckInTopicsAssociatedCheckIns	Reads /associatedCheckIns entries from the WorkersCheckInTopics table.
WorkersCheckInTopicsCheckInTopicAttachments	Reads /checkInTopicAttachments entries from the WorkersCheckInTopics table.
WorkersDevelopmentItems	Retrieves a single development item for the specified worker.
WorkersExplicitSkills	Get Explicit Skills for Skill Enabled
WorkersExplicitSkillsSkillSources	Reads /skillSources entries from the WorkersExplicitSkills table.
WorkersExternalSkillLevel	Retrieves all external skill level information for a worker. You can filter the external skill levels by externalSkillId.
WorkersRequestedFeedbackOnSelfEvents	Retrieves a single self-requested feedback event instance for the specified worker.
WorkersRequestedFeedbackOnSelfEventsBusinessProcessParametersAttachments	Reads /businessProcessParameters/attachments entries from the WorkersRequestedFeedbackOnSelfEvents table.
WorkersRequestedFeedbackOnSelfEventsFeedbackQuestions	Reads /feedbackQuestions entries from the WorkersRequestedFeedbackOnSelfEvents table.
WorkersRequestedFeedbackOnSelfEventsFeedbackResponders	Reads /feedbackResponders entries from the WorkersRequestedFeedbackOnSelfEvents table.
WorkersRequestedFeedbackOnWorkerEvents	Retrieves a single requested feedback event instance for the specified worker.
WorkersRequestedFeedbackOnWorkerEventsBusinessProcessParametersAttachments	Reads /businessProcessParameters/attachments entries from the WorkersRequestedFeedbackOnWorkerEvents table.
WorkersRequestedFeedbackOnWorkerEventsFeedbackQuestions	Reads /feedbackQuestions entries from the WorkersRequestedFeedbackOnWorkerEvents table.
WorkersRequestedFeedbackOnWorkerEventsFeedbackResponders	Reads /feedbackResponders entries from the WorkersRequestedFeedbackOnWorkerEvents table.
WorkersSkillItems	Returns skill items.

Retrieves a collection of ad hoc project time transactions.

Workday Resource Information

Returns an ad hoc project time transaction with the specified ID. You can specify the Workday ID or reference ID of the transaction. The reference ID uses the Ad_Hoc_Billable_Transaction_ID=sampleRefId format.

Example: Ad_Hoc_Billable_Transaction_ID=AD_HOC_BILLABLE_TIME-15-6.

Secured by: Manage: Ad Hoc Project Costing, Process: Project Billing - Ad Hoc Project Transactions

Scope: Project Billing, Projects

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
BillingStatus_Descriptor	String	False	A description of the instance
BillingStatus_Href	String	False	A link to the instance
BillingStatus_Id	String	False	wid / id / reference id
Descriptor	String	False	A preview of the instance
Hours	Decimal	False	The number of hours for an ad hoc project time transaction.
Href	String	False	A link to the instance
IncludeCost	Bool	False	If true, costs are calculated for the ad hoc project time transaction.
Memo	String	False	The memo for the ad hoc project time transaction.
ProjectRole_Descriptor	String	False	A description of the instance
ProjectRole_Href	String	False	A link to the instance
ProjectRole_Id	String	False	wid / id / reference id
Project_Descriptor	String	False	A description of the instance
Project_Href	String	False	A link to the instance
Project_Id	String	False	wid / id / reference id
RateToBill_Currency	String	False	The actual rate that the ad hoc project time transaction is billed at.
RateToBill_Value	Decimal	False	The actual rate that the ad hoc project time transaction is billed at.
StandardCostRate_Currency	String	False	The hourly standard cost rate for hours logged on the ad hoc project time transaction.
StandardCostRate_Value	Decimal	False	The hourly standard cost rate for hours logged on the ad hoc project time transaction.
Task_Descriptor	String	False	A description of the instance
Task_Href	String	False	A link to the instance
Task_Id	String	False	wid / id / reference id
TransactionDate	Datetime	False	The date of the ad hoc project time transaction using the yyyy-mm-dd format.
Worker_Descriptor	String	False	A description of the instance
Worker_Href	String	False	A link to the instance
Worker_Id	String	False	wid / id / reference id
ProjectOrProjectHierarchy_Prompt	String	False	The Workday ID or reference ID of a project or project hierarchy. You can use a returned project id or primaryHierarchy {id} from GET /projects.

Uploads an attachment when creating a case.

Workday Resource Information

Will return attachments

Secured by: REST API Public

Contains attachment(s)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
ContentType_Descriptor	String	False	A description of the instance
ContentType_Href	String	False	A link to the instance
ContentType_Id	String	False	wid / id / reference id
FileLength	Decimal	False	File length of the attachment
FileName	String	False	File name of the attachment

No description available.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Attribute_Id [KEY]	String	False	The Workday ID of the Attribute that owns this.
BooleanValue	Bool	False	Supported for: SELECT, INSERT, UPDATE. Returns a boolean attribute value if it is allowed for the current environment.
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
NumericValue	Decimal	False	Supported for: SELECT, INSERT, UPDATE. Returns a numeric attribute value if it is allowed for the current environment.
RestrictToEnvironments_Aggregate	String	False	Supported for: INSERT. A JSON aggregate. Returns the environments that are able to view this Application Attribute Value.
StringValue	String	False	Supported for: SELECT, INSERT, UPDATE. Returns a string attribute value if it is allowed for the current environment.

Reads /restrictToEnvironments entries from the AttributeAttributeValues table.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
AttributeAttributeValues_Id [KEY]	String	False	The Workday ID of the AttributeAttributeValues that contains this.
Attribute_Id [KEY]	String	False	The Workday ID of the Attribute that owns this.
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance

Retrieves a single billable transaction instance.

Workday Resource Information

Retrieves a billable project transaction with the specified ID.

Secured by: Manage: Project Details, Process: Project Billing - View

Scope: Project Billing, Project Tracking

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
AdjustmentCount	Decimal	False	The count of the billing rate application for the billable transaction.
AdjustmentReason_Descriptor	String	False	A description of the instance
AdjustmentReason_Href	String	False	A link to the instance
AdjustmentReason_Id	String	False	wid / id / reference id
AmountToBill_Currency	String	False	The amount to bill for a billable transaction, excluding applicable tax.
AmountToBill_Value	Decimal	False	The amount to bill for a billable transaction, excluding applicable tax.
BillableAmount_Currency	String	False	The original amount to bill the customer, excluding extended amounts on tax only customer invoices.
BillableAmount_Value	Decimal	False	The original amount to bill the customer, excluding extended amounts on tax only customer invoices.
BillableHours	Decimal	False	The original hours to bill the customer.
BillableRate_Currency	String	False	The original rate to bill the customer.
BillableRate_Value	Decimal	False	The original rate to bill the customer.
BillingStatus_Descriptor	String	False	A description of the instance
BillingStatus_Href	String	False	A link to the instance
BillingStatus_Id	String	False	wid / id / reference id
Category_Descriptor	String	False	A description of the instance
Category_Href	String	False	A link to the instance
Category_Id	String	False	wid / id / reference id
Customer_Descriptor	String	False	A description of the instance
Customer_Href	String	False	A link to the instance
Customer_Id	String	False	wid / id / reference id
Descriptor	String	False	A preview of the instance
ExpenseDescriptor_Descriptor	String	False	A description of the instance
ExpenseDescriptor_Href	String	False	A link to the instance
ExpenseDescriptor_Id	String	False	wid / id / reference id
HoursToBill	Decimal	False	The actual hours available to bill for the billable transaction.
Href	String	False	A link to the instance
InvoiceDescription	String	False	The description for the supplier invoice line item, expense report line item, or usage-based transaction.
Memo	String	False	The memo for the project billable transaction.
PreviouslyInvoiced	Bool	False	If true, the billable transaction has been previously invoiced.
ProjectRole_Descriptor	String	False	A description of the instance
ProjectRole_Href	String	False	A link to the instance
ProjectRole_Id	String	False	wid / id / reference id
ProjectTask_Descriptor	String	False	A description of the instance
ProjectTask_Href	String	False	A link to the instance
ProjectTask_Id	String	False	wid / id / reference id
Project_Descriptor	String	False	A description of the instance
Project_Href	String	False	A link to the instance
Project_Id	String	False	wid / id / reference id
RateToBill_Currency	String	False	The actual rate that the billable transaction is billed at.
RateToBill_Value	Decimal	False	The actual rate that the billable transaction is billed at.
ReasonForChange	String	False	The reason for the rate change for the billable transaction.
ResourceProvider_Descriptor	String	False	A description of the instance
ResourceProvider_Href	String	False	A link to the instance
ResourceProvider_Id	String	False	wid / id / reference id
RevenueStatus_Descriptor	String	False	A description of the instance
RevenueStatus_Href	String	False	A link to the instance
RevenueStatus_Id	String	False	wid / id / reference id
TransactionDate	Datetime	False	The date of the billable transaction.
TransactionSource_Descriptor	String	False	A description of the instance
TransactionSource_Href	String	False	A link to the instance
TransactionSource_Id	String	False	wid / id / reference id
Worker_Descriptor	String	False	A description of the instance
Worker_Href	String	False	A link to the instance
Worker_Id	String	False	wid / id / reference id
ZeroAmountToBill	Bool	False	If true, the billable transaction has a zero rate.
BillingStatus_Prompt	String	False	Filters the billable transactions by status. Specify the Workday ID of the status. You can specify multiple status query parameters.
Customer_Prompt	String	False	The Workday ID of the customer associated with the project for the billable transaction. To get a valid ID, you can call GET /customers in the Customer Accounts REST service.
FromDate_Prompt	Date	False	Filters the billable transactions with transaction date on or after the specified date. Use the yyyy-mm-dd format.
Phase_Prompt	String	False	The Workday ID of the project phase associated with the billable transaction for the time entry. To get a valid ID, call GET /planPhases in the Projects REST service.
Project_Prompt	String	False	The Workday ID of the project associated with the billable transactions. To get a valid ID, you can call GET /projects in the Projects REST service.
SpendCategory_Prompt	String	False	The Workday ID of the spend category for the billable transaction associated with the expense report line.
Task_Prompt	String	False	The Workday ID of the project task associated with the billable transaction for the time entry. To get a valid ID, call GET /planTasks in the Projects REST service.
TimeCode_Prompt	String	False	The Workday ID of the time code for the billable transaction associated with the time entry.
ToDate_Prompt	Date	False	Filters the billable transactions with transaction date on or before the specified date. Use the yyyy-mm-dd format.
TransactionSource_Prompt	String	False	Filters the billable transactions by transaction source. Specify the Workday ID of the transaction source.
Worker_Prompt	String	False	The Workday ID of the worker associated with the billable transaction. To get a valid ID, call GET /workers in the Staffing service.

Retrieves a list of cases that the user is secured to view.

Workday Resource Information

Retrieves a case with the specified ID. Case details include: title, detailed message, case ID, status, creation date, case link, assignee, confidential, about, by, for, type, and serviceTeam.

Secured by: Help Case Data+TG, Self Service: Help Case Management+TG

Scope: Help

Aggregate Fields

The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

Attachments_Aggregate

[{
  contentType: { /* Content type of the attachment */
     *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. */
}]

QuestionnaireResponses_QuestionnaireAnswers_Aggregate

[{
  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. */
     *id: Text /* wid / id / reference id */
  }
  questionnaireAttachments: [{
      contentType: { /* Content type of the attachment */
         *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 */
  }]
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
AboutWorker_Id	String	False	wid / id / reference id
About_Descriptor	String	False	A preview of the instance
About_Id	String	False	Id of the instance
About_Person_Descriptor	String	False	A description of the instance
About_Person_Href	String	False	A link to the instance
About_Person_Id	String	False	wid / id / reference id
Assignee_Descriptor	String	False	A preview of the instance
Assignee_Id	String	False	Id of the instance
Assignee_Person_Descriptor	String	False	A description of the instance
Assignee_Person_Href	String	False	A link to the instance
Assignee_Person_Id	String	False	wid / id / reference id
Attachments_Aggregate	String	False	Case Creation Attachments.
By_Descriptor	String	False	A preview of the instance
By_ExternalCreator_Email	String	False	External Case Creator Email.
By_ExternalCreator_Id	String	False	Id of the instance
By_ExternalCreator_Name	String	False	External Case Creator Name and External in Parenthesis or Purged External Case Creator text.
By_Id	String	False	Id of the instance
By_Worker_Descriptor	String	False	A preview of the instance
By_Worker_Id	String	False	Id of the instance
By_Worker_Person_Descriptor	String	False	A description of the instance
By_Worker_Person_Href	String	False	A link to the instance
By_Worker_Person_Id	String	False	wid / id / reference id
CaseID	String	False	Case ID.
CaseLink	String	False	The link to view the Case.
CaseReopenDetails_CaseReopenDueDate	String	False	The details for the reopening of a case. This includes whether a worker can reopen a case and the last date that a worker can reopen a case.
CaseReopenDetails_CaseReopenStatus	Bool	False	True if a worker can reopen a case.
CaseType_Id	String	False	wid / id / reference id
Confidential	Bool	False	If true, the case is confidential.
CreationDate	Datetime	False	The date that the case was created on.
DetailedMessage	String	False	The description of the case.
ForExternalCreator_Id	String	False	wid / id / reference id
ForWorker_Id	String	False	wid / id / reference id
For_Descriptor	String	False	A preview of the instance
For_ExternalCreator_Email	String	False	External Case Creator Email.
For_ExternalCreator_Id	String	False	Id of the instance
For_ExternalCreator_Name	String	False	External Case Creator Name and External in Parenthesis or Purged External Case Creator text.
For_Id	String	False	Id of the instance
For_Worker_Descriptor	String	False	A preview of the instance
For_Worker_Id	String	False	Id of the instance
For_Worker_Person_Descriptor	String	False	A description of the instance
For_Worker_Person_Href	String	False	A link to the instance
For_Worker_Person_Id	String	False	wid / id / reference id
FormattedCreationDate	String	False	The creation date of the case formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone.
QuestionnaireHolder_Id	String	False	wid / id / reference id
QuestionnaireResponses_Descriptor	String	False	A preview of the instance
QuestionnaireResponses_Id	String	False	Id of the instance
QuestionnaireResponses_QuestionnaireAnswers_Aggregate	String	False	The set of answers for a questionnaire.
QuestionnaireResponses_QuestionnaireTargetContext_Id	String	False	wid / id / reference id
QuestionnaireResponses_QuestionnaireTarget_Id	String	False	wid / id / reference id
SatisfactionSurvey_Active	Bool	False	If true, the case has an active satisfaction survey
SatisfactionSurvey_Directive	String	False	Returns the Survey Directive text for the Satisfaction Survey.
SatisfactionSurvey_Results_Comment	String	False	Case satisfaction survey response comment.
SatisfactionSurvey_Results_FormattedCreationDate	String	False	The creation date of the case satisfaction survey response formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone.
SatisfactionSurvey_Results_Id	String	False	Id of the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Descriptor	String	False	A description of the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Href	String	False	A link to the instance
SatisfactionSurvey_Results_QuestionnaireResponse_Questionnaire_Id	String	False	wid / id / reference id
SatisfactionSurvey_Results_Score_Description	String	False	Description of the case satisfaction survey response score.
SatisfactionSurvey_Results_Score_Number	Decimal	False	Score for the case satisfaction survey response.
SatisfactionSurvey_Task	String	False	If true, the Satisfaction Survey has been dismissed.
ServiceTeam_Descriptor	String	False	A description of the instance
ServiceTeam_Href	String	False	A link to the instance
ServiceTeam_Id	String	False	wid / id / reference id
Source_Id	String	False	wid / id / reference id
Status_Descriptor	String	False	A preview of the instance
Status_Id	String	False	Id of the instance
Title	String	False	The title of the case.
Type_Confidential	Bool	False	Case type confidential flag for REST service.
Type_Description	String	False	Case Type Description.
Type_Id	String	False	Id of the instance
Type_Inactive	Bool	False	True if the case type is inactive.
Type_Name	String	False	Returns the display id of the instance.
Type_ServiceCategory_Description	String	False	The description of the service category.
Type_ServiceCategory_Id	String	False	Id of the instance
Type_ServiceCategory_Name	String	False	The name of the service category.
Desc_Prompt	Bool	False	If true, sorts results in descending order.
MyCases_Prompt	Bool	False	Retrieves cases owned by the processing user.
OpenCases_Prompt	Bool	False	Retrieves open cases and cases that were resolved or canceled less than 7 days ago.
Sort_Prompt	String	False	The field to sort results by. The default is creationDate. Note: Currently supports creationDate only.

Retrieves a list of comment timeline items for a case.

Workday Resource Information

Retrieves a timeline item for a case with the specified timeline ID. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments and a questionnaire answer if applicable.

Secured by: REST API Public

Contains attachment(s)

Aggregate Fields

The Cloud represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

Attachments_Aggregate

[{
  contentType: { /* Content type of the attachment */
     *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. */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False
Cases_Id [KEY]	String	False	The Workday ID of the Cases that owns this.
Attachments_Aggregate	String	False	Case Timeline Item (Derived) has Case Attachment (Derived) [RL].
Comment_Content	String	False	returns rich text comment for a Case
Comment_TextBody	String	False	returns normal text comment for a Case
CreationDate	Datetime	False	The date that the case timeline item was created on.
Description	String	False	Used by the Case Creation Timeline Item, contains the detailed message written by case creators.
FormattedCreationDate	String	False	The creation date of the timeline item formatted to include the year, month, day, hour and minute. The date format depends on the processing user's locale and uses the user's timezone.
Guidance_KbArticle_Descriptor	String	False	A preview of the instance
Guidance_KbArticle_Id	String	False	Id of the instance
Guidance_UiTask_Descriptor	String	False	A preview of the instance
Guidance_UiTask_Id	String	False	Id of the instance
Guidance_UiTask_Url	String	False	Returns the fully qualified URL for the given Task
QuestionnaireResponse_Questionnaire_Descriptor	String	False	A description of the instance
QuestionnaireResponse_Questionnaire_Href	String	False	A link to the instance
QuestionnaireResponse_Questionnaire_Id	String	False	wid / id / reference id
SubmittedBy_Descriptor	String	False	A preview of the instance
SubmittedBy_ExternalCreator_Email	String	False	External Case Creator Email.
SubmittedBy_ExternalCreator_Id	String	False	Id of the instance
SubmittedBy_ExternalCreator_Name	String	False	External Case Creator Name and External in Parenthesis or Purged External Case Creator text.
SubmittedBy_Id	String	False	Id of the instance
SubmittedBy_Worker_Descriptor	String	False	A preview of the instance
SubmittedBy_Worker_Id	String	False	Id of the instance
SubmittedBy_Worker_Person_Descriptor	String	False	A description of the instance
SubmittedBy_Worker_Person_Href	String	False	A link to the instance
SubmittedBy_Worker_Person_Id	String	False	wid / id / reference id
Type_Descriptor	String	False	A preview of the instance
Type_Id	String	False	Id of the instance
Desc_Prompt	Bool	False	If true, sorts results in descending order.
MyCases_Prompt	Bool	False	Retrieves cases owned by the processing user.
OpenCases_Prompt	Bool	False	Retrieves open cases and cases that were resolved or canceled less than 7 days ago.
Sort_Prompt	String	False	The field to sort results by. The default is creationDate. Note: Currently supports creationDate only.

Reads /attachments entries from the CasesTimeline table.

Workday Resource Information

Retrieves a timeline item for a case with the specified timeline ID. Comment timeline items include comments and associated attachments. Action timeline items include an action with an action text. Creation timeline items include a description, associated attachments and a questionnaire answer if applicable.

Secured by: REST API Public

Contains attachment(s)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
CasesTimeline_Id [KEY]	String	False	The Workday ID of the CasesTimeline that contains this.
Cases_Id [KEY]	String	False	The Workday ID of the Cases that owns this.
Comment	String	False	Questionnaire attachment comment
ContentType_Id	String	False	wid / id / reference id
Descriptor	String	False	A preview of the instance
FileLength	Decimal	False	File length of the attachment
FileName	String	False	File name of the attachment
Href	String	False	A link to the instance
Desc_Prompt	Bool	False	If true, sorts results in descending order.
MyCases_Prompt	Bool	False	Retrieves cases owned by the processing user.
OpenCases_Prompt	Bool	False	Retrieves open cases and cases that were resolved or canceled less than 7 days ago.
Sort_Prompt	String	False	The field to sort results by. The default is creationDate. Note: Currently supports creationDate only.

No description available.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Application_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Application_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Description	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the description for this application attributes configuration.
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Name	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the name of this application attributes configuration.
ReferenceIdValue	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the reference ID for this application attributes configuration.
Version	Decimal	False	Supported for: SELECT, INSERT, UPDATE. Returns the version for this application attributes configuration.
Application_Prompt	String	False	No description available.
Name_Prompt	String	False	No description available.

No description available.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Configurations_Id [KEY]	String	False	The Workday ID of the Configurations that owns this.
Alias	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the alias of this application attribute.
Description	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the description of this application attribute.
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Name	String	False	Supported for: SELECT, INSERT, UPDATE. Returns name of this application attribute.
Required	Bool	False	Supported for: SELECT, INSERT, UPDATE. Returns whether this application attribute is required or not.
Type_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Type_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Values_Aggregate	String	False	Supported for: INSERT. A JSON aggregate. Returns Application Attribute Values owned by this Application Attribute.
AttributeType_Prompt	String	False	No description available.
Application_Prompt	String	False	Only used when a Configurations_Id filter is not provided. No description available.
Name_Prompt	String	False	Only used when a Configurations_Id filter is not provided. No description available.