Ext-Gatekeeper



[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/ext-gatekeeper

Summary


Resources Methods
https://localhost:8443/api/rest/ext-gatekeeper

GET  Retrieves a list of external gatekeeper's records.

POST  Add a new external gatekeeper.

https://localhost:8443/api/rest/ext-gatekeeper/test-lrq

POST  Test location request.

https://localhost:8443/api/rest/ext-gatekeeper/debug-postliminary

POST  Test a postliminary script to a dial rule for an external gatekeeper.

https://localhost:8443/api/rest/ext-gatekeeper/{value}

DELETE  Deletes information about an external gatekeeper.

GET  Retrieves information about an external gatekeeper.

PUT  Updates information about an external gatekeeper.

Resources


https://localhost:8443/api/rest/ext-gatekeeper


Methods

GET


Retrieves a list of external gatekeeper's records. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-ext-gatekeeper-list+xml
application/vnd.plcm.plcm-ext-gatekeeper-list+json
Gatekeeper's list successfully retrieved
304
Gatekeeper's information has not changed since the last search.

Note: The API client must provide the "plcm-ext-gatekeeper-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-ext-gatekeeper-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
external gatekeepers on the server.

POST


Add a new external gatekeeper. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-gatekeeper+xml
application/vnd.plcm.plcm-ext-gatekeeper+json

Response

Status Representation Description
201 External Gatekeeper created successfully.
400 text/plain
Bad request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ext-gatekeeper already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
RAS port is not valid
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
IP address is required or not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Gatekeeper name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If authentication is enabled. Authentication name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If authentication is enabled. Password is required.

https://localhost:8443/api/rest/ext-gatekeeper/test-lrq


Methods

POST


Test location request. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-ext-gatekeeper+xml
application/vnd.plcm.plcm-ext-gatekeeper+json

Response

Status Representation Description
200 Gatekeeper at specific address and port responded to location request (LRQ) and is available.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid hostname or IP address.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Hostname or IP address cannot be blank
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If authentication is enabled. Authentication name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
If authentication is enabled. Password is required .

https://localhost:8443/api/rest/ext-gatekeeper/debug-postliminary


Methods

POST


Test a postliminary script to a dial rule for an external gatekeeper.
It lets you specify parameters of a call and the dial string, and see what effect the script has on the dial string.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-request+json

Response

Status Representation Description
200 application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+xml
application/vnd.plcm.plcm-dial-rule-preliminary-debug-result+json
The debug session was completed.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. Administrator user role required.

https://localhost:8443/api/rest/ext-gatekeeper/{value}


Template Parameters

Name Type Description
value xs:string Unique identifier or name of external gatekeeper .
User can provide either identifier or name of gatekeeper to retrieve or update or delete the gatekeeper entity.

Methods

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

Status Representation Description
204 Ext-gatekeeper information successfully deleted
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such ext-gatekeeper.

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

application/vnd.plcm.plcm-ext-gatekeeper+xml
application/vnd.plcm.plcm-ext-gatekeeper+json

Response

Status Representation Description
204
Ext-gatekeeper information successfully updated.
Note: The response will only contain both an ETag value
and link to the updated ext-gatekeeper resource.
400 text/plain
Bad request.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such ext-gatekeeper.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
You do not have the appropriate ext-gatekeeper role to make this configuration change.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ext-gatekeeper resource has changed on the server.

Note: The response will contain the ETag value and link that reflects
the server's ext-gatekeeper resource in the HTTP response header.

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-ext-gatekeeper.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The API client must supply the ETag in the message body that is bounded by
the "entity-tag" XML tag. Refer to the "plcm-ext-gatekeeper.xsd" for details.
If the message body does not contain the ETag value, the server will
look for the ETag in the "If-Match" header.