Get Device (Company Groups) Tree

Release Time

06/07/2018

Views

5206 times

Tags

get Device Company groups Tree

Description

This resource provide Device Tree

Scheme

https

Host

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

Path

/api/rest/v1/structure/device-company-groups-tree

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

See the below links for more detail:

Query Params

Key	Value	Description
groupName	string	optional (for filtering)
companyName	string	optional (for filtering)

Execution

Sample execution can be handled via Postman Application.

{
  "type": "object",
  "properties": {
    "companyIds": {
      "type": "array",
      "items": {
        "type": "int"
      }
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "int"
      }
    }
  }
}

Header part can be handled via Postman Application

Success Output

{
    "title": "List of nodes",
    "type": "object",
    "properties": {
        "treeNodes": {
            "type": "array",
            "items": {
                "id": "__node",
                "type": "object",
                "description": "Node object representation",
                "properties": {
                    "nodes": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "$ref": "__node"
                        }
                    },
                    "extraData": {
                        "type": "object",
                    }
                }
            }
        }
    },
    "required": ["treeNodes"]
}

Error Output

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