Build Request

Get all the build requests in FOTA

Request
query Parameters
limit
integer

Number of results to return per page

offset
integer

The initial index from which to return the results

Responses
200

Build request list in FOTA

get/api/v0/buildrequest/
Response samples
application/json
{
  • "count": 0,
  • "previous": "string",
  • "next": "string",
  • "results": [
    ]
}

Create a build request

Request
Request Body schema: application/json
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
source_build
string
target_build
required
string
state
string
Enum: "BUILD_SCHEDULED" "BUILD_JOB_STARTED" "BUILD_STARTED" "BUILD_FINISHED" "BUILD_SUCCEDED" "BUILD_FAILED" "BUILD_ABORTED" "BUILD_JOB_COMPLETED"
build_progress
integer
client
string
client_callback_url
string
Responses
201

Build request create succesful

400

Build request create error

401

Build request create error

post/api/v0/buildrequest/
Request samples
application/json
{
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "device_name": 0,
  • "track": 0,
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Get a build request

Request
path Parameters
buildrequest_id
required
string

ID of the build request

Responses
200

Build request information

get/api/v0/buildrequest/{buildrequest_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "device_name": 0,
  • "track": 0,
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Update a Build Request

Request
path Parameters
buildrequest_id
required
string

ID of the Build request

Request Body schema: application/json
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
source_build
string
target_build
required
string
state
string
Enum: "BUILD_SCHEDULED" "BUILD_JOB_STARTED" "BUILD_STARTED" "BUILD_FINISHED" "BUILD_SUCCEDED" "BUILD_FAILED" "BUILD_ABORTED" "BUILD_JOB_COMPLETED"
build_progress
integer
client
string
client_callback_url
string
Responses
200

Updated build request information

400

Build request update error

401

Build request update error

put/api/v0/buildrequest/{buildrequest_id}/
Request samples
application/json
{
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "device_name": 0,
  • "track": 0,
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Partial update build request

Request
path Parameters
buildrequest_id
required
string

ID of the Build request

Request Body schema: application/json
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
source_build
string
target_build
required
string
state
string
Enum: "BUILD_SCHEDULED" "BUILD_JOB_STARTED" "BUILD_STARTED" "BUILD_FINISHED" "BUILD_SUCCEDED" "BUILD_FAILED" "BUILD_ABORTED" "BUILD_JOB_COMPLETED"
build_progress
integer
client
string
client_callback_url
string
Responses
200

Update build request information

400

Build request update error

401

Build request update error

patch/api/v0/buildrequest/{buildrequest_id}/
Request samples
application/json
{
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "device_name": 0,
  • "track": 0,
  • "source_build": "string",
  • "target_build": "string",
  • "state": "BUILD_SCHEDULED",
  • "build_progress": 0,
  • "client": "string",
  • "client_callback_url": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z"
}

Delete a build request

Request
path Parameters
buildrequest_id
required
string

ID of the build request

Responses
200

Deleted Build Request Information

401

Build request delete error

delete/api/v0/buildrequest/{buildrequest_id}/