Provisioning Service

Modify a specific entity.

put

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: When modifying the root entity, the uuid 0000-0000-0000 must be entered.

Body

allOfobject

parentstring · uuid

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

managementPolicystring · uuid

deviceConfigurationstring · uuid

sourceIPobject

rrmstring · enum

Options: off, on, inherit

childrenstring · uuid[]

venuesstring · uuid[]

contactsstring · uuid[]

locationsstring · uuid[]

devicesstring · uuid[]

managementPoliciesstring · uuid[]

variablesstring · uuid[]

managementRolesstring · uuid[]

mapsstring · uuid[]

configurationsstring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "rrm": "off",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "venues": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "locations": [
      "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"
    ]
  }'

200

403

404

No body

Delete a specific entity.

delete

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of contacts.

get

/contact

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of contacts comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of contacts

uuidOnlyboolean

return only the UUIDs of contacts

venuestring · uuid

entitystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Return a list of contacts

Retrieve a specific contact.

get

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Success

Create a specific entity.

post

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

primaryEmailstring

secondaryEmailstring

accessPINstring

entitystring · uuid

managementPolicystring · uuid

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "title": "text",
    "salutation": "text",
    "firstname": "text",
    "lastname": "text",
    "initials": "text",
    "visual": "text",
    "primaryEmail": "text",
    "secondaryEmail": "text",
    "accessPIN": "text",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "type": "SUBSCRIBER",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

No body

Modify a specific contact.

put

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

titlestring

salutationstring

firstnamestring

lastnamestring

initialsstring

visualstring

primaryEmailstring

secondaryEmailstring

accessPINstring

entitystring · uuid

managementPolicystring · uuid

typestring · enum

Options: SUBSCRIBER, USER, INSTALLER, CSR, MANAGER, BUSINESSOWNER, TECHNICIAN, CORPORATE

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "title": "text",
    "salutation": "text",
    "firstname": "text",
    "lastname": "text",
    "initials": "text",
    "visual": "text",
    "primaryEmail": "text",
    "secondaryEmail": "text",
    "accessPIN": "text",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "type": "SUBSCRIBER",
    "phones": [
      "text"
    ],
    "mobiles": [
      "text"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

No body

Delete a specific contact.

delete

/contact/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of locations.

get

/location

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of Locations comma separated

Example: uuid1,uuid2,uuid3

countOnlyboolean

return the number of Locations

uuidOnlyboolean

return only the UUIDs of Locations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Return a list of Locations

Retrieve a specific location.

get

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Success

Create a specific location.

post

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

buildingNamestring

citystring

statestring

postalstring

countrystring

entitystring · uuid

managementPolicystring · uuid

geoCodestring

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

addressLinesstring[]

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

No body

Modify a specific location.

put

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

buildingNamestring

citystring

statestring

postalstring

countrystring

entitystring · uuid

managementPolicystring · uuid

geoCodestring

typestring · enum

Options: SERVICE, EQUIPMENT, AUTO, MANUAL, SPECIAL, UNKNOWN, CORPORATE

addressLinesstring[]

phonesstring[]

mobilesstring[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

No body

Delete a specific location.

delete

/location/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

forcebooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of inventory.

get

/inventory

Authorizations

Query parameters

entitystring · uuid

venuestring · uuid

unassignedboolean

deviceTypestring

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: serial1,serial2,serial3

serialOnlyboolean

only serial numbers of full device details

countOnlyboolean

return the number of devices

withExtendedInfoboolean

return extended information

orderBystring

return extended information

Example: serialNumber:a,created:d

rrmOnlyboolean · default: false

return the list of devices under RRM

subscriberstring · uuid

return the list of devices under RRM

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

{
  "serialNumbers": [
    "text"
  ]
}

Return a list of elements

Retrieve a specific inventory tag.

get

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Query parameters

configboolean

explainboolean

firmwareOptionsboolean

applyConfigurationboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "created": 1,
    "modified": 1,
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "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",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "locale": "text",
  "rrm": "off",
  "devClass": "any"
}

Succesful retrieve configuratiopn or part of the configuration

Create a specific Inventory.

post

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Body

allOfobject

serialNumberstring

deviceTypestring

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

qrCodestring

geoCodestring

locationstring · uuid

contactstring · uuid

deviceConfigurationstring · uuid

managementPolicystring · uuid

statestring

localestring · min: 2 · max: 2

rrmstring · enum

Options: off, on, inherit

devClassstring · enum

Options: any, venue, entity, subscriber

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "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",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "state": "text",
    "locale": "text",
    "rrm": "off",
    "devClass": "any"
  }'

200

403

404

No body

Modify a specific inventory.

put

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

removeSubscriberstring · uuidrequired

Query parameters

unassignboolean

Body

allOfobject

serialNumberstring

deviceTypestring

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

qrCodestring

geoCodestring

locationstring · uuid

contactstring · uuid

deviceConfigurationstring · uuid

managementPolicystring · uuid

statestring

localestring · min: 2 · max: 2

rrmstring · enum

Options: off, on, inherit

devClassstring · enum

Options: any, venue, entity, subscriber

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "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",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "state": "text",
    "locale": "text",
    "rrm": "off",
    "devClass": "any"
  }'

200

403

404

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "created": 1,
    "modified": 1,
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "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",
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "state": "text",
  "locale": "text",
  "rrm": "off",
  "devClass": "any"
}

success

Delete a specific inventory.

delete

/inventory/{serialNumber}

Authorizations

Path parameters

serialNumberstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of venues.

get

/venue

Authorizations

Query parameters

entitystring · uuid

venuestring · uuid

unassignedboolean

deviceTypestring

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of Venues comma separated

Example: serial1,serial2,serial3

serialOnlyboolean

only serial numbers of full device details

countOnlyboolean

return the number of devices

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

{
  "venues": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "created": 1,
        "modified": 1,
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": [
          1
        ]
      },
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "parent": "123e4567-e89b-12d3-a456-426614174000",
      "managementPolicy": "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",
      "location": "123e4567-e89b-12d3-a456-426614174000",
      "sourceIP": {
        "list": [
          "text"
        ]
      },
      "rrm": "off",
      "children": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "devices": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "contacts": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "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

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

No body

Create a specific venue.

post

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

createObjectsobject

Body

allOfobject

entitystring · uuid

parentstring · uuid

managementPolicystring · uuid

topologyobject[]

designstring

deviceConfigurationstring · uuid

locationstring · uuid

sourceIPobject

rrmstring · enum

Options: off, on, inherit

childrenstring · uuid[]

devicesstring · uuid[]

contactsstring · uuid[]

managementPoliciesstring · uuid[]

managementRolesstring · uuid[]

variablesstring · uuid[]

mapsstring · uuid[]

configurationsstring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "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",
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "rrm": "off",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "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

No body

Modify a specific venue.

put

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

parentstring · uuid

managementPolicystring · uuid

topologyobject[]

designstring

deviceConfigurationstring · uuid

locationstring · uuid

sourceIPobject

rrmstring · enum

Options: off, on, inherit

childrenstring · uuid[]

devicesstring · uuid[]

contactsstring · uuid[]

managementPoliciesstring · uuid[]

managementRolesstring · uuid[]

variablesstring · uuid[]

mapsstring · uuid[]

configurationsstring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "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",
    "location": "123e4567-e89b-12d3-a456-426614174000",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "rrm": "off",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "devices": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "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

No body

Delete a specific venue.

delete

/venue/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve the list of maps

get

/map

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

filterstring

Filter the results

myMapsboolean

Return only maps I created

sharedWithMeboolean

Return only maps shared with Me

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Return a list of Venues

Retrieve a specific map.

get

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Successfull retrieval of a map

Create a specific map.

post

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

managementPolicystring · uuid

datastring

creatorstring · uuid

accessobject

visibilitystring · enum

Options: private, public, select

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "data": "text",
    "creator": "123e4567-e89b-12d3-a456-426614174000",
    "access": {
      "list": [
        {
          "users": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "roles": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "access": "none"
        }
      ]
    },
    "visibility": "private"
  }'

200

403

404

No body

Modify a specific map.

put

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

managementPolicystring · uuid

datastring

creatorstring · uuid

accessobject

visibilitystring · enum

Options: private, public, select

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "data": "text",
    "creator": "123e4567-e89b-12d3-a456-426614174000",
    "access": {
      "list": [
        {
          "users": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "roles": {
            "list": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          },
          "access": "none"
        }
      ]
    },
    "visibility": "private"
  }'

200

403

404

No body

Delete a specific map.

delete

/map/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Get a list of policies.

get

/managementPolicy

Authorizations

Query parameters

entitystring · uuid

venuestring · uuid

unassignedboolean

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of policies comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of policies

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Return a list of Venues

Retrieve a specific policy.

get

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

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

Succesful retrieve a management policy

Create a specific policy.

post

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

entriesobject[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entries": [
      {
        "policy": "text",
        "users": [
          "text"
        ],
        "resources": [
          "text"
        ],
        "access": [
          "NOACCESS"
        ]
      }
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ]
  }'

200

403

404

No body

Modify a specific policy.

put

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

entitystring · uuid

venuestring · uuid

entriesobject[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "123e4567-e89b-12d3-a456-426614174000",
    "entries": [
      {
        "policy": "text",
        "users": [
          "text"
        ],
        "resources": [
          "text"
        ],
        "access": [
          "NOACCESS"
        ]
      }
    ],
    "inUse": [
      "each uuid is preceded by ent, or ven to say that the elemenet is entity or venue"
    ]
  }'

200

403

404

No body

Delete a specific policy.

delete

/managementPolicy/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of management roles.

get

/managementRole

Authorizations

Query parameters

entitystring · uuid

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of roles

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

{
  "roles": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "created": 1,
        "modified": 1,
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": [
          1
        ]
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "entity": "123e4567-e89b-12d3-a456-426614174000",
      "venue": "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"
      ]
    }
  ]
}

Return a list of elements

Create a specific management role.

post

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

managementPolicystring · uuid

entitystring · uuid

venuestring · uuid

usersstring · uuid[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "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"
    ]
  }'

200

403

404

No body

Modify a specific management role.

put

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Body

allOfobject

managementPolicystring · uuid

entitystring · uuid

venuestring · uuid

usersstring · uuid[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "entity": "123e4567-e89b-12d3-a456-426614174000",
    "venue": "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"
    ]
  }'

200

403

404

No body

Delete a specific management role.

delete

/managementRole/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Retrieve a list of configurations.

get

/configurations

Authorizations

Query parameters

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of devices

venuestring · uuid

entitystring · uuid

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

{
  "configurations": [
    {
      "allOf": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "description": "text",
        "created": 1,
        "modified": 1,
        "notes": [
          {
            "created": 1,
            "createdBy": "text",
            "note": "text"
          }
        ],
        "tags": [
          1
        ]
      },
      "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
      "subscriberOnly": false,
      "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",
      "rrm": "off",
      "deviceTypes": [
        "text"
      ],
      "configuration": [
        {
          "name": "text",
          "description": "text",
          "weight": 1,
          "configuration": "text"
        }
      ],
      "variables": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "inUse": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ]
}

Return a list of elements

Retrieve a specific configuration.

get

/configurations/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: When looking for the root entity, the uuid 0000-0000-0000 must be entered.

Query parameters

expandInUseboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

{
  "allOf": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "created": 1,
    "modified": 1,
    "notes": [
      {
        "created": 1,
        "createdBy": "text",
        "note": "text"
      }
    ],
    "tags": [
      1
    ]
  },
  "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
  "subscriberOnly": false,
  "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",
  "rrm": "off",
  "deviceTypes": [
    "text"
  ],
  "configuration": [
    {
      "name": "text",
      "description": "text",
      "weight": 1,
      "configuration": "text"
    }
  ],
  "variables": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "inUse": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Success

Create a specific configuration.

post

/configurations/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: 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

validateOnlyboolean

Body

allOfobject

managementPolicystring · uuid

subscriberOnlyboolean · default: false

firmwareUpgradestring

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

firmwareRCOnlyboolean

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

rrmstring · enum

Options: off, on, inherit

deviceTypesstring[]

configurationobject[]

variablesstring · uuid[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "subscriberOnly": false,
    "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",
    "rrm": "off",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "configuration": "text"
      }
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

No body

Modify a specific configuration.

put

/configurations/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: When modifying the root entity, the uuid 0000-0000-0000 must be entered.

Body

allOfobject

managementPolicystring · uuid

subscriberOnlyboolean · default: false

firmwareUpgradestring

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

firmwareRCOnlyboolean

venuestring · uuid

entitystring · uuid

subscriberstring · uuid

rrmstring · enum

Options: off, on, inherit

deviceTypesstring[]

configurationobject[]

variablesstring · uuid[]

inUsestring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "subscriberOnly": false,
    "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",
    "rrm": "off",
    "deviceTypes": [
      "text"
    ],
    "configuration": [
      {
        "name": "text",
        "description": "text",
        "weight": 1,
        "configuration": "text"
      }
    ],
    "variables": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "inUse": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }'

200

403

404

No body

Delete a specific configuration.

delete

/configurations/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: The root entity cannot be deleted.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

403

404

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

The requested operation was performed.

Get the country code for an IP address

get

/iptocountry

Authorizations

Query parameters

ipliststringrequired

Example: 10.2.2.2,10.3.4.3

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

List of country codes.

get

/signup

Authorizations

Query parameters

emailstring · email

macAddressstring

signupUUIDstring · uuid

dashboardboolean · default: false

deviceIDstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

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

Successfull completion

post

/signup

Authorizations

Query parameters

emailstring · emailrequired

macAddressstringrequired

deviceIDstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

No body

put

/signup

Authorizations

Query parameters

signupUUIDstring · uuidrequired

operationstring · enumrequired

Options: cancel, emailVerified, deviceVerified

Body

reasonstring

timeinteger · int64

errorCodeinteger · int32

statusstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

No body

delete

/signup

Authorizations

Query parameters

emailstring · email

macAddressstring

signupUUIDstring · uuid

deviceIDstring

Responses

application/json

cURL

JavaScript

Python

HTTP

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

204

400

403

404

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

The requested operation was performed.

Retrieve lists of control blocks

get

/variables

Authorizations

Query parameters

venuestring · uuid

entitystring · uuid

offsetinteger

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

limitinteger

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

filterstring

Filter the results

selectstring

Supply a list of devices comma separated

Example: serial1,serial2,serial3

countOnlyboolean

return the number of devices

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

No body

Get the last version of the dashboard.

get

/dashboard

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

No body

Retrieve different values from the running service.

get

/system

Authorizations

Query parameters

commandstring · enumrequired

Get a value

Options: info

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

403

404

{
  "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

/system

Authorizations

Body

one of

Responses

application/json

cURL

JavaScript

Python

HTTP

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

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

Successful command execution

Create a specific entity.

post

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

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

Body

allOfobject

parentstring · uuid

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

managementPolicystring · uuid

deviceConfigurationstring · uuid

sourceIPobject

rrmstring · enum

Options: off, on, inherit

childrenstring · uuid[]

venuesstring · uuid[]

contactsstring · uuid[]

locationsstring · uuid[]

devicesstring · uuid[]

managementPoliciesstring · uuid[]

variablesstring · uuid[]

managementRolesstring · uuid[]

mapsstring · uuid[]

configurationsstring · uuid[]

Responses

application/json

cURL

JavaScript

Python

HTTP

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",
      "created": 1,
      "modified": 1,
      "notes": [
        {
          "created": 1,
          "createdBy": "text",
          "note": "text"
        }
      ],
      "tags": [
        1
      ]
    },
    "parent": "123e4567-e89b-12d3-a456-426614174000",
    "managementPolicy": "123e4567-e89b-12d3-a456-426614174000",
    "deviceConfiguration": "123e4567-e89b-12d3-a456-426614174000",
    "sourceIP": {
      "list": [
        "text"
      ]
    },
    "rrm": "off",
    "children": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "venues": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "contacts": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "locations": [
      "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"
    ]
  }'

200

403

404

No body

Retrieve a specific entity.

get

/entity/{uuid}

Authorizations

Path parameters

uuidstring · uuidrequired

Example: When looking for the root entity, the uuid 0000-0000-0000 must be entered.

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

403

404

No body

Modify a specific entity.

Delete a specific entity.

Retrieve a list of contacts.

Retrieve a specific contact.

Create a specific entity.

Modify a specific contact.

Delete a specific contact.

Retrieve a list of locations.

Retrieve a specific location.

Create a specific location.

Modify a specific location.

Delete a specific location.

Retrieve a list of inventory.

Retrieve a specific inventory tag.

Create a specific Inventory.

Modify a specific inventory.

Delete a specific inventory.

Retrieve a list of venues.

Retrieve a specific venue.

Create a specific venue.

Modify a specific venue.

Delete a specific venue.

Retrieve the list of maps

Retrieve a specific map.

Create a specific map.

Modify a specific map.

Delete a specific map.

Get a list of policies.

Retrieve a specific policy.

Create a specific policy.

Modify a specific policy.

Delete a specific policy.

Retrieve a list of management roles.

Create a specific management role.

Modify a specific management role.

Delete a specific management role.

Retrieve a list of configurations.

Retrieve a specific configuration.

Create a specific configuration.

Modify a specific configuration.

Delete a specific configuration.

Get the country code for an IP address

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

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

modify the signup command in play

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

Retrieve lists of control blocks

Get the last version of the dashboard.

Retrieve different values from the running service.

Perform some system wide commands.

Create a specific entity.

Retrieve a specific entity.