View

View one or more clients

Tokens

This action requires the following tokens:

  • client-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
client Label   Only show the client with the given label
searchname String   Only show clients containing the given string somewhere in the name
formfactor Label   Only show clients with the given form factor
searchformfactor String   Only show clients containing the given string somewhere in the formfactor name
os Label   Only show clients with the given OS
osversion String   Only show clients having the given OS version
searchos String   Only show clients containing the given string somewhere in the OS name
searchosversion String   Only show clients containing the given string somewhere in the OS version
software Label   Only show clients with the given software
softwareversion String   Only show clients having the given software version
searchsoftware String   Only show clients containing the given string somewhere in the software name
searchsoftwareversion String   Only show clients containing the given string somewhere in the software version
softwaretype Label   Only show clients with the given software type
searchsoftwaretype String   Only show clients containing the given string somewhere in the software type name
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String label

Defines the field to order the results by; can be any of the following:

  • label – Order lexicographically by label
  • name – Order lexicographically by name
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
label Label Label of this client
name String Name of this client
formfactor

Formfactor of this client

The value of this field is an object containing the following fields:

Name Type Description
label Label Label of this form factor
name String Name of this form factor
os

Operating system of this client

The value of this field is an object containing the following fields:

Name Type Description
label Label Label of this OS
name String Name of this OS
version String Version of this OS
software

Software of this client

The value of this field is an object containing the following fields:

Name Type Description
label Label Label of this software
name String Name of this software
version String Version of this software
softwaretype

Software type of this client

The value of this field is an object containing the following fields:

Name Type Description
label Label Label of this software type
name String Name of this software type

Errors

This action will always return one of the default status codes.