View the Change Management (CM) Schedule Optimizer API documentation in the interactive swagger UI
Optimizer Request Example
{
"requestId": "3e828de1-c6b9-4782-b028-e2a98b0cce72",
"changeWindows": [
{
"startTime": "2019-03-08T21:39:57.818Z",
"endTime": "2019-03-12T21:39:57.819Z"
}
],
"commonData":
[{
"name": "requestType",
"value": "VNF Config Update"
}
],
"elements": [{
"elementId": "nodeid1",
"elementData": [{
"name": "ticketManagementId",
"value": "33333-333a-dsfa-dsfadsfadsfdsfdasfdaf"
}, {
"name": "id",
"value": "33333333adsfadsfadsfadsfdsfdasfdaf"
}
]
}
],
"policies": [
{
"policyName": "vertical",
"policyDescription": "Vertical topology",
"policyModifiers": []
},
{
"policyName": "localMaintenanceWindow",
"policyDescription": "Include only local maintenace window - default midnight to 6AM",
"policyModifiers": []
}
]
}
The message is a representative of an Scheduler Optimizer Request that is derived from the Create Schedule request. The Schedule Optimizer will use the following APIs to retrieve the data necessary to invoke the Schedule Optimizer Engine:
- Policy API -
- Topology Service
- Ticket Management Service
Note that the commonData and elementData structures provide a means for passing carrier specific information to the Topology and Ticket Management interfaces which are necessarily carrier specific implementations.
The policies provides a means for client to provide policy names along with policy attribute modifiers (details TBD). The list of supported policies is available vie the GET policies API call.
Optimizer Response Example
{
"requestId": "3e828de1-c6b9-4782-b028-e2a98b0cce72",
"status": "COMPLETED",
"schedules": [
{
"scheduledElements": [
{
"elementId": "nodeid1",
"groupId": "",
"scheduleType": "ConcurrencyConstraint",
"startTime": "2019-03-08T21:39:57.844Z",
"endTime": "2019-03-08T22:39:57.844Z",
"durationSeconds": 3600
}
],
"unScheduledElements": []
}
]
}
The optimizer response is designed to return one or more schedules. Each schedule will contain a list of the elements successfully scheduled (scheduledElements) as well as a list of elements that could not be scheduled.(unScheduledElements). A best effort will be made to provide a reason for the inability to schedule the unscheduled elements.
