Skip to main content

"describeServices"

JSON ADMIN "describeServices" action returns session objects that the logged-in account is authorized to view

The "describeServices" action returns session objects that the logged-in account is authorized to view.

Essential information

  • When the "params" property is omitted, the "describeServices" action returns information about the current session and all other sessions directly created by the account.

  • Placeholder

Request examples

Minimal request

Maximal request
Response examples
Successful response
Failure response
Use the describeSession API action to return information about the services
API actionsJSON ADMIN APIjsonActionadmin servicedescribeServicedescribeServicesdescribesServicedescribesServicesdescribe service
"params"
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Property summary
Table 1. "params" property summaries
Property
Description
Default
Type
Limits (inclusive)
"authTokens"
contains one or more authorization token strings
[]
array
At least one "authToken"


"result"
The "result" property is a required object set by the server that contains the result of an action.
Essential information:
Properties summary
Table 2. "result" property summaries
Property
Description
Type
Limits (inclusive)
"authToken"
signifies that the client is authenticated and authorized
string
Minimum length: 0
Maximum length: 255
"defaultBinaryFormat"
specifies the default value for the "binaryFormat" property, which tells the server how to parse binary data from the client when the binary format is not specified in the action request
string
"base64"
"hex"
"defaultDatabaseName"
specifies the default value of the "databaseName" property
string
Minimum length: 1
Maximum length: 64
"defaultOwnerName"
specifies the initial value of the "defaultOwnerName" property used by JSON APIs and FairCom's web application
string
Minimum length: 1
Maximum length: 64
"defaultResponseOptions"
specifies a default value for "responseOptions" that is used by default in all other action calls. "includeFields" and "excludeFields" are mutually exclusive and "includePaths" and "excludePaths" are mutually exclusive
object
One of the following:
"includeFields"
"excludeFields"
"includePaths"
"excludePaths"
"omit" 
"numberFormat"
"dataFormat"
"description"
describes an object for later identification
string
Minimum length: 0
Maximum length: 65,500
"idleConnectionTimeoutSeconds"
specifies the number of seconds that a session with no activity will stay open
integer
0 - 2147483647
"idleCursorTimeoutSeconds"
specifies the number of seconds to keep a cursor open
integer
0 - 2147483647
"username"
specifies the account name of a user or application
string
Minimum length: 1
Maximum length: 64


"authToken"
The "authToken" property signifies that the client is authenticated and authorized. It is required.
Essential information
  • It is supplied by the server in response to the connect action.
  • Clients must include it in all subsequent requests to validate that the client is authenticated and authorized. If the client does not supply the correct values, the server returns an unauthorized error.
"defaultResponseOptions"
The "defaultResponseOptions" property is a "responseOptions" object. It defines a default value for "responseOptions" that is used by default in all other action calls. It defaults to an empty object.
Essential information
  • JSON NAV allows you to choose how your program detects errors. By default, all error properties are included in each response – unless you override this behavior as shown in the example.
  • The example omits the error object in all responses and omitting the error object makes it easier for statically typed languages, such as C, C++, Java, C#, and VB, because they prefer properties to always be present. To help these languages, the "errorCode", "errorMessage", and "errorData" properties are always present whether there is an error or not.
Example
"defaultResponseOptions": {
      "dataFormat": "objects",
      "numberFormat": "string",
      "binaryFormat": "hex"
    }
"dataFormat"
The "dataFormat" property is an optional, case-insensitive string enum that defines the format of the response in the "data" property. The default format is an array of arrays. The alternative is an array of objects. The default for "dataFormat" can be changed during a "createSession" action by assigning a different value to the "dataFormat" property in "defaultResponseOptions".
There are three different (but similar) versions of the "dataFormat" property:
Two of those versions occur in a request and another occurs in a response. They all indicate how data is formatted.
  • "dataFormat" in the request inside "responseOptions" determines how the "data" property in the response is formatted.
    Possible values include:
    • "arrays"
      This is the default and causes the server to return results as an array of arrays, which is the most efficient.
    • "objects"
      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
  • "dataFormat" in the request in the "params" object notifies the server how the "sourceData" property is formatted in the request. This version is rarely used because of the default "autoDetect" behavior.
    Possible values include:
    • "arrays"
      This causes the server to return results as an array of arrays, which is the most efficient.
    • "objects"
      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
    • "autoDetect"
      This is the default and causes the server to automatically detect the format of the data in the "sourceData" property.
  • "dataFormat" in the response shows the client how the server formatted the "data" property.
    Possible values include:
    • "arrays"
      This is the default and causes the server to return results as an array of arrays, which is the most efficient.
    • "objects"
      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.
"idleConnectionTimeoutSeconds"
The "idleConnectionTimeoutSeconds" property is an optional integer from 0 to 2,147,483,647. It is the number of seconds that a session with no activity will stay open.
Essential information
  • Each time a session executes an operation, the session timer restarts.
  • A value of 0 keeps a session open indefinitely.
"idleCursorTimeoutSeconds"
The "idleCursorTimeoutSeconds" property is an optional integer from 0 to 2,147,483,647. It is the number of seconds to keep a cursor open.
Essential information
  • Each time a cursor retrieves records, the cursor timer restarts.
  • A value of -1 keeps a cursor open indefinitely.
  • A value of 0 immediately closes a cursor after the current operation.
"username"
The "username" property is a required string from 1 to 64 bytes. It is the account name of a user or application.
Essential information
  • It is required by the "createSession" action for authentication.
  • All API actions are performed in the context of the account identified by "username". For example, all tables created by an account are owned by the account. All queries use tables owned by the account.
  • In JSON DB API and JSON Hub API, use the "ownerName" property to cause an action to use a different account name than the value of "username". This allows an account to use tables created by another account and to create tables that are owned by another account.
  • Unlike other property names, such as "databaseName", "username" is all lowercase.
  • A zero-length username is invalid.