Page Comparison

Content-Type

application/json

Operation Type

POST

URI

https://{host}:{port}/api/usecaseui/server/v1/uui-lcm/Sotnservices

Header Name

Required?

Description

Accept

N

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

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.

Authorization

N

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.

service

Y

1

SOTN service Object

The content of the RequestInfo object.

site

Y

1…n

SOTN sites Object

The content of Router request object

serviceName

Y

1

String

A unique name to create service.

description

Y

1

String

Information related to service

COS

Y

1

String

Type of subscription(Premium/Standard)

serviceType

Y

1

String

Type of Service(epl/evpl)

highAvailability

Y

1

String

High Bandwidth(yes/no).

CIR

Y

1

String

EIR

Y

1

String

Site name

Y

1

string

A unique name to create site

address

Y

1

string

Address of the site laoction

description

Y

1

string

Information related to site

Zipcode

Y

1

String

Postal code for site location

Vlan

Y

1

String

serviceId

Y

1

String

A unique Id for created service.

operationId

Y

1

String

Content-Type

application/json

Operation Type

GET

URI

https://{host}:{port}/api/usecaseui-server/v1/uui-lcm/Sotnservices/servicesubscription/SOTN/serviceinstance/{instanceId}

Accept

N

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

Content-Type

N

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.

Authorization

N

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.

Service Information

Y

1

UUID/String

A unique Id for an ONAP transaction.

Sire Information

Y

1

UUID/String

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

ethtSvcName

Y

1

Timestamp

cir

Y

1

Timestamp

eir

N

0..N

List of LinkInfo

List of Link's

ebs

Y

1

Coloraware

Y

1

cbs

Y

1

SiteName

Y

1

String

A unique site Name

Description

Y

1

String

Description about site

Postalcode

Y

1

String

Information sitelocaton

Content-Type

application/json

Operation Type

GET

URI

https://{host}:{port}/api/usecaseui-server/v1/uui-lcm/Sotnservices/topology/service/service-subscriptions/service-subscription/{servicetypeparam}/service-instances/service-instance/{serviceInstanceId}

Accept

N

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

Content-Type

N

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.

Authorization

N

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.

zipCode

Y

1

String

Zipcode/PostalCode of site.

role

Y

1

String

Spoke/Hub

siteName

Y

1

String

Unique name for site

description

Y

1

String

Site address

location

Y

1

String

Address of site

attribute

Y

1

Site attribute object

Have site info attribute in below table

Zip Code

Y

1

String

Postal code of location(site)

Site Name

Y

1

String

A unique name for site

cvlan

Y

1

String

Access node Id

N

1

String

Access LTP Id

Y

1

String

Link Status

Y

1

String

Active/Down

Status of Link

Location

Y

1

String

Information of city(i.e cityname)

Content-Type

application/json

Operation Type

GET

URI

https://{host}:{port}/api/usecaseui-server/v1/uui-lcm/Sotnservices/resourceTopology/service/service-subscriptions/service-subscription/service-instances/service-instance/{serviceInstace}

Accept

N

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

Content-Type

N

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.

Authorization

N

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.

Nodes

Y

1

Nodes array

List of nodes

Edges

Y

1

Edges array

List of connection between nodes(startnode-->endnode)

Id

Y

1

String

A unique id for node

shape

Y

1

String

circular

shape of the node

image

Y

1

String

Jpg/png/jpeg

Image for node

label

N

1

String

Label for node 

color

Y

1

String

Color of node

Data node

Y

1

object

It is vary upon nodes info

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.

520

Solver error

Requested number of solutions cannot be found.