Campaigns V3

Schedule a firmware upgrade

POST
/fota/v3/campaigns/firmware/{accountName}

This endpoint allows a user to schedule a firmware upgrade for a list of devices.

Authorization

thingspace_oauth VZ-M2M-Token
AuthorizationBearer <token>

This is the ThingSpace token, from Credentials and Tokens is used

In: header

VZ-M2M-Token<token>

M2M Session Token (How to generate an M2M session token?)

In: header

Path Parameters

accountName*string

Account identifier.

Request Body

application/json

Firmware upgrade information.

Firmware upgrade information.

campaignName?string

Campaign name.

firmwareName*string

Firmware name to upgrade to.

firmwareFrom*string

Old firmware version.

firmwareTo*string

New firmware version.

protocol*string

Valid values include: LWM2M, OMA and HTTP.

startDate*string

Campaign start date.

Formatdate
endDate*string

Campaign end date.

Formatdate
campaignTimeWindowList?array<>

List of allowed campaign time windows.

deviceList*array<string>

Device IMEI list.

autoAssignLicenseFlag*boolean

This flag, when set to true, will assign a FOTA license automatically if the device does not have one already.

autoAddDevicesFlag*boolean

this flag, when set to true, will automatically add a device of the same make and model to a campaign.

Response Body

application/json

application/json

curl -X POST "https://example.com/fota/v3/campaigns/firmware/0000123456-00001" \  -H "Content-Type: application/json" \  -d '{    "campaignName": "Smart FOTA - test 4",    "firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10512_SR1.2.0.0-10657",    "firmwareFrom": "SR1.2.0.0-10512",    "firmwareTo": "SR1.2.0.0-10657",    "protocol": "LWM2M",    "startDate": "2021-09-29",    "endDate": "2021-10-01",    "campaignTimeWindowList": [      {        "startTime": 18,        "endTime": 22      }    ],    "deviceList": [      "15-digit IMEI"    ],    "autoAssignLicenseFlag": false,    "autoAddDevicesFlag": false  }'
{  "id": "f858b8c4-2153-11ec-8c44-aeb16d1aa652",  "accountName": "0000123456-00001",  "campaignName": "Smart FOTA - test 4",  "firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10512_SR1.2.0.0-10657",  "protocol": "LWM2M",  "firmwareFrom": "SR1.2.0.0-10512",  "firmwareTo": "SR1.2.0.0-10657",  "make": "SEQUANS Communications",  "model": "GM01Q",  "status": "CampaignRequestPending",  "startDate": "2021-09-29",  "endDate": "2021-10-01",  "campaignTimeWindowList": [    {      "startTime": 18,      "endTime": 22    }  ]}