/tickets/templates/{id}

GET /tickets/templates/{id}

Get template

Retrieve a specific template by ID

Required Parameters

id path string

Try it out

Output:

Responses

Description

Template retrieved successfully

{
  "id": "string",
  "name": "string",
  "content": "string",
  "description": "string",
  "category": "string",
  "isPublic": false,
  "variables": [
    "string"
  ],
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "updatedBy": "string",
  "usageCount": 0,
  "lastUsedAt": "string"
}

References

#/components/schemas/Template #/components/schemas/TemplateDetailed

#/components/schemas/Template

OpenAPI
TypeScript

type: object
properties:
  id:
    type: string
  name:
    type: string
    description: Template name
  content:
    type: string
    description: Template content
  description:
    type: string
    nullable: true
    description: Template description
  category:
    type: string
    nullable: true
    description: Template category
  isPublic:
    type: boolean
    description: Whether available to all users
  variables:
    type: array
    items:
      type: string
    description: Available template variables
  createdBy:
    type: string
  createdAt:
    type: string
    format: date-time
  updatedAt:
    type: string
    format: date-time
  updatedBy:
    type: string
    nullable: true

|
export interface Template {
  id?: string;
  /** Template name */
  name?: string;
  /** Template content */
  content?: string;
  /** Template description */
  description?: string;
  /** Template category */
  category?: string;
  /** Whether available to all users */
  isPublic?: boolean;
  /** Available template variables */
  variables?: string[];
  createdBy?: string;
  createdAt?: Date;
  updatedAt?: Date;
  updatedBy?: string;
}

allOf:
  - type: object
    properties:
      id:
        type: string
      name:
        type: string
        description: Template name
      content:
        type: string
        description: Template content
      description:
        type: string
        nullable: true
        description: Template description
      category:
        type: string
        nullable: true
        description: Template category
      isPublic:
        type: boolean
        description: Whether available to all users
      variables:
        type: array
        items:
          type: string
        description: Available template variables
      createdBy:
        type: string
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
      updatedBy:
        type: string
        nullable: true
    fromRef: "#/components/schemas/Template"
  - type: object
    properties:
      usageCount:
        type: integer
        description: Number of times template has been used
      lastUsedAt:
        type: string
        format: date-time
        nullable: true
        description: Last time template was used

|
export interface TemplateDetailed_AllOf_0 {
  id?: string;
  /** Template name */
  name?: string;
  /** Template content */
  content?: string;
  /** Template description */
  description?: string;
  /** Template category */
  category?: string;
  /** Whether available to all users */
  isPublic?: boolean;
  /** Available template variables */
  variables?: string[];
  createdBy?: string;
  createdAt?: Date;
  updatedAt?: Date;
  updatedBy?: string;
}

export interface TemplateDetailed_AllOf_1 {
  /** Number of times template has been used */
  usageCount?: number;
  /** Last time template was used */
  lastUsedAt?: Date;
}

export type TemplateDetailed = TemplateDetailed_AllOf_0 &
  TemplateDetailed_AllOf_1;

Route Source Code

Check out the source code for this route entrypoint here: /tickets/templates/[id]/route.ts

Or the swagger.yaml spec this documentation was generated from: /tickets/templates/swagger.yaml