DistributionRequests
Creates journey distribution.
Workday Resource Information
Creates a single journey distribution instance with the specified data.In the request body, specify 1 of the 2 required fields: builder or discoverableBuilder. Specify receipients if applicable, or if this is a support journey, and if you'd like to exclude recipients who've already received this journey instance.
Secured by: Distribute Journeys, Self-Service: Journey Distribution
Scope: Journeys
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.
Journeys_Aggregate
[{
descriptor: Text /* The display name of the instance */
id: Text /* Id of the instance */
}]
Recipients_Aggregate
[{
id: Text /* Id of the instance */
}]
SupportTargets_Aggregate
[{
id: Text /* Id of the instance */
}]
Input
| Name | Type | Description |
| Builder_Id | String | wid / id / reference id |
| Category_Id | String | wid / id / reference id |
| Descriptor | String | The display name of the instance |
| DiscoverableBuilder_Id | String | wid / id / reference id |
| Id | String | Id of the instance |
| IncludePreviousRecipients | Bool | Include recipients who've already received this journey builder. |
| Journeys_Aggregate | String | Journeys can be created, configured, personalized and distributed to recipients such as workers or students. |
| Recipients_Aggregate | String | Journey recipients are people who receive a journey, such as workers or students. |
| RelatedRole_Id | String | wid / id / reference id |
| SupportTargets_Aggregate | String | The workers whom the distributed journeys support. |
Result Set Columns
| Name | Type | Description |
| Builder_Descriptor | String | The display name of the instance |
| Builder_Href | String | A link to the instance |
| Builder_Id | String | wid / id / reference id |
| Category_Descriptor | String | The display name of the instance |
| Category_Href | String | A link to the instance |
| Category_Id | String | wid / id / reference id |
| Descriptor | String | The display name of the instance |
| DiscoverableBuilder_Descriptor | String | The display name of the instance |
| DiscoverableBuilder_Href | String | A link to the instance |
| DiscoverableBuilder_Id | String | wid / id / reference id |
| Id | String | Id of the instance |
| IncludePreviousRecipients | Bool | Include recipients who've already received this journey builder. |
| Journeys_Aggregate | String | Journeys can be created, configured, personalized and distributed to recipients such as workers or students. |
| Recipients_Aggregate | String | Journey recipients are people who receive a journey, such as workers or students. |
| RelatedRole_Descriptor | String | The display name of the instance |
| RelatedRole_Href | String | A link to the instance |
| RelatedRole_Id | String | wid / id / reference id |
| SupportTargets_Aggregate | String | The workers whom the distributed journeys support. |