View

View information about one or more applications

Tokens

This action requires the following tokens:

  • application-read

Arguments

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

Argument Type Default Description
application Hash   Only show the application with the given hash
searchname String   Only show applications containing the given string somewhere in the name
role Hash   Only show applications having this role
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 created

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

  • name – Order lexicographically by name
  • created – Order by the date when the item was created
  • modified – Order by the date when the item was last modified
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
id Hash Application ID
name String Application name
description String Application description
iplock IP Mask IP-lock data for this application
datecreated DateTime When the application was created
datemodified DateTime When the application was last modified
active Boolean Whether this application is active
account Hash Account for this application
customer Hash Customer for this application
timezone TimeZone Timezone for this application

Errors

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