
Create a scheduled event for one or a series of future orders. Also a latest order is created and set to APPROVAL or SCHEDULED status
This call has no restrictions.
All parameters are required unless otherwise stated.
Field | Description | Type | Notes |
<scheduled_event_create> | |||
<scheduleInfo> | |||
<hourOfDay> | Integer | ||
<minuteOfHour> | Integer | ||
<durationLength> | Integer | ||
<cycleType> | |||
<cycleFrequency> | Integer | ||
<sectionsInCycle> | |||
<section> | String |
0-* Elements |
|
</sectionsInCycle> | |||
<startDate> | String | ||
<reoccurrence> | Integer | ||
<endDate> | String | ||
<dateExceptions> | |||
<dateException> | String |
0-* Elements |
|
</dateExceptions> | |||
</scheduleInfo> | |||
<orderCreateParam> | |||
<tenantId> | URI | ||
<scheduledEventId> | URI | ||
<scheduledTime> | String | ||
<executionWindow> | URI | ||
<additionalScheduleInfo> | String | ||
<parameters> |
0-* Elements |
||
<friendly_value> | String | ||
<label> | String | ||
<value> | String | ||
<friendly_label> | String | ||
</parameters> | |||
<catalog_service> | URI | ||
</orderCreateParam> | |||
</scheduled_event_create> |
ScheduledEventRestRep
Field | Description | Type | Notes |
<scheduled_event> | |||
<scheduleInfo> | |||
<hourOfDay> | Integer | ||
<minuteOfHour> | Integer | ||
<durationLength> | Integer | ||
<cycleType> | |||
<cycleFrequency> | Integer | ||
<sectionsInCycle> | |||
<section> | String |
0-* Elements |
|
</sectionsInCycle> | |||
<startDate> | String | ||
<reoccurrence> | Integer | ||
<endDate> | String | ||
<dateExceptions> | |||
<dateException> | String |
0-* Elements |
|
</dateExceptions> | |||
</scheduleInfo> | |||
<latestOrderId> | URI | ||
<execution_window> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</execution_window> | |||
<catalog_service> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</catalog_service> | |||
<event_status> | String | ||
<tenant> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</tenant> | |||
<orderCreateParam> | |||
<tenantId> | URI | ||
<scheduledEventId> | URI | ||
<scheduledTime> | String | ||
<executionWindow> | URI | ||
<additionalScheduleInfo> | String | ||
<parameters> |
0-* Elements |
||
<friendly_value> | String | ||
<label> | String | ||
<value> | String | ||
<friendly_label> | String | ||
</parameters> | |||
<catalog_service> | URI | ||
</orderCreateParam> | |||
<name> | The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. | String | |
<id> | An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. | URI | |
<link> | A hyperlink to the details for this resource | ||
<creation_time> | A timestamp that shows when this resource was created in ViPR | DateTime | |
<tags> | Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search. | ||
<tag> | String |
0-* Elements |
|
</tags> | |||
<inactive> | Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. | Boolean | |
<global> | Boolean | ||
<remote> | Boolean | ||
<vdc> | |||
<id> | ViPR ID of the related object | URI | |
<link> | A hyperlink to the related object | ||
</vdc> | |||
<internal> | Whether or not the resource is an internal resource. | Boolean | |
</scheduled_event> |