MCU Pool



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/mcu-pools

Summary


Resources Methods
https://localhost:8443/api/rest/mcu-pools

GET  Get all MCU pools on the DMA.

POST  Creates an MCU pool.

https://localhost:8443/api/rest/mcu-pools/{value}

GET  Get an MCU pool on the DMA.

PUT Updates information about an MCU pool.

DELETE Deletes an MCU pool.

Resources


https://localhost:8443/api/rest/mcu-pools


Methods

GET


Get all MCU pools on the DMA.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-mcu-pool-list+xml
application/vnd.plcm.plcm-mcu-pool-list+json
application/vnd.plcm.plcm-mcu-pool-list-v2+xml
application/vnd.plcm.plcm-mcu-pool-list-v2+json
MCU pools information successfully retrieved.
304
MCU pool has not changed since the last search.

Note: The API client must provide the "plcm-mcu-pool-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-pool-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 API client
made changes to MCU pools on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: administrator, provisioner

POST


Creates an MCU pool.
Name is required.
DMA roles required: administrator

[tags: DMA]

Request

Representations

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

Response

Status Representation Description
201 The MCU pool definition was created successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an MCU more than once.
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 30 characters in length, inclusive.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid character(s), E.g. comma, quotation mark.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name is in use by another MCU pool.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an empty or missing MCU identifier.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an MCU identifier that does not map to a known MCU.

https://localhost:8443/api/rest/mcu-pools/{value}


Template Parameters

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

Methods

GET


Get an MCU pool on the DMA.
[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. Note that 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 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-mcu-pool+xml
application/vnd.plcm.plcm-mcu-pool+json
application/vnd.plcm.plcm-mcu-pool-v2+xml
application/vnd.plcm.plcm-mcu-pool-v2+json
MCU pool information successfully retrieved
304 application/vnd.plcm.plcm-mcu-pool+xml
application/vnd.plcm.plcm-mcu-pool+json
application/vnd.plcm.plcm-mcu-pool-v2+xml
application/vnd.plcm.plcm-mcu-pool-v2+json

MCU pool has not changed since the last search.

Note: The API client must provide the "plcm-mcu-pool" 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-pool" 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 API client
made changes to the MCU pool on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: administrator.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such MCU pool.
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).

PUT

Updates information about an MCU pool. [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 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-mcu-pool+xml
application/vnd.plcm.plcm-mcu-pool+json
application/vnd.plcm.plcm-mcu-pool-v2+xml
application/vnd.plcm.plcm-mcu-pool-v2+json

Response

Status Representation Description
204 MCU pool 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 MCU pool with the given identifier could be found.
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 30 characters in length, inclusive.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied name contains invalid character(s), E.g. comma, quotation mark.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an empty or missing MCU identifier.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an MCU identifier that does not map to a known MCU.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The MCU list contains an MCU more than once.

DELETE

Deletes an MCU pool. [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 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 pool successfully deleted.
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 MCU pool with the given identifier could be found.