Request

GET /api/requests

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/requests[/:request_id]

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Job

GET /api/console-task

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/console-task

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/console-task

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/console-task[/:console_task_id]

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/console-task[/:console_task_id]

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/console-task[/:console_task_id]

Fields

Field Type Description Required
state YES
creator YES
command YES
parameters YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CronJobs

GET /api/cron-jobs[/:cron_logs_id]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/cron-jobs[/:cron_logs_id]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

CurrencyExchangeRate

GET /api/currency-exchange-rate

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/currency-exchange-rate

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/currency-exchange-rate

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/currency-exchange-rate[/:currency-exchange-rate_id]

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/currency-exchange-rate[/:currency-exchange-rate_id]

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/currency-exchange-rate[/:currency-exchange-rate_id]

Fields

Field Type Description Required
state YES
title YES
currency YES
destinationCurrency NO
destinationCurrency YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Currency

GET /api/currency

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/currency

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/currency

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/currency[/:currency_id]

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/currency[/:currency_id]

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/currency[/:currency_id]

Fields

Field Type Description Required
state YES
name YES
code YES
symbol YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Datatable

Datatable service methods

POST /api/datatable

Fields

Field Type Description Required
draw integer NO
columns array YES
start integer YES
length integer YES
search array NO
filter array NO
source string NO
dql string NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded
Content-Type
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/datatable[/:datatable_id]

Fields

Field Type Description Required
draw integer NO
columns array YES
start integer YES
length integer YES
search array NO
filter array NO
source string NO
dql string NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/datatable[/:datatable_id]

Fields

Field Type Description Required
draw integer NO
columns array YES
start integer YES
length integer YES
search array NO
filter array NO
source string NO
dql string NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded
Content-Type
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/x-www-form-urlencoded
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DeveloperLogs

GET /api/developer-logs

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/developer-logs

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/developer-logs

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/developer-logs[/:developer_logs_id]

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/developer-logs[/:developer_logs_id]

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/developer-logs[/:developer_logs_id]

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/developer-logs[/:developer_logs_id]

Fields

Field Type Description Required
environment YES
result YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

DocumentsTemplate

GET /api/documents-template

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/documents-template

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/documents-template

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/documents-template[/:template_id]

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/documents-template[/:template_id]

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/documents-template[/:template_id]

Fields

Field Type Description Required
state YES
name YES
entityClass YES
type YES
owner YES
renderer YES
documentType YES
isFile NO
template YES
conditions NO
domain NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Request

GET /api/requests

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/requests[/:request_id]

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

EntityVersion

GET /api/entity-versions

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/entity-versions[/:entity-version_id]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/entity-versions[/:entity-version_id]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Device

GET /api/device

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/device

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/device

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/device[/:device_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/device[/:device_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/device[/:device_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/device[/:device_id]

Fields

Field Type Description Required
name/name YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Task

GET /api/devices/task

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/devices/task

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/devices/task

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/devices/task[/:task_id]

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/devices/task[/:task_id]

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/devices/task[/:task_id]

Fields

Field Type Description Required
id NO
device YES
priority YES
state NO
data NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
application/pdf
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
application/pdf
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Article

GET /api/help/article

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/help/article

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/help/article

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/help/article[/:article_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/help/article[/:article_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/help/article[/:article_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Section

GET /api/help/section

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/help/section

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/help/section

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/help/section[/:section_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/help/section[/:section_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/help/section[/:section_id]

Fields

Field Type Description Required
name/name NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

InputFilter

GET /api/input-filter

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/input-filter[/:input_filter_id]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Length

GET /api/length

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/length

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/length

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/length[/:length_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/length[/:length_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/length[/:length_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/length[/:length_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Request

GET /api/requests

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/requests[/:request_id]

Fields

Field Type Description Required
state NO
request NO
environment NO
result NO

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Statistic

GET /api/statistics[/:module][/:report][/:actions]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/statistics[/:module][/:report][/:actions]

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

Weight

GET /api/weight

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/weight

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/weight

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

GET /api/weight[/:weight_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

POST /api/weight[/:weight_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 201: Created
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

PATCH /api/weight[/:weight_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json
Content-Type
application/vnd.application\api.v1+json
application/json

Body


                                            

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 200: OK
  • 404: Not Found
  • 400: Client Error
  • 422: Unprocessable Entity

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed

Body


                                            

DELETE /api/weight[/:weight_id]

Fields

Field Type Description Required
state YES
title YES
unit YES

Request

Headers

Header Value
Accept
application/vnd.application\api.v1+json
application/json

Response

Status Codes

  • 406: Not Acceptable
  • 415: Unsupported Media Type
  • 204: No Content
  • 404: Not Found

Headers

Header Value
Content-Type
application/vnd.application\api.v1+json
application/json
Allow Comma-separated list of all HTTP methods allowed