Calculates the minimum device configuration commands required to save new service instances or update existing service instances.
Route
POST /service_management/testInstances
Roles
adminengineeringsupportapiread
Parameters
DetailsExampleSchema
Name
Type
Required
Description
instance
object
yes
An object with a single field. The field's key is the service model's XPATH. The field's value is an array of objects. Each element of the array is an object representing the properties of a service model instance. Can be obtained with API ServiceManager.getInstance().
options
object
yes
Allows for passing options to an IAP adapter. Reference the JSON schema posted at https://docs.itential.io/.
An object containing dry-run results for the service instances being provisioned suitable as input to the ViewTestService job task.
Copied to Clipboard
{
"device": [
{
"name": "non dolor est in nulla",
"data": "esse in nulla commodo"
},
{
"name": "deserunt",
"data": "fugiat ut adipisicing"
}
],
"success": false
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"required": [
"device",
"success"
],
"properties": {
"device": {
"oneOf": [
{
"type": "object",
"title": "device",
"description": "A JSON containing device hostname(s) and their configuration commands required to save new service instances or update existing service instances. This is returned when only one service instance is passed to testInstances.",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
}
},
{
"type": "array",
"title": "device",
"description": "An array containing JSONs, containing device hostname(s) and their configuration commands required to save new service instances or update existing service instances. This is returned when multiple service instances are passed to testInstances.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string"
}
}
}
}
]
},
"success": {
"type": "boolean",
"title": "success",
"description": "A false value indicates a runtime problem."
}
}
}
