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.

/endpoints/{endpointId}/commands/{commandType} post

post /endpoints/{endpointId}/commands/{commandType}

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.

Secured by oauth_2_0 with scopes:
  • endpoint:update

RCI supports OAuth 2.0 for authenticating all API requests.

URI Parameters

  • endpointId: required (string)

    Unique endpoint identifier.

  • commandType: required (string)

    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.

Headers

  • Authorization: required (string)

    Used to send an OAuth 2.0 JWT.

    Example:

    Authorization: bearer {your-access-token}

Body

Media type: application/json

Type: any

Example:

GOTO:

{
  "latitude": 17.7499989,
  "longitude": 142.4824904
}

HTTP status code 200

Command was invoked successfully.

Body

Media type: application/json

Type: object

Properties

  • message: required (string)

    Detailed description.

Example:

GOTO:

{
  "message": "Command has been successfully performed by the endpoint."
}

HTTP status code 404

Missing endpointId or user does not have permissions to perform this operation.

HTTP status code 405

A request method is not supported for the requested endpoint.

Body

Media type: application/json

Type: object

Properties

  • message: required (string)

    Detailed error description.

Example:

GOTOERR:

{
  "message": "Command you are trying to invoke is not supported by the endpoint."
}

Secured by oauth_2_0

Headers

  • Authorization: (string)

    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.