Balluff BVS ID-M1280 F1 Series, Configuration Manual

Page: 225 / 316

BVS ID-M1280xF1-xx-xxx
english 67
4.2.3 Available resources and requests
4.2.3.1 GET requests
Get API version
Resource: versions
URL: http://HOSTNAME/api/balluff/versions
Response:
Object Content
description Description of the API version.
url The version number how it is used in the URL.
version The current API version.
Example:
[
[
{
"description" : "Current version of the REST API" ,
"url" : "v1" ,
"version" : "1.0.0"
}
]
]
Get API description
Resource: apidocs
URL: http://HOSTNAME/api/balluff/v1/apidocs
Response: A YAML file containing a description of all available REST commands.
Contrary to all the other commands, the version number is not part of the URL. 
NOTE
The YAML file can be visualized via a swagger editor e.g. https://swagger.io/tools/swagger-editor/
