The REST API provides the following methods to manage licenses:

POST /admin/licenses

URI

POST /admin/licenses

Description

Installs the given license which is in text/XML or binary format.

Request Header

Content-Type: text/xml, application/octet-stream
CSRF Protection Enabled

Content-Type: text/vnd.orchestral.rhapsody.6_0+xml, application/vnd.orchestral.rhapsody.6_0+octet-stream
CSRF Protection Enabled

Request Body

The content of the .ohl license file as string or binary stream.

The maximum size for the license file whose content is in a binary stream is 50KB.

Response Status

200 OK - license in text/XML format installed successfully.
204 No Content - license in binary format installed successfully.
Response Body Empty.

Access Rights

'Write licenses REST API'.

GET /admin/licenses

URI

GET /admin/licenses

Description

Returns the details of current licenses that are installed and the number of communication points in use which counts towards each license limit.

RequestHeader

Accept: text/xml, text/html

Accept: text/vnd.orchestral.rhapsody.6_0+xml
Accept: text/vnd.orchestral.rhapsody.6_4+xml

Request Body

Empty.

Response Status

200 OK - operation successful.
Response Body

text/html displays the license information in a browser; text/xml returns the license information in XML format.

<licenseInfo>
  <environmentType>Test</environmentType>
  <licenses>
    <license valid="true">
      <name>Rhapsody Engine</name>
      <version>6.3</version>
      <type>TEST</type>
      <id>05ca2abb-1fbd-4225-a983-53fbe691a1e7</id>
      <issueDate>2017-10-17T00:00:00.000+13:00</issueDate>
      <licensee>Rhapsody Health</licensee>
    </license>
  </licenses>
  <totalCommpoints>-1</totalCommpoints>
  <internal>false</internal>
  <componentId>SAP Toolkit</componentId>
  <componentId>Branding</componentId>
  <componentId>IHE Toolkit</componentId>
  <usedCommpoints>15</usedCommpoints>
</licenseInfo>

A license for unlimited communication points indicated by a totalCommpoints element with a value of -1.

Access Rights

'Read licenses REST API'.

DELETE /admin/licenses/<id>

URI

DELETE /admin/licenses/<id>

Description

Removes the license with the given license ID.

Request Header

Empty.

Request Body

Empty.

Response Status

200 OK - license removed successfully.
Response Body Empty.

Access Rights

'Write licenses REST API'.