Extreme Networks Logo
Documentation Powered by ReDoc

ExtremeLocation Asset Manager APIs (1.0.0)

Download OpenAPI specification:Download

Extreme Networks Support: support@extremenetworks.com URL: https://www.extremenetworks.com

ExtremeLocation Asset Manager APIs allow you to programmatically access and manage assets and asset alarms. You can classify onboarded assets and declassify removed assets. Assets can be onboarded with or without tracker device mapping.

ExtremeLocation User Documentation

Asset API

Retrieve all assets

Get all asset details page by page

query Parameters
pg
integer <int32>
Default: "1"

Page number

ps
integer <int32>
Default: "10000"

Page size.

Responses

200

Asset details

204

No content : if no data for given tenant.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

get /v1/assets
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page_number": 0,
  • "page_size": 0,
  • "total_record_count": 0,
  • "records":
    [
    ]
}

Create/Update asset details

If the Asset ID is specified in the request body, then details are updated, otherwise a new entity is created.

Request Body schema: multipart/form-data
contentDisposition
object (ContentDisposition)
entity
object
headers
object
mediaType
object (MediaType)
messageBodyWorkers
object (MessageBodyWorkers)
parent
object (MultiPart)
providers
object (Providers)
formDataContentDisposition
object (FormDataContentDisposition)
simple
boolean
Default: false
name
string
value
string
parameterizedHeaders
object

Responses

200

Asset created/updated successfully.

400

Bad Request : Some of the mandatory fields are missing.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

post /v1/assets
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "siteId": "string",
  • "siteName": "string",
  • "trackerId": "string",
  • "trackerName": "string",
  • "type": "string",
  • "trackerDeviceConfig":
    {
    },
  • "prohibitedCats":
    [
    ],
  • "confinedCats":
    [
    ],
  • "alarms":
    [
    ],
  • "photo":
    {
    },
  • "activeAlarms": false,
  • "updateTimeStamp": "string",
  • "assetCategory": "string"
}

Retrieve asset image by ID

Download asset image by ID

path Parameters
file
required
string

image file ID.

Responses

200

Asset image stream retrieved

204

No content : No image.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

get /v1/assets/image/{file}
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets/image/{file}

Retrieve asset details by ID

Get asset details by ID

path Parameters
id
required
string

Responses

200

Asset details

204

No content : if no asset entity for given id.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

get /v1/assets/{id}
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "siteId": "string",
  • "siteName": "string",
  • "trackerId": "string",
  • "trackerName": "string",
  • "type": "string",
  • "trackerDeviceConfig":
    {
    },
  • "prohibitedCats":
    [
    ],
  • "confinedCats":
    [
    ],
  • "alarms":
    [
    ],
  • "photo":
    {
    },
  • "activeAlarms": false,
  • "updateTimeStamp": "string",
  • "assetCategory": "string"
}

Update asset details

Update the asset details. If ID is specifiec then details are updated, otherwise a new entity is created.

Request Body schema: multipart/form-data
contentDisposition
object (ContentDisposition)
entity
object
headers
object
mediaType
object (MediaType)
messageBodyWorkers
object (MessageBodyWorkers)
parent
object (MultiPart)
providers
object (Providers)
formDataContentDisposition
object (FormDataContentDisposition)
simple
boolean
Default: false
name
string
value
string
parameterizedHeaders
object

Responses

200

Asset created/updated successfully.

400

Bad Request : Some of the mandatory fields are missing.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired.Re-authenticate

put /v1/assets/{id}
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "desc": "string",
  • "siteId": "string",
  • "siteName": "string",
  • "trackerId": "string",
  • "trackerName": "string",
  • "type": "string",
  • "trackerDeviceConfig":
    {
    },
  • "prohibitedCats":
    [
    ],
  • "confinedCats":
    [
    ],
  • "alarms":
    [
    ],
  • "photo":
    {
    },
  • "activeAlarms": false,
  • "updateTimeStamp": "string",
  • "assetCategory": "string"
}

Delete asset entity

Delete asset details from the system.

path Parameters
id
required
string

Asset unique ID.

Responses

200

Asset deleted successfully.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Failed to delete the asset details. Check message for detailed action.

599

User session has expired. Re-authenticate

delete /v1/assets/{id}
https://manage.extremelocation.com/eloc-api/asset-manager/v1/assets/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

Asset Alarm API

Retrieve asset alarms

Get all asset alarm details page by page. Filter can be added to filter by active or by given asset id

query Parameters
pg
integer <int32>
Default: "1"

Page number

ps
integer <int32>
Default: "10000"

Page size.

active
boolean
Default: "true"

Active filter.

aid
string

Asset id filter.

Responses

200

Asset alarms details

204

No content : if no data for given tenant.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

get /v1/alarms
https://manage.extremelocation.com/eloc-api/asset-manager/v1/alarms

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "page_number": 0,
  • "page_size": 0,
  • "total_record_count": 0,
  • "records":
    [
    ]
}

Retrieve asset alarm by ID

Get asset alarm by ID

path Parameters
id
required
string

Alarm ID

Responses

200

Asset alarm details

204

No content : if no data for given tenant.

401

Unauthorized : Invalid auth token

500

Internal Server Error : API Error. Check message for detailed action.

599

User session has expired. Re-authenticate

get /v1/alarms/{id}
https://manage.extremelocation.com/eloc-api/asset-manager/v1/alarms/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "tid": "string",
  • "assetId": "string",
  • "assetName": "string",
  • "eventType": "SITE_EXIT",
  • "category": "string",
  • "assetCategory": "string",
  • "siteName": "string",
  • "siteId": "string",
  • "timestamp": "2019-08-14T19:02:33Z",
  • "active": false
}