Device counter by company Id

Release Time

06/07/2018

Views

4615 times

Tags

Company ID Device Counter

Description

This resource provides Device counter by company Id.

Scheme

https

Host

Valid ITSM host (example: subdomain-msp.cmdm.comodo.com )

Path

/api/rest/v1/device/count-by-company/companyId/:companyId

Request Headers

Key	Value	Description
Http method	GET	Http method
Content-Type	application/json
x-auth-type	4,3,2,1	Authentication type identifier
x-auth-token	access token	depending of auth-type token

Query Params

Key	Value	Description
companyId	integer	Identifier of company [required]

See the below link for details:

Execution

Sample execution can be handled via Postman Application.

Header part can be handled via Postman Application

Success Output

{
        "title": "Response of device count",
        "type": "object",
        "properties": {
            "model": {
                "type": "object",
                "properties": {
                    "deviceCount": {
                        "type": "number",
                        "description": "Count of device inside these group. Appears when group id is valid"
                    },
                }
            },
            "status":{
                "enum": [
                    "SUCCESS",
                    "ERROR"
                 ],
                "description": "Identifier of execution status"
            },
            "errors":{
                "type": "object",
                "properties": {
                    "companyId": {
                        "type": "string",
                        "description": "Description regarding errors"
                    },
                }
            }
        }
    }

Error Output

Possible  HTTP codes
200	      Ok.
400	      Bad request
401	      Unauthorized
403   	  Forbidden
404	      Not found