EffectiveChanges
Tracks effective change data related to organizations and workers, providing insights into historical and upcoming changes in employment, organizational structure, and worker attributes.
Table Specific Information
Select
The Workday driver requires filtering on Id in order to perform the query.
For example:
SELECT * FROM EffectiveChanges WHERE Id = '12345';
Workday Resource Information
Generates effective change data for organizations or workers based on request parameters.Secured by: Manage: Data Changes On Demand+TG
Scope: Global Payroll Connect
Aggregate Fields
The driver represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.
This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.
RequestCriteria_Fields_OnlyInclude_Aggregate
[{
id: Text /* Id of the instance */
}]
RequestCriteria_Organizations_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
RequestCriteria_ResponseFilter_AdditionalNameTypes_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
RequestCriteria_ResponseFilter_OrganizationRoles_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
RequestCriteria_ResponseFilter_OrganizationTypes_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
RequestCriteria_ResponseFilter_PaymentElectionRules_Aggregate
[{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
RequestCriteria_WorkerOverrides_Aggregate
[{
entryMomentFromOverride: Date /* Entry Moment override for the \~Worker\~. */
id: Text /* The \~worker\~ to override. */
}]
RequestCriteria_Workers_Aggregate
[{
id: Text /* Id of the instance */
}]
ResponseData_Documents_Aggregate
[{
documentId: Text /* Document ID for document. Can be used in conjunction with Blobitory API to retrieve the document. */
documentTags: [{
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}]
fileName: Text /* File name for document. */
organization: { /* Organization for document. */
descriptor: Text /* A preview of the instance */
id: Text /* Id of the instance */
}
}]
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
Unique identifier of the instance, used to reference specific records. |
| RequestCriteria_AllEffective | Bool | False |
Defaults to 'false'. Set to true to include all effective changes within the specified date range. If 'false', only incremental changes made within the entry range are returned. |
| RequestCriteria_EffectiveFrom | Datetime | False |
The start date for retrieving changes based on their effective date. |
| RequestCriteria_EffectiveTo | Datetime | False |
The end date for retrieving changes based on their effective date. |
| RequestCriteria_EntryMomentFrom | Datetime | False |
The start date for retrieving changes based on the date they were entered into the system. |
| RequestCriteria_EntryMomentTo | Datetime | False |
The end date for retrieving changes based on the date they were entered into the system. |
| RequestCriteria_ExcludeWorkers | Bool | False |
Set to true to exclude workers specified in the 'workers' request parameter from the output. By default, the parameter is inclusive. |
| RequestCriteria_ExtendedAllEffectiveTo | Datetime | False |
The upper limit for an optional extended range of effective changes. |
| RequestCriteria_Fields_FieldSetVersion | String | False |
Specifies the version of fields for which changes are requested. |
| RequestCriteria_Fields_OnlyInclude_Aggregate | String | False |
A comma-separated list of specific fields to include in the response, with 1 space after each comma. |
| RequestCriteria_ForceRerun | Bool | False |
Set to true to generate a new request, even if the parameters match a previous request. Use only if the previous request is complete or has failed. |
| RequestCriteria_IncludeRequestCriteriaInResponse | Bool | False |
Defaults to false. Set to true to include the original request parameters in the response. |
| RequestCriteria_Organizations_Aggregate | String | False |
Specifies organizations relevant to the external data request, such as pay groups. |
| RequestCriteria_ResponseFilter_AdditionalNameTypes_Aggregate | String | False |
A comma-separated list of additional name types to filter and include in the output, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Descriptor | String | False |
A description of the instance |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Href | String | False |
A link to the instance |
| RequestCriteria_ResponseFilter_ConfigurableCompensationBasis_Id | String | False |
wid / id / reference id |
| RequestCriteria_ResponseFilter_CountryNameFormat | String | False |
Specifies the format in which country names should be returned. |
| RequestCriteria_ResponseFilter_CountryRegionNameFormat | String | False |
Specifies the format in which country region names should be returned. |
| RequestCriteria_ResponseFilter_ExcludeAdditionalJobs | Bool | False |
Set to true to exclude additional job data from the response. |
| RequestCriteria_ResponseFilter_FullSnapshot | Bool | False |
Set to true to include all workers within the request, regardless of whether they have changes to report. |
| RequestCriteria_ResponseFilter_IncludeEndedContracts | Bool | False |
Set to true to include data related to ended contracts in the output. |
| RequestCriteria_ResponseFilter_OrganizationRoles_Aggregate | String | False |
A comma-separated list of organization roles to include in the Position data section, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_OrganizationTypes_Aggregate | String | False |
A comma-separated list of organization types to filter and include in the output, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_PaymentElectionRules_Aggregate | String | False |
A comma-separated list of payment election rules used to filter payment election data, with 1 space after each comma. |
| RequestCriteria_ResponseFilter_ReportPostTermCompensation | Bool | False |
Set to true to include post-termination compensation changes in the output. |
| RequestCriteria_SchemaOnly | Bool | False |
Set to true to return only the schema file. Set to false to return both the schema file and other output files. Use this option to identify available API fields and map them to external vendor fields as needed. |
| RequestCriteria_WorkerOverrides_Aggregate | String | False |
A comma-separated list of worker overrides relevant to the data request, with 1 space after each comma. |
| RequestCriteria_Workers_Aggregate | String | False |
A comma-separated list of workers relevant to the data request, with 1 space after each comma. |
| ResponseData_Documents_Aggregate | String | False |
Comma-separated IDs of documents containing data produced using the request parameters. Use the Blobitory REST API to retrieve the documents, with 1 space after each comma. |
| ResponseData_Status_Descriptor | String | False |
Descriptive status message providing additional context about the instance. |
| ResponseData_Status_Href | String | False |
URL link to access the instance. |
| ResponseData_Status_Id | String | False |
Unique identifier of the instance, which can be a Workday identifier (WID), Id, or reference Id. |