Templates API
TrueSight Network Automation REST API – Version 3.0 – Templates
The base URL for the API is:
https://serverName:portNumber/bca-networks/api
GET /v3.0/templates
GET /v3.0/templates
Description
Retrieves templates, matching any filter criteria; may filter by filterable template dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
query | Filter for templates matching this name, asterisk wildcards allowed |
| ||
filter.contents | query | Filter for templates whose content matches this text, asterisk wildcards allowed |
| |
filter.deviceType | query | Filter for templates with a content of this device type, by GUID |
| |
orderBy | query | Sort by the specified attribute (name or a listable template dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | "+name" |
|
offset | query | Return the specified page number | 1 |
|
limit | query | Define the number of rows in a page or the maximum number of templates to return | 25 |
|
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation |
|
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access templates | |
500 | Internal server error: Unexpected exception occurred |
POST /v3.0/templates
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new template | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
201 | Created: New template successfully added | |
400 | Bad request: Input template DTO is missing or new template is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new template | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/templates/{nameOrKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access templates | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
PUT /v3.0/templates/{nameOrKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template to be modified |
| |
body | body | Complete new attribute values for the template; anything left out will be considered to be null and will be nulled out in the template | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input template DTO is missing or modified template is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the template | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
DELETE /v3.0/templates/{nameOrKey
}
Description
Deletes a template that is not referenced by any jobs, predefined jobs, policies, or rule corrective actions; if this template is instead referenced only in the subject of a rule, or in the contents of another template, this delete request will succeed, but then the rule/template may produce an "unresolved parameter" error during a snapshot or a refresh device status operation, or when displaying the compliance summary report
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template to be deleted |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation |
|
400 | Bad request: Template is currently in use by a job, predefined job, policy, or rule corrective action | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to delete the template | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
PATCH /v3.0/templates/{nameOrKey
}
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template to be modified |
| |
body | body | New attribute values for the template, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Input JSON patch information is missing or modified template is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the template | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
GET /v3.0/templates/{nameOrKey}/runtime_parameters
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template of interest |
| |
Authorization | header | Authorization token formatted as 'Bearer [token]' |
|
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in | |
403 | Forbidden: Not allowed to access templates | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
Object Definitions
Object | Schema |
---|---|
DynamicFieldValueDTO | A dynamic field value
|
JsonPatch | A list of JSON Patch operations
|
JsonPatch.OneOperation | One JSON Patch operation |
JsonPatch.Pointer | Pointer or path to an element or property
|
JsonPatch.Add | Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.
|
JsonPatch.Remove | Remove a value from an object or array.
|
JsonPatch.Replace | Replace an existing value. THe value can be any JSON value.
|
JsonPatch.Move | Move a value from one location to the other. "path" is the destination.
|
JsonPatch.Copy | Copy a value from one location to another. "path" is the destination.
|
JsonPatch.Test | Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.
|
TemplateContentDTO | A single script that can be deployed to a device to effect configuration changes
|
TemplateDTO | Information about a template
|
TemplateRuntimeParameterDTO | Information about a runtime parameter referenced by a template.
|
Comments
Log in or register to comment.