Releases

Managing Product Versions and Updates

The 'Releases' endpoint, functioning as an integral part of the 'Products' section in the Babel Licensing API, is specifically focused on managing and tracking the various versions or updates of products. This endpoint plays a vital role in maintaining comprehensive records of each product's lifecycle, particularly from the perspective of licensing. It ensures that every iteration, enhancement, or modification of a product is accurately documented and aligned with its corresponding licenses

Get

Roles: Administrator, LicenseManager

This GET method is used to access and view detailed information about the various releases of a specific product. It enables users to fetch data such as release versions, release dates, and descriptions of the changes or features in each release.

Retrieves a list of releases for a specific product.

GET/v1/products/{productId}/releases

Path parameters

productId*integer (int32)

product_id is the ID of the product.

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

releasesarray of Release (object)

releases is the list of product releases.

totalReleasesCountinteger (int32)

total_releases_count is the total number of product releases.

Request

JavaScriptCurl

const response = await fetch('/v1/products/{productId}/releases', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "releases": [
    {
      "releaseDate": "text",
      "name": "text",
      "version": "text",
      "description": "text"
    }
  ]
}

Post

Roles: Administrator, LicenseManager

The POST method allows for the introduction of a new release for a product within the system. It is used to add details about a new version, including version number, release notes, and the specifics of what is new or improved in this iteration.

Inserts a new release for a specific product.

POST/v1/products/{productId}/releases

Path parameters

productId*integer (int32)

product_id is the ID of the product.

Body

application/json

productIdinteger (int32)

product_id is the ID of the product.

releaseRelease (object)

Release represents a product release in the system.

Response

200default

Success

Body

application/json

releaseIdinteger (int32)

release_id is the ID of the inserted product release.

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/products/{productId}/releases', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Put

Roles: Administrator, LicenseManager

Utilizing the PUT method allows for modifications to the details of an existing product release..

Updates a release for a specific product.

PUT/v1/products/{productId}/releases

Path parameters

productId*integer (int32)

product_id is the ID of the product.

Body

application/json

productIdinteger (int32)

product_id is the ID of the product.

releaseRelease (object)

Release represents a product release in the system.

Response

200default

Success

Body

application/json

releaseIdinteger (int32)

release_id is the ID of the updated product release.

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/products/{productId}/releases', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}

Delete

Roles: Administrator, LicenseManager

The DELETE method is used to remove the record of a specific product release from the system.

Deletes a release for a specific product.

DELETE/v1/products/{productId}/releases/{releaseId}

Path parameters

productId*integer (int32)

product_id is the ID of the product.

releaseId*integer (int32)

release_id is the ID of the product release to delete.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/products/{productId}/releases/{releaseId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}