Content-Type

application/json

Operation Type

POST

URI

https://{host}:{port}/api/oof/mdons/route/v1

Accept

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

Authorization

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-Length

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

Content-Type

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

routeInfo

Y

1

Route Info Object

The content of the Route Info Object

requestInfo

Y

1

requestInfo Object

The content of the requestInfo Object

routeRequest

Y

1

Route Request Object

The content of the Route request object

srcDetails

Y

1

node Object

Src node details

dstDetails

Y

1

node Object

Dst node details

serviceRate

Y

1

String

Service rate

interfaceId

Y

1

String

Interface identifier

nodeId

Y

1

String

Node identifier

controllerId

Y

1

String

Controller identifier

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.

callbackHeader

N

1

JSON blob

The header information a client expecting in a async callback.

sourceId

Y

1

String

The unique ID of a client making an optimization call.

requestType

N

1

String

Type of request

numSolutions

N

1

Integer

number of solutions expected

optimizers

N

1...N

List of String

Optimizer to use

timeout

N

1

Integer

A tolerance window (in secs) for expecting solutions. Default is 600 secs.

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 a requestStatus is failed.

requestStatus

Y

1

String

The status of a request.

solutions

Y

Solution object

Route Solution

routeInfo

Y

1

Response Route info object

serviceRoute

Y

0...N

List of controllers object

linkList

Y

0...N

List of String

srcInterfaceId

Y

1

String

dstInterfaceId

Y

1

String

controllerId

Y

1

String