Get Office365 Plans for Dashboard

Select

SaaS

Customer Managed

Returns all Office365 active plans with number of entities associated to the plan per workload

Responses

application/json

Schema
Example (from schema)
Success

Schema

error object
errorMessage string
errorCode int32
o365Plans object[]
plan object
id int32
name string
planTier string
Possible values: [STANDARD, ENTERPRISE, SYNTEX]
planSubType string
Possible values: [ExchangeUser, Office365]
contentIndexingEnabled boolean
Tells if Content Indexing is enabled on this plan
mailboxes int32
Number of mailboxes assocaited with this plan
users int32
Number of users assocaited with this plan
sites int32
Number of sites assocaited with this plan
teams int32
Number of teams assocaited with this plan
totalEntities int32
Count of total associated entities for the Office 365 plan
company object
id int32
Company Id
name string
Company name
GUID string
GUID of the company
alias string
The company domain or NetBIOS name
isReseller boolean
Enable reseller mode. A reseller is a user or user groups who can operate multiple tenant environments. The service provider can assign one or more resellers as the tenant operator for a company. The reseller can switch to any of their assigned tenant environment and operate on the company as a tenant user. Once enabled, the reseller mode cannot be disabled.
primaryContacts object[]
id int32
name string
associatedEntitiesCount int32
Gives the number of entities associated with the company
status string
Possible values: [UNKNOWN, ACTIVE, DEACTIVATED, DELETED]
Gives the company status
commcell object
name string
Name of the commcell the entity belongs to.
displayName string
Display name of the commcell the entity belongs to.
operators object[]
List of operators configured for the company
fullName string
Full name of the operator
userGroup object
id int32
name string
user object
id int32
name string
role object
id int32
name string
totalO365Plans int32
Total number of Office365 plans returned

{
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  },
  "o365Plans": [
    {
      "plan": {
        "id": 0,
        "name": "string"
      },
      "planTier": "STANDARD",
      "planSubType": "ExchangeUser",
      "contentIndexingEnabled": true,
      "mailboxes": 0,
      "users": 0,
      "sites": 0,
      "teams": 0,
      "totalEntities": 0,
      "company": {
        "id": 0,
        "name": "string",
        "GUID": "string",
        "alias": "string",
        "isReseller": true,
        "primaryContacts": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "associatedEntitiesCount": 0,
        "status": "UNKNOWN",
        "commcell": {
          "name": "string",
          "displayName": "string"
        },
        "operators": [
          {
            "fullName": "string",
            "userGroup": {
              "id": 0,
              "name": "string"
            },
            "user": {
              "id": 0,
              "name": "string"
            },
            "role": {
              "id": 0,
              "name": "string"
            }
          }
        ]
      }
    }
  ],
  "totalO365Plans": 0
}

{
  "o365Plans": [
    {
      "plan": {
        "id": 18,
        "name": "Office365 Standard Plan"
      },
      "planTier": "STANDARD",
      "contentIndexingEnabled": false,
      "mailboxes": 24,
      "users": 15,
      "sites": 32,
      "teams": 9,
      "totalEntities": 80
    }
  ],
  "totalO365Plans": 1
}

Bad Request

application/json

Schema
Example (from schema)
Bad request

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Invalid parameters",
  "errorCode": 1
}

Internal Server Error

application/json

Schema
Example (from schema)
Internal server error

Schema

errorMessage string
errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

{
  "errorMessage": "Internal error",
  "errorCode": 1
}

GET /v4/office365/plans

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Office365/Plans' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

Get Office365 Plans for Dashboard​

Authorization

Request

Get Office365 Plans for Dashboard