MEmendix
jobs

Get status and result

Retrieve the 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

Query parameters

logstring

Set the value to true to request the build log for the deployment package. The default value is false.

Response

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

idstring required

The ID of a JobRequest.

status'running' | 'finished' | 'failed' | 'created' 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
packageIdstring uuid

Only present if the JobRequest was for building or uploading a deployment package.

Example response

{
  "id": "42dec69c-9bdb-4918-a979-716fbbe3b8a6",
  "status": "finished",
  "details": "Request to delete a deployment package.",
  "packageId": "63e50976-34bf-4ce4-820b-9e5f106e5fa5",
  "error": {
    "code": 400,
    "message": "Request validation errors"
  },
  "log": {
    "build": "Pipeline created at 2023-02-17T15:01:19Z [teamserver-discovery] 2023-02-17T15:01:24.551071428Z Project: a335e635-e0aa-4514-9437-c95aafa1fc12 [teamserver-discovery] 2023-02-17T15:01:24.551130910Z Determining repository type..."
  }
}

Changes

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