CData Python Connector for Workday

Build 24.0.9111

EffectiveChanges

Generates effective change data for organizations or workers based on request parameters.

Columns

Name Type ReadOnly Description
Id [KEY] String False

Id of the instance

RequestCriteria_AllEffective Bool False

Supported for: SELECT, INSERT. Default is false. Only set to true if you want all effective changes in the effective range. Otherwise, it will only give incremental changes entered within the entry range.

RequestCriteria_EffectiveFrom Datetime False

Supported for: SELECT, INSERT. The date from which the effective moment for the request should query data for.

RequestCriteria_EffectiveTo Datetime False

Supported for: SELECT, INSERT. The date up until which the entry moment for the request should query data for.

RequestCriteria_EntryMomentFrom Datetime False

Supported for: SELECT, INSERT. The date from which the entry moment for the request should query data for.

RequestCriteria_EntryMomentTo Datetime False

Supported for: SELECT, INSERT. The date up until which the entry moment for the request should query data for.

RequestCriteria_ExcludeWorkers Bool False

Supported for: SELECT, INSERT. If set to true, workers in the "workers" request parameter will be excluded from the output. By default, the parameter is inclusive.

RequestCriteria_ExtendedAllEffectiveTo Datetime False

Supported for: SELECT, INSERT. Upper limit of the optional extended all effective range.

RequestCriteria_Fields_FieldSetVersion String False

Supported for: SELECT, INSERT. Version of fields that changes are requested for.

RequestCriteria_Fields_OnlyInclude_Aggregate String False

Supported for: INSERT. A JSON aggregate. A list of fields that changes are requested for.

RequestCriteria_ForceRerun Bool False

Supported for: SELECT, INSERT. This boolean is used to force a new request to be generated even if the same parameters as a prior request are sent. Force Rerun should only be used if the previous request is complete or has failed for some reason.

RequestCriteria_IncludeRequestCriteriaInResponse Bool False

Supported for: SELECT, INSERT. Default is false. When true, the original request will be shown in the response.

RequestCriteria_Organizations_Aggregate String False

Supported for: INSERT. A JSON aggregate. Organization for external data request (e.g. pay group).

RequestCriteria_ResponseFilter_AdditionalNameTypes_Aggregate String False

Supported for: INSERT. A JSON aggregate. Filter Additional Names by Additional Name Types to include in output.

RequestCriteria_ResponseFilter_CountryNameFormat String False

Supported for: SELECT, INSERT. Format for Country Name.

RequestCriteria_ResponseFilter_CountryRegionNameFormat String False

Supported for: SELECT, INSERT. Format for Country Region Name.

RequestCriteria_ResponseFilter_ExcludeAdditionalJobs Bool False

Supported for: SELECT, INSERT. Exclude Additional Job data from output.

RequestCriteria_ResponseFilter_FullSnapshot Bool False

Supported for: SELECT, INSERT. If true, returns all workers in the request regardless if the worker has changes to report or not.

RequestCriteria_ResponseFilter_IncludeEndedContracts Bool False

Supported for: SELECT, INSERT. Include Ended Contracts in output.

RequestCriteria_ResponseFilter_OrganizationRoles_Aggregate String False

Supported for: INSERT. A JSON aggregate. Organization Roles to include in Position data section.

RequestCriteria_ResponseFilter_OrganizationTypes_Aggregate String False

Supported for: INSERT. A JSON aggregate. Filter Organizations by Organization Types.

RequestCriteria_ResponseFilter_PaymentElectionRules_Aggregate String False

Supported for: INSERT. A JSON aggregate. Filter Payment Elections by Payment Election Rules to include in output.

RequestCriteria_ResponseFilter_ReportPostTermCompensation Bool False

Supported for: SELECT, INSERT. Include Post Termination compensation changes in output.

RequestCriteria_SchemaOnly Bool False

Supported for: SELECT, INSERT. If true, the API only returns the schema file. If false, the API returns the schema file and other output files. Use this option to identify available API fields and map to external vendor fields as needed.

RequestCriteria_WorkerOverrides_Aggregate String False

Supported for: INSERT. A JSON aggregate. Worker Overrides for data request.

RequestCriteria_Workers_Aggregate String False

Supported for: INSERT. A JSON aggregate. Workers for data request.

ResponseData_Documents_Aggregate String False

Supported for: INSERT. A JSON aggregate. IDs of documents containing data produced with the parameters of the request. One can use the Blobitory REST API to retrieve the documents.

ResponseData_Status_Descriptor String False

Supported for: SELECT. A description of the instance

ResponseData_Status_Href String False

Supported for: SELECT. A link to the instance

ResponseData_Status_Id String False

Supported for: SELECT, INSERT. wid / id / reference id

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9111