Accept

N

Determines the format of the body of the response. Valid value is “application/json”

Authorization

Y

Supplies Basic Authentication credentials for the request. If the Authorization header is missing, then an HTTP 400 Invalid Request response is returned. If the string supplied is invalid, then an HTTP 401 Unauthorized response is returned.

Content-Type

Y

Determines the format of the request content. Only application/json is supported.

Content-Length

N

Number of bytes in the body of the request. Note that content length is limited to 1 MB.

requestInfo

Y

1

RequestInfo Object

The content of the RequestInfo object.

schedulingInfo

Y

1

SchedulingInfo Object

The Content of the SchedulingInfo object.

transactionId

Y

1

UUID/String

A unique ID to track an ONAP transaction.

requestId

Y

1

UUID/String

A unique ID to track multiple requests associated with a transaction.

callbackUrl

Y

1

URL

The end point of a callback service where recommendations are posted.

sourceId

Y

1

String

The unique ID of a client making an optimization call.

requestType

Y

1

String

create, update, delete

The type of a request

numSolutions

N

1

Integer

Expected number of solutions. numSolution can also be specified using an optimization query policies, where the default configured value is 1. The value from a request gets higher precedence over the value defined in a policy.

optimizers

Y

1..N

List of Strings

scheduling

A list of optimization services.

timeout

Y

1

Integer

A tolerance window (in secs) for expecting solutions.

startTime

Y

1

String

Schedule start time in the ISO format from which upgrades can be started.

endTime

Y

1

String

Schedule end time in the ISO format by which upgrades must be completed.

normalDurationInSecs

Normal upgrade duration in Sec.

additionalDurationInSecs

Additional duration in Sec for backout.

concurrencyLimit

Number of upgrades at the same time.

changeElements

nodeId

Y

1

String

The ID of a node to be upgraded.

groupId

N

1

String

The group ID of a node.

requestId

Y

1

UUID/String

A unique Id for an ONAP transaction.

transactionId

Y

1

UUID/String

A unique ID to track multiple requests associated with a transaction.

statusMessage

N

1

String

Reasoning if requestStatus is failure.

requestStatus

Y

1

String

success, failure, pending

The status of a request.

solutions

Y

1

Solution Object

Solutions related to a request.

groupId

Y

1

String

The group ID of nodes.

startTime

Y

1

String

The start time of a group to be upgraded in the ISO format.

The end time of a group to be upgraded in the ISO format.

latestInstanceStartTime

Latest time when an instance of this group can be started in the ISO format.

nodeId

The node Ids associated with a group Id.

201

Created

An optimization solution is found.

202

Accepted

An optimization request is accepted.

400

Bad request

Bad request.

401

Unauthorized

Request body is not compliant with the API definition.

404

Not found

The server cannot find the requested URI.

405

Method not found

The requested method is not supported by a server.

500

Internal server error

The server encountered an internal server error or timed out.