Provisioning Service

Retrieve a specific entity.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When looking for the root entity, the uuid 0000-0000-0000 must be entered.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

No Content

Create a specific entity.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When creating the root entity, the uuid 0000-0000-0000 must be entered. When creating a non-root entity, uuid must be 1

Body

allOfobjectoptional

parentstring · uuidoptional

If empty, then this is the root entity, otherwise this points to a parent entity

childrenstring · uuid[]optional

venuesstring · uuid[]optional

The list of UUID of the venues for this entity

contactsstring · uuid[]optional

The list of UUID of the contacts for the entity

locationsstring · uuid[]optional

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuidoptional

deviceConfigurationstring · uuidoptional

devicesstring · uuid[]optional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

rrmstring · enumoptionalAvailable options:

sourceIPobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "venues": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "locations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicies": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementRoles": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "maps": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "configurations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "rrm": "off",
    "sourceIP": {
      "list": [
        "text"
      ]
    }
  }'

200

403

404

200

No Content

Modify a specific entity.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When modifying the root entity, the uuid 0000-0000-0000 must be entered.

Body

allOfobjectoptional

parentstring · uuidoptional

If empty, then this is the root entity, otherwise this points to a parent entity

childrenstring · uuid[]optional

venuesstring · uuid[]optional

The list of UUID of the venues for this entity

contactsstring · uuid[]optional

The list of UUID of the contacts for the entity

locationsstring · uuid[]optional

The list of UUID of the locations associated with thit entiry

managementPolicystring · uuidoptional

deviceConfigurationstring · uuidoptional

devicesstring · uuid[]optional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

rrmstring · enumoptionalAvailable options:

sourceIPobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "venues": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "locations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicies": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementRoles": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "maps": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "configurations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "rrm": "off",
    "sourceIP": {
      "list": [
        "text"
      ]
    }
  }'

200

403

404

200

No Content

Delete a specific entity.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: The root entity cannot be deleted.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/entity/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of contacts.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of contacts

uuidOnlybooleanoptional

return only the UUIDs of contacts

venuestring · uuidoptional

entitystring · uuidoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/contact' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "contacts": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "type": "SUBSCRIBER",
      "title": "text",
      "salutation": "text",
      "firstname": "text",
      "lastname": "text",
      "initials": "text",
      "visual": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "primaryEmail": "text",
      "secondaryEmail": "text",
      "accessPIN": "text",
      "inUse": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Return a list of contacts

Retrieve a specific contact.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "type": "SUBSCRIBER",
  "title": "text",
  "salutation": "text",
  "firstname": "text",
  "lastname": "text",
  "initials": "text",
  "visual": "text",
  "phones": [
    "text"
  ],
  "mobiles": [
    "text"
  ],
  "primaryEmail": "text",
  "secondaryEmail": "text",
  "accessPIN": "text",
  "inUse": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
}

Success

Create a specific entity.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptionalAvailable options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

inUsestring · uuid[]optional

entitystring · uuidoptional

managementPolicystring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "type": "SUBSCRIBER",
    "title": "text",
    "salutation": "text",
    "firstname": "text",
    "lastname": "text",
    "initials": "text",
    "visual": "text",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "primaryEmail": "text",
    "secondaryEmail": "text",
    "accessPIN": "text",
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Modify a specific contact.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptionalAvailable options:

titlestringoptional

salutationstringoptional

firstnamestringoptional

lastnamestringoptional

initialsstringoptional

visualstringoptional

phonesstring[]optional

mobilesstring[]optional

primaryEmailstringoptional

secondaryEmailstringoptional

accessPINstringoptional

inUsestring · uuid[]optional

entitystring · uuidoptional

managementPolicystring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/contact/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "type": "SUBSCRIBER",
    "title": "text",
    "salutation": "text",
    "firstname": "text",
    "lastname": "text",
    "initials": "text",
    "visual": "text",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "primaryEmail": "text",
    "secondaryEmail": "text",
    "accessPIN": "text",
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Delete a specific contact.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/contact/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of locations.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlybooleanoptional

return the number of Locations

uuidOnlybooleanoptional

return only the UUIDs of Locations

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/location' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "locations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "type": "SERVICE",
      "buildingName": "text",
      "addressLines": [
        "text"
      ],
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phones": [
        "text"
      ],
      "mobiles": [
        "text"
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "geoCode": "text"
    }
  ]
}

Return a list of Locations

Retrieve a specific location.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "type": "SERVICE",
  "buildingName": "text",
  "addressLines": [
    "text"
  ],
  "city": "text",
  "state": "text",
  "postal": "text",
  "country": "text",
  "phones": [
    "text"
  ],
  "mobiles": [
    "text"
  ],
  "inUse": [
    "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "geoCode": "text"
}

Success

Create a specific location.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptionalAvailable options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

managementPolicystring · uuidoptional

geoCodestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "type": "SERVICE",
    "buildingName": "text",
    "addressLines": [
      "text"
    ],
    "city": "text",
    "state": "text",
    "postal": "text",
    "country": "text",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "geoCode": "text"
  }'

200

403

404

200

No Content

Modify a specific location.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

typestring · enumoptionalAvailable options:

buildingNamestringoptional

addressLinesstring[]optional

citystringoptional

statestringoptional

postalstringoptional

countrystringoptional

phonesstring[]optional

mobilesstring[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

managementPolicystring · uuidoptional

geoCodestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/location/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "type": "SERVICE",
    "buildingName": "text",
    "addressLines": [
      "text"
    ],
    "city": "text",
    "state": "text",
    "postal": "text",
    "country": "text",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "geoCode": "text"
  }'

200

403

404

200

No Content

Delete a specific location.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/location/{uuid}?force=true' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of inventory.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

deviceTypestringoptional

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

serialOnlybooleanoptional

only serial numbers of full device details

countOnlybooleanoptional

return the number of devices

withExtendedInfobooleanoptional

return extended information

orderBystringoptional

return extended information

Example: serialNumber:a,created:d

rrmOnlybooleanoptional

return the list of devices under RRM

Default: false

subscriberstring · uuidoptional

return the list of devices under RRM

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/inventory' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

{
  "serialNumbers": [
    "text"
  ]
}

Return a list of elements

Retrieve a specific inventory tag.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

serialNumberstring · uuidrequired

Query parameters

configbooleanoptional

explainbooleanoptional

firmwareOptionsbooleanoptional

applyConfigurationbooleanoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "serialNumber": "text",
  "deviceType": "text",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "qrCode": "text",
  "geoCode": "text",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "contact": "123e4567-e89b-12d3-a456-426614174000",
  "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
  "rrm": "off",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "devClass": "any",
  "locale": "text"
}

Succesful retrieve configuratiopn or part of the configuration

Create a specific Inventory.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

serialNumberstring · uuidrequired

Body

allOfobjectoptional

serialNumberstringoptional

deviceTypestringoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationstring · uuidoptional

contactstring · uuidoptional

deviceConfigurationstring · uuidoptional

rrmstring · enumoptionalAvailable options:

managementPolicystring · uuidoptional

statestringoptional

devClassstring · enumoptionalAvailable options:

localestring · min: 2 · max: 2optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "serialNumber": "text",
    "deviceType": "text",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000",
    "qrCode": "text",
    "geoCode": "text",
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "contact": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "rrm": "off",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "state": "text",
    "devClass": "any",
    "locale": "text"
  }'

200

403

404

200

No Content

Modify a specific inventory.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

serialNumberstring · uuidrequired

removeSubscriberstring · uuidrequired

Query parameters

unassignbooleanoptional

Body

allOfobjectoptional

serialNumberstringoptional

deviceTypestringoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

qrCodestringoptional

geoCodestringoptional

locationstring · uuidoptional

contactstring · uuidoptional

deviceConfigurationstring · uuidoptional

rrmstring · enumoptionalAvailable options:

managementPolicystring · uuidoptional

statestringoptional

devClassstring · enumoptionalAvailable options:

localestring · min: 2 · max: 2optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "serialNumber": "text",
    "deviceType": "text",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000",
    "qrCode": "text",
    "geoCode": "text",
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "contact": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "rrm": "off",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "state": "text",
    "devClass": "any",
    "locale": "text"
  }'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "serialNumber": "text",
  "deviceType": "text",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000",
  "qrCode": "text",
  "geoCode": "text",
  "location": "123e4567-e89b-12d3-a456-426614174000",
  "contact": "123e4567-e89b-12d3-a456-426614174000",
  "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
  "rrm": "off",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "devClass": "any",
  "locale": "text"
}

success

Delete a specific inventory.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

serialNumberstring · uuidrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/inventory/{serialNumber}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of venues.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

deviceTypestringoptional

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of Venues comma separated

Example: serial1,serial2,serial3

serialOnlybooleanoptional

only serial numbers of full device details

countOnlybooleanoptional

return the number of devices

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/venue' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "venues": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "children": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "devices": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "topology": [
        {
          "parent": "123e4567-e89b-12d3-a456-426614174000",
          "child": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "design": "text",
      "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "rrm": "off",
      "sourceIP": {
        "list": [
          "text"
        ]
      },
      "managementPolicies": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "managementRoles": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "maps": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "configurations": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Return a list of venues.

Retrieve a specific venue.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

No Content

Create a specific venue.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

createObjectsobjectoptional

Body

allOfobjectoptional

entitystring · uuidoptional

parentstring · uuidoptional

childrenstring · uuid[]optional

managementPolicystring · uuidoptional

devicesstring · uuid[]optional

topologyobject[]optional

designstringoptional

deviceConfigurationstring · uuidoptional

contactsstring · uuid[]optional

locationstring · uuidoptional

rrmstring · enumoptionalAvailable options:

sourceIPobjectoptional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "topology": [
      {
        "parent": "123e4567-e89b-12d3-a456-426614174000",
        "child": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "design": "text",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "rrm": "off",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "managementPolicies": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementRoles": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "maps": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "configurations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

200

No Content

Modify a specific venue.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entitystring · uuidoptional

parentstring · uuidoptional

childrenstring · uuid[]optional

managementPolicystring · uuidoptional

devicesstring · uuid[]optional

topologyobject[]optional

designstringoptional

deviceConfigurationstring · uuidoptional

contactsstring · uuid[]optional

locationstring · uuidoptional

rrmstring · enumoptionalAvailable options:

sourceIPobjectoptional

managementPoliciesstring · uuid[]optional

The list of UUID of the venues for this entity

managementRolesstring · uuid[]optional

The list of UUID of the venues for this entity

variablesstring · uuid[]optional

The list of UUID of the venues for this entity

mapsstring · uuid[]optional

The list of UUID of the venues for this entity

configurationsstring · uuid[]optional

The list of UUID of the venues for this entity

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "topology": [
      {
        "parent": "123e4567-e89b-12d3-a456-426614174000",
        "child": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "design": "text",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "rrm": "off",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "managementPolicies": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "managementRoles": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "maps": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "configurations": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

200

No Content

Delete a specific venue.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: The root entity cannot be deleted.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/venue/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve the list of maps

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

myMapsbooleanoptional

Return only maps I created

sharedWithMebooleanoptional

Return only maps shared with Me

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/map' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "list": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "data": "text",
      "visibility": "private",
      "creator": "123e4567-e89b-12d3-a456-426614174000",
      "access": {
        "list": [
          {
            "users": {
              "list": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "roles": {
              "list": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            },
            "access": "none"
          }
        ]
      }
    }
  ]
}

Return a list of Venues

Retrieve a specific map.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "data": "text",
  "visibility": "private",
  "creator": "123e4567-e89b-12d3-a456-426614174000",
  "access": {
    "list": [
      {
        "users": {
          "list": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "roles": {
          "list": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        },
        "access": "none"
      }
    ]
  }
}

Successfull retrieval of a map

Create a specific map.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entitystring · uuidoptional

venuestring · uuidoptional

managementPolicystring · uuidoptional

datastringoptional

visibilitystring · enumoptionalAvailable options:

creatorstring · uuidoptional

accessobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "data": "text",
    "visibility": "private",
    "creator": "123e4567-e89b-12d3-a456-426614174000",
    "access": {
      "list": [
        {
          "users": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "roles": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "access": "none"
        }
      ]
    }
  }'

200

403

404

200

No Content

Modify a specific map.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entitystring · uuidoptional

venuestring · uuidoptional

managementPolicystring · uuidoptional

datastringoptional

visibilitystring · enumoptionalAvailable options:

creatorstring · uuidoptional

accessobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "data": "text",
    "visibility": "private",
    "creator": "123e4567-e89b-12d3-a456-426614174000",
    "access": {
      "list": [
        {
          "users": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "roles": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "access": "none"
        }
      ]
    }
  }'

200

403

404

200

No Content

Delete a specific map.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/map/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Get a list of policies.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

entitystring · uuidoptional

venuestring · uuidoptional

unassignedbooleanoptional

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of policies comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of policies

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/managementPolicy' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "policies": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "entries": [
        {
          "users": [
            "text"
          ],
          "resources": [
            "text"
          ],
          "access": [
            "NOACCESS"
          ],
          "policy": "text"
        }
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Return a list of Venues

Retrieve a specific policy.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUsebooleanoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "entries": [
    {
      "users": [
        "text"
      ],
      "resources": [
        "text"
      ],
      "access": [
        "NOACCESS"
      ],
      "policy": "text"
    }
  ],
  "inUse": [
    "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
  ],
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "venue": "123e4567-e89b-12d3-a456-426614174000"
}

Succesful retrieve a management policy

Create a specific policy.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entriesobject[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

venuestring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entries": [
      {
        "users": [
          "text"
        ],
        "resources": [
          "text"
        ],
        "access": [
          "NOACCESS"
        ],
        "policy": "text"
      }
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Modify a specific policy.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

entriesobject[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

venuestring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "entries": [
      {
        "users": [
          "text"
        ],
        "resources": [
          "text"
        ],
        "access": [
          "NOACCESS"
        ],
        "policy": "text"
      }
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Delete a specific policy.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: The root entity cannot be deleted.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/managementPolicy/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of management roles.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

entitystring · uuidoptional

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of roles

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/managementRole' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "roles": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "users": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "inUse": [
        "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
      ],
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Return a list of elements

Create a specific management role.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: during creation, must be set to 1. The real uuid will be returned in the created object

Body

allOfobjectoptional

managementPolicystring · uuidoptional

usersstring · uuid[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

venuestring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "users": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Modify a specific management role.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Body

allOfobjectoptional

managementPolicystring · uuidoptional

usersstring · uuid[]optional

inUsestring · uuid[]optionalExample: each uuid is preceded by ent, or ven to say that the elemenet is entity or venue

entitystring · uuidoptional

venuestring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "users": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ],
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Delete a specific management role.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequired

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/managementRole/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve a list of configurations.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of devices

venuestring · uuidoptional

entitystring · uuidoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/configurations' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "configurations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "created": 1,
        "modified": 1,
        "tags": [
          1
        ]
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "deviceTypes": [
        "text"
      ],
      "configuration": [
        {
          "name": "text",
          "description": "text",
          "weight": 1,
          "configuration": "text"
        }
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "inUse": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "subscriberOnly": true,
      "rrm": "off",
      "firmwareUpgrade": "auto or a time string of the format DOW-HH:MM",
      "firmwareRCOnly": true,
      "venue": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "subscriber": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Return a list of elements

Retrieve a specific configuration.

get

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When looking for the root entity, the uuid 0000-0000-0000 must be entered.

Query parameters

expandInUsebooleanoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/configurations/{uuid}' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "deviceTypes": [
    "text"
  ],
  "configuration": [
    {
      "name": "text",
      "description": "text",
      "weight": 1,
      "configuration": "text"
    }
  ],
  "variables": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inUse": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "subscriberOnly": true,
  "rrm": "off",
  "firmwareUpgrade": "auto or a time string of the format DOW-HH:MM",
  "firmwareRCOnly": true,
  "venue": "123e4567-e89b-12d3-a456-426614174000",
  "entity": "123e4567-e89b-12d3-a456-426614174000",
  "subscriber": "123e4567-e89b-12d3-a456-426614174000"
}

Success

Create a specific configuration.

post

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When creating the root entity, the uuid 0000-0000-0000 must be entered. When creating a non-root entity, uuid must be 1

Query parameters

validateOnlybooleanoptional

Body

allOfobjectoptional

managementPolicystring · uuidoptional

deviceTypesstring[]optional

configurationobject[]optional

variablesstring · uuid[]optional

inUsestring · uuid[]optional

subscriberOnlybooleanoptionalDefault: false

rrmstring · enumoptionalAvailable options:

firmwareUpgradestringoptionalExample: auto or a time string of the format DOW-HH:MM

firmwareRCOnlybooleanoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/configurations/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "configuration": "text"
      }
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "subscriberOnly": true,
    "rrm": "off",
    "firmwareUpgrade": "auto or a time string of the format DOW-HH:MM",
    "firmwareRCOnly": true,
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Modify a specific configuration.

put

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: When modifying the root entity, the uuid 0000-0000-0000 must be entered.

Body

allOfobjectoptional

managementPolicystring · uuidoptional

deviceTypesstring[]optional

configurationobject[]optional

variablesstring · uuid[]optional

inUsestring · uuid[]optional

subscriberOnlybooleanoptionalDefault: false

rrmstring · enumoptionalAvailable options:

firmwareUpgradestringoptionalExample: auto or a time string of the format DOW-HH:MM

firmwareRCOnlybooleanoptional

venuestring · uuidoptional

entitystring · uuidoptional

subscriberstring · uuidoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/configurations/{uuid}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "allOf": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "created": 1,
      "modified": 1,
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "configuration": "text"
      }
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "subscriberOnly": true,
    "rrm": "off",
    "firmwareUpgrade": "auto or a time string of the format DOW-HH:MM",
    "firmwareRCOnly": true,
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "subscriber": "123e4567-e89b-12d3-a456-426614174000"
  }'

200

403

404

200

No Content

Delete a specific configuration.

delete

Authorizations

bearerAuthApiKeyAuth

Path parameters

uuidstring · uuidrequiredExample: The root entity cannot be deleted.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/configurations/{uuid}' \
  --header 'Authorization: Bearer JWT'

204

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Get the country code for an IP address

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

ipliststringrequiredExample: 10.2.2.2,10.3.4.3

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/iptocountry?iplist=10.2.2.2%2C10.3.4.3' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "enabled": true,
  "countryCodes": [
    "text"
  ]
}

List of country codes.

This call allows someone to get the status of a signup.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

emailstring · emailoptional

macAddressstringoptional

signupUUIDstring · uuidoptional

dashboardbooleanoptionalDefault: false

deviceIDstringoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/signup' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "created": 1,
    "modified": 1,
    "tags": [
      1
    ]
  },
  "email": "[e-mail]",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "macAddress": "text",
  "serialNumber": "text",
  "created": 1,
  "completed": 1,
  "error": 1,
  "status": "text",
  "statusCode": 1
}

Successfull completion

This call allows a new subscriber to register themselves and their devices.

post

Authorizations

bearerAuthApiKeyAuth

Query parameters

emailstring · emailrequired

macAddressstringrequired

deviceIDstringoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/signup?email=name%40gmail.com&macAddress=text' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

No Content

modify the signup command in play

put

Authorizations

bearerAuthApiKeyAuth

Query parameters

signupUUIDstring · uuidrequired

operationstring · enumrequiredAvailable options:

Body

reasonstringoptional

timeinteger · int64optional

errorCodeinteger · int32optional

statusstringoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://localhost:16005/api/v1/signup?signupUUID=123e4567-e89b-12d3-a456-426614174000&operation=cancel' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reason": "text",
    "time": 1,
    "errorCode": 1,
    "status": "text"
  }'

200

400

403

404

200

No Content

This call allows someone to delete a specific signUp or all signups according to serialNumber of email address

delete

Authorizations

bearerAuthApiKeyAuth

Query parameters

emailstring · emailoptional

macAddressstringoptional

signupUUIDstring · uuidoptional

deviceIDstringoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://localhost:16005/api/v1/signup' \
  --header 'Authorization: Bearer JWT'

204

400

403

404

204

{
  "Operation": "text",
  "Details": "text",
  "Code": 1
}

The requested operation was performed.

Retrieve lists of control blocks

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

venuestring · uuidoptional

entitystring · uuidoptional

offsetintegeroptional

Pagination start (starts at 1. If not specified, 1 is assumed)

limitintegeroptional

Maximum number of entries to return (if absent, no limit is assumed)

filterstringoptional

Filter the results

selectstringoptional

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlybooleanoptional

return the number of devices

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/variables' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

200

No Content

Get the last version of the dashboard.

get

Authorizations

bearerAuthApiKeyAuth

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/dashboard' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

No Content

Retrieve different values from the running service.

get

Authorizations

bearerAuthApiKeyAuth

Query parameters

commandstring · enumrequired

Get a value

Available options:

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://localhost:16005/api/v1/system?command=info' \
  --header 'Authorization: Bearer JWT'

200

403

404

200

{
  "version": "text",
  "uptime": 1,
  "start": 1,
  "os": "text",
  "processors": 1,
  "hostname": "text",
  "certificates": [
    {
      "filename": "text",
      "expires": 1
    }
  ]
}

Successful command execution

Perform some system wide commands.

post

Authorizations

bearerAuthApiKeyAuth

Body

one ofoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://localhost:16005/api/v1/system' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "command": "setloglevel",
    "subsystems": [
      {
        "tag": "text",
        "value": "text"
      }
    ]
  }'

200

403

404

200

{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}

Successful command execution