Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Warning

This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

Info

The information on this page applies to iSymphony 3.1+.

Description

The module license REST resource allows access to the module licenses for a specific license. Each module in the system can have its own license, where license properties specific to the module are stored. 

 

Panel
titleOn this page:

Table of Contents
maxLevel2
indent1
 

Root Resource Path

Code Block
communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses

JSON Representation

Code Block
{
  "id": "c5ec4a36-545b-4f80-a82c-4b009b7621a7",
  "moduleId": "core"
}
PropertyTypeDescription
id
String

Configuration id of the module license.

moduleIdStringThe id of the module the license is for.

Resource Paths

communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses
DescriptionAccesses all module licenses for the core server license.
GET Gets all the module licenses for the core server license.
 
communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}
DescriptionAccesses a specific module license.
GET

Gets a specific module license.

Parameters:

  • moduleLicenseId: The configuration id of the module license.

Errors:

  • 404: Returned if a module license with the given id does not exist.

Sub/Child Resource Paths

communication_manager/rest/config/server/coreServers/[{id} | getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties
Description

Access the sub/child resource that provides the properties of the module license.

See Module License Properties for more information.

Curl Examples

Get all module licenses for the given core server license

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/moduleLicenses

Get a specific module license

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/config/server/coreServers/bb8404fb-95b6-474c-b30e-0975283ea692/license/moduleLicenses/c5843sfb-95b6-474c-b32e-0973283ea592