Summary
Save Instances
Description
Save instances with an option.
Route
POST /service_management/saveInstances
Roles
admin
engineering
support
apiwrite
Parameters
Details Example Schema
Name
Type
Required
Description
instance
object
yes
Service instance to save.
options
object
yes
Options for saving the instances. These include sync and force. Setting force to true will be equivalent to commiting with no-out-of-sync-check option in NSO. Do note that the particular option is dangerous, and should be used carefully.
Copied to Clipboard
{
"instance": {
"servicePath": []
},
"options": {
"sync": true,
"force": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"instance": {
"title": "instance",
"$ref": "serviceManagerDoc#/definitions/instance"
},
"options": {
"title": "options",
"type": "object",
"properties": {
"sync": {
"type": "boolean"
},
"force": {
"type": "boolean"
}
}
}
},
"required": [
"instance",
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
array
Result of saving the service instances.
Copied to Clipboard
[
{
"action": "update",
"target": [],
"xpath": [],
"success": false,
"error": "model data not found"
},
{
"action": "update",
"target": [],
"xpath": [],
"success": true,
"error": "model data not found"
},
{
"action": "update",
"target": [],
"xpath": [],
"success": true,
"error": "model data not found"
}
]
Copied to Clipboard
{
"title": "result",
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"examples": [
"update"
]
},
"target": {
"type": "array"
},
"xpath": {
"type": "array"
},
"success": {
"type": "boolean"
},
"error": {
"type": "string",
"examples": [
"model data not found"
]
}
}
}
}
