server/info

Gets meta-information about the current API.

Request Message

Authorization

None

Message Representation

{
    "action": {string},
    "requestId": {object}
}

Message Parameters

Property Name

Required

Type

Description

action

Yes

string

Action name: server/info

requestId

No

object

Request unique identifier, will be passed back in the response message.

Response Message

Message Representation

{
    "action": {string},
    "status": {string},
    "requestId": {object},
    "info": {
        "apiVersion": {string},
        "serverTimestamp": {datetime},
        "restServerUrl": {string}
    }
}

Message Parameters

Property Name

Type

Description

action

string

Action name: server/info

status

string

Operation execution status (success or error).

requestId

object

Request unique identifier as specified in the request message.

info

object

The ApiInfo resource.

info.apiVersion

string

API version.

info.serverTimestamp

datetime

Current server timestamp.

info.restServerUrl

string

REST server URL.