Bagtower Production (v2.0)

Download OpenAPI specification:Download

API for the Bagtower application

Authentication

api_key

Security Scheme Type API Key
Header parameter name: x-api-key

authorizer-bagtower-dev

A JWT athorizer, requires user credentials

Security Scheme Type API Key
Header parameter name: Authorization

AlertSettings

GET alertSettings

Get all defined alert settings templates

Authorizations:

Responses

200

200 response

401

401 response

500

500 response

get/alertSettings
https://api.bagtower.bag-era.fr/production/alertSettings

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Items":
    [
    ]
}

POST alertSettings/

Create a new alert template

Authorizations:
Request Body schema: application/json
Items
Array of objects (alertSetting)

Responses

201

201 response

401

401 response

403

403 response

404

404 response

500

500 response

post/alertSettings
https://api.bagtower.bag-era.fr/production/alertSettings

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Items":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Items":
    [
    ]
}

POST alertSettings/attach

Activate one or multiple alertSetting for a device

Authorizations:
Request Body schema: application/json
companyId
required
string

Id of the company of the device

alertSettings
Array of strings

List of alert settings to associate

deviceId
required
string

Id of the device to associate

Responses

201

201 response

401

401 response

403

403 response

404

404 response

500

500 response

post/alertSettings/attach
https://api.bagtower.bag-era.fr/production/alertSettings/attach

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "companyId": "string",
  • "alertSettings":
    [
    ],
  • "deviceId": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alertStatus": true,
  • "period": 60,
  • "types": { },
  • "frames":
    [
    ],
  • "companyName": "string",
  • "lastStateChangeTs": 0,
  • "pool": true,
  • "keyId": "string",
  • "alertData": { },
  • "deviceId": "string",
  • "deviceName": "string",
  • "createdTs": 0,
  • "enabled": true,
  • "alertsList":
    [
    ],
  • "tags":
    [
    ],
  • "companyId": "string",
  • "modifiedTs": 0,
  • "alertSettings":
    [
    ],
  • "group": "string",
  • "status": "string"
}

POST alertSettings/detach

Desactivate an alertSetting for a device

Authorizations:
Request Body schema: application/json
companyId
required
string

Id of the company of the device

alertSettings
Array of strings

List of alert settings to associate

deviceId
required
string

Id of the device to associate

Responses

201

201 response

401

401 response

403

403 response

404

404 response

500

500 response

post/alertSettings/detach
https://api.bagtower.bag-era.fr/production/alertSettings/detach

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "companyId": "string",
  • "alertSettings":
    [
    ],
  • "deviceId": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alertStatus": true,
  • "period": 60,
  • "types": { },
  • "frames":
    [
    ],
  • "companyName": "string",
  • "lastStateChangeTs": 0,
  • "pool": true,
  • "keyId": "string",
  • "alertData": { },
  • "deviceId": "string",
  • "deviceName": "string",
  • "createdTs": 0,
  • "enabled": true,
  • "alertsList":
    [
    ],
  • "tags":
    [
    ],
  • "companyId": "string",
  • "modifiedTs": 0,
  • "alertSettings":
    [
    ],
  • "group": "string",
  • "status": "string"
}

PATCH alertSettings/detach

Desactivate an alertSetting for a device

Authorizations:
Request Body schema: application/json
companyId
required
string

Id of the company of the device

alertSettings
Array of strings

List of alert settings to associate

deviceId
required
string

Id of the device to associate

Responses

201

201 response

401

401 response

403

403 response

404

404 response

500

500 response

patch/alertSettings/detach
https://api.bagtower.bag-era.fr/production/alertSettings/detach

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "companyId": "string",
  • "alertSettings":
    [
    ],
  • "deviceId": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "alertStatus": true,
  • "period": 60,
  • "types": { },
  • "frames":
    [
    ],
  • "companyName": "string",
  • "lastStateChangeTs": 0,
  • "pool": true,
  • "keyId": "string",
  • "alertData": { },
  • "deviceId": "string",
  • "deviceName": "string",
  • "createdTs": 0,
  • "enabled": true,
  • "alertsList":
    [
    ],
  • "tags":
    [
    ],
  • "companyId": "string",
  • "modifiedTs": 0,
  • "alertSettings":
    [
    ],
  • "group": "string",
  • "status": "string"
}