SVC MCU



[tags: DMA,RPRM]

Resource Root

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

Summary


Resources Methods
https://localhost:8443/api/rest/svc-mcus

GET Retrieves SVC MCUs.

POST  Creates an SVC MCU definition.

https://localhost:8443/api/rest/svc-mcus/alert-count

GET  Retrieves total number of alerts on all svc mcus.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}

GET  Retrieves an SVC MCU.

PUT Updates information about an MCU.

DELETE Deletes an MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/set-service-status

POST  Sets the service status for the specified MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/restart

POST  Reboots the specified MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/factory-reset

POST  Resets the SVC MCU to factory defaults.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/logs

GET  Get the list of available SVC MCU logs.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/download-logs

POST  Request to initiate the process to download the set of logs, as described in the request.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/cancel-task

POST  Request to cancel an ongoing task (Cancel log downloading, for example).

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/start

POST  Request to initiate the packet capture process on svc mcu [tags: DMA] .

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/packet-capture/stop

POST  Request to stop the packet capture process on svc mcu [tags: DMA] .

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users

GET  Retrieves list of users on this SVC MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}

GET  Retrieves a specific user on this SVC MCU.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/users/{user-name}

PUT  Update a specific user on this SVC MCU.

Resources


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


Methods

GET

Retrieves SVC MCUs. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu-list+xml
application/vnd.plcm.plcm-svc-mcu-list+json
Information successfully retrieved
304
SVC MCUs information has not changed since the last search.

Note: The API client must provide the "plcm-svc-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.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator,
provisioner

POST


Creates an SVC MCU definition.
Name, management address, username, and password are required.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json

Response

Status Representation Description
201 The SVC 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
The supplied name contains invalid characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Management address is required.
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 management username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management password is required.
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 address is already used.

https://localhost:8443/api/rest/svc-mcus/alert-count


Methods

GET


Retrieves total number of alerts on all svc mcus. Etag's calculation includes configuration fields only.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-svc-mcu-alert-count+xml
application/vnd.plcm.plcm-svc-mcu-alert-count+json
Information successfully retrieved
304
Alert count has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" 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-svc-mcu" 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 External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

GET


Retrieves an SVC MCU. 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-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json
Information successfully retrieved
304
MCU information has not changed since the last search.

Note: The API client must provide the "plcm-svc-mcu" 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-svc-mcu" 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 External SIP Peer on the server.
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
No such MCU.

PUT

Updates information about an MCU. [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.

Representations

application/vnd.plcm.plcm-svc-mcu+xml
application/vnd.plcm.plcm-svc-mcu+json

Response

Status Representation Description
204
MCU successfully updated.
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.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU.
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
The supplied name contains invalid characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Management address is required.
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 management username is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The management password is required.

DELETE

Deletes an MCU. [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.

Response

Status Representation Description
204 MCU deleted successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/set-service-status


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Sets the service status for the specified MCU.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-svc-mcu-set-service-status-request+xml
application/vnd.plcm.plcm-svc-mcu-set-service-status-request+json

Response

Status Representation Description
204 The service status for the MCU was set as specified.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The requested service status value is not a viable option for this request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU cannot be set to the specified service status because the MCU has active calls on it.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/restart


Template Parameters

Name Type Description
svc-mcu-identifier xs:string Unique identifier of the SVC MCU.

Methods

POST


Reboots the specified MCU.

[tags: DMA]

Response

Status Representation Description
204 The MCU is rebooted.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. User roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU does not exist.

https://localhost:8443/api/rest/svc-mcus/{svc-mcu-identifier}/factory-reset


Template Parameters