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 core server REST resource allows access to the configuration of a core server. There are currently no top level properties of a core server that can be modified. This resource simply serves as a parent resource to access other sub/child resources.

 

Panel
titleOn this page:

Table of Contents
maxLevel2
indent1
 

Root Resource Path

Code Block
communication_manager/api/resource/core	

JSON Representation

Code Block
{
	"serverId": "9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7"	
}
PropertyTypeDescription
serverId
String

The id of the core server that the configuration represents.

Anchor
auth_token_rest_json
auth_token_rest_json
Session Authentication Token

The following is the JSON used for requesting a Session Authentication Token from the core server resource.

Request

Code Block
{
	"username": "johnd",
	"password": "pass"
}
PropertyTypeDescription
username
String

The authentication username to create the session token with.

password
StringThe authentication password to create the session token with.

Reply

Code Block
{
	"sessionIdentifier": "1b841f86-8dfe-4e97-9609-8af83888fbfd",
	"userIdentifier": "ed38fe4d-13ad-4fd0-be25-d3404c421370",
	"expiry": 1417995590444,
	"renewExpiry": false
}
PropertyTypeDescription
sessionIdentifier
String

The identifier provided to the system when logging in with this session token.

userIdentifier
StringThe UUID of the user this session token is related to.
expiry
longThe Unix timestamp, in milliseconds, when the token will expire.
renewExpiry
boolean

True if the session expiry will be extended when the token is successfully used.

Info

This value will always be false for tokens created via the REST system.

Resource Paths

communication_manager/api/resource/core
DescriptionAccesses the configuration models for all core servers in the system.
GET Gets all the configuration models for all core servers in the system.
 
communication_manager/api/resource/core/{core_server_id}
Description

Accesses the configuration model for the specified core server.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.
GETGets the chat configuration model for the specified core server.

Sub/Child Resource Paths

communication_manager/api/resource/core/{core_server_id}/users
Description

Access the sub/child resource for users, in a specified core server, via the core server id.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.

See User Configuration for more information.

 
communication_manager/api/resource/core/{core_server_id}/statuses
Description

Access the sub/child resource for statuses, in a specified core server via the via the core server id.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.

See User Status Configuration for more information.

 
communication_manager/api/resource/core/{core_server_id}/userGroups
Description

Access the sub/child resource for user groups, in a specified core server via the via the core server id.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.

See User Group Configuration for more information.

 
communication_manager/api/resource/core/{core_server_id}/permissions
Description

Access the sub/child resource for permissions, in a specified core server via the via the core server id.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.

See Permissions Configuration for more information.

 
communication_manager/api/resource/core/{core_server_id}/authToken
Description

Access the sub/child resource for creating authentication tokens, via the core server id.

For JSON used to in the request and response for this resource see Session Authentication Token above.

Parameters:

  • core_server_id: The UUID of the core server.

Errors:

  • 404 'Failed to locate the core server with the given id.': Returned if no core server exists with the given id.

See Session Authentication Tokens for more information.

Curl Examples

Get configuration for all core servers

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core

Get the configuration for a specific core server

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Accept: application/json" http://localhost:58080/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7

Request an authentication session token

Code Block
languagebash
curl --user manager:manag3rpa55word -k -i -H "Content-Type: application/json" -H "Accept: application/json" -X POST -d '{"username":"johnd","password":"pass"}' http://localhost:55050/communication_manager/api/resource/core/9280cd1c-4ad7-4ed9-ae8a-0648b0b45cf7/authToken