Image diff retry
Warning: The API documentation here is for Managed Game Server Hosting (Clanforge). If you’re using Game Server Hosting (Multiplay), refer to the Game Server API documentation.
Retry the image difference analysis job identified by <diffid>.
https://api.multiplay.co.uk/cfp/v1/imagediff/<diffid>/retryMETHOD |
| GET |
Request 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 that identifies a difference analysis in a completed or failed state. The specified <diffid> will be retried (i.e., the differences will be recalculated). | No |
Response fields
| Field | Type | Description | Optional |
|---|---|---|---|
| diffid | integer | ID of the diff job that was triggered | 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 |
Example request
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/imagediff/<diffid>/retry?accountserviceid=<accountserviceid>' \
--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'Example response
{
"diffid": <diffid>,
"jobcreated": <jobcreated>,
"joberror": <joberror>,
"jobeta": <jobeta>,
"jobfailed": <jobfailed>,
"jobprogress": <jobprogress>,
"jobstart": <jobstart>,
"jobstateid": <jobstateid>,
"jobstatename": <jobstatename>,
"jobupdated": <jobupdated>
}