openapi: 3.1.0
info:
  title: Helpcenter LayoutRuleCriteria API
  version: 1.0.0
tags:
- name: LayoutRuleCriteria
paths:
  /api/v1/layouts/{layoutId}/layoutRules/criteriaFields:
    get:
      tags:
      - LayoutRuleCriteria
      summary: Get Layout Rule Criteria
      description: This API lists the fields that can be used in criteria of a specified module in layout rules. Available pre-defined values may contain ${EMPTY}, ${NOTEMPTY}, ${OPEN}, ${CLOSED}, ${CURRENTTIME}. Available types are Text, Date, DateTime, Text, Boolean and Arithmetic.
      operationId: getLayoutRuleCriteria
      parameters:
      - name: category
        in: query
        description: Category for getting the field criteria for primary or secondary fields
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: Category for getting the field criteria for primary or secondary fields
          enum:
          - primary
          - secondary
          maxLength: 100
          minLength: 0
      - name: layoutId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int64
          pattern: ([0-9]+)
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '200':
          $ref: '#/components/responses/getCriteriaResponse'
      security:
      - iam-oauth2-schema:
        - Desk.settings.READ
      x-audience:
      - external-public
components:
  responses:
    getCriteriaResponse:
      description: getCriteriaResponse template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              criteriaFields:
                $ref: ./LayoutRuleCriteria.json#/components/schemas/fieldDetailList
            required:
            - criteriaFields
          examples:
            Valid responses Definitions:
              value:
                criteriaFields:
                - displayLabel: Tickets
                  name: tickets
                  fieldDetails:
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: accountId
                    fieldLabel: Account Name
                    i18NLabel: Account Name
                    type: lookup
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: contactId
                    fieldLabel: Contact Name
                    i18NLabel: Contact Name
                    type: lookup
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: starts with
                      value:
                      - ${CUSTOM}
                    - condition: contains
                      value:
                      - ${CUSTOM}
                    - condition: doesn't contain
                      value:
                      - ${CUSTOM}
                    - condition: ends with
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: phone
                    fieldLabel: Phone
                    i18NLabel: Phone
                    type: text
                  - availableConditions:
                    - condition: is OPEN
                      value:
                      - ${OPEN}
                    - condition: is CLOSED
                      value:
                      - ${CLOSED}
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: starts with
                      value:
                      - ${CUSTOM}
                    - condition: contains
                      value:
                      - ${CUSTOM}
                    - condition: doesn't contain
                      value:
                      - ${CUSTOM}
                    - condition: ends with
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: status
                    fieldLabel: Status
                    i18NLabel: Status
                    type: text
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: productId
                    fieldLabel: Product Name
                    i18NLabel: Product Name
                    type: lookup
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CURRENTTIME}
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CURRENTTIME}
                      - ${CUSTOM}
                    - condition: is after
                      value:
                      - ${CURRENTTIME}
                      - ${CUSTOM}
                    - condition: is before
                      value:
                      - ${CURRENTTIME}
                      - ${CUSTOM}
                    - condition: between
                      value:
                      - - ${CURRENTTIME}
                        - ${CUSTOM}
                      - - ${CURRENTTIME}
                        - ${CUSTOM}
                    - condition: not between
                      value:
                      - - ${CURRENTTIME}
                        - ${CUSTOM}
                      - - ${CURRENTTIME}
                        - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: dueDate
                    fieldLabel: Due Date
                    i18NLabel: Due Date
                    type: dateTime
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: starts with
                      value:
                      - ${CUSTOM}
                    - condition: contains
                      value:
                      - ${CUSTOM}
                    - condition: doesn't contain
                      value:
                      - ${CUSTOM}
                    - condition: ends with
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: priority
                    fieldLabel: Priority
                    i18NLabel: Priority
                    type: text
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: starts with
                      value:
                      - ${CUSTOM}
                    - condition: contains
                      value:
                      - ${CUSTOM}
                    - condition: doesn't contain
                      value:
                      - ${CUSTOM}
                    - condition: ends with
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: channel
                    fieldLabel: Mode
                    i18NLabel: Mode
                    type: text
                  - availableConditions:
                    - condition: is
                      value:
                      - ${CUSTOM}
                    - condition: isn't
                      value:
                      - ${CUSTOM}
                    - condition: starts with
                      value:
                      - ${CUSTOM}
                    - condition: contains
                      value:
                      - ${CUSTOM}
                    - condition: doesn't contain
                      value:
                      - ${CUSTOM}
                    - condition: ends with
                      value:
                      - ${CUSTOM}
                    - condition: is empty
                      value:
                      - ${EMPTY}
                    - condition: is not empty
                      value:
                      - ${NOTEMPTY}
                    fieldName: classification
                    fieldLabel: Classification
                    i18NLabel: Classification
                    type: text
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter