v4.0 Templates API
TrueSight Network Automation REST API – TemplateService
The base URL for the API is:
templates
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/templates
Click here to expand...
Description
Retrieves templates, matching any filter criteria or view; may filter by filterable template dynamic fields by including query parameters in the form 'filter.dynamicFieldName=value'
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
filter.name | query | Filter for templates matching this name, asterisk wildcards allowed | string | |
filter.contents | query | Filter for templates whose content matches this text, asterisk wildcards allowed | string | |
filter.deviceType | query | Filter for templates with a content of this device type, by GUID | string | |
filter.vendor | query | Filter for templates with a content of this vendor GUID | string | |
filter.containerBlueprintName | query | Filter for templates with a content of this container blueprint name | string | |
view | query | Filter for templates per the named private or shared view; any input filter.* or orderBy parameters override those settings in the view | string | |
orderBy | query | Sort by the specified attribute (contents, name, or a listable template dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending) | string | |
offset | query | Return the specified page number | 1 | integer |
limit | query | Define the number of rows in a page or the maximum number of templates to return | 25 | integer |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | [ |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to access templates | |
404 | Not found: No matching view found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/templates
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Complete attributes of the new template | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
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 accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to add a new template or not allowed to specify an ACL | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Green" title="POST"/}}
/v4.0/templates/changes_to_acls
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
body | body | Changes to be made in the access control lists | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | OK: Access control lists updated successfully | |
400 | Bad request: Template access control lists are not enabled, input DTO is missing or invalid, or a modified template is invalid | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to manage the access control lists of templates,not allowed to modify a particular template, or not allowed to grant or revoke a particular right | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/templates/custom_rights_management_information
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
400 | Bad request: Template access control lists are not enabled | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, or the specified user is not logged in | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/templates/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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 |
{{status subtle="false" colour="Yellow" title="PUT"/}}
/v4.0/templates/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template to be modified | string * | |
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]' | string * |
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 accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the template or not allowed to modify the ACL | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Red" title="DELETE"/}}
/v4.0/templates/{nameOrKey}
Click here to expand...
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 | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | string |
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 accessToken cookie, 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 |
{{status subtle="false" colour="Yellow" title="PATCH"/}}
/v4.0/templates/{nameOrKey}
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template to be modified | string * | |
body | body | New attribute values for the template, in JSON Patch format | ||
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
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 accessToken cookie, or the specified user is not logged in | |
403 | Forbidden: Not allowed to modify the template or not allowed to modify the ACL | |
404 | Not found: No single matching accessible template found | |
500 | Internal server error: Unexpected exception occurred |
{{status subtle="false" colour="Blue" title="GET"/}}
/v4.0/templates/{nameOrKey}/runtime_parameters
Click here to expand...
Parameters
Name | Located in | Description | Default | Schema |
---|---|---|---|---|
nameOrKey | path | Name or database key of the template of interest | string * | |
Authorization | header | Authorization token formatted as 'Bearer [token]' | string * |
Responses
Code | Description | Schema |
---|---|---|
200 | successful operation | |
401 | Unauthorized: Failed to provide a suitable Authorization header or accessToken cookie, 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 |
---|---|
AclChangesDTO | Click here to expand...{ |
AclDTO | Click here to expand...{ |
ComponentId | Click here to expand...{ |
CustomRightsManagementDTO | Click here to expand...{ |
DynamicFieldValueDTO | Click here to expand...{ |
JsonPatch | Click here to expand...[ |
JsonPatch.OneOperation | Click here to expand... |
JsonPatch.Pointer | Click here to expand...string |
JsonPatch.Add | Click here to expand...{ |
JsonPatch.Remove | Click here to expand...{ |
JsonPatch.Replace | Click here to expand...{ |
JsonPatch.Move | Click here to expand...{ |
JsonPatch.Copy | Click here to expand...{ |
JsonPatch.Test | Click here to expand...{ |
OsImageReleaseDTO | Click here to expand...{ |
PerRoleRightsDTO | Click here to expand...{ |
TemplateContentDTO | Click here to expand...{ |
TemplateDTO | Click here to expand...{ |
TemplateRuntimeParameterDTO | Click here to expand...{ |