Documentation

Support

Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Image update status

Documentation for Image update status
Read time 1 minuteLast updated a day ago
Get the status of the image update identified by 
<updateid>
. 
https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/status
METHOD
GET

Request parameters

VARIABLEDESCRIPTIONOPTIONAL
accountserviceidThe <accountserviceid> parameter accepts an account service ID (ASID) associated with the specified resource. The credentials in the request header must have access to the ASID to perform the request.No
updateidThe <updateid> parameter accepts an update ID representing the image update job to get the status of.

The image update ID is returned from the Image Update Create endpoint.		No

Response fields

FieldTypeDescriptionOptional
jobcreatedintegerUnix timestamp of when the job was createdNo
joberrorstringMessage indicating the job errorYes
jobetaintegerUnix timestamp representing the time at which the job is expected to completeYes
jobfailedintegerNumeric flag indicating whether the job has failedNo
jobprogressintegerPercentage between 0 and 100 indicating job progressNo
jobstartstringUnix timestamp of when the job was startedYes
jobstateidintegerJob state ID indicating the state of the jobYes
jobstatenamestringName of the job stateNo
jobupdatedintegerUnix timestamp of when the job was last updatedNo
successbooleanFlag indicating whether this request was a successNo

Example request

curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imageupdate/<updateid>/status?accountserviceid=<accountserviceid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'

Example response

{
    "jobprogress": <jobprogress>,
    "jobstateid": <jobstateid>,
    "jobstart": <jobstart>,
    "joberror": null,
    "jobeta": <jobbeta>,
    "jobfailed": <jobfailed>,
    "success": true,
    "jobcreated": <jobcreated>,
    "updateid": <updateid>,
    "jobupdated": <jobupdateid>,
    "jobstatename": <jobstatename>
}