Skip to main content

Get Commcell Group Details​

Select

SaaS
Customer Managed

Get details of a commcellGroup based on id

Path Parameters
  • commcellGroupId int32 required

    Id of the commcellGroupId whose details have to be fetched

Header Parameters
  • mode

    Possible values: [EdgeMode]

Responses

Success

Schema
  • CommcellGroup object
  • id int32
  • GUID string
  • name string
  • Company object
  • id int32
  • GUID string
  • name string
  • AssociationCount int32

    Commcell association info.

  • GlobalConfigInfo object

    Only applicable on Global CommCells

  • id string
  • name string
  • commcells object[]

    List of Service CommCells where the global configuration is applied

  • id int32
  • name string
  • guid string
  • scope string

    The entity level at which the config is applied.

  • scopeFilterQuery string

    CommCellEntityCache filter query string used for filtering the scope

  • applyOnAllCommCells boolean

    Decides whether the global configuration should be applied to all the Service commcells, including the newly created ones

  • isMarkedForDeletion boolean

    Indicates whether global configuration deletion has been started.

  • status string
  • ServiceCommcells object[]
  • Commcell object
  • id int32
  • GUID string
  • name string
  • Version string

    Version of the service commcell.

  • activeManagementStatus string

    Possible values: [DISABLED, INPROGRESS, ENABLED, FAILED]

    Returns active management status of the service commcell.

  • description string

    Description of the commcell group.

GET /v4/commcellgroup/:commcellgroupid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
commcellGroupId — path required
mode — header
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/CommcellGroup/:commcellGroupId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'