このページでは、CData Cloud でのWorkday への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Workday への接続

接続の確立 は、CData Cloud にデータベースを作成するためのWorkday への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してWorkday からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Workday に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Workday への接続

このセクションでは、4つのWorkday API の接続パラメータを設定する方法、およびTenant とBaseURL を取得する方法について説明します。必要なAPI のパラメータが設定され、カスタムOAuth および / またはAzure AD API クライアントを作成したら、接続の準備は完了です。

接続の前提条件

API	前提条件	接続パラメータ
WQL	WQL サービスを有効化 （下記参照）	ConnectionType： WQL
Reports as a Service	カタログレポートの設定 （データアクセスのファインチューニング を参照）	ConnectionType： Reports
REST	自動で有効化	ConnectionType： REST
SOAP	自動で有効化	以下のWorkday SOAP API への認証を参照

BaseURL およびTenant の取得

BaseURL およびTenant プロパティを取得するため、Workday にログインしてView API Clients を検索します。 この画面では、Workday はBaseURL とTenant の両方を含むURL であるWorkday REST API Endpoint を表示します。

REST API Endpoint のフォーマットは、 https://domain.com/subdirectories/mycompany です。ここで、

• https://domain.com/subdirectories/ はBaseURL です。
• mycompany（URL の最後のスラッシュの後の部分）はTenant です。

例えば、REST API エンドポイントがhttps://wd3-impl-services1.workday.com/ccx/api/v1/mycompany の場合、 BaseURL はhttps://wd3-impl-services1.workday.com であり、Tenant はmycompany です。

WQL サービスを有効化

Workday WQL API を介して接続するには、はじめにWQL Service を有効にする必要があります。

1. Workday を開きます。
2. 検索バーにView Domain と入力します。
3. プロンプトにWorkday Query Language と入力します。
4. Allowed Security Group Types のいずれかに、接続するユーザーが含まれていることを確認します。

Workday への認証

Basic 認証以外のほとんどのWorkday 接続では、認証のためにOAuth ベースのカスタムAPI クライアントアプリケーションを作成する必要があります。これには、ユーザーがAzure AD 資格情報を介して接続するエンタープライズインストールも含まれます。

以下のコンテンツでは、非SSO 環境（アクセスするアプリケーションごとに個別のログイン）での認証方法について説明します。この場合、カスタムOAuth API クライアントが必要になります。SSO 環境での認証に関する詳細と、Workday に接続するための2種類のカスタムAPI クライアントアプリケーションの作成に関する情報については、カスタムAPI クライアントアプリケーションの作成 を参照してください。

カスタムOAuth アプリケーションの作成

このセクションでは、OAuth ベースのAPI クライアントを使用して、SSO のない環境で認証を行う方法について説明します。

OAuth 接続では、カスタムOAuth アプリケーションを作成する必要があります。カスタムOAuth アプリケーションの作成については、カスタムAPI クライアントアプリケーションの作成 を参照してください。

Workday で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

Note： SOAP 経由で接続したい場合は、カスタムOAuth アプリケーションを必要としないBasic 認証を使用できます。Workday SOAP API への認証を参照してください。

OAuth 認証

接続の前に、以下の変数を設定します。

• OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

Workday への接続 をクリックして、デフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

ドライバーは、以下のようにOAuth プロセスを完了します。

• コールバックURL からアクセストークンを取得します。
• 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
• OAuth 値を保存し、接続間で永続化します。

標準ユーザーとして認証

Workday で標準ユーザーとして認証するには、カスタムAPI クライアントアプリケーションの作成 で説明するように、はじめにAPI クライアントを作成する必要があります。

API クライアントを設定したら、Workday 認証情報を使用して接続するために以下のプロパティを設定します。

• ConnectionType および関連するすべてのプロパティ
• AuthScheme： OAuth。
• OAuthClientId：View API Client ページで取得したClient ID。
• OAuthClientSecret：View API Client ページで取得したClient Secret。パブリッククライアントを使う場合には、この値をブランクにします。
• Tenant：アカウントのテナント。
• BaseURL：View API Clients ページにあるREST API Endpoint のベースURL。

AzureAD で使用するAPI クライアントを作成した場合は、以下のプロパティを設定します。

• ConnectionType および関連するすべてのプロパティ
• AuthScheme：AzureAD。
• OAuthClientId：View API Client ページで取得したClient ID。
• Tenant：アカウントのテナント。
• BaseURL：View API Clients ページにあるREST API Endpoint のベースURL。
• SSOProperties：AzureTenant、AzureClientId、AzureClientSecret、Resource など、SSO に使用される Azure 固有のプロパティ。

ISU として認証

ISU として認証するには、カスタムAPI クライアントアプリケーションの作成 で説明するように、はじめにAPI Client またはAPI Client for Integrations のいずれかを作成する必要があります。 API Client for Integrations またはAPI Client using the JWT bearer grant type のいずれかを作成できます。

API Client for Integrations を作成した場合、接続するには次のプロパティを設定します。

• ConnectionType および関連するすべてのプロパティ
• AuthScheme：OAuthISU。
• OAuthClientId：View API Client ページで取得したClient ID。
• OAuthClientSecret：View API Client ページで取得したClient Secret。
• OAuthRefreshToken：Manage Refresh Tokens for Integrations ページで取得したリフレッシュトークン。
• Tenant：アカウントのテナント。
• BaseURL：View API Clients ページにあるREST API Endpoint のベースURL。

JWT でAPI Client を作成した場合、接続するには次のプロパティを設定します。

• ConnectionType および関連するすべてのプロパティ
• AuthScheme：OAuthJWT。
• OAuthJWTCertType：証明書の種類。keytool または openssl pkcs12 で証明書を作成した場合、PFXFILE になります。
• OAuthJWTCert：作成した証明書ファイルのパス。
• OAuthJWTCertPassword：作成した証明書ファイルのパスワード。
• OAuthJWTIssuer：View API Client ページで取得したClient ID。
• OAuthJWTSubject：使用しているISU のユーザー名。
• Tenant：アカウントのテナント。
• BaseURL：View API Clients ページにあるREST API Endpoint のベースURL。

Workday SOAP API への認証

SOAP API を使用する接続では、Basic 認証に加えて、WQL およびレポートサービスと同じ認証スキームがすべてサポートされます。 上記の各構成をSOAP で使用するには、UseWQL プロパティをfalse に設定します。

Basic 認証

Basic 認証（APIクライアントを設定する必要はありません）を使用するには、次の接続パラメータを設定します。

• ConnectionType：SOAP。
• AuthScheme：Basic。
• User：Workday ユーザーアカウント名。
• Password：ユーザーの認証に使用するパスワード。
• Tenant：アカウントのテナント。
• BaseURL：View API Clients ページにあるREST API Endpoint のベースURL。

その他の認証方法は、WQL およびレポーティングサービスの場合と同じ方法で構成されます。

データアクセスのファインチューニング

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.

Troubleshooting

Invalid Request

While connecting, you may receive an error stating "Invalid Request". This is a server-side Workday error. It often indicates that your user account has not been granted the permissions required to either connect via the API, or to obtain the specific information you have requested.

The tables and columns are retrieved from a publicly available service that requires no authentication, so this error may appear while either testing the connection, or when trying to retrieve data after metadata has been obtained.

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.

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

WQL APIs

When ConnectionType is set to WQL, the Cloud models Workday data sources as views. You can get a complete list of these data sources using the Data Sources standard report in Workday. The Cloud exposes each data source using its WQL Alias which is shown on the View Data Source page.

The Cloud exposes two kinds of data sources: Prism data sources and Core data sources. All Prism data sources start with the prefix cds_.

1. Prism data sources provide access to published tables and dataset defined within Prism Analytics. 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.
2. 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:

1. The Cloud only exposes data sources that are accessible to the user you have authenticated as. For example, a user with only HR roles is able to view data sources containing employee records but not data sources about financial assets.
2. The Cloud only supports one data source filter per data source. The Cloud uses the unfiltered version of the data source when it is available, and picks the first filter when a filter is required. See WQLDataSourceFilters for more information.

You can use UseSplitTables to work around this limtiation by splitting 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. See データアクセスのファインチューニング for details on what is required.

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. ConnectionType must be set to SOAP in order to use them.

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'

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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Workday ビュー

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

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 that must each be accessed in separate ways. Which category a table belongs to affects its performance, structure, and imposes different requirements inserting and modifying rows.

• Base entities can be read directly, like Requisitions.
• Child entities are part of some other entity. For example, the Cloud reads RequisitionsWorktags by looking up Requisitions and extracting the list of worktags. In this case Requisitions is the parent table.
• Owned entities that can only be read by going through another entity. For example, the Cloud needs a specific Requisition in order to read its line items from RequisitionsRequisitionLines. In this case Requisitions is the owner table.
• Owned child entities which are a combination of both. For example, the Cloud reads RequisitionsRequisitionLinesWorktags by looking up a specific Requisition, then looking up its RequisitionsRequisitionLines, and finally extracting the worktags from each line. In this case Requisisions is the owner table and RequisitionsRequisitionLines is the parent table.

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 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 an 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'

Refer to the documentation for each specific change table to see what operations it supports.

Cloud はWorkday のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Workday テーブル

Name	Description
AdHocProjectTimeTransactions	Retrieves an ad hoc project time transaction instance.
Attachments	Will return attachments
BillableTransactions	Retrieves a single billable transaction instance.
Cases	Retrieves a case with the specified ID that the user is secured to view.
CasesTimeline	Retrieves a comment timeline item for a case with the specified timeline ID.
EventDrivenIntegrationVendorResponse	Retrieves a single Event-Driven Integration vendor response.
ExpenseEntries	Retrieves a single instance of a Quick Expense.
ExpenseEntriesAttachments	Reads attachments entries from the ExpenseEntries table
ExpenseReports	Retrieves a single instance of an Expense Report.
ExternalCreators	Retrieves contact details for a single external \~case\~ contact instance.
HomeContactInformationChangesAddresses	An address as it exists staged for update by the parent business process.
HomeContactInformationChangesEmailAddresses	An email address as it exists staged for update by the parent business process.
HomeContactInformationChangesInstantMessengers	An instant messenger as it exists staged for update by the parent business process.
HomeContactInformationChangesPhoneNumbers	A phone number as it exists staged for update by the parent business process.
HomeContactInformationChangesWebAddresses	A web address as it exists staged for update by the parent business process.
ImmigrationEventsDependentImmigrationData	Retrieves a dependent immigration data instance for the specified student ID.
ImmigrationEventsImmigrationData	Retrieves an immigration data instance for the specified immigration event.
InterviewsFeedback	No description available
JobChangesAdministrative	Retrieves the administrative options for the specified job change ID.
JobChangesBusinessTitle	Retrieves a business title for the specified job change ID.
JobChangesComment	Returns the comment information for the specified job change ID.
JobChangesContract	Retrieves the contract options for the specified change job ID.
JobChangesJobClassification	Retrieves a job classification for the specified job change ID.
JobChangesJobProfile	Retrieves a job profile for the specified job change ID.
JobChangesLocation	Returns the location information for the specified job change ID.
JobChangesMoveTeam	Retrieves a move team option from the specified job change ID.
JobChangesOpening	Retrieves the opening options for the specified job change ID.
JobChangesPosition	Retrieves a position for the specified job change ID.
JobChangesStartDetails	Retrieves the start details for the specified job change ID.
MessageTemplates	Retrieves a message template with the specific ID.
OrganizationAssignmentChangesBusinessUnit	Retrieves a business unit for the specified organization assignment change ID.
OrganizationAssignmentChangesComment	Retrieves the comment information for the specified organization assignment change ID.
OrganizationAssignmentChangesCompany	Retrieves a company for the specified organization assignment change ID.
OrganizationAssignmentChangesCostCenter	Retrieves a cost center for the specified organization assignment change ID.
OrganizationAssignmentChangesCosting	Retrieves the costing organizations for the specified organization assignment change ID.
OrganizationAssignmentChangesCustomOrganizations	Retrieves the custom organizations for the specified organization assignment change ID.
OrganizationAssignmentChangesRegion	Retrieves a region for the specified organization assignment change ID.
OrganizationAssignmentChangesStartDetails	Retrieves the start details for the specified organization assignment change ID.
PayGroupsPeriods	Retrieves a payroll period for the specified Payroll Interface pay group ID.
Payments	Retrieves a single customer invoice payment instance.
PaymentsRemittanceDetails	Retrieves a single customer invoice payment remittance line instance.
PayrollInputs	Retrieves a single payroll input instance.
PayrollInputsInputDetails	Reads inputDetails entries from the PayrollInputs table
PayrollInputsRunCategories	Reads runCategories entries from the PayrollInputs table
PayrollInputsWorktags	Reads worktags entries from the PayrollInputs table
PlanPhases	Retrieves a single project plan phase instance.
PlanTasks	Retrieves a single project plan task instance.
Projects	Retrieves a single project instance.
Prospects	Retrieves a single \~prospect\~ instance.
ProspectsEducations	Retrieves a single education instance for a \~prospect\~.
ProspectsExperiences	Retrieves a single experience instance for a \~prospect\~.
ProspectsLanguages	Retrieves a single language instance for a \~prospect\~.
ProspectsResumeAttachments	Retrieves a single resume attachment instance for a \~prospect\~.
ProspectsSkills	Retrieves a single skill instance for a \~prospect\~.
Requests	Retrieves the request with the specified ID.
Requisitions	Retrieves a requisition.
RequisitionsAttachments	Retrieves the metadata or the attachment content of the specified requisition.
RequisitionsRequisitionLines	Retrieves a requisition line for the specified requisition.
RequisitionsRequisitionLinesWorktags	Reads worktags entries from the RequisitionsRequisitionLines table
RequisitionsWorktags	Reads worktags entries from the Requisitions table
ResourceForecastLinesAllocations	Retrieve Resource Forecast Line Allocation.
ResourcePlanLines	Retrieves a single resource plan line instance.
ScorecardResults	Provides the ability to set up and retrieve Scores on Scorecard Results.
Scorecards	Retrieves Compensation Scorecard information.
ScorecardsDefaultScorecardGoals	Reads defaultScorecardGoals entries from the Scorecards table
ScorecardsScorecardProfiles	Reads scorecardProfiles entries from the Scorecards table
StudentsPayments	Retrieves a single student payment instance for the specified student ID.
SupplierInvoiceRequests	Retrieves a single supplier invoice instance.
SupplierInvoiceRequestsAttachments	Retrieves a single attachment instance.
TaskResources	Retrieves a single task resource instance.
TaskResourcesProjectResources	Reads projectResources entries from the TaskResources table
TimeClockEvents	Retrieves a time clock event.
WorkContactInformationChangesAddresses	An address as it exists staged for update by the parent business process.
WorkContactInformationChangesEmailAddresses	An email address as it exists staged for update by the parent business process.
WorkContactInformationChangesInstantMessengers	An instant messenger as it exists staged for update by the parent business process.
WorkContactInformationChangesPhoneNumbers	A phone number as it exists staged for update by the parent business process.
WorkContactInformationChangesWebAddresses	A web address as it exists staged for update by the parent business process.
WorkersAnytimeFeedbackEvents	Retrieves a feedback given event instance with the specified ID.
WorkersBusinessTitleChanges	Retrieves a business title change instance for a specific worker.
WorkersCheckIns	Retrieves a single Check-In instance.
WorkersCheckInsAssociatedTopics	Reads associatedTopics entries from the WorkersCheckIns table
WorkersCheckInsCheckInAttachments	Reads checkInAttachments entries from the WorkersCheckIns table
WorkersCheckInTopics	Retrieves a single Check-In topic instance.
WorkersCheckInTopicsAssociatedCheckIns	Reads associatedCheckIns entries from the WorkersCheckInTopics table
WorkersCheckInTopicsCheckInTopicAttachments	Reads checkInTopicAttachments entries from the WorkersCheckInTopics table

Retrieves an ad hoc project time transaction instance.

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

Will return attachments

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	Supported for: SELECT. A description of the instance
ContentType_Href	String	False	Supported for: SELECT. A link to the instance
ContentType_Id	String	False	Supported for: SELECT, INSERT. wid / id / reference id
FileLength	Decimal	False	Supported for: SELECT, INSERT. File length of the attachment
FileName	String	False	Supported for: SELECT, INSERT. File name of the attachment

Retrieves a single billable transaction instance.

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

Retrieves a case with the specified ID that the user is secured to view.

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

[{
  id: Text /* \~Case\~ Attachment ID. */
  fileName: Text /* File name of the attachment */
  contentType: { /* Content type of the attachment */
     *id: Text /* wid / id / reference id */
  }
  fileLength: Numeric /* File length of the attachment */
  descriptor: Text /* A preview of the instance */
}]

QuestionnaireResponses_QuestionnaireAnswers_Aggregate

[{
  questionnaireAttachments: [{
      fileName: Text /* File name of the attachment */
      contentType: { /* Content type of the attachment */
         *id: Text /* wid / id / reference id */
      }
      fileLength: Numeric /* File length of the attachment */
      id: Text /* Id of the instance */
      descriptor: Text /* A preview of the instance */
  }]
  answerMultipleChoices: [{
      id: Text /* Id of the instance */
      descriptor: Text /* A preview of the instance */
  }]
  answerNumeric: Numeric /* The answer in a numeric format. */
  answerText: Text /* The text answer for a questionnaire. */
  answerDate: Date /* The answer in a date format. */
  questionItem: { /* Question Item for Questionnaire Answer. Question item represents the question in a questionnaire. */
     *id: Text /* wid / id / reference id */
  }
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns

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

Retrieves a comment timeline item for a case with the specified timeline ID.

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

[{
  id: Text /* \~Case\~ Attachment ID. */
  fileName: Text /* File name of the attachment */
  contentType: { /* Content type of the attachment */
     *id: Text /* wid / id / reference id */
  }
  fileLength: Numeric /* File length of the attachment */
  descriptor: Text /* A preview of the instance */
}]

Columns

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

Retrieves a single Event-Driven Integration vendor response.

Workday Resource Information

Retrieves an Event-Driven Integration vendor response with the specified ID.

Secured by: Global Payroll System, Set Up: Payroll Interface (Update Vendor Response for Event-Driven Integration)+TG

Scope: Payroll Interface

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.

ErrorMessageSet_Errors_Aggregate

[{
  recordType: Text /* The type of error being recorded. Examples: Data error, Configuration error. */
  diagnosis: Text /* An explanation for the root cause of the error. */
  group: [{
      groupData: [{
          name: Text /* The name of the reported field attribute. Examples: Amount, Currency, Status. */
          value: Text /* The value of the reported field attribute. Examples: 2000, USD, Active. */
      }]
      groupValue: Text /* The specific name of the type of data being provided by the third-party payroll system. Examples: Car Allowance, Home Address. */
      groupName: Text /* The group category holding the data being provided by the third-party payroll system. Examples: Allowance, Address. */
  }]
  messageNumber: Text /* An integer number identifying the error reported. */
  messageCategory: Text /* The category for where the error occurred. Examples: Worker Data, Organization, Supervisory, Staffing. */
  procedure: Text /* The steps to fix the error. */
 *vendorErrorMessage: Text /* Required detailed error message that explains what occurred in the third-party payroll system while processing the worker changes sent through event-driven integration. */
  who: Text /* Lists the names, positions, or roles of the concerned audience for handling the error resolution. */
 *severity: { /* The severity level for the vendor-defined integration error message. */
     *id: Text /* wid / id / reference id */
  }
  functionalArea: Text /* The functional area that was impacted by the error reported. Examples: Position, Compensation, Personal data. */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Required Workday ID for the Event-Driven Integration. Workday provides this to the third-party payroll vendor as part of the initial file delivery.
ErrorMessageSet_Errors_Aggregate	String	False	Supported for: INSERT. A JSON aggregate. A data set containing a group of payroll messages and exceptions returned by payroll vendor for the worker changes sent by Event Driven Integration.
OverallStatus_Descriptor	String	False	Supported for: SELECT. A description of the instance
OverallStatus_Href	String	False	Supported for: SELECT. A link to the instance
OverallStatus_Id	String	False	Supported for: SELECT, INSERT. wid / id / reference id
Relaunchable	Bool	False	Supported for: SELECT, INSERT. If true, Workday displays the Resend to Payroll button on the Review Event Driven Integration for Third Party Payroll step to resubmit worker changes after making any corrections. If false, Workday doesn't display the button. The field might be set to false if there isn�t anything the user can do to fix the errors and resubmitting the changes will result in the same errors.
SetLsrd	Bool	False	Supported for: SELECT, INSERT. If true, Workday updates the LSRD for that particular worker. The next time you run the batch PECI integration, only changes that occurred after running the Event-Driven Integration is included for the worker. If false, Workday sends the original data again during the next transmission, either through the event-driven integration or the Payroll Effective Change Interface integration.
SkipReview	Bool	False	Supported for: SELECT, INSERT. If true, Workday displays the Review Event Driven Integration for Third Party Payroll step on the Maintain Local Payroll Data task.
SkipReviewReason	String	False	Supported for: SELECT, INSERT. The reason that gives guidance whether or not to complete the Maintain Local Payroll Data step after the Review Event Driven Integration for Third Party Payroll step. This field applies when you configured the Hire business process with the Maintain Local Payroll Data step right after the Review Event Driven Integration for Third Party Payroll step. Workday displays this reason on the Maintain Local Payroll Data task after the Review Event Driven Integration for Third Party Payroll step.

Retrieves a single instance of a Quick Expense.

Workday Resource Information

Retrieves a Quick Expense with the specified WID.

Secured by: Self-Service: Expense Report

Scope: Expenses

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

[{
  fileLength: Numeric /* File length of the attachment */
  fileName: Text /* File name of the attachment */
  contentType: { /* Content type of the attachment */
     *id: Text /* wid / id / reference id */
  }
  id: Text /* Id of the instance */
  href: Text /* A link to the instance */
  descriptor: Text /* A preview of the instance */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Amount_Currency	String	False	Supported for: SELECT, INSERT, UPDATE. Amount for Expense Entry
Amount_Value	Decimal	False	Supported for: SELECT, INSERT, UPDATE. Amount for Expense Entry
Attachments_Aggregate	String	False	Supported for: INSERT. A JSON aggregate. CRF for Entries REST operation to expose Attachment related to Optical Character Recognition
Date	Datetime	False	Supported for: SELECT, INSERT, UPDATE. Date of Expense Entry
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
EntryType_Descriptor	String	False	Supported for: SELECT. A description of the instance
EntryType_Href	String	False	Supported for: SELECT. A link to the instance
EntryType_Id	String	False	Supported for: SELECT. wid / id / reference id
ExpenseEntryStatus_Descriptor	String	False	Supported for: SELECT. A description of the instance
ExpenseEntryStatus_Href	String	False	Supported for: SELECT. A link to the instance
ExpenseEntryStatus_Id	String	False	Supported for: SELECT. wid / id / reference id
ExpenseItem_Descriptor	String	False	Supported for: SELECT. A description of the instance
ExpenseItem_Href	String	False	Supported for: SELECT. A link to the instance
ExpenseItem_Id	String	False	Supported for: SELECT, INSERT, UPDATE. wid / id / reference id
HasOCRReceipt	Bool	False	Supported for: SELECT, INSERT. Boolean value indicating whether the Mobile Expense has an OCR image.
Href	String	False	Supported for: SELECT, INSERT, UPDATE. A link to the instance
Image_Id	String	False	Supported for: UPDATE. wid / id / reference id
Memo	String	False	Supported for: SELECT, INSERT, UPDATE. Memo for the Entry
Merchant	String	False	Supported for: SELECT, INSERT, UPDATE. Expense Merchant Name
ScanStatus_Descriptor	String	False	Supported for: SELECT. A description of the instance
ScanStatus_Href	String	False	Supported for: SELECT. A link to the instance
ScanStatus_Id	String	False	Supported for: SELECT, INSERT. wid / id / reference id
EntryType_Prompt	String	False	No description available
ExpenseEntryStatus_Prompt	String	False	No description available
FromDate_Prompt	Date	False	No description available
ToDate_Prompt	Date	False	No description available

Reads attachments entries from the ExpenseEntries table

Workday Resource Information

Retrieves a Quick Expense with the specified WID.

Secured by: Self-Service: Expense Report

Scope: Expenses

Contains attachment(s)

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
ExpenseEntries_Id [KEY]	String	False	The Wordkay ID of the ExpenseEntries that contains this
ContentType_Descriptor	String	False	Supported for: SELECT. A description of the instance
ContentType_Href	String	False	Supported for: SELECT. A link to the instance
ContentType_Id	String	False	Supported for: SELECT, INSERT, UPDATE. wid / id / reference id
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
FileLength	Decimal	False	Supported for: SELECT, INSERT, UPDATE. File length of the attachment
FileName	String	False	Supported for: SELECT, INSERT, UPDATE. File name of the attachment
Href	String	False	Supported for: SELECT, INSERT, UPDATE. A link to the instance
EntryType_Prompt	String	False	No description available
ExpenseEntryStatus_Prompt	String	False	No description available
FromDate_Prompt	Date	False	No description available
ToDate_Prompt	Date	False	No description available

Retrieves a single instance of an Expense Report.

Workday Resource Information

Retrieves details of an Expense Report referenced by its Workday Identifier (WID).

Secured by: Self-Service: Expense Report

Scope: Expenses

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Company_Id	String	False	Supported for: INSERT. wid / id / reference id
CreationDate	Datetime	False	Supported for: SELECT, INSERT. Creation Date label to be used for REST API
Descriptor	String	False	Supported for: SELECT, INSERT. A preview of the instance
ExpenseReportMemo	String	False	Supported for: SELECT, INSERT. Memo label to be used for REST API
ExpenseReportStatus_Descriptor	String	False	Supported for: SELECT. A description of the instance
ExpenseReportStatus_Href	String	False	Supported for: SELECT. A link to the instance
ExpenseReportStatus_Id	String	False	Supported for: SELECT. wid / id / reference id
Href	String	False	Supported for: SELECT. A link to the instance
Payee_Id	String	False	Supported for: INSERT. wid / id / reference id
TotalAmount_Currency	String	False	Supported for: SELECT. Total Amount for the Expense Report
TotalAmount_Value	Decimal	False	Supported for: SELECT. Total Amount for the Expense Report
Worktag_Descriptor	String	False	Supported for: INSERT. A preview of the instance
Worktag_Id	String	False	Supported for: INSERT. Id of the instance
ExpenseReportMemo_Prompt	String	False	No description available
ExpenseReportStatus_Prompt	String	False	Accepts multiple inputs. No description available
FromDate_Prompt	Date	False	No description available
ToDate_Prompt	Date	False	No description available

Retrieves contact details for a single external \~case\~ contact instance.

Workday Resource Information

Retrieves contact details for an external case contact with the specified ID. Contact details include an email address and a name, if applicable.

Secured by: Help Case External Contacts+TG

Scope: Help

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
Blocked	Bool	False	Supported for: SELECT, INSERT. If true, the external contact is blocked and they can't create cases.
Email	String	False	Supported for: SELECT, INSERT. The email for the external case contact.
Name	String	False	Supported for: SELECT, INSERT. The name for the external case contact.
Email_Prompt	String	False	The email address that identifies the external case contact.
HideBlockedCreators_Prompt	Boolean	False	If true, blocked contacts are excluded from the response.

An address as it exists staged for update by the parent business process.

Workday Resource Information

Retrieve an existing address as it exists when staged by the parent business process.

Secured by: Person Data: Home Address, Self-Service: Home Address

Scope: Contact Information

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.

Usage_UsedFor_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
HomeContactInformationChange_Id [KEY]	String	False	The ID of the change process. Must be set in all queries.
AddressLine1	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 1
AddressLine1Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 1
AddressLine2	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 2
AddressLine2Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 2
AddressLine3	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 3
AddressLine3Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 3
AddressLine4	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 4
AddressLine4Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 4
AddressLine5	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 5
AddressLine5Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 5
AddressLine6	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 6
AddressLine6Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 6
AddressLine7	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 7
AddressLine7Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 7
AddressLine8	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 8
AddressLine8Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 8
AddressLine9	String	False	Supported for: SELECT, INSERT, UPDATE. Address Line 9
AddressLine9Local	String	False	Supported for: SELECT, INSERT, UPDATE. Local Address Line 9
City	String	False	Supported for: SELECT, INSERT, UPDATE. City
CityLocal	String	False	Supported for: SELECT, INSERT, UPDATE. City - Local
CitySubdivision1	String	False	Supported for: SELECT, INSERT, UPDATE. City Subdivision 1
CitySubdivision1Local	String	False	Supported for: SELECT, INSERT, UPDATE. City Subdivision 1 - Local
CitySubdivision2	String	False	Supported for: SELECT, INSERT, UPDATE. City Subdivision 2
CitySubdivision2Local	String	False	Supported for: SELECT, INSERT, UPDATE. City Subdivision 2 - Local
CountryCity_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
CountryCity_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
CountryRegion_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
CountryRegion_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Country_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Country_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Effective	Datetime	False	Supported for: SELECT. The date this business process takes effect.
NumberDaysWFH	Decimal	False	Supported for: SELECT, INSERT, UPDATE. Number of Days WFH
PostalCode	String	False	Supported for: SELECT, INSERT, UPDATE. Postal Code
RegionSubdivision1	String	False	Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1
RegionSubdivision1Local	String	False	Supported for: SELECT, INSERT, UPDATE. Region Subdivision 1 - Local
RegionSubdivision2	String	False	Supported for: SELECT, INSERT, UPDATE. Region Subdivision 2
Usage_Comment	String	False	Supported for: SELECT, INSERT, UPDATE. Returns the description for a given communication method.
Usage_Primary	Bool	False	Supported for: SELECT, INSERT, UPDATE. Is Primary
Usage_Public	Bool	False	Supported for: SELECT, INSERT, UPDATE. Is Public Visibility
Usage_UsageType_Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
Usage_UsageType_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Usage_UsedFor_Aggregate	String	False	Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Used For
PrimaryOnly_Prompt	Boolean	False	No description available
UsedFor_Prompt	String	False	No description available

An email address as it exists staged for update by the parent business process.

Workday Resource Information

Retrieve an existing email address as it exists when staged by the parent business process.

Secured by: Person Data: Home Email, Self-Service: Home Email

Scope: Contact Information

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.

Usage_UsedFor_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	False	Id of the instance
HomeContactInformationChange_Id [KEY]	String	False	The ID of the change process. Must be set in all queries.
Descriptor	String	False	Supported for: SELECT, INSERT, UPDATE. A preview of the instance
EmailAddress	String	False	Supported for: SELECT, INSERT, UPDATE. The email address.
Usage_Comment	String	False	Supported for: SELECT, INSERT, UPDATE. The description for a given communication method.
Usage_Primary	Bool	False	Supported for: SELECT, INSERT, UPDATE. True if the communication method has any primary usage type.
Usage_Public	Bool	False	Supported for: SELECT, INSERT, UPDATE. True if the communication method is public. If no results are returned, the communication method is private.
Usage_UsageType_Id	String	False	Supported for: SELECT, INSERT, UPDATE. Id of the instance
Usage_UsedFor_Aggregate	String	False	Supported for: SELECT, INSERT, UPDATE. A JSON aggregate. Usage behaviors for the communication method, such as mailing, billing shipping etc.
PrimaryOnly_Prompt	Boolean	False	If true, returns only the IDs of the person's primary email addresses.
PublicOnly_Prompt	Boolean	False	If true, returns only the IDs of the person's public email addresses.
UsageType_Prompt	String	False	Specifies usage type, such as home or work. Only used if the service provides access to multiple usage types from the same endpoint.
UsedFor_Prompt	String	False	Specifies usage behavior, such as mailing, billing, or shipping.