Conference Template

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/conference-templates

Summary

Resources	Methods
https://localhost:8443/api/rest/conference-templates	GET Retrieves conference templates. POST Creates a conference room template.
https://localhost:8443/api/rest/conference-templates/{value}	GET Retrieves a conference template. PUT Updates a conference template. DELETE Deletes a conference template.

Resources

https://localhost:8443/api/rest/conference-templates

Methods

GET

Retrieves conference templates. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-template-list+xml application/vnd.plcm.plcm-conference-template-list+json application/vnd.plcm.plcm-conference-template-list-v2+xml application/vnd.plcm.plcm-conference-template-list-v2+json application/vnd.plcm.plcm-conference-template-list-v3+xml application/vnd.plcm.plcm-conference-template-list-v3+json application/vnd.plcm.plcm-conference-template-list-v4+xml application/vnd.plcm.plcm-conference-template-list-v4+json application/vnd.plcm.plcm-conference-template-list-v5+xml application/vnd.plcm.plcm-conference-template-list-v5+json application/vnd.plcm.plcm-conference-template-list-v6+xml application/vnd.plcm.plcm-conference-template-list-v6+json application/vnd.plcm.plcm-conference-template-list-v7+xml application/vnd.plcm.plcm-conference-template-list-v7+json application/vnd.plcm.plcm-conference-template-list-v8+xml application/vnd.plcm.plcm-conference-template-list-v8+json	Information successfully retrieved.
304		Conference template information has not changed since the last search. Note: The API client must provide the "plcm-conference-template-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-template-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to conference templates on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, provisioner

POST

Creates a conference room template. Any submitted ID is ignored. The ID is assigned by the system.

Name is required and must be unique. If a conference room template pre-exists with the same name the request fails.

DMA role required: administrator.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-template-v3+xml

application/vnd.plcm.plcm-conference-template-v3+json

application/vnd.plcm.plcm-conference-template-v4+xml

application/vnd.plcm.plcm-conference-template-v4+json

application/vnd.plcm.plcm-conference-template-v5+xml

application/vnd.plcm.plcm-conference-template-v5+json

application/vnd.plcm.plcm-conference-template-v6+xml

application/vnd.plcm.plcm-conference-template-v6+json

application/vnd.plcm.plcm-conference-template-v7+xml

application/vnd.plcm.plcm-conference-template-v7+json

application/vnd.plcm.plcm-conference-template-v8+xml

application/vnd.plcm.plcm-conference-template-v8+json

Response

Status	Representation	Description
201		Conference room template created successfully. The ETag returned in the HTTP header represents the version of the conference room template.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name already used.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid name length. Required: 1 - 50 characters.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid description length. If supplied, description must be less than 50 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid RMX profile. The RMX profile name supplied is not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian lecture mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian floor and chair control value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian layout control value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian mute DTMF value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian allow mute audio value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian content channel video value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian content resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian custom layout allowed value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian layout value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid HD resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid line rate value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid content rate value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid encryption policy value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid TIP compatibility value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid TIP compatibility value. It must be set to NONE when conference mode is not AVC only.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid gathering language value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering access number 1 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering access number 2 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 1 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 2 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 3 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid video quality value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid resolution limit value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 settings value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 protocol value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid video layout value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid telepresence mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid telepresence layout mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid skin value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid IVR service value. The value was not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid recording link value. The value was not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid recording type value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid codec support value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid priority value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	You cannot specify both Cascading for Size and Use Cascading. These features are mutually exclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid participants join type.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Conference Mode Experience value is not valid for the selected codec.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	One or more video content settings conflict with the selected conference codec value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Content Protocol must be H.264 cascade optimized (H_264_FIX) if cascade by size or bandwidth is selected.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	AS SIP Content cannot be set in sSVC and Mixed mode.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Content Protocol can only be H.264 HD and H.246 Cascade Optimized when conference mode is SVC Only
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Line rate in SVC and Mixed mode cannot exceed 4096 Kbps.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid WebRTC aspect value.
409	application/vnd.plcm.plcm-error+xml	A WebRTC-enabled template cannot be configured to use an RMX profile.
409	application/vnd.plcm.plcm-error+xml	One or more settings within the template are incompatible with a WebRTC-enabled experience.
409	application/vnd.plcm.plcm-error+xml	multiple-resolution, content-transcoding-h264 and h264-poly-svc-cascade must be set to true when conference-codec-support is AVC_POLY_SVC, all other transcode options must be false.

https://localhost:8443/api/rest/conference-templates/{value}

Template Parameters

Name	Type	Description
value	xs:string	Unique name or identifier of the template. [tags: DMA]

Methods

GET

Retrieves a conference template. [tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. Unfortunately, the name can be modified in the system and, as a result, will invalidate the resource URL. However, the API client has the option of reading this resource by its immutable, unique identifier that can be retrieved in the entity body. Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name\|identifier} Note 2: If the "name" enumeration is specified, then the value should correspond to the name. Otherwise, the resource cannot not be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot not be found. Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-template+xml application/vnd.plcm.plcm-conference-template+json application/vnd.plcm.plcm-conference-template-v2+xml application/vnd.plcm.plcm-conference-template-v2+json application/vnd.plcm.plcm-conference-template-v3+xml application/vnd.plcm.plcm-conference-template-v3+json application/vnd.plcm.plcm-conference-template-v4+xml application/vnd.plcm.plcm-conference-template-v4+json application/vnd.plcm.plcm-conference-template-v5+xml application/vnd.plcm.plcm-conference-template-v5+json application/vnd.plcm.plcm-conference-template-v6+xml application/vnd.plcm.plcm-conference-template-v6+json application/vnd.plcm.plcm-conference-template-v7+xml application/vnd.plcm.plcm-conference-template-v7+json application/vnd.plcm.plcm-conference-template-v8+xml application/vnd.plcm.plcm-conference-template-v8+json	Information successfully retrieved.
304		Conference template information has not changed since the last search. Note: The API client must provide the "plcm-conference-template" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-template" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to the conference template on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, provisioner
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such template.

PUT

Updates a conference template. [tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. Unfortunately, the name can be modified in the system and, as a result, will invalidate the resource URL. However, the API client has the option of reading this resource by its immutable, unique identifier that can be retrieved in the entity body. Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name\|identifier} Note 2: If the "name" enumeration is specified, then the value should correspond to the name. Otherwise, the resource cannot not be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot not be found. Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Representations

application/vnd.plcm.plcm-conference-template-v3+xml

application/vnd.plcm.plcm-conference-template-v3+json

application/vnd.plcm.plcm-conference-template-v4+xml

application/vnd.plcm.plcm-conference-template-v4+json

application/vnd.plcm.plcm-conference-template-v5+xml

application/vnd.plcm.plcm-conference-template-v5+json

application/vnd.plcm.plcm-conference-template-v6+xml

application/vnd.plcm.plcm-conference-template-v6+json

application/vnd.plcm.plcm-conference-template-v7+xml

application/vnd.plcm.plcm-conference-template-v7+json

application/vnd.plcm.plcm-conference-template-v8+xml

application/vnd.plcm.plcm-conference-template-v8+json

Response

Status	Representation	Description
204		Conference room template updated successfully. The ETag returned in the HTTP header represents the current version of the conference room template.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no template with the identifier supplied in the URL and/or the body of the request.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL and/or the body of the request cannot be parsed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL does not match that supplied in the body of the request. Only one of these is required but if they are both supplied they must match.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The Conference Mode Experience value is not valid for the selected codec.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag supplied in the header and/or body does not match that on the server. This usually means that the template upon which the update is based has changed since the last time you accessed it.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag is missing and required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ETag in the header does not match that in the body Only one of these is required but if they are both supplied they must match.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name already used. Since the template to be updated is identified by identifier, not name, the name may be changed, but not to a name that is already taken by another template.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid name length. Required: 1 - 50 characters.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid description length. If supplied, description must be less than 50 characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid RMX profile. The RMX profile name supplied is not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian lecture mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian floor and chair control value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian layout control value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian mute DTMF value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian allow mute audio value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian content channel video value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian content resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian custom layout allowed value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid Codian layout value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid HD resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid line rate value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid content rate value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid encryption policy value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid TIP compatibility value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid TIP compatibility value. It must be set to NONE when conference mode is not AVC Only.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid gathering language value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering access number 1 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering access number 2 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 1 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 2 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Gathering info 3 too long.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid video quality value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid resolution limit value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 settings value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 protocol value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid video layout value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid telepresence mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid telepresence layout mode value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid skin value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid IVR service value. The value was not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid recording link value. The value was not recognized by the system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid recording type value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid codec support value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid priority value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	You cannot specify both Cascading for Size and Use Cascading. These features are mutually exclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid participants join type.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid H239 resolution value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Content Protocol must be H.264 cascade optimized (H_264_FIX) if cascade by size or bandwidth is selected.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid WebRTC aspect value.
409	application/vnd.plcm.plcm-error+xml	A WebRTC-enabled template cannot be configured to use an RMX profile.
409	application/vnd.plcm.plcm-error+xml	One or more settings within the template are incompatible with a WebRTC-enabled experience.
409	application/vnd.plcm.plcm-error+xml	multiple-resolution, content-transcoding-h264 and h264-poly-svc-cascade must be set to true when conference-codec-support is AVC_POLY_SVC, all other transcode options must be false.

DELETE

Deletes a conference template. [tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. Unfortunately, the name can be modified in the system and, as a result, will invalidate the resource URL. However, the API client has the option of reading this resource by its immutable, unique identifier that can be retrieved in the entity body. Note 1: The URL form is https://{host}:{port}/api/rest/{resource}/{value}?type={name\|identifier} Note 2: If the "name" enumeration is specified, then the value should correspond to the name. Otherwise, the resource cannot not be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot not be found. Note 4: The read will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id", is not required.

Response

Status	Representation	Description
204		Conference room template deleted successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized. DMA role required: administrator
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There is no template with the identifier supplied in the URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The ID supplied in the URL cannot be parsed.