Webex · Schema

OverridesDTO

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
organizationId string ID of the contact center organization. This field is required for all bulk save operations.
id string 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 integer The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
name string Enter a name for the agent profile.
description string (Optional) Enter a description of the profile.
timezone string The time zone that you provision for your overrides.
overrides array Work hours to be overridden
latestOverride object
overridesCount integer
createdTime integer This is the created time of the entity.
lastUpdatedTime integer This is the updated time of the entity.
View JSON Schema on GitHub

JSON Schema

webex-overridesdto-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/OverridesDTO",
  "title": "OverridesDTO",
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "string",
      "format": "uuid",
      "description": "ID of the contact center organization. This field is required for all bulk save operations.",
      "example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
      "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}$"
    },
    "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",
      "format": "int32",
      "description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
      "example": 1
    },
    "name": {
      "type": "string",
      "description": "Enter a name for the agent profile.",
      "example": "My Overrides",
      "maxLength": 80,
      "minLength": 0,
      "pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
    },
    "description": {
      "type": "string",
      "description": "(Optional) Enter a description of the profile.",
      "example": "My Overrides Desc",
      "maxLength": 255,
      "minLength": 0
    },
    "timezone": {
      "type": "string",
      "description": "The time zone that you provision for your overrides.",
      "example": "America/New_York",
      "minLength": 1
    },
    "overrides": {
      "type": "array",
      "description": "Work hours to be overridden",
      "example": {
        "name": "My Overrides",
        "description": "My Overrides Desc",
        "timezone": "America/New_York",
        "overrides": [
          {
            "name": "Day for me",
            "startDateTime": "2022-05-26T00:00",
            "endDateTime": "2022-05-26T23:59",
            "workingHours": true
          },
          {
            "name": "Fire Drill",
            "startDateTime": "2022-05-26T14:30",
            "endDateTime": "2022-05-26T16:30",
            "workingHours": false
          }
        ],
        "id": "93912f11-6017-404b-bf14-5331890b1797",
        "organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
        "createdTime": 1628231177000,
        "lastUpdatedTime": 1628231177000
      },
      "items": {
        "$ref": "#/components/schemas/OverrideDTO"
      },
      "minItems": 1
    },
    "latestOverride": {
      "$ref": "#/components/schemas/OverrideDTO"
    },
    "overridesCount": {
      "type": "integer",
      "format": "int64"
    },
    "createdTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the created time of the entity.",
      "example": 123456789
    },
    "lastUpdatedTime": {
      "type": "integer",
      "format": "int64",
      "description": "This is the updated time of the entity.",
      "example": 123456789
    }
  },
  "required": [
    "name",
    "overrides",
    "timezone"
  ]
}