MEmendix
packages

Build deployment package

Create a new deployment package for a given branch and revision.

post/apps/{appId}/packages/build

Request

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

Request body

branchstring required

The name of the branch

revisionstring required

The revision number (for SVN) or string (for Git)

descriptionstring

An optional description of the package

versionstring

The version of the package in x.y.z format

Example request

{
  "branch": "main",
  "revision": "93de884c",
  "description": "Fixed issues 7733, 7734 and 7613",
  "version": "2.0.4"
}

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.