BulkRequestDTOAuxiliaryCodeDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-bulk-request-dtoauxiliary-code-dto-schema.json",
  "title": "BulkRequestDTOAuxiliaryCodeDTO",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-auxiliary-code-api-openapi.yml#/components/schemas/BulkRequestDTOAuxiliaryCodeDTO",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/BulkRequestItemDTOAuxiliaryCodeDTO"
      }
    }
  },
  "$defs": {
    "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"
        },
        "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."
        },
        "version": {
          "type": "integer",
          "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
          "format": "int32"
        },
        "name": {
          "maxLength": 80,
          "minLength": 0,
          "pattern": "^[a-zA-Z0-9._)\\/(\\-\\s]*$",
          "type": "string",
          "description": "A name for the code."
        },
        "description": {
          "maxLength": 255,
          "minLength": 0,
          "type": "string",
          "description": "A short description indicating the context of the code."
        },
        "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"
        },
        "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."
        },
        "isSystemCode": {
          "type": "boolean",
          "description": "Indicates whether this is the system default code(true) or not(false). \n\n"
        },
        "workTypeId": {
          "type": "string",
          "description": "Indicates the work type id associated with this code."
        },
        "workTypeCode": {
          "type": "string",
          "description": "Indicates the work type associated with this 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.",
          "enum": [
            "NOT_APPLICABLE",
            "EXCLUDED",
            "INCLUDED"
          ]
        },
        "systemDefault": {
          "type": "boolean",
          "description": "Indicates whether the created resource is system created or not"
        },
        "createdTime": {
          "type": "integer",
          "description": "Creation time(in epoch millis) of this resource.",
          "format": "int64",
          "readOnly": true
        },
        "lastUpdatedTime": {
          "type": "integer",
          "description": "Time(in epoch millis) when this resource was last updated.",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "BulkRequestItemDTOAuxiliaryCodeDTO": {
      "type": "object",
      "properties": {
        "itemIdentifier": {
          "type": "integer",
          "description": "Unique item identifier for a bulk operation.",
          "format": "int32"
        },
        "item": {
          "$ref": "#/$defs/AuxiliaryCodeDTO"
        },
        "requestAction": {
          "type": "string",
          "description": "Identifier for action type. Possible values can be SAVE and DELETE."
        }
      }
    }
  }
}