Summary
Make REST Actions to NSO
Description
Interface to make rest actions to NSO
Route
POST /nso_manager/restAction/:adapterId
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| adapterId |
string |
yes |
Adapter's name. |
| params |
object |
yes |
Parameters such as path and content-type |
| body |
object |
yes |
Body object to send to NSO |
Copied to Clipboard
{
"params": {
"path": "/api/operational/devices/commit-queue/queue-item/1555963207450/_operations/prune",
"accept": "application/vnd.yang.collection+json",
"method": "POST",
"contentType": "application/vnd.yang.collection+json"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"params": {
"title": "params",
"type": "object",
"example": {
"path": "/restconf/data/tailf-ncs:devices/commit-queue/add-lock",
"accept": "application/yang-data+json",
"method": "POST",
"contentType": "application/yang-data+json"
},
"properties": {
"path": {
"type": "string",
"examples": [
"/api/operational/devices/commit-queue/queue-item/1555963207450/_operations/prune",
"/api/operational/devices/commit-queue/queue-item/1555963207450/_operations/delete"
]
},
"accept": {
"type": "string",
"examples": [
"application/vnd.yang.data+json",
"application/vnd.yang.collection+json",
"application/vnd.yang.collection+xml"
]
},
"method": {
"type": "string",
"examples": [
"POST",
"GET"
]
},
"contentType": {
"type": "string",
"examples": [
"application/vnd.yang.data+json",
"application/vnd.yang.collection+json",
"application/yang-data+json"
]
}
},
"required": [
"path",
"accept"
]
},
"body": {
"title": "body",
"type": "object",
"example": {}
}
},
"required": [
"params",
"body"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
array |
Array of results. |
Copied to Clipboard
[
{
"result": "204"
},
{
"result": "204"
},
{
"result": "204"
},
{
"result": "204"
},
{
"result": "204"
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"type": "object",
"properties": {
"result": {
"type": "string",
"examples": [
"204"
]
}
}
}
}
