Assemblies

Assemblies: Licensing .NET Components with Babel Licensing

The Assemblies section in the Babel Licensing Service API plays a pivotal role in the licensing of .NET components. An assembly in the .NET framework context is a reusable, versionable, and self-describing building block of a .NET application. Through Babel Licensing, these assemblies become the primary entities for which licensing is applied and managed, ensuring that each component used in an application adheres to the specified licensing terms.

Get

Roles: Administrator, LicenseManager

This method is used for accessing detailed information about specific assemblies managed by the Babel Licensing Service. This functionality is crucial for monitoring and managing the software components that are licensed, ensuring they are up-to-date and compliant with the licensed applications.

Retrieves a list of assemblies.

get
Authorizations
Query parameters
selectstringOptional
filterstringOptional
sortstringOptional
takeinteger · int32Optional
skipinteger · int32Optional
Responses
200

Success

application/json
get
/v1/assemblies
GET /v1/assemblies HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "code": 1,
  "message": "text",
  "assemblies": [
    {
      "id": 1,
      "name": "text",
      "version": "text",
      "culture": "text",
      "publicKeyToken": "text",
      "mappingFileId": 1,
      "debugSymbolsKey": "text"
    }
  ],
  "totalAssembliesCount": 1
}

Post

Roles: Administrator, LicenseManager

The POST method facilitates the registration of new assemblies within the system. It is used to add new assembly details.

Inserts a new assembly.

post
Authorizations
Body

InsertAssemblyRequest is used to insert a new assembly.

Responses
200

Success

application/json
post
/v1/assemblies
POST /v1/assemblies HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "assembly": {
    "id": 1,
    "name": "text",
    "version": "text",
    "culture": "text",
    "publicKeyToken": "text",
    "mappingFileId": 1,
    "debugSymbolsKey": "text"
  }
}
{
  "assemblyId": 1,
  "success": true,
  "code": 1,
  "message": "text"
}

Put

Roles: Administrator, LicenseManager

Utilizing the PUT method allows for modifications to the information of existing assemblies. This could involve updating the version details. This method is vital for keeping the assembly information current and accurate, reflecting any updates or changes in the software components.

Updates an existing assembly.

put
Authorizations
Body

UpdateAssemblyRequest is used to update an existing assembly.

Responses
200

Success

application/json
put
/v1/assemblies
PUT /v1/assemblies HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "assembly": {
    "id": 1,
    "name": "text",
    "version": "text",
    "culture": "text",
    "publicKeyToken": "text",
    "mappingFileId": 1,
    "debugSymbolsKey": "text"
  }
}
{
  "success": true,
  "code": 1,
  "message": "text"
}

Delete

Roles: Administrator, LicenseManager

The DELETE method is used to remove assembly records from the Babel Licensing Service. This action may be necessary when an assembly is no longer in use, has been superseded by a newer version, or when it's necessary to clean up outdated records.

Deletes an assembly by ID.

delete
Authorizations
Path parameters
assemblyIdinteger · int32Required

assembly_id is the ID of the assembly to delete.

Responses
200

Success

application/json
delete
/v1/assemblies/{assemblyId}
DELETE /v1/assemblies/{assemblyId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "code": 1,
  "message": "text"
}

Last updated