HuntGroup



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/hunt-groups

Summary


Resources Methods
https://localhost:8443/api/rest/hunt-groups

GET  Retrieves the list of hunt groups.

POST  Creating hunt group.

https://localhost:8443/api/rest/hunt-groups/{value}

GET  Retrieves the hunt group information.

PUT  Updating hunt group.

DELETE  Removes the hunt group information.

Resources


https://localhost:8443/api/rest/hunt-groups


Methods

GET


Retrieves the list of hunt groups.
[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-hunt-group-list+xml
application/vnd.plcm.plcm-hunt-group-list+json
List of hunt group successfully retrieved.
304
List of hunt group information has not been changed since the last search.

Note: The API client must provide the "plcm-hunt-group-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-hunt-group-list" ETag can be accessed from the initial search result's HTTP
response header. This also assumes no other client made changes to
hunt group on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed

POST


Creating hunt group.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-hunt-group+xml
application/vnd.plcm.plcm-hunt-group+json

Response

Status Representation Description
201
Hunt group successfully created.
Note: The response will only contain an ETag value.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name (hunt group) already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Alias value is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Hunt group name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Aliases are duplicate.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Member endpoint identifiers are duplicate.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Some of member endpoint identifiers are blank.

https://localhost:8443/api/rest/hunt-groups/{value}


Template Parameters

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

Methods

GET


Retrieves the hunt group information.
[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|identifier}
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, then 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-hunt-group+xml
application/vnd.plcm.plcm-hunt-group+json
Hunt group information successfully retrieved.
304
Hunt group information has not been changed since the last search.

Note: The API client must provide the "plcm-hunt-group" 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-hunt-group" ETag can be accessed from the initial search result's HTTP
response header. This also assumes no other client made changes to
hunt group on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such hunt group

PUT


Updating hunt group.
[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|identifier}
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, then 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-hunt-group+xml
application/vnd.plcm.plcm-hunt-group+json

Response

Status Representation Description
204
Hunt group successfully updated.
Note: The response will only contain both an ETag value
and link to the updated hunt group resource.
400 text/plain
Bad request.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such hunt group
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name (hunt group) already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ID passed in the URI (URI ID)does not match the ID in the body (ID in Body).
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Alias value is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Hunt group name is required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Aliases are duplicate.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Member endpoint identifiers are duplicate.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Some of member endpoint identifiers are blank.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The resource has changed on the server. The API client must retrieve the latest resource version, apply the resource modifications, then update to the server.
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-hunt-group.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.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The request contained ETags in both the header (header-ETag) and the body (body-ETag) and they do not match.

DELETE


Removes the hunt group information.
[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|identifier}
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, then 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 application/vnd.plcm.plcm-hunt-group+xml
application/vnd.plcm.plcm-hunt-group+json
Hunt group deleted successfully.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User has insufficient permissions to perform the operation.
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Authentication failed
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such hunt group