---
title: "CriteriaTemplate"
url: "https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8/schemas/CriteriaTemplate"
---

> Full API specification: https://us-prod.jeffyongtaotang.com/apis/konnect-service-catalog-1/versions/cdbef9b7-686c-4189-bbc8-55c727a972e8.md

# CriteriaTemplate

Representation of a criteria template.

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.3.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    CriteriaTemplateName:
      type: string
      description: Reference to the unique `name` of the criteria template.
      example: time_to_merge
    CriteriaTemplateSchema:
      x-convert-oneOf: true
      anyOf:
        - title: EmptySchema
          type: object
          nullable: true
        - type: object
          required:
            - type
            - definition
          properties:
            type:
              type: string
              enum:
                - simple
            definition:
              type: object
              additionalProperties:
                type: string
                enum:
                  - string
                  - number
                  - boolean
          title: CriteriaTemplateSimpleSchema
          description: >
            Defines the parameters required to evaluate the criteria using
            simple schema.

            Set to `null` when the given criteria does not rely on
            parameterization.
        - type: object
          required:
            - type
            - definition
          properties:
            type:
              type: string
              enum:
                - json_schema
            definition:
              type: object
              additionalProperties: true
          title: CriteriaTemplateJSONSchema
          description: >
            Defines the parameters required to evaluate the criteria using JSON
            schema.

            Set to `null` when the given criteria does not rely on
            parameterization.
    CriteriaTemplate:
      type: object
      description: Representation of a criteria template.
      required:
        - name
        - display_name
        - category
        - template_string
        - integration_name
        - installed
        - schema
        - required_integration_capability
      properties:
        name:
          $ref: "#/components/schemas/CriteriaTemplateName"
        display_name:
          type: string
          description: The human-readable display name of the template.
        category:
          type: string
          enum:
            - Source Code Management
            - Incident Management
            - Observability
            - Code Quality
            - Issue Tracking
            - Communications
            - Feature Management
            - Security / Vulnerability
            - Documentation
            - Catalog Management
            - Gateway Configuration
          nullable: true
          description: Categorical tag for the functionality the template relates to.
          example: Source Code Management
        template_string:
          type: string
          nullable: true
          description: "[Liquid](https://shopify.github.io/liquid/) template string used
            to render the criteria interpolated by parameters."
        integration_name:
          type: string
          nullable: true
          description: >
            The catalog integration who registered the given criteria template.

            This will be `null` when a template is always available independent
            of connected integrations.
        installed:
          type: boolean
          description: >
            Whether the template is available given the current state of the
            catalog.

            For example, this will be `false` when the template is provided by
            an integrastion

            that is not currently connected.
        schema:
          $ref: "#/components/schemas/CriteriaTemplateSchema"
        required_integration_capability:
          type: string
          nullable: true
          enum:
            - null
            - on_call_provider
            - incident_provider
            - pull_request_provider
            - workflow_provider
          description: >
            Required capability from connected integrations to use this criteria
            template.

            Applicable for templates that are not provided by a given
            integration (functional

            across integrations).
```