Webex · Schema

AdminBatchStartJobObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
operation string The kind of operation to be carried out.
targetLocationId string Mandatory for a `MOVE` operation. The target location within organization where the unassigned numbers will be moved from the source location.
numberUsageType string The number usage type. Mandatory for `NUMBER_USAGE_CHANGE` operation.
numberList array Numbers on which to execute the operation.
View JSON Schema on GitHub

JSON Schema

webex-adminbatchstartjobobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AdminBatchStartJobObject",
  "title": "AdminBatchStartJobObject",
  "type": "object",
  "required": [
    "operation",
    "numberList"
  ],
  "properties": {
    "operation": {
      "type": "string",
      "example": "MOVE|NUMBER_USAGE_CHANGE",
      "description": "The kind of operation to be carried out."
    },
    "targetLocationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
      "description": "Mandatory for a `MOVE` operation. The target location within organization where the unassigned numbers will be moved from the source location."
    },
    "numberUsageType": {
      "type": "string",
      "example": "NONE|SERVICE",
      "description": "The number usage type. Mandatory for `NUMBER_USAGE_CHANGE` operation."
    },
    "numberList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/numberItem"
      },
      "description": "Numbers on which to execute the operation."
    }
  }
}