Device list

Release Time

06/07/2018

Views

21786 times

Execution

Sample execution can be handled via Postman Application.

{
  "title": "Request for device list",
  "type": "object",
  "properties": {
    "search": {
      "type": "object",
      "properties": {
        "attributes": {
          "groupIds": {
            "type": "object",
            "properties": {
              "value": {
                "type": "array",
                "items": {
                  "type": "int"
                }
              },
              "type": {
                "type": "string"
              }
            }
          },
          "companyIds": {
            "type": "object",
            "properties": {
              "value": {
                "type": "array",
                "items": {
                  "type": "int"
                }
              },
              "type": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Header part can be handled via Postman Application

Success Output

{
  "title": "Device list response",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "int"
          },
          "id_owner": {
            "type": "int"
          },
          "uuid": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "model": {
            "type": "string"
          },
          "os_version": {
            "type": "string"
          },
          "byod_type": {
            "type": "int"
          },
          "formfactor": {
            "type": "int"
          },
          "mdm_token": {
            "type": "string"
          },
          "lock_type": {
            "type": "int"
          },
          "added_at": {
            "type": "int"
          },
          "was_active_at": {
            "type": "int"
          },
          "online_status": {
            "type": "int"
          },
          "online_status_at": {
            "type": "int"
          },
          "is_rooted": {
            "type": "bool"
          },
          "is_deleted": {
            "type": "bool"
          },
          "friendly_name": {
            "type": "string"
          },
          "allow_auto_rename": {
            "type": "bool"
          },
          "has_dm_client": {
            "type": "bool"
          },
          "predefined_components": {
            "type": "object",
            "properties": {
              "ces": {
                "type": "bool"
              },
              "rmm": {
                "type": "bool"
              }
            }
          },
          "os_type": {
            "type": "int"
          },
          "patches_available_count": {
            "type": "int"
          },
          "patches_status": {
            "type": "int"
          },
          "active_components_html": {
            "type": "string"
          },
          "is_ces_installed": {
            "type": "bool"
          },
          "exported_configuration_exist": {
            "type": "bool"
          },
          "owner": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string"
              },
              "id": {
                "type": "int"
              },
              "email": {
                "type": "string"
              }
            }
          },
          "company": {
            "type": "object",
            "properties": {
              "username": {
                "type": "string"
              },
              "id": {
                "type": "int"
              },
              "email": {
                "type": "string"
              },
              "subdomain": {
                "type": "string"
              }
            }
          },
          "is_online": {
            "type": "bool"
          },
          "is_online_http": {
            "type": "bool"
          },
          "rmm_host": {
            "type": "string"
          },
          "takeover_enable": {
            "type": "bool"
          },
          "ccv_version": {
            "type": "string"
          },
          "is_support_new_crc_takeover": {
            "type": "bool"
          },
          "agent_version": {
            "type": "string"
          },
          "ccs_version": {
            "type": "string"
          }
        }
      }
    },
    "pagination": {
      "type": "object",
      "properties": {
        "pageSize": {
          "type": "int"
        },
        "pageCount": {
          "type": "int"
        },
        "offset": {
          "type": "int"
        },
        "itemCount": {
          "type": "int"
        },
        "currentPage": {
          "type": "int"
        }
      }
    }
  }
}

Error Output

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

Key	Value	Description
Http method	POST	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