Module License Properties

Last modified by michaely on 2021/09/10 23:34

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

The information on this page applies to iSymphony 3.1+.

Description

The module license properties REST resource allows access to the properties of a specific module licenses. Each module licenses property will specify functionality that the license allows.

On this page:

The [toc] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

Root Resource Path

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

JSON Representation

{
"id": "f7814391-b894-4c04-b0ff-0877f1a93f26",
"key": "pbx_connections",
"value": "1",
"displayName": "PBX Connections",
"description": "The total amount of PBX connections allowed.",
"display": true
}

Property	Type	Description
id	String	Configuration id of the module license property.
key	String	The key of the module license property.
displayName	String	The display name of the module license property.
description	String	The description of the module license property.
display	Boolean	Flag specifying if the property should be visible on the License activation page, in the administration interface.

Resource Paths

communication_manager/rest/config/server/coreServers/[{id} \| getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties
Description	Accesses all properties for the module license license.
GET	Gets all the properties for the module license.

communication_manager/rest/config/server/coreServers/[{id} \| getByName/{slug}]/license/moduleLicenses/{moduleLicenseId}/properties/{propertyId}
Description	Accesses a specific module license property.
GET	Gets a specific module license property. Parameters: propertyId: The configuration id of the module license property. Errors: 404: Returned if a module license property with the given id does not exist.

Curl Examples

Get all properties for the given module license

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/properties