Obseron REST API - Counters

Counters

Endpoint: https://server:port/api/counters

Supported actions: GET, POST, DELETE, PATCH

Examples:

GET    https://server:port/api/counters
GET    https://server:port/api/counters/1894cbb2-796d-4799-9a11-c5408568723d
PATCH  https://server:port/api/counters/1894cbb2-796d-4799-9a11-c5408568723d
POST   https://server:port/api/counters
DELETE https://server:port/api/counters/1894cbb2-796d-4799-9a11-c5408568723d

Permissions:

POST:   Accessing settings
DELETE: Accessing settings
PATCH:  Accessing settings

Add a new counter ("value" field is not mandatory):

POST https://server:port/api/counters
{
    "name": "New counter",
    "value": 0
}

POST Response:

{
   "id": "c7c34c3b-4c4d-4b15-adea-07c557982758",
   "name": "New counter",
   "value": 0
}

Change the name of the counter:

PATCH https://server:port/api/counters/c7c34c3b-4c4d-4b15-adea-07c557982758
{
    "name": "New counter renamed"
}

POST Response:

{
   "id": "c7c34c3b-4c4d-4b15-adea-07c557982758",
   "name": "New counter renamed",
   "value": 0
}

Change the value of the counter:

PATCH https://server:port/api/counters/c7c34c3b-4c4d-4b15-adea-07c557982758
{
    "value": 12
}

PATCH Response:

{
   "id": "c7c34c3b-4c4d-4b15-adea-07c557982758",
   "name": "New counter renamed",
   "value": 12
}