Sign in
FOTA Job Executions

FetchCurrentPendingFOTAJobExecution

Fetches the pending (QUEUED or IN_PROGRESS) job execution with the earliest createdAt date. This will allow consistent FIFO (First In First Out) processing of incoming executions.

get/fota-job-executions/{deviceId}/current

Path parameters

deviceIdstring required

This is the canonical device id used in the device certificate, and as the MQTT client id.

Example:nrf-1234567890123456789000

Query parameters

firmwareType'APP' | 'MODEM' | 'BOOT' | 'SOFTDEVICE' | 'BOOTLOADER' | 'MDM_FULL' | 'SMP' | 'CUSTOM'

Firmware types that can be specified in the device's shadow in reported.device.serviceInfo.fota_v2 and in its Elasticsearch document in the firmware.supports array.

Return only executions with the given firmware type

Response

Ok

tenantIdstring required

The UUID of the team owning the device(s)

status'QUEUED' | 'IN_PROGRESS' | 'FAILED' | 'SUCCEEDED' | 'TIMED_OUT' | 'CANCELLED' | 'REJECTED' | 'DOWNLOADING' required
executionIdstring required

Universally unique identifier

jobIdstring required

Universally unique identifier

statusDetailstring
createdAtstring date-time required
deviceIdstring required

This is the canonical device id used in the device certificate, and as the MQTT client id.

lastUpdatedAtstring date-time required

Example response

{
  "status": "SUCCEEDED",
  "deviceId": "nrfsim-453330795897806100000",
  "createdAt": "2020-12-09T18:34:13.472Z",
  "executionId": "4d50a3ba-9573-4ec9-b362-02e2bde5aaee",
  "jobDocument": {
    "path": "3701edba-5bd5-4fcf-a0d1-769457a8f409/APP*c52c99d3*v1.3.0-280-g485445b6a869/AT_fast_blink.bin",
    "host": "firmware.nrfcloud.com",
    "firmwareType": "APP",
    "fileSize": 253640,
    "version": "v1.3.0-280-g485445b6a869"
  },
  "jobId": "f539350f-7784-470c-b0cf-c669147b0c54",
  "lastUpdatedAt": "2020-12-09T18:34:18.731Z",
  "tenantId": "3701edba-5bd5-4fcf-a0d1-769457a8f409",
  "statusDetail": "Job Completed"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.