Matching results

System Configurations

A system configuration is an entity used to identify the software elements (application, firmware) that have to be defined on the device. A system configuration contains a set of applications indicating the order of installation between software elements. A system configuration is identified by a name.

Read only fields are computed by AirVantage and can only be seen on response fragments sent by find, create, or edit requests.

Field Description Read Only Type
uid System configuration's unique identifier. true uid
name System configuration's name. false string
applications List of applications. false object array

This is a complete representation of an System Configuration. This fragment can be used for create or edit requests. Please refer to the fields section to know which fields can be modified.

{
    "uid": "",
    "name": "",
    "applications": [{
        "uid": "",
        "name": "",
        "revision" : "",
        "type" : "",
        "category" : ""
       }, {
        "uid": "",
        "name": "",
        "revision" : "",
        "type" : "",
        "category" : ""
       }]
}

/api/v1/systemconfig

Returns a list of system configurations with their complete details.

Request

GET https://na.airvantage.net/api/v1/systemconfig

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
[
    {
         "uid": "ad6b9044bac346c1811b38ea2dd9fb68",
         "name": "MyConfig1",
         "applications": [{
            "uid": "08fc7db9841945df8ffa647165bb57e6",
            "name": "OASIS AR6220",
            "revision" : "vR7.53",
            "type" : "AR6220",
            "category" : "FIRMWARE"
        }]
    },
    {
         "uid": "bd6b8044bac346c1811b38ea2dd9fb70",
         "name": "MyConfig2",
         "applications": [{
            "uid": "e061fff752704d23af80c63373631fba",
            "name": "LWM2M AR8652",
            "revision" : "v4.3",
            "type" : "AR8652",
            "category" : "FIRMWARE"
        }]
    }
]
Name Description Use Default Type Operand
company Set the context company. optional caller's company uid =
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions device.management.action

/api/v1/systemconfig/{uid}

Returns detailed information about the specified system configuration.

Request

GET https://na.airvantage.net/api/v1/systemconfig/ad6b9044bac346c1811b38ea2dd9fb68

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
{
   "uid": "ad6b9044bac346c1811b38ea2dd9fb68",
   "name": "MyConfig1",
    "applications": [{
        "uid": "08fc7db9841945df8ffa647165bb57e6",
        "name": "OASIS AR6220",
        "revision" : "vR7.53",
        "type" : "AR6220",
        "category" : "FIRMWARE"
    }]
}
Name Description
system.config.unknown Raised when the 'uid' points to an unknown system configuration.
HTTP Method GET
Requires Authentication Yes
Rate Limited Yes
Headers None
Permissions device.management.action

/api/v1/systemconfig

Creates a new system configuration. Response returns the system configuration with its uid.

Request

POST https://na.airvantage.net/api/v1/systemconfig
Content-Type: application/json
...
{
   "name": "MyConfig1",
    "applications": [{
        "uid": "08fc7db9841945df8ffa647165bb57e6"
    }, {
        "uid": "93ab886c981d454698574e66387a6557"
    }]
}      

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "1ba88be133944bef810b3f09d7da6f11",
   "name": "MyConfig1",
   "applications": [{
        "uid": "08fc7db9841945df8ffa647165bb57e6",
        "name": "ALEOS GX400",
        "revision" : "4.2.5.005",
        "type" : "ALEOS.PROD.12",
        "category" : "FIRMWARE"
    }, {
        "uid": "93ab886c981d454698574e66387a6557"
        "name": "The Application",
        "revision" : "1.20.3",
        "type" : "THE.TYPE",
        "category" : "APPLICATION"
    }]
}
Name Description Use Default Type
company Set the context company. optional caller's company uid
Name Description
system.config.missing.name Raised when no name has been specified.
system.config.missing.applications Raised when no application has been specified.
system.config.name.not.unique Raised when name already exists.
application.unknown Raised when application is unknown.
application.invalid.state Raised when application state is invalid. Only PUBLISHED applications can be used.
system.config.missing.firmware Raised when a FIRMWARE is missing.
system.config.missing.software Raised when an APPLICATION is missing.
system.config.too.many.firmware Raised when there are more than one firmware type.
system.config.wrong.application.category Raised when category of application is wrong. Only FIRMWARE and APPLICATION can be part of a system configuration.
system.config.wrong.application.manager Raised when application manager is wrong.
HTTP Method POST
Requires Authentication Yes
Rate Limited Yes
Headers Content-type: application/json
Permissions device.management.action

/api/v1/systemconfig/{uid}

Edits the system configuration identified by the uid in the request.

Request

PUT https://na.airvantage.net/api/v1/systemconfig/cd772bf2dca74a85ba177a10a7e5a721
Content-Type: application/json
...
{
    "name" : "MyNewConfigName",
    "applications": [{
        "uid": "08fc7db9841945df8ffa647165bb57e6"
    }]
}

Response
200 OK

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "uid": "cd772bf2dca74a85ba177a10a7e5a721",
   "name": "MyNewConfigName",
   "applications": [{
        "uid": "08fc7db9841945df8ffa647165bb57e6",
        "name": "ALEOS GX400",
        "revision" : "4.2.5.005",
        "type" : "ALEOS.PROD.12",
        "category" : "FIRMWARE"
    }]
}
Name Description
system.config.missing.name Raised when no name has been specified.
system.config.missing.applications Raised when no application has been specified.
system.config.name.not.unique Raised when name already exists.
application.unknown Raised when application is unknown.
application.invalid.state Raised when application state is invalid. Only PUBLISHED applications can be used.
system.config.missing.firmware Raised when a FIRMWARE is missing.
system.config.missing.software Raised when an APPLICATION is missing.
system.config.too.many.firmware Raised when there are more than one firmware type.
system.config.wrong.application.category Raised when category of application is wrong. Only FIRMWARE and APPLICATION can be part of a system configuration.
system.config.wrong.application.manager Raised when application manager is wrong.
HTTP Method PUT
Requires Authentication Yes
Rate Limited Yes
Headers Content-type: application/json
Permissions device.management.action

/api/v1/systemconfig/{uid}

Deletes a specific system configuration from the AirVantage.

Request

DELETE https://na.airvantage.net/api/v1/systemconfig/f25fda79e47540228f089ed155f50d5f

Response
200 OK

HTTP/1.1 200 OK
Content-Length: 0
Name Description
system.config.unknown Raised when the 'uid' points to an unknown system configuration.
HTTP Method DELETE
Requires Authentication Yes
Rate Limited Yes
Headers -
Permissions device.management.action
TOP