RCI service REST API documentation version v1
{schema}://{host}/api/{version}
- schema: required (one of http, https - default: http)
- host: required (string - default: localhost)
- version: required (v1)
Commands
Command invocation.
{schema}://{host}/api/{version}
Command invocation.
Invokes command on the endpoint and returns its result in a response. Body can be any valid json that is meaningful for the target endpoint.
RCI supports OAuth 2.0 for authenticating all API requests.
Unique endpoint identifier.
Represents the type of the command client wants to invoke on the endpoint. Command type MUST be a non-empty alpha-numeric string identifying the command type to the endpoint.
Used to send an OAuth 2.0 JWT.
Example:
Authorization: bearer {your-access-token}
Media type: application/json
Type: any
Example:
GOTO:
{
"latitude": 17.7499989,
"longitude": 142.4824904
}
Command was invoked successfully.
Media type: application/json
Type: object
Properties
Detailed description.
Example:
GOTO:
{
"message": "Command has been successfully performed by the endpoint."
}
Missing endpointId or user does not have permissions to perform this operation.
A request method is not supported for the requested endpoint.
Media type: application/json
Type: object
Properties
Detailed error description.
Example:
GOTOERR:
{
"message": "Command you are trying to invoke is not supported by the endpoint."
}
Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.