server/info

Gets meta-information about the current API.

Request Message

Authorization

None

Message Representation

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

Message Parameters

Property NameRequiredTypeDescription
actionYesstringAction name: server/info
requestIdNoobjectRequest 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 NameTypeDescription
actionstringAction name: server/info
statusstringOperation execution status (success or error).
requestIdobjectRequest unique identifier as specified in the request message.
infoobjectThe ApiInfo resource.
info.apiVersionstringAPI version.
info.serverTimestampdatetimeCurrent server timestamp.
info.restServerUrlstringREST server URL.