MEmendix
jobs

Get Status and Result

Retrieve status of an asynchronous job which has been initiated by an API call. Each API call which successfully starts a job will return the "id" of the job which can be used in this API call.

get/jobs/{jobId}

Request

  • Base URL
    https://privatecloud.mendixcloud.com/api/v4
  • Auth
    API key in header Authorization

Response

The job response returned by a get-job request. The Location header is populated once the job has been created successfully.

idstring uuid required

Model for jobId.

status'created' | 'running' | 'failed' | 'finished' required

created - a job has been created but has not been picked up for processing <br/> running - the job is being processed <br/> finished - the job has finished processing <br/> failed - something went wrong and the job processing failed

detailsstring

Example response

{
  "id": "db6ed4d3-8b6d-4c2b-ad2b-2a69d0f7afe0",
  "status": "finished",
  "details": "Request to create cluster.",
  "error": {
    "code": 400,
    "message": "Request validation errors"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.