Refer to the swagger doc for the api documentation
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
...
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NSSI API Request |
|---|
| collapse | true |
|---|
|
{
"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"
}
} |
...
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NSSI API Response |
|---|
| collapse | true |
|---|
|
{
"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)
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NxI API Request |
|---|
| collapse | true |
|---|
|
{
"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"
} |
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NxI API Response |
|---|
| collapse | true |
|---|
|
{
"requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"requestStatus": "success",
"terminateResponse": true,
"reason": ""
} |
Sample NxI API(NSSI Termination)
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NxI API Request |
|---|
| collapse | true |
|---|
|
{
"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"
} |
| Code Block |
|---|
| language | yml |
|---|
| theme | RDark |
|---|
| title | Sample NxI API Response |
|---|
| collapse | true |
|---|
|
{
"requestId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"transactionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"requestStatus": "success",
"terminateResponse": true,
"reason": ""
} |
1. Select NST API
Interface Definition | Description |
|---|
Content-Type | application/json |
Operation Type | POST |
URI | https://{host}:{port}/api/oof/selection/nst/v1 |
...