5. API Version (/version)

Description

Operation for obtaining the current API version.

Request

To start the operation, make a HTTP GET request to an HTTP URL of the following form:

https://{service}/v1/version

Authorization
Authorization is not required.

Request parameters
No additional Parameters are required.

Request headers
No additional Headers are required.

Request body
The body part is not used for the HTTP GET requests.

Response

A response with a 200 OK status specifying that the request was correctly processed will be
returned. The response is a JSON representation.

Example

HTTP/1.1 200 OK
Content-Type: application/json

{"version":"1.0.0"}

In case of error, the response will indicate a status other than 200 OK.

Response parameters
No additional Parameters are returned.

Response headers
The following Headers may be present in the HTTP response:

  • Content-Type - the content type of the document model.
Content-Type: application/json

Response body
JSON representation containing the following fields:

  • version - API version.
{"version":"1.0.0"}

Did this page help you?