Core Server

Version 5.1 by michaely on 2015/07/09 12:02

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.

Description

The live core server REST resource allows access to information about a core server. There are currently no actions that can be performed on a core server. This resource simply serves as a parent resource to access other sub/child resources.

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/live/coreServers

JSON Representation

{
"id": "11de1781-b239-4ced-bd24-7b06d4c9956b",
"slug": "default",
"name": "default"
}

Property	Type	Description
id	String	The id of the core server.
slug	String	The directory slug of the core server.
name	String	The display name of the core server.

Resource Paths

communication_manager/rest/live/coreServers/
Description	Accesses the state of all core servers in the system.
GET	Gets the state of all core servers in the system.

communication_manager/rest/live/coreServers/{core_server_id}
Description	Access the state of a specific core server, by core server id. Parameters: core_server_id: the id of the core server to access Errors: 404 Not Found: Returned if no core server with the given id exists
GET	Gets the state of a specific core server.

communication_manager/rest/live/coreServers/getByName/{core_server_slug}
Description	Access the state of a specific core server, by core server slug. Parameters: core_server_slug: the slug of the core server to access Errors: 404 Not Found: Returned if no core server with the given slug exists
GET	Gets the state of a specific core server.

communication_manager/rest/live/coreServers/[{core_server_id} \| getByName/{core_server_slug}]/users
Description	Access the sub/child resource for users, Parameters: core_server_slug: the slug of the core server to access Errors: 404 Not Found: Returned if no core server with the given slug exists
GET

Resource Actions

path
Description	description Parameters: parameter name: parameter description Errors: error code and message: Error description
HTTP Method	Method description

Curl Examples

Example description

curl code