Summary
Save Instances
Description
Save instances with an option.
Route
POST /service_management/saveInstances
Roles
admin
engineering
support
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
instance |
object |
yes |
Service instance to save. |
options |
object |
yes |
Allows for passing options to an IAP adapter. Reference the JSON schema posted at https://docs.itential.io/. |
Copied to Clipboard
{
"instance": {
"servicePath": []
},
"options": {
"sync": true,
"commit-sync": false,
"no_overwrite": true,
"staging": true,
"force": false
}
}
Return
DetailsExampleSchema
Name |
Type |
Description |
result |
array |
Result of saving the service instances. |
Copied to Clipboard
[
{
"action": "update",
"target": [],
"xpath": [],
"success": true,
"error": "model data not found"
},
{
"action": "update",
"target": [],
"xpath": [],
"success": true,
"error": "model data not found"
},
{
"action": "update",
"target": [],
"xpath": [],
"success": false,
"error": "model data not found"
},
{
"action": "update",
"target": [],
"xpath": [],
"success": false,
"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"
]
}
}
}
}