Multiplay Clanforge

Open Clanforge

Multiplay Clanforge

Image version status

Documentation for Image version status
Read time 1 minuteLast updated a day ago

Return the status of the image version identified by
<imageversionid>
.
https://api.multiplay.co.uk/cfp/v1/imageversion/<imageversionid>/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
imageversionidThe <imageversionid> parameter identifies the game image version. The <imageversionid> is returned by a previous call to Image Create Version.No

Response Fields

FieldTypeDescriptionOptional
imageversionidintegerID of the image version being usedNo
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

Possible job states (values of
jobstateid
)

JOBSTATEIDDESCRIPTION
1Created (new job)
2Pending (waiting to be queued)
3Queued (waiting to be processed)
4Running
5Completed
6Failed

Example request

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

Example response

{
  "imageversionid": <imageversionid>,
  "jobcreated": <jobcreated>,
  "joberror": <joberror>,
  "jobeta": <jobeta>,
  "jobfailed": <jobfailed>,
  "jobprogress": <jobprogress>,
  "jobstart": <jobstart>,
  "jobstateid": <jobstateid>,
  "jobstatename": <jobstatename>,
  "jobupdated": <jobupdated>,
  "success": true
}