MCU

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/mcus

Summary

Resources	Methods
https://localhost:8443/api/rest/mcus	GET Retrieves all MCUs on the DMA. POST Creates an MCU definition. POST Creates an MCU definition.
https://localhost:8443/api/rest/mcus/{value}	GET Retrieves an MCU on the DMA. PUT Updates information about an MCU. DELETE Deletes an MCU.
https://localhost:8443/api/rest/mcus/{value}/mcu-status	GET Retrieves an MCU on the DMA.
https://localhost:8443/api/rest/mcus/{value}/set-service-status	POST Sets the service status for the specified MCU.
https://localhost:8443/api/rest/mcus/{value}/set-registration-admission-policy	POST Sets the registration admission policy for the specified MCU.
https://localhost:8443/api/rest/mcus/debug-postliminary	POST Test a postliminary script to a dial rule for an MCU.
https://localhost:8443/api/rest/mcus/default	GET Get default values for MCUs.

Resources

https://localhost:8443/api/rest/mcus

Methods

GET

Retrieves all MCUs on the DMA. Etag's calculation includes all fields -configuration and status.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-mcu-list+xml application/vnd.plcm.plcm-mcu-list+json application/vnd.plcm.plcm-mcu-list-v2+xml application/vnd.plcm.plcm-mcu-list-v2+json application/vnd.plcm.plcm-mcu-list-v3+xml application/vnd.plcm.plcm-mcu-list-v3+json application/vnd.plcm.plcm-mcu-list-v4+xml application/vnd.plcm.plcm-mcu-list-v4+json application/vnd.plcm.plcm-mcu-list-v5+xml application/vnd.plcm.plcm-mcu-list-v5+json application/vnd.plcm.plcm-mcu-list-v6+xml application/vnd.plcm.plcm-mcu-list-v6+json application/vnd.plcm.plcm-mcu-list-v7+xml application/vnd.plcm.plcm-mcu-list-v7+json	MCUs information successfully retrieved.
304		MCU has not changed since the last get. Note: The API client must provide the "plcm-mcu-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-mcu-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 MCU's on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator, provisioner
429	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Too many requests. This resource is rate-limited at 1 second(s).

POST

Creates an MCU definition.
Name, IP, username, password, type, and signaling types are required.
DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-mcu-v2+xml

application/vnd.plcm.plcm-mcu-v2+json

application/vnd.plcm.plcm-mcu-v3+xml

application/vnd.plcm.plcm-mcu-v3+json

application/vnd.plcm.plcm-mcu-v4+xml

application/vnd.plcm.plcm-mcu-v4+json

application/vnd.plcm.plcm-mcu-v5+xml

application/vnd.plcm.plcm-mcu-v5+json

application/vnd.plcm.plcm-mcu-v6+xml

application/vnd.plcm.plcm-mcu-v6+json

Response

Status	Representation	Description
201		The MCU definition was created successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name must be between 1 and 32 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied name contains invalid characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied management address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied signaling type is not a valid selection.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The SIP signaling address is missing. SIP signaling address is required when credentials (management username, password, IP) are not provided for an MCU designated for SIP support.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied SIP signaling address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The H.323 signaling address is missing. H.323 signaling address is required when credentials (management username, password, IP) are not provided for an MCU designated for H.323 support.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied H.323 signaling address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is missing. Media address is required when credentials (management username, password, IP) are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is duplicated.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	You must supply either media addresses or credentials (user ID, password, management address) to configure an MCU.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The user ID is required. Credentials (management username, password, IP) are required when media and signaling addresses are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The password is required. Credentials (management username, password, IP) are required when media and signaling addresses are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The gateway delimiter is required. Delimiter must be provided for MCUs designated as gateways.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied gateway delimiter is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	MCU name is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Management IP address is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Signaling IP address is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Hosts resolve to the same address.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	If specified, the number of ports reserved for cascading must not be negative.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The override-default field was true, but the corresponding field was not specified.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The override-default field was false, but the corresponding field was specified with a value other than the default.
500	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	An error occurred creating a configuration editing session.

POST

Creates an MCU definition.
Name, IP, username, password, type, and signaling types are required.
DMA roles required: administrator

[tags: DMA]

Request

Query Parameters

Name	Type	Description
asynchronous	xs:boolean	If this is set to True, this method will create a task to add the MCU in the background. The Location header in the response is the resource path to the task. If this is set to False, this method will wait until the MCU is created, and return. This parameter, by default, is False.

Representations

application/vnd.plcm.plcm-mcu-v7+xml

application/vnd.plcm.plcm-mcu-v7+json

Response

Status	Representation	Description
201		The MCU definition was created successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Name must be between 1 and 32 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied name contains invalid characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied management address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied signaling type is not a valid selection.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The SIP signaling address is missing. SIP signaling address is required when credentials (management username, password, IP) are not provided for an MCU designated for SIP support.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied SIP signaling address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The H.323 signaling address is missing. H.323 signaling address is required when credentials (management username, password, IP) are not provided for an MCU designated for H.323 support.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied H.323 signaling address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is missing. Media address is required when credentials (management username, password, IP) are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The media address is duplicated.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	You must supply either media addresses or credentials (user ID, password, management address) to configure an MCU.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The user ID is required. Credentials (management username, password, IP) are required when media and signaling addresses are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The password is required. Credentials (management username, password, IP) are required when media and signaling addresses are not provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The gateway delimiter is required. Delimiter must be provided for MCUs designated as gateways.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied gateway delimiter is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	MCU name is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Management IP address is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Signaling IP address is already used.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Hosts resolve to the same address.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	If specified, the number of ports reserved for cascading must not be negative.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The override-default field was true, but the corresponding field was not specified.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The override-default field was false, but the corresponding field was specified with a value other than the default.
500	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	An error occurred creating a configuration editing session.

https://localhost:8443/api/rest/mcus/{value}

Template Parameters

Name	Type	Description
value	xs:string	Unique name or identifier of the MCU.

Methods

GET

Retrieves an MCU on the DMA. Etag's calculation includes configuration fields only.

[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\|id} 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, 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. Note 5: The Etag's calculation includes configuration fields (as opposed to status). DMA can modify configuration fields but cannot modify status fields.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-mcu+xml application/vnd.plcm.plcm-mcu+json application/vnd.plcm.plcm-mcu-v2+xml application/vnd.plcm.plcm-mcu-v2+json application/vnd.plcm.plcm-mcu-v3+xml application/vnd.plcm.plcm-mcu-v3+json application/vnd.plcm.plcm-mcu-v4+xml application/vnd.plcm.plcm-mcu-v4+json application/vnd.plcm.plcm-mcu-v5+xml application/vnd.plcm.plcm-mcu-v5+json application/vnd.plcm.plcm-mcu-v6+xml application/vnd.plcm.plcm-mcu-v6+json application/vnd.plcm.plcm-mcu-v7+xml application/vnd.plcm.plcm-mcu-v7+json	MCU information successfully retrieved.