DELETE
Deletes information about an external gatekeeper.
[tags: DMA,RPRM]
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
GET
Retrieves information about an external gatekeeper.
[tags: DMA,RPRM]
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 |
| 200 |
application/vnd.plcm.plcm-ext-gatekeeper+xml
application/vnd.plcm.plcm-ext-gatekeeper+json
|
Ext-gatekeeper information successfully retrieved. |
| 304 |
|
Ext-gatekeeper information has not changed since the last retrieval.
Note: The API client must provide the "plcm-ext-gatekeeper" 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 single ext-gatekeeper retrieval in the "If-None-Match" header, then
the HTTP response will contain the ext-gatekeeper representation in the message
body.
The "plcm-ext-gatekeeper" ETag can be accessed from the initial retrieval result's HTTP
response header. Also, subsequent retrievals require the identical domain and
ext-gatekeeper name to ensure an equivalent ETag value. This also assumes no other client made changes to
ext-gatekeepers on the server.
|
| 404 |
application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
|
No such ext-gatekeeper |
PUT
Updates information about an external gatekeeper.
[tags: DMA,RPRM]
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
Response
|