components

Returns the status and metadata of a specific release.

Retrieves the current status and metadata of a specific release. This allows Marketplace component publishers to monitor the release status progress and make informed decisions about next steps.

Authorization: The user must have access to view the release.

Status Values:

Draft: The release is in Draft state and hasn't been submitted for review or published yet.
InReview: The release is under review.
- For private components, it is ready to be reviewed by a Mendix Admin if private approval is enabled for the related company.
- For public components, it undergoes security scanning and review by the security system.
Declined: The release is declined.
- For private components, the release is declined by a Mendix Admin.
- For public components, the security checks did not pass for the release.
Published: The release is published to the Marketplace and ready to be consumed.

get/releases/{releaseId}

Request

Base URL
https://marketplace-api.mendix.com/v1
Auth
API key in header Authorization

Path parameters

releaseIdstring uuid required

This is the UUID of the release.

Response

successful operation

namestring required

This is the name of the release of the component.

status'Draft' | 'InReview' | 'Declined' | 'Published' required

The current status of the release. Possible values are: Draft (being prepared), InReview (submitted for review), Declined (reviewed and declined), Published (approved and publicly available).

releaseIdstring uuid required

This is the UUID of the release.

versionNumberstring required

This is the version number of the release. The format is major.minor.patch (for example, 2.0.0).

minSupportedMendixVersionstring required

This is the Studio Pro version selected during the onboarding. This means that any Studio Pro version equal to or greater than this version is compatible with the latest release of the component.

publicationDatestring yyyy-MM-ddTHH-mm-ssZ

The date when the release was published. This field is only present for releases with the Published status.

releaseNotesstring

The release notes for this release.

Example response

{
  "name": "3d Viewer",
  "status": "Draft",
  "releaseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "versionNumber": "10.1.1",
  "minSupportedMendixVersion": "10.1.1",
  "publicationDate": "2023-09-01T09:04:00Z",
  "releaseNotes": "These are the release notes for this release."
}

Changes

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