Versions Compared

Old Version 20

changes.mady.by.user Mark Unwin

Saved on

compared with

New Version 21

changes.mady.by.user Mark Unwin

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TypeEndpoint  
GET/devicesReturn a collection of devices with the default set of columns from the system table (system.system_id, system.icon, system.man_type, system.hostname, system.domain, system.man_ip_address, system.man_description, system.man_os_family, system.man_status) 
GET/devices/{id}Return an individual devices details. 
GET/devices?subresourcesub_resource={subresource sub_resource name}To return all items in a subresource sub_resource for a collection of devices. If you wanted all software you would use http://{server}/open-audit/index.php/devices?sub_resource=software 
GET/devices/{id}?subresourcesub_resource={subresource sub_resource name}To return all items in a subresource sub_resource for a specific device. 
GET/devices?sub_resource={subresource sub_resource name}&sub_resource_id={subresource sub_resource id}To return a specific item in a subresource sub_resource for a collection of devices - not especially useful. You would more likely use the below (request a subresource sub_resource items from a specific device) 
GET/devices{id}?sub_resource={subresource sub_resource name}&sub_resource_id={subresource sub_resource id}To return a specific subresource sub_resource item for a specific device. 
POST | PUT | PATCH/devices/{id}

To update a device attribute. The body of the POST should be JSON formatted using the attribute name 'data'.

An example post updating the description is below.

Code Block
languagejs
data: {
    "id":1,
    "description":"This is a test"
}
 

Device

...

sub_resource Names

NAMENAMENAME

audit_log
bios
change_log
disk
dns
edit_log
ip
log
memory
module
monitor
motherboard

netstat
network
optical
pagefile
partition
print_queue
processor
route
san
scsi
server
server_item 

service
share
software
software_key
sound
task
user
user_group
variable
video
vm
windows

...