Build Detail

Get all the build details present

Returns all the details of build posted by Jenkins

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 details list in FOTA

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

Create a new build detail entry

Request
Request Body schema: application/json
build_type
required
string
Enum: "FULL" "INCREMENTAL"
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
build_no
required
string
meta_data
required
object
s3_key
required
string
is_lkg
boolean
Default: false
source_build
string
target_build
required
string
size_in_bytes
integer
is_active
boolean
Default: true
lkg
string <uuid>
Responses
201

Build detail created

400

Build detail create error

401

Build detail create error

post/api/v0/builddetail/
Request samples
application/json
{
  • "build_type": "FULL",
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "is_lkg": false,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "build_type": 0,
  • "device_name": 0,
  • "track": 0,
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "cloud_front_url": "string",
  • "is_lkg": true,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0",
  • "created_on": "string",
  • "updated_on": "string"
}

Get a build detail

Request
path Parameters
builddetail_id
required
string

ID of the build detail

Responses
200

Build detail information

get/api/v0/builddetail/{builddetail_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "build_type": 0,
  • "device_name": 0,
  • "track": 0,
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "cloud_front_url": "string",
  • "is_lkg": true,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0",
  • "created_on": "string",
  • "updated_on": "string"
}

Update a Build Detail

Request
path Parameters
builddetail_id
required
string

ID of the Build detail

Request Body schema: application/json
build_type
required
string
Enum: "FULL" "INCREMENTAL"
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
build_no
required
string
meta_data
required
object
s3_key
required
string
is_lkg
boolean
Default: false
source_build
string
target_build
required
string
size_in_bytes
integer
is_active
boolean
Default: true
lkg
string <uuid>
Responses
200

Updated build detail information

400

Build detail update error

401

Build detail update error

put/api/v0/builddetail/{builddetail_id}/
Request samples
application/json
{
  • "build_type": "FULL",
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "is_lkg": false,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "build_type": 0,
  • "device_name": 0,
  • "track": 0,
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "cloud_front_url": "string",
  • "is_lkg": true,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0",
  • "created_on": "string",
  • "updated_on": "string"
}

Partial update build detail

Request
path Parameters
builddetail_id
required
string

ID of the build detail

Request Body schema: application/json
build_type
required
string
Enum: "FULL" "INCREMENTAL"
device_name
required
string
Enum: "HUMMINGBIRD" "BLUEJAY" "FALCON" "FALCON_32" "PEACOCK" "FOENIX" "HAWK" "EAGLE"
track
required
string
Enum: "ALPHA" "BETA" "PRODUCTION"
build_no
required
string
meta_data
required
object
s3_key
required
string
is_lkg
boolean
Default: false
source_build
string
target_build
required
string
size_in_bytes
integer
is_active
boolean
Default: true
lkg
string <uuid>
Responses
200

Updated build detail Information

400

Build detail update error

401

Build detail update error

patch/api/v0/builddetail/{builddetail_id}/
Request samples
application/json
{
  • "build_type": "FULL",
  • "device_name": "HUMMINGBIRD",
  • "track": "ALPHA",
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "is_lkg": false,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "build_type": 0,
  • "device_name": 0,
  • "track": 0,
  • "build_no": "string",
  • "meta_data": { },
  • "s3_key": "string",
  • "cloud_front_url": "string",
  • "is_lkg": true,
  • "source_build": "string",
  • "target_build": "string",
  • "size_in_bytes": 0,
  • "is_active": true,
  • "lkg": "03f83540-55bc-4ee1-bf84-9180112980d0",
  • "created_on": "string",
  • "updated_on": "string"
}

Delete a build detail

Request
path Parameters
builddetail_id
required
string

ID of the build detail

Responses
200

Deleted build detail Information

401

Build detail delete error

delete/api/v0/builddetail/{builddetail_id}/