License Templates

License Templates: Blueprint for Streamlined License Creation

In the Babel Licensing Service, License Templates serve as a foundational blueprint for the creation of licenses, streamlining the process and ensuring consistency across licensing terms. These templates are particularly beneficial when managing licenses for specific product releases or various versions of a software package.

Get

Roles: Administrator, LicenseManager

This method is employed to access information about existing license templates. It allows users to view details such as the components, features, and restrictions defined in each template. This functionality is crucial for understanding the predefined licensing frameworks and ensuring they align with the current product and licensing strategies.

Retrieves a list of license templates.

GET/v1/license-templates

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.

licenseTemplatesarray of LicenseTemplate (object)

license_templates is the list of license templates.

totalLicenseTemplatesCountinteger (int32)

total_license_templates_count is the total number of license templates.

Request

JavaScriptCurl

const response = await fetch('/v1/license-templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenseTemplates": [
    {
      "name": "text",
      "code": "text",
      "format": "Xml",
      "licenseFileName": "text",
      "generateKeyInfo": false,
      "description": "text",
      "template": "text",
      "product": {
        "id": "text",
        "name": "text",
        "version": "text",
        "copyright": "text",
        "url": "text",
        "description": "text"
      },
      "components": [
        "text"
      ],
      "assemblies": [
        {
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "debugSymbolsKey": "text"
        }
      ],
      "fields": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "features": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "expireDate": "text",
          "key": "text",
          "data": "text"
        }
      ],
      "restrictions": [
        {
          "id": "text",
          "name": "text",
          "expireDate": "text"
        }
      ]
    }
  ]
}

Post

Roles: Administrator, LicenseManager

The POST method facilitates the creation of new license templates. It enables users to define a new set of licensing terms and conditions that will be applied to future licenses created from this template. This method is essential for setting up new licensing structures for upcoming product releases or updates.

Inserts a new license template.

POST/v1/license-templates

Body

application/json

licenseTemplateLicenseTemplate (object)

LicenseTemplate represents a license template.

Response

200default

Success

Body

application/json

templateIdinteger (int32)

template_id is the ID of the inserted license template.

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/license-templates', {
    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 existing license templates. This could include updating the terms and conditions, adapting the template to new product versions, or altering other key attributes. This method is crucial for maintaining the relevance of license templates in response to evolving product features or licensing requirements.

Updates an existing license template.

PUT/v1/license-templates

Body

application/json

licenseTemplateLicenseTemplate (object)

LicenseTemplate represents a license template.

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/license-templates', {
    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 delete existing license templates from the system. This action might be necessary when a template is outdated, replaced by a newer version, or no longer applicable to the current product lineup. It is an important aspect of managing the lifecycle of license templates, ensuring that only relevant and current templates are in use.

Deletes a license template by ID.

DELETE/v1/license-templates/{templateId}

Path parameters

templateId*integer (int32)

template_id is the ID of the license template 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/license-templates/{templateId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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