Territory



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/territories

Summary


Resources Methods
https://localhost:8443/api/rest/territories

GET Retrieves Territory list.

POST Create a new territory.

POST  Creates multiple territories.

PUT  Updates multiple territories.

POST  Deletes multiple territories.

https://localhost:8443/api/rest/territories/{territory-identifier}

GET  Retrieves a territory.

PUT  Updates a territory specified by this territory identifier.

DELETE  Deletes the Territory specified by this territory identifier.

Resources


https://localhost:8443/api/rest/territories


Methods

GET

Retrieves Territory list. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-territory-list+xml
application/vnd.plcm.plcm-territory-list+json
application/vnd.plcm.plcm-territory-list-v2+xml
application/vnd.plcm.plcm-territory-list-v2+json
application/vnd.plcm.plcm-territory-list-v3+xml
application/vnd.plcm.plcm-territory-list-v3+json
Information successfully retrieved
304
Territory information has not changed since the last search.

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

POST

Create a new territory. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-territory+xml
application/vnd.plcm.plcm-territory+json
application/vnd.plcm.plcm-territory-v2+xml
application/vnd.plcm.plcm-territory-v2+json
application/vnd.plcm.plcm-territory-v3+xml
application/vnd.plcm.plcm-territory-v3+json

Response

Status Representation Description
201 Territory 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. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory name cannot be blank
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Primary cluster must be defined
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Primary and secondary cluster cannot be the same
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Territory name has already been used
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Primary node specified, but does not exist
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Secondary node specified, but does not exist
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
At most three territories may be configured as conference room hosts.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Backup cluster cannot be specified without specifying a primary cluster.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Site topology change is not allowed when DMA is integrated with RPRM.

POST


Creates multiple territories.
Use with caution as the amount of time it will take for a response
will be dependent of the number of territories being created.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-territory-list-v3+xml
application/vnd.plcm.plcm-territory-list-v3+json

Response

Status Representation Description
207 application/vnd.plcm.plcm-multistatus+xml
application/vnd.plcm.plcm-multistatus+json

The multistatus response will contain a plcm-operation-status entry for each territory.
The http-status value is the creation status of the territory and will have the same values
as the single createTerritory request.
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. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Site topology change is not allowed when DMA is integrated with RPRM.

PUT


Updates multiple territories.
Use with caution as the amount of time it will take for a response
will be dependent of the number of territories being updated.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-territory-list-v3+xml
application/vnd.plcm.plcm-territory-list-v3+json

Response

Status Representation Description
207 application/vnd.plcm.plcm-multistatus+xml
application/vnd.plcm.plcm-multistatus+json

The multistatus response will contain a plcm-operation-status entry for each territory.
The http-status value is the update status of the territory and will have the same values
as the single putTerritory (i.e. update) request.
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. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Site topology change is not allowed when DMA is integrated with RPRM.

POST


Deletes multiple territories.
Use with caution as the amount of time it will take for a response
will be dependent of the number of territories being deleted.
DMA roles required: administrator
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-bulk-delete+xml
application/vnd.plcm.plcm-bulk-delete+json

Response

Status Representation Description
207 application/vnd.plcm.plcm-multistatus+xml
application/vnd.plcm.plcm-multistatus+json

The multistatus response will contain a plcm-operation-status entry for each territory.
The http-status value is the deletion status of the territory and will have the same values
as the single deleteTerritory request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: administrator
409 application/vnd.plcm.plcm-error+xml