approveScheduleRequest

Adds an accept/reject approval status to the schedule request identified by scheduleId

/{apiVersion}/schedules/{scheduleId}/approvals

Parameters

Path parameters

Body parameters

Responses

Status: 200 - OK

...

Status: 500 - Unexpected Runtime error

...

createScheduleRequest

Creates a schedule request for scheduleId

/{apiVersion}/schedules/{scheduleId}

Parameters

Path parameters

Body parameters

\[\]

Responses

Status: 202 - Schedule request accepted for optimization.

...

Status: 500 - Unexpected Runtime error

...

deleteScheduleRequest

Cancels the schedule request for scheduleId
/{apiVersion}/schedules/{scheduleId}

Parameters

Path parameters

Responses

Status: 204 - Delete successful

...

Status: 500 - Unexpected Runtime error

...

getScheduleRequestInfo

Retrieve the schedule request for scheduleId
/{apiVersion}/schedules/{scheduleId}

Parameters

Path parameters

Responses

Status: 200 - OK

Schema

 {

createDateTime:

 string

Date/time schedule was created.

optimizerDateTime:

string

optimizerMessage:

...

deleteDateTime:

string

domainData:

[

 {

Domain specific data represented as name/value pairs

name:

string

value:

string

}

]

scheduleApprovals:

[

 {

Details of a schedule approval/rejection.

approvalDateTime:

 string

Date/time schedule time slot was accepted/rejected.

status:

 string

Approval status.

Enum: Accepted, Rejected

userId:

 string

ATTUID of the user accepting/rejecting the time slot.

}

]

groups:

[

 {

Scheduling critirea for a group of VNFs

finishTime:

 string

Date/time by which all of the workflows should be completed.

groupId:

 string

Name of the group of VNFs to be scheduled

lastInstanceStartTime:

 string

The latest date/time by which a workflow is to be started.

startTime:

 string

The date/time when workflows are to be started.

additionalDurationInSecs:

 integer (int32)

Time added to the workflow interval to allow for rollback in case of failure.

concurrencyLimit:

 integer (int32)

The maximum number of workflows that should be started simultaneiously.

normalDurationInSecs:

 integer (int32)

Expected duration of a successful workflow execution.

policyId:

 string

The name of the schedule optimization policy used by the change management schedule optimizer.

changeManagementSchedules:

[

The list of VNF workflows scheduled.

 {

VNF details for Change Management Schedule

tmChangeId:

 string

TM Change Id

tmStatus:

 string

TM ticket status

Enum: ,Closed

tmApprovalStatus:

 string

TM ticket approval status

Enum: ,Approved

finishTime:

 string

Anticipated time of completion based upon start time and duration

startTime:

 string

Start time of this VNF workflow assigned by Scheduler based upon the group start time returned by the optimizer and concurrency.

status:

 string

Status of the VNF.

Enum:See CMSStatusEnum

vnfName:

 string

Name of the VNF.

dispatchTime:

 string

Actual time the VNF workflow was dispatched.

executionCompletedTime:

 string

Actual time the VNF workflow execution was completed as reported by MSO.

msoRequestId:

 string

MSO Request ID of the workflow returned at dispatch time.

msoStatus:

 string

Final MSO status.

Enum:COMPLETED, FAILED

msoMessage:

 string

MSO final status message.

statusMessage:

 string

Scheduler status message.

msoTime:

 string

Time of last poll for MSO status.

}

]

}

]

}

Status: 404 - No record found

Status: 500 - Unexpected Runtime error

...

healthCheck

Returns health status of server.
/{apiVersion}/health

Parameters

Path parameters

Query parameters

array\[Boolean\]

Responses

Status: 200 - OK

...

searchScheduleRequestDetails

Returns a list of Schedule request details based upon the filter criteria.
/{apiVersion}/schedules/scheduleDetails

Parameters

Path parameters

Query parameters

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

_Creation date and time (<low date>\[,<hi date>\])_

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

Responses

Status: 200 - OK

...

Status: 500 - Unexpected Runtime error

...

searchScheduleRequests

Returns a list of Scheduler Requests based upon the filter criteria.
/{apiVersion}/schedules

Parameters

Path parameters

Query parameters

array\[String\]

array\[String\]

array\[String\]

array\[String\]

array\[String\]

_Creation date and time (<low date>\[,<hi date>\])_

array\[String\]

array\[String\]

Responses

Status: 200 - OK

...

Status: 500 - Unexpected Runtime error

...

sniroCallback

Processes optimizer results callback to a Pending Optimization schedule.
/{apiVersion}/optimizerCallback

Parameters

Path parameters

Body parameters

Responses

Status: 200 - OK

...