Definitions

Security

simple_auth

Basic authentication using Username and *Password*credentials sent using the Authorization header.

Type : basic

token_cookie

API Key authentication using a session token. In order to retrieve a session token, authenticate using the simple_auth security scheme to the /management/sessions/ endpoint. Pass this token to the respective endpoint setting the gfresttoken cookie value.

Currently the OpenAPIv2.0 specification does not support cookies to send the API key.

Type : apiKey
Name : gfresttoken
In : COOKIE

Command

Holds information for command objects that can be used to execute non CRUD operations.

Name Description Schema

command optional

The name of the command.

String

method optional

The HTTP method needed to invoke the command. Either GET, POST or DELETE

String

path optional

The relative path to the resource that represents the command. This path is relative to the URL of the target`s resource.

String

GeneralResult

Represents the general result of an administration or monitoring operation.

Name Description Schema

command optional

The name of the resource/object that is the target of the operation (in case of a successful operation) or the name of the method or command executed (in case of a failed operation).

String

exit_code optional

The result of the operation’s execution, either SUCCESS or FAILURE

string

message optional

Details the message the server sends in case of encountering an error in executing the operation. If no error was encountered, this property is empty.

String

LogRecord

Represents a log record in the target domain.

Name Description Schema

Message optional

A unique identifier for the message that consists of a module code and a numerical value.

string

loggedDateTimeInMS optional

The timestamp for this record in UNIX time format.

integer(int64)

loggedLevel optional

The level of the logged event (EMERGENCY, ALERT, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, and FINEST)

string

loggerName optional

Name of the logger that registered the log event.

string

messageID optional

Identifier of the logged event.

string

nameValuePairs optional

Contains a key-value tuple of the ID and name of the thread that created the message in the format _ThreadID=thread-id;_ThreadName=thread-name;

string

productName optional

A shorthand alias for the product’s edition, profile and version, e.g. Payara 4.1

string

recordNumber optional

The identifier of this log record in a numerical format

integer(int32)

Method

Holds information for a method object that is used for executing CRUD operations of resources.

Name Description Schema

messageParameters optional

A set of metadata information for the method`s body parameters. Only available for POST methods.

< string, MethodParameter > map

name optional

The name of the method, one of GET, POST or DELETE

string

queryParameters optional

A set of metadata information for the method`s query parameters. Only available for GET methods.

< string, MethodParameter > map

MethodParameter

Describes the structure for a method`s message or query parameter.

Name Description Schema

acceptableValues optional

A text that describes the range of possible values for the parameter`s value.

string

defaultValue optional

The default value of the parameter if omitted.

string

key optional

Indicates whether the parameter is a key for the method.

boolean

optional optional

Indicates whether the parameter is optional or mandatory for the method execution.

boolean

type optional

The data type of the parameter, one of boolean, string or int.

string

MonitoringResult

Represents the result of a monitoring operation when querying for a specific resource.

Polymorphism : Composition

Name Description Schema

command optional

The name of the resource/object that is the target of the operation (in case of a successful operation) or the name of the method or command executed (in case of a failed operation).

string

exit_code optional

The result of the operation’s execution, either SUCCESS or FAILURE

string

extraProperties optional

A group of additional properties that contains the statistics results and child resources for monitoring.

extraProperties

message optional

Details the message the server sends in case of encountering an error in executing the operation. If no error was encountered, this property is empty.

string

extraProperties

Name Description Schema

childResources optional

A list of child resources for the target resource. Each child resource is specified as a key-value pair of the resource`s name and it`s URL. This property is only available for the results of query operations.

< string, string(url) > map

entity optional

A list of the metric information and statistics retrieved since the last monitoring was executed. Each property of this object represents a separate metric/statistic.

< string, Statistic > map

OperationResult

Represents the result of an administration operation executed when targeting a resource.

Polymorphism : Composition

Name Description Schema

command optional

The name of the resource/object that is the target of the operation (in case of a successful operation) or the name of the method or command executed (in case of a failed operation).

string

exit_code optional

The result of the operation’s execution, either SUCCESS or FAILURE

string

extraProperties optional

A group of additional properties that contain context information about the resource and the operations this resource supports.

extraProperties

message optional

Details the message the server sends in case of encountering an error in executing the operation. If no error was encountered, this property is empty.

string

extraProperties

Name Description Schema

childResources optional

A list of child resources for the target resource. Each child resource is specified as a key-value pair of the resource`s name and it`s URL. This property is only available for the results of query operations.

< string, string(url) > map

commandLog optional

A string detailing the exact asadmin command executed on the server. This property is only available for the results of add, update or delete operations.

string

commands optional

A list of metadata sets of the available non-CRUD operations (asadmin subcommands) that can be executed on the target resource. This property is only available for the results of query operations.

< Command > array

entity optional

Represents the current configuration of a resource. Each property of the resource is configured as a key-value pair of the object itself.

< string, string > map

methods optional

A list of metadata sets of available CRUD methods that the target resource supports. This property is only available for the results of query operations.

< Method > array

Statistic

Represents compilation data for the metric of a resource’s statistics.

Name Description Schema

count optional

The current value of the statistic. Used for count statistics.

integer(int32)

current optional

The current value of the statistic since its monitoring began. Used for ranged/string/time statistics

integer(int32)

description optional

A text that describes what the statistic represents.

string

highwatermark optional

The highest value of the statistic since its monitoring began. Used for ranged statistics

integer(int32)

lastsampletime optional

The time at which the statistic was last sampled in UNIX format.

integer(int32)

lowwatermark optional

The lowest value of the statistic since its monitoring began. Used for ranged statistics

integer(int32)

name optional

The name of the statistic as shown in client applications

string

starttime optional

The time at which the monitoring of the statistic began in UNIX format

integer(int32)

unit optional

The unit of measurement of the statistic, which is one of the following units of measurement:

  • count - The cumulative value of an attribute.

  • range - The lowest, highest and current value of an attribute over time.

  • boundedrange - Same as range, but with fixed limits.

  • string - Used to represent the textual state of an object (for example CONNECTED, DISCONNECTED)

  • time - Values of an attribute that are used to provide timing measurements (time taken to perform an operation, average time, etc.)

string

TokenResult

Represents the result of requesting a session token.

Polymorphism : Composition

Name Description Schema

command optional

The name of the resource/object that is the target of the operation (in case of a successful operation) or the name of the method or command executed (in case of a failed operation).

string

exit_code optional

The result of the operation’s execution, either SUCCESS or FAILURE

string

extraProperties optional

Holds the session token

extraProperties

message optional

Details the message the server sends in case of encountering an error in executing the operation. If no error was encountered, this property is empty.

string

extraProperties

Name Description Schema

token optional

A session token used for authenticating user requests

string