EN
Español
English
Português
    Devices/Get the Device List Summary

    Request Details/Get the Device List Summary

    Verb:POST
    URL: *{url}/device/list


    Parameters

    Parameters for this request that must be sent in the body of the request:

    Field Description Guy Obligatory Possible values
    updateDate Date value that the modification is filtered Date No -
    search Value by which it will be filtered in the search Text No Values that can be used for search:
    - Name
    - IpAddress
    - Domain
    - Manufacturer
    - Model
    -Serial
    orderField Field by which the list will be sorted Text Yes name,
    userName,
    description,
    responsibleUserName
    orderType Field indicating sort type, ascending or descending Text Yes ASC, DESC
    pageSize This field indicates the number of results expected in the response Whole yes -
    pageIndex This field indicates the result number we have obtained in previous queries, this field is used in conjunction with pageSize for pagination Whole yes -


    Answer

    • Code: 200 – Successful Answer:True
    Field Description Guy
    agentProfile Describes the agent profile assigned to the device Text
    agentVersion Describes the agent’s profile version Text
    completeIpAddress Device IP address Text
    cpuCore Number of CPU Nuclei Whole
    cpuLogic Number of logical cores Whole
    creationDate Date of creation of the device in ADM Text
    daysSinceLastInventory Days since the last inventory of the device was taken Whole
    diskAviable Amount of disk available Numerical
    diskTotal Disk size quantity Numerical
    Description Description given to the device Text
    Discovery Reports if the device was discovered Boolean
    diskUsage Hard Disk Usage Percentage Numerical
    Domain Domain to which the device belongs Text
    Id Device Identifier Whole
    ipRegistred IP with which the device was registered Text
    ipAddress List of IP addresses assigned to the device Text Listing
    lastInventory Date on which the last inventory was run Date
    macAddress List of mac addresses assigned to the device Text Listing
    macAddressRegister Registered mac address Alfanumeric
    maufacturer Device Manufacturer Text
    memoryUsage Memory usage percentage Numerical
    model Device Model Text
    Name Device Name Text
    operatingSystem Device operating system Text
    operatingSystemVersion Version of the operating system installed on the device Text
    responsibleUserEmail Email from the device manager Text
    responsibleUserId Device Owner Identifier Text
    responsibleUserName Name of the person responsible for the device Text
    serial Machine Serial Text
    status Device status Text
    totalRam Total RAM of the device Numerical
    type Device Type (0 = Desktop, 1 = Laptop, 2 = Server, 3 = Printer, 4 = Switch, 5 = Router). The above are predefined by ADM. If custom types were created, the ID can be consulted in the following table to know its equivalence: AAM_DEVICE_TYPE. Whole
    userName Username on the machine Text
    vistualization Virtualization Type (Esxi55, HyperV2) Text
    • Code: 400 - Bad request Answer: Error Description Message
    • Code: 401- Error: Unauthorized Answer: Authorization has been refused

    • Code: 500 - Internal Error Server Answer: Error Description Message

    • BadRequest Search parameters not sent
    • ValidationError If one of the required values is not sent