Software Management Reports V3

Get firmware campaign status

GET
/fota/v3/reports/{acc}/firmware/campaigns

Retrieve a list of campaigns for an account that have a specified campaign status.

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

acc*string

Account identifier.

Query Parameters

campaignStatus*CampaignStatus

Campaign status.

Value in

  • "CampaignRequestPending"
  • "CampaignRequestFailed"
  • "CampaignRequestQueued"
  • "CampaignCancelled"
  • "CampaignAborted"
  • "CampaignFailed"
  • "CampaignScheduled"
  • "CampaignEnded"
lastSeenCampaignId?string

Last seen campaign Id.

Response Body

application/json

application/json

curl -X GET "https://example.com/fota/v3/reports/0000123456-00001/firmware/campaigns?campaignStatus=CampaignRequestPending"
{  "hasMoreData": true,  "lastSeenCampaignId": "60b5d639-ccdc-4db8-8824-069bd94c95bf",  "campaignList": [    {      "accountName": "0000123456-00001",      "id": "60b5d639-ccdc-4db8-8824-069bd94c95bf",      "campaignName": "FOTA_Verizon_Upgrade",      "firmwareName": "FOTA_Verizon_Model-A_02To03_HF",      "firmwareFrom": "FOTA_Verizon_Model-A_00To01_HF",      "firmwareTo": "FOTA_Verizon_Model-A_02To03_HF",      "make": "Verizon",      "model": "Model-A",      "status": "CampaignEnded",      "startDate": "2020-08-21",      "endDate": "2020-08-22",      "campaignTimeWindowList": [        {          "startTime": 20,          "endTime": 21        }      ]    }  ]}