Branding

Version 7.1 by michaely on 2016/05/28 21:24

For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

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 server REST resource allows access to branding, version, and build information.

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

JSON Representation

{{code}}
"name": "iSymphony",
"provider": "i9 Technologies",
"website": "http:\/\/www.getisymphony.com",
"copyright": "Copyright \u00c2\u00a9 2016 HEHE Enterprises, LLC. All Rights Reserved.",
"eula": "<EULA TEXT>",
"version": "3.3.1.2343",
"revision": "43d2c50d",
"build": "2343",
"buildDate": 201603301247,
"buildDate": 201603301247,
"maintenanceRenewURL": "http:\/\/go.getisymphony.com\/mylicenses",
"maintenanceUpgradeInfoURL": "http:\/\/go.getisymphony.com\/maintenance"
}
{{/code}}

|=(((
Property
)))|=(((
Type
)))|=(((
Description
)))
|(% colspan="1" %)(% colspan="1" %)
(((
name\\
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The brand name.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
provider
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The brand provider.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
website
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The providers website.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
copyright
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The application copyright.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
eual
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The End User License Agreement.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
version
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The full version string.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
revision
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The revision of the build.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
build
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The build number.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
buildDate
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The build date. In the format yyyyMMddhhmm.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
aboutText
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The about screen text.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
maintenanceRenewURL
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The URL for maintenance renewals.
)))
|(% colspan="1" %)(% colspan="1" %)
(((
maintenanceUpgradeInfoURL
)))|(% colspan="1" %)(% colspan="1" %)
(((
String
)))|(% colspan="1" %)(% colspan="1" %)
(((
The URL for maintenance upgrade information.
)))

== Resource Paths ==
== Resource Paths ==
|=(% colspan="2" %)(% colspan="2" %)
(((
{{{communication_manager/rest/config/server/brand}}}
)))
|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
(((
**Description**
)))|(((
Accesses the branding, version, and build information of the server.
)))
|(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
(((
**GET**
)))|(((
Gets the branding, version, and build information of the server.
)))

= Curl Examples =

=== Get the server brand, version, and build information ===

{{code language="bash"}}
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" https://localhost:55050/communication_manager/rest/config/server/brand
{{/code}}