Webex · Schema

ActiveSkillDTO

In activeSkills and activeEnumSkills at least one skill is mandatory.

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.
textValue string A short textual description that represents a skill the agent has.
booleanValue boolean Indicates whether the agent has this skill (True) or does not have the skill (False).
proficiencyValue integer A number between 0 and 10 to indicate how proficient the agent is in this skill.
skillId string Indicates a value that represents a skill the agent has.
createdTime integer This is the created time of the entity.
lastUpdatedTime integer This is the updated time of the entity.
skillName string Name of the skill, included in the payload only when 'includeSkillDetails' is true.
View JSON Schema on GitHub

JSON Schema

webex-activeskilldto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ActiveSkillDTO",
  "title": "ActiveSkillDTO",
  "type": "object",
  "description": "In activeSkills and activeEnumSkills at least one skill is mandatory.",
  "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
    },
    "textValue": {
      "type": "string",
      "description": "A short textual description that represents a skill the agent has.",
      "example": "Credit card SME",
      "maxLength": 100,
      "minLength": 0
    },
    "booleanValue": {
      "type": "boolean",
      "description": "Indicates whether the agent has this skill (True) or does not have the skill (False).",
      "example": true
    },
    "proficiencyValue": {
      "type": "integer",
      "format": "int32",
      "description": "A number between 0 and 10 to indicate how proficient the agent is in this skill.",
      "example": 1,
      "maximum": 10,
      "minimum": 0
    },
    "skillId": {
      "type": "string",
      "description": "Indicates a value that represents a skill the agent has.",
      "example": "FRENCH",
      "minLength": 1
    },
    "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
    },
    "skillName": {
      "type": "string",
      "description": "Name of the skill, included in the payload only when 'includeSkillDetails' is true.",
      "example": "Customer Support"
    }
  },
  "required": [
    "booleanValue",
    "skillId"
  ]
}