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

Authorizations

Path parameters

productIdinteger · int32required

product_id is the ID of the product.

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/products/{productId}/releases' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "releases": [
    {
      "id": 1,
      "releaseDate": "text",
      "name": "text",
      "version": "text",
      "description": "text"
    }
  ],
  "totalReleasesCount": 1
}

Success

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

Authorizations

Path parameters

productIdinteger · int32required

product_id is the ID of the product.

Body

productIdinteger · int32optional

product_id is the ID of the product.

releaseobjectoptional

Release represents a product release in the system.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/products/{productId}/releases' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "productId": 1,
    "release": {
      "id": 1,
      "releaseDate": "text",
      "name": "text",
      "version": "text",
      "description": "text"
    }
  }'

200

default

200

{
  "releaseId": 1,
  "success": true,
  "code": 1,
  "message": "text"
}

Success

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

Authorizations

Path parameters

productIdinteger · int32required

product_id is the ID of the product.

Body

productIdinteger · int32optional

product_id is the ID of the product.

releaseobjectoptional

Release represents a product release in the system.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/products/{productId}/releases' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "productId": 1,
    "release": {
      "id": 1,
      "releaseDate": "text",
      "name": "text",
      "version": "text",
      "description": "text"
    }
  }'

200

default

200

{
  "releaseId": 1,
  "success": true,
  "code": 1,
  "message": "text"
}

Success

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

Authorizations

Path parameters

productIdinteger · int32required

product_id is the ID of the product.

releaseIdinteger · int32required

release_id is the ID of the product release to delete.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/products/{productId}/releases/{releaseId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success