CData Python Connector for Workday

Build 25.0.9454

SubmitHomeContactInformationChange

Submit the specified contact change ID.

Workday Resource Information

Submits the specified home contact information change ID.

To submit the Home Contact Change event and initiate the Home Contact Change business process, specify an empty request body: {}.
To save for later, specify this request body:
{
"businessProcessParameters": {
"action":{
"id": "d9e41a8c446c11de98360015c5e6daf6"
}
}
}

The action id value is the Workday ID of the Save for Later action. If you submit this endpoint with the Save for Later action, you can no longer edit nor resubmit the Home Contact Change event using the REST APIs. The user with correct permissions can edit and submit the saved Home Contact Change event in the Workday UI.

Secured by: Change Home Contact Information (REST Service)

Scope: Contact Information

Aggregate Fields

The connector 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.

BusinessProcessParameters_Attachments_Aggregate


[{
  category: { /* Returns the category of a Business Process Attachment. */
     -descriptor: Text /* The display name of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  contentType: { /* Content type of the attachment */
     -descriptor: Text /* The display name of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  description: Text /* Event attachment description */
  fileLength: Numeric /* File length of the attachment */
  fileName: Text /* File name of the attachment */
  id: Text /* Id of the instance */
 -uploadDate: Date /* Returns Date the Business Process Attachment was updated. */
  uploadedBy: { /* Returns the primary Role of the person who uploaded the Attachment. */
     -descriptor: Text /* The display name of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Input

Name Type Description
HomeContactInformationChange_Id String Unique identifier for the home contact information change request.
BusinessProcessParameters_Action_Id String Unique identifier for the action performed in the business process.
BusinessProcessParameters_Attachments_Aggregate String Attachments related to the business process, uploaded by the user.
BusinessProcessParameters_Comment String Comment field associated with the business process (returns null if not applicable).
BusinessProcessParameters_For_Id String Unique identifier for the person or entity the business process is related to.
BusinessProcessParameters_OverallBusinessProcess_Id String Unique identifier for the overall business process.
BusinessProcessParameters_TransactionStatus_Id String Unique identifier for the transaction status of the business process.
Descriptor String The display name of the instance
Id String Unique identifier for the specific change request instance.

Result Set Columns

Name Type Description
BusinessProcessParameters_CriticalValidations String Critical validation messages triggered by the action event.
BusinessProcessParameters_OverallStatus String The current status of the business process (e.g., Successfully Completed, Denied, Terminated).
BusinessProcessParameters_WarningValidations String Warning validation messages triggered by the action event.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454