Versions Compared

Old Version 8

changes.mady.by.user dr_patel_an

Saved on

compared with

New Version 9

changes.mady.by.user dr_patel_an

Saved on

Key

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

...

Header NameRequired?Description

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.

Request Body

AttributeQualifierRequired?CardinalityContentValuesDescription

requestInfo

MY

1

RequestInfo Object


The content of the RequestInfo object.

placementInfo

MY

1

PlacementInfo Object


The Content of the PlacementInfo object.

licenseInfo

MN

1

LicenseInfo Object


The Content of the LicenseInfo object.

serviceInfo

MY

1

ServiceInfo Object


The Content of the ServiceInfo object.

RequestInfo Object

AttributeQualifierRequired?CardinalityContentValuesDescription

transactionId

MY

1

UUID/String


A unique ID to track an ONAP transaction.

requestId

MY

1

UUID/String


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

callbackUrl

MY

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

MY

1

String


The unique ID of a client making an optimization call.

requestType

MY

1

String

create, update, delete

The type of a request

numSolutions

ON

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

MY

1..N

List of Strings

placement

A list of optimization services.

timeout

MY

1

Integer


A tolerance window (in min) for expecting solutions.

PlacementInfo Object

AttributeQualifierRequired?CardinalityContentValuesDescription

requestParameters

MY

1

JSON BLOB


A service ordering information.

placementDemands

MY

1..N

List of PlacementDemand Object


The resource information for a placement service.

PlacementDemand Object

AttributeQualifierRequired?CardinalityContentValuesDescription

resourceModuleName

MY

1

String


A resource name as defined in a service model.

serviceResourceId

MY

1

String


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

tenantId

ON

1

String


A tenant Id as defined in the ordering system.

resourceModelInfo

MY

1

ModelMetaData Object


Resource model information as defined in SDC.

existingCandidates

ON

1

Candidates Object


The existing placement information of a resource.

excludedCandidates

ON

1

Candidates Object


Candidates that need to be excluded from solutions.

requiredCandidates

ON

1

Candidates Object


Candidates that must be included in solutions.

ModelMetaData Object

AttributeQualifierRequired?CardinalityContentValuesDescription

modelInvariantId

MY

1

String


A model invariant Id as defined in a service model.

modelVersionId

MY

1

String


A unique model Id as defined in a service model.

modelName

ON

1

String


A model name as defined in a service model.

modelType

ON

1

String


A model type as defined in a service model.

modelVersion

ON

1

String


A model version as defined in a service model.

modelCustomizationName

ON

1

String


A model customization name as defined in a service model.

Candidates Object

AttributeQualifierRequired?CardinalityContentValuesDescription

identifierType

MY

1

String

service_instance_id, vnf_name, cloud_region_id

The type of a candidate.

identifiers

MY

1..N

List of Strings


A list of identifiers.

ServiceInfo Object

AttributeQualifierRequired?CardinalityContentValuesDescription

serviceInstanceId

MY

1

String


A service instance id associated with a request.

serviceModelInfo

MY

1

ModelMetaData Object


A list of identifiers.

LicenseInfo Object

AttributeQualifierRequired?CardinalityContentValuesDescription

licenseDemands

MY

1

List of LicenseDemands Object


A list of resources for license selection.

LicenseDemands Object

AttributeQualifierRequired?CardinalityContentValuesDescription

resourceModuleName

MY

1

String


A resource name as defined in a service model.

serviceResourceId

MY

1

String


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

resourceModelInfo

MY

1

ModelMetaData Object


Resource model information as defined in a service model.

existingLicenses

ON

1

LicenseModel Object


Existing license information assigned to a resource.

LicenseModel Object

AttributeQualifierRequired?CardinalityContentValuesDescription

entitlementPoolUUID

MY

1..N

List of Strings


Entitlement pool UUIDs associated with a resource.

licenseKeyGroupUUID

MY

1..N

List of Strings


License key groups associated with a resource

Synchronous Response Body

AttributeQualifierRequired?CardinalityContentValuesDescription

requestId

MY

1

UUID/String


A unique Id for an ONAP transaction.

transactionId

MY

1

UUID/String


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

statusMessage

ON

1

String


Reasoning if a requestStatus is failure.

requestStatus

MY

1

String

success, failure

The status of a request.

Asynchronous Response Body

AttributeQualifierRequired?CardinalityContentValuesDescription

requestId

MY

1

UUID/String


A unique Id for an ONAP transaction.

transactionId

MY

1

UUID/String


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

statusMessage

ON

1

String


Reasoning if requestStatus is failure.

requestStatus

MY

1

String

success, failure, pending

The status of a request.

solutions

MY

1

Solution Object


Solutions related to a request.

Solution Object

AttributeQualifierRequired?CardinalityContentValuesDescription

placementSolutions

MY

1..N

List of ComprehensiveSolution Object


A list of placement solutions.

licenseSolutions

MY

1

List of LicenseSolution Object


A list of license solutions

ComprehensiveSolution Object

AttributeQualifierRequired?CardinalityContentValuesDescription
-

MY

1..N

List of PlacementSolution Object


A list of placement solutions.

PlacementSolution Object

AttributeQualifierRequired?CardinalityContentValuesDescription

resourceModuleName

MY

1

String


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

serviceResourceId

MY

1

String


A resource Id as defined in a service model.

identifierType

MY

1

String

service_instance_id, cloud_region_id

The type of a candidate.

identifier

MY

1

String


The id of a candidate.

assignmentInfo

ON

1..N

List of AssignmentInfo object


Additional information related to a candidate.

AssignmentInfo Object

AttributeQualifierRequired?CardinalityContentValuesDescription

key

MY

1

String


An attribute name.

value

MY

1

String


An attribute value.

LicenseSolutions Object

AttributeQualifierRequired?CardinalityContentValuesDescription

resourceModuleName

MY

1

String


A resource name as defined in a service.

serviceResourceId

MY

1

String


A resource Id as defined in a service.

entitlementPoolUUID

MY

1..N

List of String


A list of entitlementPoolUUIDs.

licenseKeyGroupUUID

MY

1..N

List of String


A list of licenseKeyGroupUUID.

entitlementPoolInvariantUUID

MY

1..N

List of String


A list of entitlementPoolInvariantUUID .

licenseKeyGroupInvariantUUID

MY

1..N

List of String


A list of licenseKeyGroupInvariantUUID .

...