Campaigns V2
Schedule a software upgrade
This endpoint allows user to schedule a software upgrade.
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
account*string
Account identifier.
Request Body
*/*
Software upgrade information.
Software upgrade information.
campaignName?string
Campaign name.
softwareName*string
Software name to upgrade to.
softwareFrom*string
Old software name.
softwareTo*string
New software name.
distributionType*string
OMA or HTTP.
startDate*string
Campaign start date.
Format
dateendDate*string
Campaign end date.
Format
datedownloadAfterDate?string
Specifies starting date client should download package. If null, client will download as soon as possible.
Format
datedownloadTimeWindowList?array<>
List of allowed download time windows.
installAfterDate?string
Client will install package after date. If null, client will install as soon as possible.
Format
dateinstallTimeWindowList?array<>
List of allowed install time windows.
deviceList*array<string>
Device IMEI list.
Response Body
application/json
application/json
curl -X POST "https://example.com/fota/v2/campaigns/0000123456-00001" \ -H "Content-Type: */*" \ -d '<campaignName>FOTA_Verizon_Upgrade</campaignName> <softwareName>FOTA_Verizon_Model-A_02To03_HF</softwareName> <softwareFrom>FOTA_Verizon_Model-A_00To01_HF</softwareFrom> <softwareTo>FOTA_Verizon_Model-A_02To03_HF</softwareTo> <distributionType>HTTP</distributionType> <startDate>2020-08-21</startDate> <endDate>2020-08-22</endDate> <downloadAfterDate>2020-08-21</downloadAfterDate> <downloadTimeWindowList> <startTime>20</startTime> <endTime>21</endTime> </downloadTimeWindowList> <installAfterDate>2020-08-21</installAfterDate> <installTimeWindowList> <startTime>22</startTime> <endTime>23</endTime> </installTimeWindowList> <deviceList>990013907835573</deviceList> <deviceList>990013907884259</deviceList>'{ "id": "60b5d639-ccdc-4db8-8824-069bd94c95bf", "accountName": "0402196254-00001", "campaignName": "FOTA_Verizon_Upgrade", "softwareName": "FOTA_Verizon_Model-A_02To03_HF", "distributionType": "HTTP", "make": "Verizon", "model": "Model-A", "softwareFrom": "FOTA_Verizon_Model-A_00To01_HF", "softwareTo": "FOTA_Verizon_Model-A_02To03_HF", "startDate": "2020-08-21", "endDate": "2020-08-22", "downloadAfterDate": "2020-08-21", "downloadTimeWindowList": [ { "startTime": 20, "endTime": 21 } ], "installAfterDate": "2020-08-21", "installTimeWindowList": [ { "startTime": 22, "endTime": 23 } ], "status": "CampaignRequestPending"}