Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

AttributeRequired?CardinalityContentValuesDescription

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.

callbackHeaderN1JSON 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

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

Y

1

Integer


A tolerance window (in secs) for expecting solutions.

PlacementInfo Object

AttributeRequired?CardinalityContentValuesDescription

requestParameters

Y

1

JSON BLOB


A

service ordering information

JSON object conaining service and customer-specific data. A client or service designer is required to specify the location of information in the JSON blob through optimization query policies.

placementDemands

Y

1..N

List of PlacementDemand Object


The resource information for a placement service.

PlacementDemand Object

AttributeRequired?CardinalityContentValuesDescription

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

Candidates Object


The existing placement information of a resource.

excludedCandidates

N

1

Candidates Object


Candidates that need to be excluded from solutions.

requiredCandidates

N

1

Candidates Object


Candidates that must be included in solutions.

...

AttributeRequired?CardinalityContentValuesDescription

licenseDemands

Y

1..N

List of LicenseDemands Object


A list of resources for license selection.

...

AttributeRequired?CardinalityContentValuesDescription

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

...