---
title: "CriteriaEvaluationRelationMap"
url: "https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f/schemas/CriteriaEvaluationRelationMap"
---

> Full API specification: https://dev-portal.dehaven.org/apis/konnect-service-catalog-1-2-0/versions/5f6559bf-d7ba-429c-95c4-cbf2371e663f.md

# CriteriaEvaluationRelationMap

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Service Catalog
  version: 1.2.0
servers:
  - url: https://us.api.konghq.com/v1
    description: US Region Base URL
  - url: https://eu.api.konghq.com/v1
    description: EU Region Base URL
  - url: https://au.api.konghq.com/v1
    description: AU Region Base URL
  - url: https://me.api.konghq.com/v1
    description: ME Region Base URL
  - url: https://in.api.konghq.com/v1
    description: IN Region Base URL
components:
  schemas:
    CriteriaEvaluationRelationResult:
      type: object
      required:
        - is_passing
        - relation
        - details
      properties:
        is_passing:
          type: boolean
          description: Whether or not the relation has passed the criteria evaluation.
        relation:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
        details:
          $ref: "#/components/schemas/CriteriaEvaluationResultDetails"
    CriteriaEvaluationErrorResult:
      type: object
      required:
        - relation
        - error
      properties:
        relation:
          type: object
          required:
            - id
            - name
          properties:
            id:
              type: string
            name:
              type: string
        error:
          x-flatten-allOf: true
          allOf:
            - $ref: "#/components/schemas/CriteriaEvaluationError"
            - example: null
    CriteriaEvaluationResultDetails:
      type: object
      description: Provides additional metadata about the criteria evaluation result.
      nullable: true
      required:
        - raw_value
        - display_text
      properties:
        raw_value:
          description: >
            Raw value of the criteria evaluation.


            For example, a service may be failing the `time_to_acknowledge`
            criteria evaluation when

            the the mean time-to-ack is greater than 15 minutes. This value
            represents the _actual_

            mean time-to-ack value for the service which if not passing could be
            25 minutes.
          oneOf:
            - type: number
            - type: string
            - type: boolean
            - $ref: "#/components/schemas/TimeValue"
            - $ref: "#/components/schemas/CriteriaEvaluationRelationMap"
            - type: object
              additionalProperties: true
            - nullable: true
        display_text:
          type: string
          example: 25 minutes
          description: Renderable text providing human-readable context about the
            evaluation value.
      example:
        raw_value:
          unit: minutes
          value: 25
        display_text: 25 minutes
    CriteriaEvaluationError:
      type: object
      nullable: true
      description: >
        Details about an error that occurred during evaluation preventing
        computation of a pass/fail result.

        Will be `null` when no error occurred.
      required:
        - type
        - details
      properties:
        type:
          type: string
          description: The type of error that occurred.
          example: integration_unauthorized
        details:
          type: string
          description: Human-readable error message about the error.
          example: >
            The GitHub integration is unauthorized. Please ensure that the

            integration is re-authorized for the criteria to be successfully
            evaluated.
    TimeValue:
      type: object
      description: Represents a time value inclusive of units.
      required:
        - value
        - unit
      properties:
        value:
          type: number
          example: 3.25
        unit:
          type: string
          example: hours
          enum:
            - milliseconds
            - seconds
            - minutes
            - hours
            - days
            - months
            - years
    CriteriaEvaluationRelationMap:
      type: object
      required:
        - instance
        - relation
        - map
      properties:
        instance:
          type: string
          enum:
            - criteria_result_relation_map
        relation:
          type: string
          example: gateway_svc
        map:
          additionalProperties:
            oneOf:
              - $ref: "#/components/schemas/CriteriaEvaluationRelationResult"
              - $ref: "#/components/schemas/CriteriaEvaluationErrorResult"
```