AuxiliaryCodeDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuxiliaryCodeDTO",
  "title": "AuxiliaryCodeDTO",
  "required": [
    "active",
    "defaultCode",
    "name",
    "workTypeCode",
    "workTypeId"
  ],
  "type": "object",
  "properties": {
    "organizationId": {
      "maxLength": 36,
      "minLength": 32,
      "pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
      "format": "uuid",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
    },
    "id": {
      "type": "string",
      "description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
      "example": "93912f11-6017-404b-bf14-5331890b1797"
    },
    "version": {
      "type": "integer",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "format": "int32",
      "example": 1
    },
    "name": {
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9._)\\/(\\-\\s]*$",
      "type": "string",
      "description": "A name for the code.",
      "example": "Sales-Query"
    },
    "description": {
      "maxLength": 255,
      "minLength": 0,
      "type": "string",
      "description": "A short description indicating the context of the code.",
      "example": "Wrap-up code to for sales query"
    },
    "defaultCode": {
      "type": "boolean",
      "description": "Indicates whether this is the default code(true) or not(false).\n\nIf this is the first idle or wrap-up code for your organization,it must be the default. It can be made non-default later once more codes are created.\n\n",
      "example": true
    },
    "active": {
      "type": "boolean",
      "description": "Indicates whether the code is active(when true) or not active(when false). \n\nIt is required only during a create or an update operation.",
      "example": true
    },
    "isSystemCode": {
      "type": "boolean",
      "description": "Indicates whether this is the system default code(true) or not(false). \n\n",
      "example": true
    },
    "workTypeId": {
      "type": "string",
      "description": "Indicates the work type id associated with this code.",
      "example": "19edbcf9-2dea-438b-bdae-446139a5d1fd"
    },
    "workTypeCode": {
      "type": "string",
      "description": "Indicates the work type associated with this code.",
      "example": "WRAP_UP_CODE",
      "enum": [
        "IDLE_CODE",
        "WRAP_UP_CODE"
      ]
    },
    "burnoutInclusion": {
      "type": "string",
      "description": "Indicates the idle code Inclusion status for agent burnout calculation. Default value is 'INCLUDED' for idle codes and 'NOT_APPLICABLE' for wrap up codes.",
      "example": "INCLUDED",
      "enum": [
        "NOT_APPLICABLE",
        "EXCLUDED",
        "INCLUDED"
      ]
    },
    "systemDefault": {
      "type": "boolean",
      "description": "Indicates whether the created resource is system created or not",
      "example": false
    },
    "createdTime": {
      "type": "integer",
      "description": "Creation time(in epoch millis) of this resource.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    },
    "lastUpdatedTime": {
      "type": "integer",
      "description": "Time(in epoch millis) when this resource was last updated.",
      "format": "int64",
      "readOnly": true,
      "example": 1617536244000
    }
  }
}