NOTE

This page is only for understanding. Please refer swagger for a comprehensive documentation.

swagger link : https://gerrit.onap.org/r/gitweb?p=optf/osdf.git;a=blob;f=docs/sections/swaggerdoc/oof-osdf-has-api.json;h=7289ef4a24de6f6ad728d91554dc7b0394681b27;hb=HEAD

SAMPLE API

SAMPLE NSI API ( preferReuse : true )

{
   "serviceProfile":{
      "blob":"content"
   },
   "requestInfo":{
      "transactionId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "requestId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "callbackUrl":"myDomain.com/myCallback",
      "callbackHeader":{
         "blob":"content"
      },
      "sourceId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "timeout":5,
      "numSolutions":1
   },
   "NSTInfo":{
      "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa1",
      "invariantUUID":"7ua85f64-5717-4562-b3fc-2c963f66afa6",
      "name":"embb-nst"
   },
   "NSSTInfo":[
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa2",
         "invariantUUID":"2fa85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-an-nf"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa3",
         "invariantUUID":"4fa85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-cn"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa4",
         "invariantUUID":"5ta85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-fh"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa5",
         "invariantUUID":"6ya85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-mh"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa7",
         "invariantUUID":"7ua85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-bh"
      }
   ],
   "preferReuse":true,
   "subnetCapabilities":[
      {
         "domainType":"AN-NF",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"CN",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-FH",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-MH",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-BH",
         "capabilityDetails":{
            "blob":"content"
         }
      }
   ]
}

{
  "transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "requestId": "f450f1ee-6c54-4b01-90e6-d701748f0851",
  "requestStatus": "completed",
  "solutions": [
    {
      "existingNSI": true,
      "sharedNSISolution": {
        "invariantUUID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "UUID": "e4t85f64-5717-4562-b3fc-2c963f66afa6",
        "NSIName": "embb-ser",
        "NSIId": "t5y85f64-5717-4562-b3fc-2c963f66afa6",
        "matchLevel": {
		    "key":"value"
		}
      }
    }
  ]
}

SAMPLE NSI API ( preferReuse : false )

{
   "serviceProfile":{
      "blob":"content"
   },
   "requestInfo":{
      "transactionId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "requestId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "callbackUrl":"myDomain.com/myCallback",
      "callbackHeader":{
         "blob":"content"
      },
      "sourceId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
      "timeout":5,
      "numSolutions":1
   },
   "NSTInfo":{
      "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa1",
      "invariantUUID":"7ua85f64-5717-4562-b3fc-2c963f66afa6",
      "name":"embb-nst"
   },
   "NSSTInfo":[
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa2",
         "invariantUUID":"2fa85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-an-nf"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa3",
         "invariantUUID":"4fa85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-cn"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa4",
         "invariantUUID":"5ta85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-fh"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa5",
         "invariantUUID":"6ya85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-mh"
      },
      {
         "UUID":"3fa85f64-5717-4562-b3fc-2c963f66afa7",
         "invariantUUID":"7ua85f64-5717-4562-b3fc-2c963f66afa6",
         "name":"embb-tn-bh"
      }
   ],
   "preferReuse":false,
   "subnetCapabilities":[
      {
         "domainType":"AN-NF",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"CN",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-FH",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-MH",
         "capabilityDetails":{
            "blob":"content"
         }
      },
      {
         "domainType":"TN-BH",
         "capabilityDetails":{
            "blob":"content"
         }
      }
   ]
}

{
  "transactionId": "s4r0f1ee-6c54-4b01-90e6-d701748f0851",
  "requestId": "r500f1ee-6c54-4b01-90e6-d701748f0851",
  "requestStatus": "completed",
  "solutions": [
    {
      "existingNSI": false,
      "newNSISolution": {
        "sliceProfiles": [
	      	{
         		"domainType":"AN-NF"     		
      		},
      		{
         		"domainType":"CN"
     	 	},
      		{
         		"domainType":"TN-FH"       
      		},
      		{
         		"domainType":"TN-MH"    
      		},
      		{
         		"domainType":"TN-BH" 
      		}
        ],
        "matchLevel": {
            "blob": "content"
          }
      }
    }
  ]
}

SAMPLE NSSI API 

{
  "sliceProfile": {
    "blob": "content"
  },
  "requestInfo": {
    "transactionId": "t670f1ee-6c54-4b01-90e6-d701748f0851",
    "requestId": "r450f1ee-6c54-4b01-90e6-d701748f0851",
    "callbackUrl": "myDomain.com/myCallback",
    "callbackHeader": {
      "blob": "content"
    },
    "sourceId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "timeout": 5,
    "numSolutions": 1,
    "addtnlArgs": {
      "blob": "content"
    }
  },
  "NSSTInfo": {
    "UUID": "y7785f64-5717-4562-b3fc-2c963f66afa6",
    "invariantUUID": "9fh85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "embb-cn"
  }
}

{
  "transactionId": "c440f1ee-6c54-4b01-90e6-d701748f0851",
  "requestId": "88u0f1ee-6c54-4b01-90e6-d701748f0851",
  "requestStatus": "completed",
  "solutions": [
    {
      "invariantUUID": "y7685f64-5717-4562-b3fc-2c963f66afa6",
      "UUID": "8u785f64-5717-4562-b3fc-2c963f66afa6",
      "NSSIName": "embb-core-ser",
      "NSSIId": "f4485f64-5717-4562-b3fc-2c963f66afa6",
      "matchLevel": {
			"blob":"content"
	   }
    }
  ]
}

Sample NxI API(NSI Termination)

{
  "requestInfo": {
    "transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "callbackUrl": "http://0.0.0.0:9000/osdfCallback/",
    "sourceId": "SO",
    "timeout": 5,
    "addtnlArgs": {
      "serviceProfileId":"cdad9f49-4201-4e3a-aac1-b0f27902c299"
    }
  },
  "type":"NSI",
  "NxIId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
  "UUID":"d290f1ee-6c54-4b01-90e6-d701748f0851",
  "invariantUUID":"d290f1ee-6c54-4b01-90e6-d701748f0851"

}

{
  "requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "requestStatus": "success",
  "terminateResponse": true,
  "reason": ""
}

Sample NxI API(NSSI Termination)

{
  "requestInfo": {
    "transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "callbackUrl": "http://0.0.0.0:9000/osdfCallback/",
    "sourceId": "SO",
    "timeout": 5,
    "addtnlArgs": {
      "serviceInstanceId":"4115d3c8-dd59-45d6-b09d-e756dee9b518"
    }
  },
  "type":"NSSI",
  "NxIId":"d290f1ee-6c54-4b01-90e6-d701748f0851",
  "UUID":"d290f1ee-6c54-4b01-90e6-d701748f0851",
  "invariantUUID":"d290f1ee-6c54-4b01-90e6-d701748f0851"

}

{
  "requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "requestStatus": "success",
  "terminateResponse": true,
  "reason": ""
}

1. Select NST API

1.1. Request Header

1.2. Request Body

RequestInfo Object

1.3. Synchronous Response Body

1.4. Asynchronous Response Header

NST Selection

1. Select NST API

...

Interface Definition

...

Description

...

Content-Type

...

application/json

...

Operation Type

...

POST

...

URI

...

https://{host}:{port}/api/oof/v1/selection/nst

1.1. Request Header

1.2. Request Body

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

serviceProfile Object

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

1.5. Asynchronous Response Body

...

serviceProfileParameters

...

Y

...

1

...

JSON BLOB

...

A JSON object containing service profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.

...

Attribute	Required?	Cardinality	Content	Values	Description

transactionId

requestId

Y

1

UUID/String

A unique

ID to track

Id for 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

transactionId

Y

1

JSON blobThe header information a client expecting in a async callback.

UUID/String		A unique ID to track multiple requests associated with a transaction.
statusMessage	N

sourceId

Y

1

String

The unique ID of a client making an optimization call.

numSolutions

	Reasoning if requestStatus is failed.
requestStatus	Y	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.

timeout

N

1

Integer

...

String	completed, failed, pending	The status of a request.
solutions	Y	1	List of NSTSolution Object		A list of matching NSTs

NSTSolution Object

Attribute	Required?	Cardinality	Content	Values	Description

requestId

invariantUUID

Y

1

UUID/String

A unique Id for an ONAP transaction.

transactionId

	Invariant UUID
UUID	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

accepted, failed

The status of a request.

1.4. Asynchronous Response Header

2. Select NSI API

2.1. Request Header

...

2.2. Request Body

...

subnetCapability Object

...

nstInfo Object

nsstInfo Object

2. Select NSI API

...

Interface Definition

...

Description

...

Content-Type

...

application/json

...

Operation Type

...

POST

...

URI

...

https://{host}:{port}/api/oof/v1/selection/nsi

2.1. Request Header

...

Header

...

Required

...

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

...

N

...

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

...

Content-Type

...

Y

...

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

RequestInfo Object

2.3. Synchronous Response Body

2.2. Request Body

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

Attribute	Required?	Cardinality	Content	Values	Description

serviceProfileParameters

requestId

Y

1

JSON BLOB

A JSON object containing service profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.

nstInfo Object

RequestInfo Object

2.4. Asynchronous Response Header

...

2.5. Asynchronous Response Body

Solution Object

2.4. Asynchronous Response Header

...

Header Name

...

Required?

...

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.

sharedNSISolution Object

newNSISolution Object

...

Attribute	Required?	Cardinality	Content	Values	Description

requestId

SliceProfiles

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

..N	List of SliceProfile objects		List of JSON objects containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs. Assumption: Slice profile contains sub-net type. If not, this should also be included.
matchLevel	Y	1

String

completed, failed, pending

The status of a request.

solutions

Y

1

Solution Object

Solutions related to a request.

Solution Object

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

3. Select NSSI API

3.1. Request Header

3.2. Request Body

...

sharedNSIsolutionList

...

N

...

1..N

...

List of shareNSISolution Objects

...

A list of matching NSIs from existing NSIs

...

Attribute	Required?	Cardinality	Content	Values	Description

invariantUUIDY1UUID/StringInvariant UUID

UUID

Y

1

UUID/String

UUID of NSI

NSIName

sliceProfile	Y	1

StringName of NSINSIId

JSON Blob		A JSON object containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.
NSSTInfo	Y	1

StringId of NSImatchLevel

nsstInfo Object		The content of nsstInfo Object
requestInfo	Y	1

JSON BLOBDetails of match of requirements in service profile, and recommendation rank (future enhancement, based on telemetry, capacity, etc.)

...

requestInfo Object

The content of the requestInfo Object

nsstInfo Object

NSSISolution Object

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

sliceProfile

...

Y

...

1

...

JSON BLOB

...

A JSON object containing slice profile parameters. The contents are based on 3GPP TS 23.541 Release 16 contents, and will be in the form of attribute value pairs.

RequestInfo Object

3.3. Synchronous Response Body

...

Attribute	Required?	Cardinality	Content	Values	Description

UUID

requestId

Y

1

UUID/String

UUID of NSST

invariantUUID

	A unique Id for an ONAP transaction.
transactionId	Y	1	UUID/String

Invariant UUIDNSSTName

	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

Name of NSST

NSSI Object

3.4. Asynchronous Response Header

3. Select NSSI API

...

Interface Definition

...

Description

...

Content-Type

...

application/json

...

Operation Type

...

POST

...

URI

...

https://{host}:{port}/api/oof/v1/selection/nssi

3.1. Request Header

...

Header

...

Required

...

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

...

N

...

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

...

Content-Type

...

Y

...

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

3.5. Asynchronous Response Body

sharedNSSISolution Object

...

Attribute	Required?	Cardinality	Content	Values	Description

sliceProfile

invariantUUID

Y

1

sliceProfile ObjectThe content of the sliceProfile ObjectnsstInfo

UUID/String		Invariant UUID
UUID	Y	1

nsstInfo ObjectThe content of nsstInfo ObjectrequestInfo

UUID/String		UUID of NSSI
NSSIName	Y	1

requestInfo Object

String

The content of the requestInfo Object

sliceProfile Object

nsstInfo Object

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

UUID

...

Y

...

1

...

UUID/String

...

UUID of NSST

...

RequestInfo Object

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

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.

...

timeout

...

N

...

1

...

Integer

...

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

3.3. Synchronous Response Body

...

Attribute

...

Required?

...

Cardinality

...

Content

...

Values

...

Description

...

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

...

accepted, failed

...

The status of a request.

3.4. Asynchronous Response Header

...

Header Name

...

Required?

...

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.

4. Terminate NxI (x=S, SS)

4.1. Request Header

4.2. Request Body

RequestInfo Object

...

Attribute	Required?	Cardinality	Content	Values	Description
transactionId	Y	1	UUID/String		A unique ID to track an ONAP transaction.
requestId	Y	1	UUID/String		A unique

Id for an ONAP transaction.

ID to track multiple requests associated with a transaction.
callbackUrl	N	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

transactionId

Y

1

UUID/

String

A

The unique ID

to track multiple requests associated with a transaction.statusMessage

of a client making an optimization call.
timeout	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.

Solution Object

4.3. Synchronous Response Body

NSSI Object

...

5. HTTP Response Code

...