Get Templates By Query - Crosswork Network Controller 7.1 APIs - Cisco DevNet

{"type":"api","title":"Get Templates By Query","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/963b8613-6bdd-3b27-ae70-defd3dac9131","info":{"title":"Device Configuration Templates API","description":"Device Configuration Templates API","version":"1.0.0","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"}},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Device Configuration/device-config-templates-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server-ip}:30603/crosswork/config/v1","description":"Generated server url"}]},"spec":{"tags":["Template API"],"operationId":"getTemplatesByQuery","parameters":[{"description":"Page number","name":"page","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"description":"Page Size","name":"size","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32"}},{"description":"Sort","name":"sort","in":"query","required":false,"schema":{"type":"string"},"example":"name,desc"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Template Query","type":"object","properties":{"filter_data":{"description":"Filter Data","type":"object","properties":{"page_num":{"description":"Page Number","type":"integer","format":"int32"},"match_case":{"description":"Match Case","type":"boolean"},"criteria":{"description":"Criteria","type":"string"},"descending":{"description":"Descending","type":"boolean"},"sort_by":{"description":"Sort By","type":"string"},"page_size":{"description":"Page Size","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/FilterData"},"filter":{"description":"Filter","type":"object","properties":{"type":{"description":"Type List","type":"array","items":{"type":"string","enum":["SYSTEM","USER_DEFINED_SIMPLE","USER_DEFINED_COMPOSITE","MANAGEABILITY","EVENT_DRIVEN","UNRECOGNIZED"]}},"type_value":{"description":"Type Value List","type":"array","items":{"type":"integer","format":"int32"}},"transport":{"description":"Transport List","type":"array","items":{"type":"string","enum":["CLI","GNMI","NETCONF","UNRECOGNIZED"]}},"transport_value":{"description":"Transport Value List","type":"array","items":{"type":"integer","format":"int32"}},"device_type":{"description":"Device Type List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"tag_list":{"description":"Tag List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"last_deployed_status":{"description":"Last Deployed Status","type":"string"},"author":{"description":"Author","type":"string"},"name":{"description":"Name","type":"string"},"version":{"description":"Version","type":"number","format":"float"}},"$$ref":"#/components/schemas/Filter"}},"$$ref":"#/components/schemas/TemplateQuery"},"example":{}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"description":"Template Page","type":"object","properties":{"template":{"description":"Template List","type":"array","items":{"type":"object","description":"Template data as payload","properties":{"port_type":{"description":"Port Type List","type":"array","items":{"type":"string"}},"payload_case":{"description":"Payload Case","type":"string","enum":["CONFIGLET","TEMPLATE_NAME","FLOW_ID","PAYLOAD_NOT_SET"]},"transport_value":{"description":"Transport Value","type":"integer","format":"int32"},"failure_policy_value":{"description":"Failure Policy Value","type":"integer","format":"int32"},"last_deployed_status_value":{"description":"Last Deployed Status Value","type":"integer","format":"int32"},"category_value":{"description":"Category Value","type":"integer","format":"int32"},"device_type":{"description":"Device Type List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"tag_list":{"description":"Tag List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"access_list":{"description":"Access List","type":"array","properties":{"empty":{"description":"Empty","type":"boolean"}},"items":{"type":"string"}},"is_read":{"description":"Boolean value: Is Read","type":"boolean"},"flow_id":{"description":"Flow Id","type":"string"},"type_value":{"description":"Type Value","type":"integer","format":"int32"},"notes":{"description":"Notes","type":"string"},"last_deployed_status":{"description":"Last Deployed Status","type":"string","enum":["NOT_STARTED","FAILED","PARTIAL","IN_PROGRESS","SUCCESS","NOT_DEPLOYED","SYSTEM_FAILURE","UNRECOGNIZED"]},"author":{"description":"Author","type":"string"},"template_name":{"description":"Template Name","type":"object","properties":{"template_name":{"description":"Template name List","type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/TemplateNameList"},"configlet":{"description":"Configlet","type":"string"},"variables":{"description":"Variables List","type":"array","items":{"description":"Template Variable","type":"object","properties":{"is_mandatory":{"description":"Is Mandatory","type":"boolean"},"options":{"description":"Options List","type":"array","items":{"type":"string"}},"name":{"description":"Name","type":"string"},"type":{"description":"Type","type":"string"},"default_value":{"description":"Default Value","type":"string"},"display_name":{"description":"Display Name","type":"string"},"version":{"description":"Version","type":"number","format":"float"},"description":{"description":"Description","type":"string"}},"$$ref":"#/components/schemas/TemplateVariable"}},"failure_policy":{"description":"Failure Policy","type":"string","enum":["CONTINUE_ON_FAILURE","STOP_ON_FAILURE","UNRECOGNIZED"]},"transport":{"description":"Transport","type":"string","enum":["CLI","GNMI","NETCONF","UNRECOGNIZED"]},"category":{"description":"Category","type":"string","enum":["DEVICE","INTERFACE","MODULE","UNRECOGNIZED"]},"name":{"description":"Name","type":"string"},"type":{"description":"Type","type":"string","enum":["SYSTEM","USER_DEFINED_SIMPLE","USER_DEFINED_COMPOSITE","MANAGEABILITY","EVENT_DRIVEN","UNRECOGNIZED"]},"path":{"description":"Path","type":"string"},"version":{"description":"Version","type":"number","format":"float"},"description":{"description":"Description","type":"string"}},"$$ref":"#/components/schemas/Template"}},"total_pages":{"description":"Total Pages","type":"integer","format":"int32"},"total_elements":{"description":"Total Elements","type":"integer","format":"int64"},"page_number":{"description":"Page Number","type":"integer","format":"int32"},"page_size":{"description":"Page Size","type":"integer","format":"int32"}},"$$ref":"#/components/schemas/TemplatePage"},"example":{"template":[{"name":"test","version":1,"description":"","configlet":"banner motd % change banner %","created_at":"2025-02-23T10:03:48.706297Z","updated_at":"2025-02-23T10:04:34.584437Z","transport":"CLI","category":"DEVICE","type":"USER_DEFINED_SIMPLE","variables":[],"device_type":["Cisco NCS 4202"],"port_type":[],"is_read":false,"author":"admin","tagList":[],"accessList":[],"path":"","failurePolicy":"CONTINUE_ON_FAILURE","last_deployed_status":"NOT_STARTED","notes":"Initial version"}],"page_size":30,"page_number":0,"total_pages":1,"total_elements":1}}}},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."}},"method":"post","path":"/templates/query"}}