SuccessionPlanEventsSubmit
Submits a succession plan event.
Workday Resource Information
Submits an in progress succession plan event specified by the Workday ID (WID). This operation is equivalent to submitting a succession plan event in the Manage Succession Plan task. To submit the succession plan event, specify an empty request body: {}.To add a comment, specify this request body:
{
"businessProcessParameters": {
"action":{
"id": "d9e4223e446c11de98360015c5e6daf6"
},
"comment": "Test comment."
}
}
Secured by: Manage Succession Plan (REST Service)
Scope: Talent Pipeline
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 */
}
}]
BusinessProcessParameters_Comments_Aggregate
[{
comment: Text /* Comment */
commentDate: Date /* Gives the moment at which the instance was originally created. */
person: { /* Comment made by Person */
-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 |
| SuccessionPlanEvents_Id | String | The ID of the resource to execute this process on. |
| BusinessProcessParameters_Action_Id | String | wid / id / reference id |
| BusinessProcessParameters_Attachments_Aggregate | String | 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 | The display name of the instance |
| Id | String | Id of the instance |
Result Set Columns
| Name | Type | Description |
| BusinessProcessParameters_Action_Descriptor | String | The display name of the instance |
| BusinessProcessParameters_Action_Href | String | A link to the instance |
| BusinessProcessParameters_Action_Id | String | wid / id / reference id |
| BusinessProcessParameters_Attachments_Aggregate | String | 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_Comments_Aggregate | String | Returns the comments for the current business process. |
| BusinessProcessParameters_CriticalValidations | String | Validation message for an action event triggered by a condition. |
| BusinessProcessParameters_For_Descriptor | String | The display name of the instance |
| BusinessProcessParameters_For_Href | String | A link to the instance |
| BusinessProcessParameters_For_Id | String | wid / id / reference id |
| BusinessProcessParameters_OverallBusinessProcess_Descriptor | String | The display name of the instance |
| BusinessProcessParameters_OverallBusinessProcess_Href | String | A link to the instance |
| BusinessProcessParameters_OverallBusinessProcess_Id | String | wid / id / reference id |
| BusinessProcessParameters_OverallStatus | String | The current status of the business process. For example: Successfully Completed, Denied, Terminated. |
| BusinessProcessParameters_TransactionStatus_Descriptor | String | The display name of the instance |
| BusinessProcessParameters_TransactionStatus_Href | String | A link to the instance |
| BusinessProcessParameters_TransactionStatus_Id | String | wid / id / reference id |
| BusinessProcessParameters_WarningValidations | String | Warning message for an action event triggered by a condition. |
| Descriptor | String | The display name of the instance |
| Id | String | Id of the instance |