Image diff status# Warning : The API documentation here is for Clanforge. If you’re using Multiplay Hosting, refer to the Multiplay Hosting API documentation .
Get the status of the image difference analysis with the provided <diffid>. You also must include the correct <accountserviceid>.
https://api.multiplay.co.uk/cfp/v1/imagediff/<diffid>/statusFor example,
curl -X GET \
-H "Authorization: Basic <CLANFORGE_CREDENTIALS>" \
https://api.multiplay.co.uk/cfp/v1/imagediff/1234/status?accountserviceid=5678&diff_info=1Request parameters# VARIABLE DESCRIPTION OPTIONAL accountserviceid The <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 diffid The <diffid> parameter accepts a difference analysis ID for which to return the status. No diff_info The <diff_info> parameter accepts a boolean value.If specified with a value of 1, the response will include additional information about <diffid>, including:
The game image The game The specific machine If excluded or specified with a value of 0, no additional information about the difference analysis will be included in the response.
Yes
Response fields# Field Type Description Optional diffid integer ID of the diff job No jobcreated integer Unix timestamp of when the job was created No joberror string Message indicating the job error Yes jobeta integer Unix timestamp representing the time at which the job is expected to complete Yes jobfailed integer Numeric flag indicating whether the job has failed No jobprogress integer Percentage between 0 and 100 indicating job progress No jobstart string Unix timestamp of when the job was started Yes jobstateid integer Job state ID indicating the state of the job Yes jobstatename string Name of the job state No jobupdated integer Unix timestamp of when the job was last updated No game object Object containing information about game used if diff_info=1 No machine object Object containing information about build box machine used if diff_info=1 No image object Object containing information about image used if diff_info=1 No added object Map of file paths to file objects being added No modified object Map of file paths to file objects being modified No removed object Map of file paths to file objects being removed No
Game Object# Field Type Description Optional gameid integer ID of the game used by this diff No name string Name of the game used by this diff No
Machine Object# Field Type Description Optional machineid integer ID of the buildbox this diff was run on No name string Name of the buildbox this diff was run on No
Image Object# Field Type Description Optional imageid integer ID of the image used by this diff No name string Name of the image used by this diff No gameversionid integer ID of the game version used by this diff No
File Object# Field Type Description Optional filesize string Size of file in bytes No crc32sum integer A crc32 checksum of the file No
Example request# curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imagediff/<diffid>/status?diff_info=1' \
--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>,
"added": {
<filename>: {
"size": <file>,
"crc": <crc32sum>
},
...
},
"modified": {
<filepath>: {
"size": <filesize>,
"crc": <crc32sum>
},
...
},
"removed": {
<filepath>: {
"size": <filesize>,
"crc": <crc32sum>
},
...
},
"image" : {
"imageid" : <imageid>,
"gameversionid" : <gameversionid>,
"name" : <image_name>
},
"game" : {
"gameid" : <gameid>,
"name" : <game_name>
},
"machine : {
"machineid" : <machineid>,
"name" : <machine_name>
}
}