ODBC Driver for Workday

Build 24.0.9060

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

BusinessProcessParameters_Attachments_Aggregate


[{
  category: { /* Returns the category of a Business Process Attachment. */
     -descriptor: Text /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
  contentType: { /* Content type of the attachment */
     -descriptor: Text /* A description 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 /* A description of the instance */
     -href: Text /* A link to the instance */
     *id: Text /* wid / id / reference id */
  }
}]

Input

Name Type Description
HomeContactInformationChange_Id String The ID of the change process. This value must be the same as the output from the BeginHomeContactInformationChange procedure.
BusinessProcessParameters_Action_Id String wid / id / reference id
BusinessProcessParameters_Attachments_Aggregate String A JSON aggregate. Returns attachments associated with this business process that are uploaded from the toolbar and are accessible to the processing person. Returns blank if either of these conditions are not met.
BusinessProcessParameters_Comment String Returns a null.
BusinessProcessParameters_For_Id String wid / id / reference id
BusinessProcessParameters_OverallBusinessProcess_Id String wid / id / reference id
BusinessProcessParameters_TransactionStatus_Id String wid / id / reference id
Descriptor String A preview of the instance
Id String Id of the instance

Result Set Columns

Name Type Description
BusinessProcessParameters_CriticalValidations String Validation message for an action event triggered by a condition.
BusinessProcessParameters_OverallStatus String The current status of the business process. For example: Successfully Completed, Denied, Terminated.
BusinessProcessParameters_WarningValidations String Warning message for an action event triggered by a condition.

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