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

placement

A list of optimization services.

timeout

YN

1

Integer

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

requestParameters

C

1

JSON BLOB

A

JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.

placementDemands

Y

1..N

List of PlacementDemand Object

The resource information for a placement service.

resourceModuleName

Y

1

String

A resource name as defined in a service model.

serviceResourceId

Y

1

String

A unique resource Id with a local scope between client and OOF.

tenantId

N

1

String

A tenant Id as defined in the ordering system.

resourceModelInfo

Y

1

ModelMetaData Object

Resource model information as defined in SDC.

existingCandidates

N

1..N

List of Candidates ObjectObjects

The existing placement information of a resource.

excludedCandidates

N

1..N

List of Candidates ObjectObjects

Candidates that need to be excluded from solutions.

requiredCandidates

N

1..N

List of Candidates ObjectObjects

Candidates that must be included in solutions.

globalSubscriberId

Y

1

String

An ID of a subscriber.

subscriberName

Y

1.

String

The name of a subscriber. If the name is not known, the value must be 'unknown'.

modelInvariantId

Y

A model name as defined in a service model.

modelType

N

1

String

A model type invariant Id as defined in a service model.

modelVersionmodelVersionId

NY

1

String

A unique model version Id as defined in a service model.

modelCustomizationNamemodelName

N

1

String

A model customization name as defined in a service model.

modelType

N

1

String

A model type as defined in a service model.

modelVersion

N

1

String

A model version as defined in a service model.

modelCustomizationName

N

1

String

A model customization name as defined in a service model.

identifierType

Y

1

String

service_instance_id, vnf_name, cloud_region_idserviceInstanceId, vnfName, cloudRegionId, vimId

The type of a candidate.

identifiers

Y

1..N

List of Strings

A list of identifiers.

serviceInstanceId

Y

1

String

A service instance id associated with a request.

serviceModelInfomodelInfo

Y

1

ModelMetaData Object

A list of identifiers.

licenseDemands

Y

1..N

List of LicenseDemands Object

A list of resources for license selection.

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.

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 failed.

requestStatus

Y

1

String

completed, failed, pending

The status of a request.

solutions

Y

1

Solution Object

Solutions related to a request.

placementSolutions

Y

1

..N

List of ComprehensiveSolution Object

A list of placement solutions.

licenseSolutions

Y

1

..N

List of LicenseSolution Object

A list of license solutions

Y

1.

.N

List of

PlacementSolution Object

A list of placement solutions.

resourceModuleName

Y

1

String

resourceModuleName

Y

1

String

A resource name The name of a resource as defined in a the service model.

serviceResourceId

Y

1

String

A resource Id as defined in a service model.

entitlementPoolUUIDsolution

Y

1..N

List of String

Candidates Object

The placement solution

assignmentInfo

N

A list of entitlementPoolUUIDs.

licenseKeyGroupUUID

Y

1..N

List of String

A list of licenseKeyGroupUUID.

AssignmentInfo object

Additional information related to a candidate.

key

Y

1

String

An attribute name.

value

Y

1

String

An attribute value.

resourceModuleName

Y

1

String

A resource name as defined in a service.

serviceResourceId

Y

1

String

A resource Id as defined in a service.

entitlementPoolUUID

Y

1..N

List of String

A list of entitlementPoolUUIDs.

licenseKeyGroupUUID

Y

1..N

List of String

A list of licenseKeyGroupUUID.

entitlementPoolInvariantUUID

Y

1..N

List of String

A list of entitlementPoolInvariantUUID .

licenseKeyGroupInvariantUUID

Y

1..N

List of String

A list of licenseKeyGroupInvariantUUID .

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.