Searching...

Matching results

Gateway

POST https://na.airvantage.net/api/v1/operations/gateways/import
Content-type: multipart/mixed; boundary="BoundaryUgix6QHMxLwJ4siU"
--BoundaryUgix6QHMxLwJ4siU
Content-Disposition: form-data; name="file"; filename="file.csv"
Content-Type: text/csv
// CSV attached
...
--BoundaryUgix6QHMxLwJ4siU
Content-Disposition: form-data; name="parameters"; filename="parameters.json"
Content-Type: application/json
// JSON attached
{
    "notify" : true,
    "callback" : "callback_url"
}
--BoundaryUgix6QHMxLwJ4siU--

HTTP/1.1 200 OK
Content-Type: application/json
...
{
  "operation":"4b89657f63aac4b299c1d46e98a495326"
}

Name	Description	Use	Default	Type
company	Set the context company.	optional	caller's company	uid

Header	Description	Use
IMEI	The imei of the new gateway. Expected format : a string of 15 digits	optional
MAC ADDRESS	The mac address of the new gateway. Expected format : six groups of two hexadecimal digits, separated by colons (:). (E.g. 01:23:45:67:89:AB)	optional
SERIAL NUMBER	The serial number of the new gateway.	optional
TYPE	The gateway type (E.g. M2MBoxPro)	optional
METADATA[metadataName]	The gateway metadata (E.g. ENV for environnement)	optional
LABELS	The labels of the new gateway, separated by a '|' character.	optional

At least one of the gateway identifiers (Imei, Mac Address, Serial number) is expected.

{
    "notify" : true|false,
    "callback" : "callback_url"
}
                    

Field	Description	Use	Default	Type
notify	Send an email notification to the user calling this method when the operation finishes.	optional	false	boolean
callback	The endpoint URL to call when the operation state changes. The callback is done using HTTP 'POST' method.	optional		string

HTTP Method	POST
Requires Authentication	Yes
Rate Limited	Yes
Headers	Content-type: application/octet-stream
Permissions	entities.gateways.create

POST https://na.airvantage.net/api/v1/operations/gateways/label
Content-Type: application/json
...
{
   "labels" : {
      "add" :  ["france"]
   },
   "criteria" : {
      "type" : "M2MBoxPro",
      "labels" : ["test"]
   }
}
                                

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "operation":"4b89657f63aac4b299c1d46e98a495326"
}
                                

Field	Description	Use	Default	Type
notify	Send an email notification to the user calling this method when the operation finishes	optional	false	boolean
callback	The endpoint URL to call when the operation state changes. The callback is done using HTTP 'POST' method.	optional		string
labels.add	The list of labels to add	optional		string
labels.remove	The list of labels to remove	optional		string
dependsOn.operation	Operation to be used to launch this operation In other words, the tasks of the new operation will start only when the tasks of specified operation will be finished.	required if 'dependsOn' set		uid
dependsOn.states	States of the tasks which will be used as input of this operation. Possible values are : SUCCESS, FAILURE and CANCELLED. If null or empty, all tasks from the parent operation will be used as input of this operation.	optional	SUCCESS,FAILURE,CANCELLED	string array
identifiers	List of identifiers to be used to identify gateway. The understandable identifiers are : serial number, IMEI and MAC address. A maximum of 5000 identifiers can be provided.	optional		string
identifiers.serialNumber	List of serial number to be used to identify gateways. A maximum of 5000 serial numbers can be provided.	optional		string
identifiers.imei	List of IMEI to be used to identify gateways. A maximum of 5000 IMEIs can be provided.	optional		string
identifiers.macAddress	List of MAC address to be used to identify gateways. A maximum of 5000 MAC addresses can be provided.	optional		string
criteria.uids	Labels all gateways whose uid matches with the specified ids.	optional		string
criteria.labels	Labels all gateways which have one of the specified labels.	optional		string
serialNumber	Labels all gateways whose serial number contains the given string.	optional		string
imei	Labels all gateways whose imei contains the given string.	optional		string
macAddress	Labels all gateways whose mac address contains the given string.	optional		string
type	Labels all gateways whose type contains the given string.	optional		string
states	Labels all gateways matching the specified states. States are : INVENTORY, BEING_TRANSFERRED.	optional		string
assigned	Labels all gateways assigned (or not) to a system. Expected value : true/false.	optional		boolean
metadata	Labels all gateways matching the specified metadata.	optional		string

Name	Description	Use	Default	Type	Operand
company	Set the context company.	optional	caller's company	uid	=

HTTP Method	POST
Requires Authentication	Yes
Rate Limited	Yes
Headers	Content-type: application/json
Permissions	entities.gateways.edit

POST https://na.airvantage.net/api/v1/operations/gateways/delete
Content-Type: application/json
...
{
   "gateways" : {
      "uids" : ["16199496f6d24f0691fa006ef53e5592"]
   }
}

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "operation":"4b89657f63aac4b299c1d46e98a495326"
}

Name	Description	Use	Default	Type
company	Set the context company.	optional	caller's company	uid

Field	Description	Use	Default	Type
notify	Send an email notification to the user calling this method when the operation finishes	optional	false	boolean
callback	The endpoint URL to call when the operation state changes. The callback is done using HTTP 'POST' method.	optional		string
gateways.label	Label name. All gateways linked to the label will be incorporated to the operation	required		string
gateways.uids	List of gateway uids to be used to launch the operation	required		uid
gateways.dependsOn.operation	Identifier of the operation to be used to launch this operation In other words, the tasks of the new operation will start only when the tasks of specified operation will be finished.	required if 'dependsOn' set		uid
gateways.dependsOn.states	States of the tasks which will be used as input of this operation. Possible values are : SUCCESS, FAILURE and CANCELLED. If null or empty, all tasks from the parent operation will be used as input of this operation.	optional	SUCCESS,FAILURE,CANCELLED	string array
gateways.criteria.uids	Selects all gateways whose uid matches with the specified ids.	optional		string
gateways.criteria.labels	Selects all gateways which have one of the specified labels.	optional		string
gateways.criteria.serialNumber	Selects all gateways whose serial number contains the given string.	optional		string
gateways.criteria.imei	Selects all gateways whose imei contains the given string.	optional		string
gateways.criteria.macAddress	Selects all gateways whose mac address contains the given string.	optional		string
gateways.criteria.type	Selects all gateways whose type contains the given string.	optional		string
gateways.criteria.states	Selects all gateways matching the specified states. States are : INVENTORY, BEING_TRANSFERRED.	optional		string
gateways.criteria.assigned	Selects all gateways assigned (or not) to a system. Expected value : true/false.	optional		boolean
gateways.criteria.metadata	Selects all gateways matching the specified metadata.	optional		string

HTTP Method	POST
Requires Authentication	Yes
Rate Limited	Yes
Headers	Content-type: application/json
Permissions	entities.gateways.delete

POST https://na.airvantage.net/api/v1/operations/gateways/transfer
Content-Type: application/json
...
{
  "message" : "Accept this!!",
  "destination" : "787ef34132fe89734acb9871",
  "gateways" : {
     "uids" : ["gate1", "gate2"]
  }
}

HTTP/1.1 200 OK
Content-Type: application/json
...
{
   "operation":"4b89657f63aac4b299c1d46e98a495326"
}

Send a transfert request

               
{
    "notify" : true,
    "callback" : "callback URL",
    "message" : "xxx",           
    "destination" : "xxx",        
    "gateways" : {               
       "uids" : ["xxx", "yyy"],  
       "label" : "zzz",
       "criteria" : {
          "uids" : []
          "labels" : [],
          "serialNumber" : ,
          "imei" : ,
          "macAddress" : ,
          "type" : ,
          "states" : [],
          "assigned" : ,
          "metadata" : {
             "key1" : "value1",
             "key2" : "value2",
             ...
          }
       }
    }
}
                            

Field	Description	Use	Default	Type
notify	Send an email notification to the user calling this method when the operation finishes	optional	false	boolean
callback	The endpoint URL to call when the operation state changes. The callback is done using HTTP 'POST' method.	optional		string
gateways.label	Gateway selection by label	optional		string list
gateways.uids	Gateway selection by list of uids	optional		uids list
gateways.criteria.uids	Selects all gateways whose uid matches with the specified ids.	optional		string
gateways.criteria.labels	Selects all gateways which have one of the specified labels.	optional		string
gateways.criteria.serialNumber	Selects all gateways whose serial number contains the given string.	optional		string
gateways.criteria.imei	Selects all gateways whose imei contains the given string.	optional		string
gateways.criteria.macAddress	Selects all gateways whose mac address contains the given string.	optional		string
gateways.criteria.type	Selects all gateways whose type contains the given string.	optional		string
gateways.criteria.states	Selects all gateways matching the specified states. States are : INVENTORY, BEING_TRANSFERRED.	optional		string
gateways.criteria.assigned	Selects all gateways assigned (or not) to a system. Expected value : true/false.	optional		boolean
gateways.criteria.metadata	Selects all gateways matching the specified metadata.	optional		string
message	Message to explain the purpose of the transfer	optional		string
destination	The uid of the destination company	required		uid

Use either 'gateways.label' or 'gateways.uids' but not both.

Accept a transfert request

The following API has to be used to accept a gateways transfer: Accept. When you accept a set of gateways, you can specify a label which will be applied to all the transfered gateways. The label is optional and created if it does not exist.

               
{
   "message" : "", 
   "data" : {
      "label" : ""          
   }                       
}
                            

Field	Description	Use	Default	Type
message	An acceptance message to be returned to the request sender.	optional		string
data.label	The label to add to the transfered gateways.	optional		string

Name	Description	Use	Default	Type
company	Set the context company.	optional	caller's company	uid

HTTP Method	POST
Requires Authentication	Yes
Rate Limited	Yes
Headers	Content-type: application/json
Permissions	entities.gateways.transfers.create