Provisioning Service

Retrieve a specific entity.

get
Authorizations
Path parameters
uuidstring · uuidRequiredExample: When looking for the root entity, the uuid 0000-0000-0000 must be entered.
Responses
200Success
No content
get
GET /api/v1/entity/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

No content

Create a specific entity.

post
Authorizations
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
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 · enumOptionalPossible values:
Responses
200Success
No content
post
POST /api/v1/entity/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 929

{
  "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"
    ]
  }
}
No content

Modify a specific entity.

put
Authorizations
Path parameters
uuidstring · uuidRequiredExample: When modifying the root entity, the uuid 0000-0000-0000 must be entered.
Body
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 · enumOptionalPossible values:
Responses
200Success
No content
put
PUT /api/v1/entity/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 929

{
  "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"
    ]
  }
}
No content

Delete a specific entity.

delete
Authorizations
Path parameters
uuidstring · uuidRequiredExample: The root entity cannot be deleted.
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/entity/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of contacts.

get
Authorizations
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
200

Return a list of contacts

application/json
Responseone of
or
get
GET /api/v1/contact HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a specific contact.

get
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
expandInUsebooleanOptional
Responses
200

Success

application/json
Responseone of
or
get
GET /api/v1/contact/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific entity.

post
Authorizations
Path parameters
uuidstring · uuidRequired
Body
typestring · enumOptionalPossible values:
titlestringOptional
salutationstringOptional
firstnamestringOptional
lastnamestringOptional
initialsstringOptional
visualstringOptional
phonesstring[]Optional
mobilesstring[]Optional
primaryEmailstringOptional
secondaryEmailstringOptional
accessPINstringOptional
inUsestring · uuid[]Optional
entitystring · uuidOptional
managementPolicystring · uuidOptional
Responses
200Success
No content
post
POST /api/v1/contact/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 566

{
  "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"
}
No content

Modify a specific contact.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
typestring · enumOptionalPossible values:
titlestringOptional
salutationstringOptional
firstnamestringOptional
lastnamestringOptional
initialsstringOptional
visualstringOptional
phonesstring[]Optional
mobilesstring[]Optional
primaryEmailstringOptional
secondaryEmailstringOptional
accessPINstringOptional
inUsestring · uuid[]Optional
entitystring · uuidOptional
managementPolicystring · uuidOptional
Responses
200Success
No content
put
PUT /api/v1/contact/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 566

{
  "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"
}
No content

Delete a specific contact.

delete
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
forcebooleanRequired
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/contact/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of locations.

get
Authorizations
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
200

Return a list of Locations

application/json
Responseone of
or
get
GET /api/v1/location HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a specific location.

get
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
expandInUsebooleanOptional
Responses
200

Success

application/json
Responseone of
or
get
GET /api/v1/location/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific location.

post
Authorizations
Path parameters
uuidstring · uuidRequired
Body
typestring · enumOptionalPossible values:
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
200Success
No content
post
POST /api/v1/location/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "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"
}
No content

Modify a specific location.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
typestring · enumOptionalPossible values:
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
200Success
No content
put
PUT /api/v1/location/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 561

{
  "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"
}
No content

Delete a specific location.

delete
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
forcebooleanRequired
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/location/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of inventory.

get
Authorizations
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
200

Return a list of elements

application/json
Responseone of
or
or
get
GET /api/v1/inventory HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

{
  "serialNumbers": [
    "text"
  ]
}

Retrieve a specific inventory tag.

get
Authorizations
Path parameters
serialNumberstring · uuidRequired
Query parameters
configbooleanOptional
explainbooleanOptional
firmwareOptionsbooleanOptional
applyConfigurationbooleanOptional
Responses
200

Succesful retrieve configuratiopn or part of the configuration

application/json
Responseone of
or
or
get
GET /api/v1/inventory/{serialNumber} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific Inventory.

post
Authorizations
Path parameters
serialNumberstring · uuidRequired
Body
serialNumberstringOptional
deviceTypestringOptional
venuestring · uuidOptional
entitystring · uuidOptional
subscriberstring · uuidOptional
qrCodestringOptional
geoCodestringOptional
locationstring · uuidOptional
contactstring · uuidOptional
deviceConfigurationstring · uuidOptional
rrmstring · enumOptionalPossible values:
managementPolicystring · uuidOptional
statestringOptional
devClassstring · enumOptionalPossible values:
localestring · min: 2 · max: 2Optional
Responses
200Success
No content
post
POST /api/v1/inventory/{serialNumber} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 683

{
  "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"
}
No content

Modify a specific inventory.

put
Authorizations
Path parameters
serialNumberstring · uuidRequired
removeSubscriberstring · uuidRequired
Query parameters
unassignbooleanOptional
Body
serialNumberstringOptional
deviceTypestringOptional
venuestring · uuidOptional
entitystring · uuidOptional
subscriberstring · uuidOptional
qrCodestringOptional
geoCodestringOptional
locationstring · uuidOptional
contactstring · uuidOptional
deviceConfigurationstring · uuidOptional
rrmstring · enumOptionalPossible values:
managementPolicystring · uuidOptional
statestringOptional
devClassstring · enumOptionalPossible values:
localestring · min: 2 · max: 2Optional
Responses
200

success

application/json
put
PUT /api/v1/inventory/{serialNumber} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 683

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

Delete a specific inventory.

delete
Authorizations
Path parameters
serialNumberstring · uuidRequired
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/inventory/{serialNumber} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of venues.

get
Authorizations
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
200

Return a list of venues.

application/json
Responseone of
or
get
GET /api/v1/venue HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a specific venue.

get
Authorizations
Path parameters
uuidstring · uuidRequired
Responses
200Success
No content
get
GET /api/v1/venue/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

No content

Create a specific venue.

post
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
Body
entitystring · uuidOptional
parentstring · uuidOptional
childrenstring · uuid[]Optional
managementPolicystring · uuidOptional
devicesstring · uuid[]Optional
designstringOptional
deviceConfigurationstring · uuidOptional
contactsstring · uuid[]Optional
locationstring · uuidOptional
rrmstring · enumOptionalPossible values:
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
200Success
No content
post
POST /api/v1/venue/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1050

{
  "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"
  ]
}
No content

Modify a specific venue.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
entitystring · uuidOptional
parentstring · uuidOptional
childrenstring · uuid[]Optional
managementPolicystring · uuidOptional
devicesstring · uuid[]Optional
designstringOptional
deviceConfigurationstring · uuidOptional
contactsstring · uuid[]Optional
locationstring · uuidOptional
rrmstring · enumOptionalPossible values:
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
200Success
No content
put
PUT /api/v1/venue/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 1050

{
  "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"
  ]
}
No content

Delete a specific venue.

delete
Authorizations
Path parameters
uuidstring · uuidRequiredExample: The root entity cannot be deleted.
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/venue/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve the list of maps

get
Authorizations
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
200

Return a list of Venues

application/json
get
GET /api/v1/map HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a specific map.

get
Authorizations
Path parameters
uuidstring · uuidRequired
Responses
200

Successfull retrieval of a map

application/json
get
GET /api/v1/map/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific map.

post
Authorizations
Path parameters
uuidstring · uuidRequired
Body
entitystring · uuidOptional
venuestring · uuidOptional
managementPolicystring · uuidOptional
datastringOptional
visibilitystring · enumOptionalPossible values:
creatorstring · uuidOptional
Responses
200Success
No content
post
POST /api/v1/map/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 576

{
  "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"
      }
    ]
  }
}
No content

Modify a specific map.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
entitystring · uuidOptional
venuestring · uuidOptional
managementPolicystring · uuidOptional
datastringOptional
visibilitystring · enumOptionalPossible values:
creatorstring · uuidOptional
Responses
200Success
No content
put
PUT /api/v1/map/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 576

{
  "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"
      }
    ]
  }
}
No content

Delete a specific map.

delete
Authorizations
Path parameters
uuidstring · uuidRequired
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/map/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Get a list of policies.

get
Authorizations
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
200

Return a list of Venues

application/json
Responseone of
or
get
GET /api/v1/managementPolicy HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a specific policy.

get
Authorizations
Path parameters
uuidstring · uuidRequired
Query parameters
expandInUsebooleanOptional
Responses
200

Succesful retrieve a management policy

application/json
Responseone of
or
get
GET /api/v1/managementPolicy/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific policy.

post
Authorizations
Path parameters
uuidstring · uuidRequired
Body
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
200Success
No content
post
POST /api/v1/managementPolicy/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "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"
}
No content

Modify a specific policy.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
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
200Success
No content
put
PUT /api/v1/managementPolicy/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "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"
}
No content

Delete a specific policy.

delete
Authorizations
Path parameters
uuidstring · uuidRequiredExample: The root entity cannot be deleted.
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/managementPolicy/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of management roles.

get
Authorizations
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
200

Return a list of elements

application/json
Responseone of
or
get
GET /api/v1/managementRole HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Create a specific management role.

post
Authorizations
Path parameters
uuidstring · uuidRequiredExample: during creation, must be set to 1. The real uuid will be returned in the created object
Body
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
200Success
No content
post
POST /api/v1/managementRole/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 478

{
  "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"
}
No content

Modify a specific management role.

put
Authorizations
Path parameters
uuidstring · uuidRequired
Body
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
200Success
No content
put
PUT /api/v1/managementRole/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 478

{
  "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"
}
No content

Delete a specific management role.

delete
Authorizations
Path parameters
uuidstring · uuidRequired
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/managementRole/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve a list of configurations.

get
Authorizations
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
200

Return a list of elements

application/json
Responseone of
or
get
GET /api/v1/configurations HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

{
  "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": false,
      "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"
    }
  ]
}

Retrieve a specific configuration.

get
Authorizations
Path parameters
uuidstring · uuidRequiredExample: When looking for the root entity, the uuid 0000-0000-0000 must be entered.
Query parameters
expandInUsebooleanOptional
Responses
200

Success

application/json
Responseone of
or
get
GET /api/v1/configurations/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

{
  "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": false,
  "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"
}

Create a specific configuration.

post
Authorizations
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
managementPolicystring · uuidOptional
deviceTypesstring[]Optional
variablesstring · uuid[]Optional
inUsestring · uuid[]Optional
subscriberOnlybooleanOptionalDefault: false
rrmstring · enumOptionalPossible values:
firmwareUpgradestringOptionalExample: auto or a time string of the format DOW-HH:MM
firmwareRCOnlybooleanOptional
venuestring · uuidOptional
entitystring · uuidOptional
subscriberstring · uuidOptional
Responses
200Success
No content
post
POST /api/v1/configurations/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 725

{
  "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": false,
  "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"
}
No content

Modify a specific configuration.

put
Authorizations
Path parameters
uuidstring · uuidRequiredExample: When modifying the root entity, the uuid 0000-0000-0000 must be entered.
Body
managementPolicystring · uuidOptional
deviceTypesstring[]Optional
variablesstring · uuid[]Optional
inUsestring · uuid[]Optional
subscriberOnlybooleanOptionalDefault: false
rrmstring · enumOptionalPossible values:
firmwareUpgradestringOptionalExample: auto or a time string of the format DOW-HH:MM
firmwareRCOnlybooleanOptional
venuestring · uuidOptional
entitystring · uuidOptional
subscriberstring · uuidOptional
Responses
200Success
No content
put
PUT /api/v1/configurations/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 725

{
  "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": false,
  "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"
}
No content

Delete a specific configuration.

delete
Authorizations
Path parameters
uuidstring · uuidRequiredExample: The root entity cannot be deleted.
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/configurations/{uuid} HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Get the country code for an IP address

get
Authorizations
Query parameters
ipliststringRequiredExample: 10.2.2.2,10.3.4.3
Responses
200

List of country codes.

application/json
get
GET /api/v1/iptocountry HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

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

get
Authorizations
Query parameters
emailstring · emailOptional
macAddressstringOptional
signupUUIDstring · uuidOptional
dashboardbooleanOptionalDefault: false
deviceIDstringOptional
Responses
200

Successfull completion

application/json
Responseone of
or
get
GET /api/v1/signup HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

{
  "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": "name@gmail.com",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "macAddress": "text",
  "serialNumber": "text",
  "created": 1,
  "completed": 1,
  "error": 1,
  "status": "text",
  "statusCode": 1
}

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

post
Authorizations
Query parameters
emailstring · emailRequired
macAddressstringRequired
deviceIDstringOptional
Responses
200Success
No content
post
POST /api/v1/signup HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

No content

modify the signup command in play

put
Authorizations
Query parameters
signupUUIDstring · uuidRequired
operationstring · enumRequiredPossible values:
Body
reasonstringOptional
timeinteger · int64Optional
errorCodeinteger · int32Optional
statusstringOptional
Responses
200Success
No content
put
PUT /api/v1/signup HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "reason": "text",
  "time": 1,
  "errorCode": 1,
  "status": "text"
}
No content

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

delete
Authorizations
Query parameters
emailstring · emailOptional
macAddressstringOptional
signupUUIDstring · uuidOptional
deviceIDstringOptional
Responses
204

The requested operation was performed.

application/json
delete
DELETE /api/v1/signup HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Retrieve lists of control blocks

get
Authorizations
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
200Success
No content
get
GET /api/v1/variables HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

No content

Get the last version of the dashboard.

get
Authorizations
Responses
200Success
No content
get
GET /api/v1/dashboard HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

No content

Retrieve different values from the running service.

get
Authorizations
Query parameters
commandstring · enumRequired

Get a value

Possible values:
Responses
200

Successful command execution

application/json
Responseone of
get
GET /api/v1/system HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Accept: */*

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

Perform some system wide commands.

post
Authorizations
Body
one ofOptional
or
or
or
or
Responses
200

Successful command execution

application/json
Responseone of
or
or
post
POST /api/v1/system HTTP/1.1
Host: localhost:16005
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "command": "setloglevel",
  "subsystems": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}
{
  "taglist": [
    {
      "tag": "text",
      "value": "text"
    }
  ]
}
PreviousFirmware Management ServiceNextAnalytics Service

Last updated