Create Template - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Create Template","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"createTemplate","tags":["Configuration Templates"],"deprecated":false,"summary":"Create Template","description":"API to create a template by project id.","parameters":[{"name":"Content-Type","description":"Request body content type","required":true,"schema":{"type":"string","default":"application/json"},"in":"header"},{"name":"projectId","description":"UUID of the project in which the template needs to be created","required":true,"schema":{"type":"string","default":"application/json"},"in":"path"}],"requestBody":{"description":"request","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of tag"},"name":{"type":"string","description":"Name of tag"}}},"description":"Tag object which needs to be applied on the template"},"author":{"type":"string","description":"Author of template"},"composite":{"type":"boolean","description":"Is it composite template"},"containingTemplates":{"type":"array","items":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of tag"},"name":{"type":"string","description":"Name of tag"}}},"description":"Tag object which needs to be applied on the template"},"composite":{"type":"boolean","description":"Is it composite template"},"description":{"type":"string","description":"Description of template"},"deviceTypes":{"type":"array","items":{"type":"object","properties":{"productFamily":{"type":"string","description":"Device family"},"productSeries":{"type":"string","description":"Device series"},"productType":{"type":"string","description":"Device type"}}},"description":"Applicable device types"},"id":{"type":"string","description":"UUID of template"},"language":{"type":"string","description":"Template language (JINJA or VELOCITY)"},"name":{"type":"string","description":"Name of template"},"projectName":{"type":"string","description":"Project name"},"rollbackTemplateParams":{"type":"array","items":{"type":"object","properties":{"binding":{"type":"string","description":"Bind to source"},"customOrder":{"type":"integer","description":"CustomOrder of template param"},"dataType":{"type":"string","enum":["STRING","INTEGER","IPADDRESS","MACADDRESS","SECTIONDIVIDER"],"description":"Datatype of template param"},"defaultValue":{"type":"string","description":"Default value of template param"},"description":{"type":"string","description":"Description of template param"},"displayName":{"type":"string","description":"Display name of param"},"group":{"type":"string","description":"group"},"id":{"type":"string","description":"UUID of template param"},"instructionText":{"type":"string","description":"Instruction text for param"},"key":{"type":"string","description":"key"},"notParam":{"type":"boolean","description":"Is it not a variable"},"order":{"type":"integer","description":"Order of template param"},"paramArray":{"type":"boolean","description":"Is it an array"},"parameterName":{"type":"string","description":"Name of template param"},"provider":{"type":"string","description":"provider"},"range":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of range"},"maxValue":{"type":"integer","description":"Max value of range"},"minValue":{"type":"integer","description":"Min value of range"}}},"description":"Range of param"},"required":{"type":"boolean","description":"Is param required"},"selection":{"type":"object","properties":{"defaultSelectedValues":{"type":"array","items":{"type":"string"},"description":"Default selection values"},"id":{"type":"string","description":"UUID of selection"},"selectionType":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Type of selection(SINGLE_SELECT or MULTI_SELECT)"},"selectionValues":{"type":"object","properties":{},"description":"Selection values"}},"description":"Selection of param"}}},"description":"Rollback template params(variables)"},"templateContent":{"type":"string","description":"Template content"},"templateParams":{"type":"array","items":{"type":"object","properties":{"binding":{"type":"string","description":"Bind to source"},"customOrder":{"type":"integer","description":"CustomOrder of template param"},"dataType":{"type":"string","enum":["STRING","INTEGER","IPADDRESS","MACADDRESS","SECTIONDIVIDER"],"description":"Datatype of template param"},"defaultValue":{"type":"string","description":"Default value of template param"},"description":{"type":"string","description":"Description of template param"},"displayName":{"type":"string","description":"Display name of param"},"group":{"type":"string","description":"group"},"id":{"type":"string","description":"UUID of template param"},"instructionText":{"type":"string","description":"Instruction text for param"},"key":{"type":"string","description":"key"},"notParam":{"type":"boolean","description":"Is it not a variable"},"order":{"type":"integer","description":"Order of template param"},"paramArray":{"type":"boolean","description":"Is it an array"},"parameterName":{"type":"string","description":"Name of template param"},"provider":{"type":"string","description":"provider"},"range":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of range"},"maxValue":{"type":"integer","description":"Max value of range"},"minValue":{"type":"integer","description":"Min value of range"}}},"description":"Range of param"},"required":{"type":"boolean","description":"Is param required"},"selection":{"type":"object","properties":{"defaultSelectedValues":{"type":"array","items":{"type":"string"},"description":"Default selection values"},"id":{"type":"string","description":"UUID of selection"},"selectionType":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Type of selection(SINGLE_SELECT or MULTI_SELECT)"},"selectionValues":{"type":"object","properties":{},"description":"Selection values"}},"description":"Selection of param"}}},"description":"Template params(variables)"},"version":{"type":"string","description":"Current version of template"}}},"description":"Containing templates for composite template"},"createTime":{"type":"integer","description":"Create time of template"},"customParamsOrder":{"type":"boolean","description":"Custom Params Order"},"description":{"type":"string","description":"Description of template"},"deviceTypes":{"type":"array","items":{"type":"object","properties":{"productFamily":{"type":"string","description":"Device family"},"productSeries":{"type":"string","description":"Device series"},"productType":{"type":"string","description":"Device type"}}},"description":"Applicable device types"},"failurePolicy":{"type":"string","enum":["ABORT_ON_ERROR","CONTINUE_ON_ERROR","ROLLBACK_ON_ERROR","ROLLBACK_TARGET_ON_ERROR","ABORT_TARGET_ON_ERROR"],"description":"Define failure policy if template provisioning fails"},"id":{"type":"string","description":"UUID of template"},"language":{"type":"string","description":"Template language (JINJA or VELOCITY)"},"lastUpdateTime":{"type":"integer","description":"Update time of template"},"latestVersionTime":{"type":"integer","description":"Latest versioned template time"},"name":{"type":"string","description":"Name of template"},"parentTemplateId":{"type":"string","description":"Parent templateID"},"projectId":{"type":"string","description":"Project UUID"},"projectName":{"type":"string","description":"Project name"},"rollbackTemplateContent":{"type":"string","description":"Rollback template content"},"rollbackTemplateParams":{"type":"array","items":{"type":"object","properties":{"binding":{"type":"string","description":"Bind to source"},"customOrder":{"type":"integer","description":"CustomOrder of template param"},"dataType":{"type":"string","enum":["STRING","INTEGER","IPADDRESS","MACADDRESS","SECTIONDIVIDER"],"description":"Datatype of template param"},"defaultValue":{"type":"string","description":"Default value of template param"},"description":{"type":"string","description":"Description of template param"},"displayName":{"type":"string","description":"Display name of param"},"group":{"type":"string","description":"group"},"id":{"type":"string","description":"UUID of template param"},"instructionText":{"type":"string","description":"Instruction text for param"},"key":{"type":"string","description":"key"},"notParam":{"type":"boolean","description":"Is it not a variable"},"order":{"type":"integer","description":"Order of template param"},"paramArray":{"type":"boolean","description":"Is it an array"},"parameterName":{"type":"string","description":"Name of template param"},"provider":{"type":"string","description":"provider"},"range":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of range"},"maxValue":{"type":"integer","description":"Max value of range"},"minValue":{"type":"integer","description":"Min value of range"}}},"description":"Range of param"},"required":{"type":"boolean","description":"Is param required"},"selection":{"type":"object","properties":{"defaultSelectedValues":{"type":"array","items":{"type":"string"},"description":"Default selection values"},"id":{"type":"string","description":"UUID of selection"},"selectionType":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Type of selection(SINGLE_SELECT or MULTI_SELECT)"},"selectionValues":{"type":"object","properties":{},"description":"Selection values"}},"description":"Selection of param"}}},"description":"Rollback template params(variables)"},"softwareType":{"type":"string","description":"Applicable device software type"},"softwareVariant":{"type":"string","description":"Applicable device software variant"},"softwareVersion":{"type":"string","description":"Applicable device software version"},"templateContent":{"type":"string","description":"Template content"},"templateParams":{"type":"array","items":{"type":"object","properties":{"binding":{"type":"string","description":"Bind to source"},"customOrder":{"type":"integer","description":"CustomOrder of template param"},"dataType":{"type":"string","enum":["STRING","INTEGER","IPADDRESS","MACADDRESS","SECTIONDIVIDER"],"description":"Datatype of template param"},"defaultValue":{"type":"string","description":"Default value of template param"},"description":{"type":"string","description":"Description of template param"},"displayName":{"type":"string","description":"Display name of param"},"group":{"type":"string","description":"group"},"id":{"type":"string","description":"UUID of template param"},"instructionText":{"type":"string","description":"Instruction text for param"},"key":{"type":"string","description":"key"},"notParam":{"type":"boolean","description":"Is it not a variable"},"order":{"type":"integer","description":"Order of template param"},"paramArray":{"type":"boolean","description":"Is it an array"},"parameterName":{"type":"string","description":"Name of template param"},"provider":{"type":"string","description":"provider"},"range":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"UUID of range"},"maxValue":{"type":"integer","description":"Max value of range"},"minValue":{"type":"integer","description":"Min value of range"}}},"description":"Range of param"},"required":{"type":"boolean","description":"Is param required"},"selection":{"type":"object","properties":{"defaultSelectedValues":{"type":"array","items":{"type":"string"},"description":"Default selection values"},"id":{"type":"string","description":"UUID of selection"},"selectionType":{"type":"string","enum":["SINGLE_SELECT","MULTI_SELECT"],"description":"Type of selection(SINGLE_SELECT or MULTI_SELECT)"},"selectionValues":{"type":"object","properties":{},"description":"Selection values"}},"description":"Selection of param"}}},"description":"Template params(variables)"},"validationErrors":{"type":"object","properties":{"rollbackTemplateErrors":{"type":"object","description":"Validation or design conflicts errors of rollback template"},"templateErrors":{"type":"object","description":"Validation or design conflicts errors"},"templateId":{"type":"string","description":"UUID of template"},"templateVersion":{"type":"string","description":"Current version of template"}},"description":"Validation Errors of template content"},"version":{"type":"string","description":"Current version of template"}},"description":"","$$ref":"#/components/schemas/CreateTemplateRequest"}}},"required":true},"responses":{"200":{"description":"The request was successful. The result is contained in the response body.","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"taskId":{"type":"object","description":""},"url":{"type":"string","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/CreateTemplateResponse"}}}},"201":{"description":"The POST/PUT request was fulfilled and a new resource has been created. Information about the resource is in the response body.","content":{}},"202":{"description":"Request was accepted. Use Task ID to track the prooogress","content":{}},"204":{"description":"The request was successful, however no content was returned.","content":{}},"206":{"description":"The GET request included a Range Header, and the server responded with the partial content matching the range.","content":{}},"400":{"description":"Bad Request","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"Not Found","content":{}},"409":{"description":"The target resource is in a conflicted state (for example, an edit conflict where a resource is being edited by multiple users). Retrying the request later might succeed.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"Internal Server Error","content":{}},"501":{"description":"The server has not implemented the functionality required to fulfill the request.","content":{}},"503":{"description":"The server is (temporarily) unavailable.","content":{}},"504":{"description":"The server did not respond inside time restrictions and timed-out.","content":{}}},"x-rapi-id":"ab94-a88b-4b0b-8d3d","x-rapi-overview":"API to create a template by project id.","x-rapi-domain":"Site Management","x-rapi-subdomain":"Configuration Templates","x-rapi-version":"1.0.0","x-rapi-internalPath":"/api/v1/template-programmer/project/${projectId}/template","x-rapi-publicPath":"/dna/intent/api/v1/template-programmer/project/${projectId}/template","x-rapi-registerInKONG":true,"x-rapi-banner":[],"__originalOperationId":"createTemplate","method":"post","path":"/dna/intent/api/v1/template-programmer/project/{projectId}/template"}}