Structures

The structures of the REST API output are described here.

Each output includes the general header WebAdminInfo, which contains the version of WebAdmin and the REST API, the logged in WebAdmin user and the timestamp of the call:

• WebAdminVersion
• usedApiVersion: The API version specified in the request
• apiVersion
• user
• time

After requesting a list of the UTM applications configured in WebAdmin, the structure applications, which contains an array with information about the configured UTM applications, is output in addition to the WebAdminInfo header:
Each array element contains the unique ID, the computer name, the application name, the operating system type, and the availability of the application at the last contact attempt:

• id
• serverName
• appliName
• osType: Unix / BS2000 / Windows
• availability: yes / no / unknown 

After requesting data from a specific UTM application, the structure applicationInfo, which outputs information about the selected UTM application, and the structure applicationData, which contains the requested data, are output in addition to the header WebAdminInfo:

Structure applicationInfo:

• id
• serverName
• platform
• appliName
• UTMVersion

Example for outputting application data for struct = KC_CURR_PAR:

• KC_CURR_PAR
  • Array with one element:
    • appliname
      • unit: ""
      • datatype: "string"
      • value: "APPLNAME"

etc.

Example for outputting application data for struct = KC_BCAMAPPL:

• KC_BCAMAPPL
  • Array with possibly multiple elements. First element:
    • bc_name
      • unit: ""
      • datatype: "name"
      • value: "BCNAME00"
    • etc.

• • Possibly additional element:
    
    • bc_name
      • unit: ""
      • datatype: "name"
      • value: "BCNAME01"

etc.

Possible values ​​of datatype and their meaning:

Value	Meaning
boolean	true / false / null
enum	There are only defined values
integer	Integer
name	Name of an UTM object
string	Sequence of characters

Possible values ​​of unit and their meaning:

Value	Meaning
	No unit
%	Percent
days	Days
microsec	Microseconds
msec	Milliseconds
per mille	Per mille
sec	Seconds