CAA Tenant



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/caa-tenant

Summary


Resources Methods
https://localhost:8443/api/rest/caa-tenant

GET Retrieves CAA Tenants.

POST  Creates a CAA Tenant object.

https://localhost:8443/api/rest/caa-tenant/{value}

GET  Retrieves a CAA Tenant [tags: DMA] .

PUT  Updates a CAA Tenant.

DELETE  Deletes a CAA Tenant.

https://localhost:8443/api/rest/caa-tenant/default

GET Retrieves default values for CAA tenant.

Resources


https://localhost:8443/api/rest/caa-tenant


Methods

GET

Retrieves CAA Tenants. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-caa-tenant-list+xml
application/vnd.plcm.plcm-caa-tenant-list+json
application/vnd.plcm.plcm-caa-tenant-list-v2+xml
application/vnd.plcm.plcm-caa-tenant-list-v2+json
Information successfully retrieved
304
External CAA Tenants information has not changed since the last search.

Note: The API client must provide the "plcm-caa-tenant-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-caa-tenant-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 SIP Peers 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
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
CAA Tenant not found. There are no CAA Tenants stored.

POST


Creates a CAA Tenant object. Any submitted ID is ignored.
The ID is assigned by the system.

Name and SIP URI are required and name must be unique.
If a CAA Tenant pre-exists with the same name or prefix the request fails.

DMA role required: Administrator.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-caa-tenant+xml
application/vnd.plcm.plcm-caa-tenant+json
application/vnd.plcm.plcm-caa-tenant-v2+xml
application/vnd.plcm.plcm-caa-tenant-v2+json

Response

Status Representation Description
201
CAA Tenant created successfully. The ETag returned in the HTTP header
represents the version of the SIP Peer.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: Administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
CAA Tenant with that name already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The name of the CAA Tenant is required. The name must be between 1 and 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP URI is required and must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The CAA Tenant description must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
A CAA Tenant with this prefix already exists.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The value of the passback attribute must be less than 512 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is not specified but conference-template-key-value is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is false but conference-template-key-value is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is true but conference-template-key-value is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is not specified but mcu-pool-queue-uid is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is false but mcu-pool-queue-uid is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is true but mcu-pool-queue-uid is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is not specified but first caller mcu affinity is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is false but first caller mcu affinity is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is true but first caller mcu affinity is not specified.

https://localhost:8443/api/rest/caa-tenant/{value}


Template Parameters

Name Type Description
value xs:string Unique identifier of the CAA Tenant

Methods

GET


Retrieves a CAA Tenant
[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 immutable, unique identifier: name or ID.

The URL form is
https://{host}:{port}/api/rest/{resource}/{identifier}

Response

Status Representation Description
200 application/vnd.plcm.plcm-caa-tenant+xml
application/vnd.plcm.plcm-caa-tenant+json
application/vnd.plcm.plcm-caa-tenant-v2+xml
application/vnd.plcm.plcm-caa-tenant-v2+json
Information successfully retrieved
304
CAA Tenant information has not changed since the last search.

Note: The API client must provide the "plcm-caa-tenant" 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-caa-tenant" 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 External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission. DMA roles required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
No such CAA Tenant

PUT


Updates a CAA Tenant.

DMA role required: Administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-caa-tenant+xml
application/vnd.plcm.plcm-caa-tenant+json
application/vnd.plcm.plcm-caa-tenant-v2+xml
application/vnd.plcm.plcm-caa-tenant-v2+json

Response

Status Representation Description
204
CAA Tenant updated successfully. The ETag returned in the HTTP header represents the current version
of the CAA Tenant.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no CAA Tenant with the identifier supplied in the URL and/or the body of the request.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ID supplied in the URL and/or the body of the request cannot be parsed.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ID supplied in the URL does not match that supplied in the body of the request.
Only one of these is required but if they are both supplied they must match.
412 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag supplied in the header and/or body does not match that on the server.
This usually means that the template upon which the update is based has changed
since the last time you accessed it.
428 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ETag is missing and required.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

The ETag in the header does not match that in the body
Only one of these is required but if they are both supplied they must match.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Name already used. Since the CAA Tenant to be updated is identified by identifier, not name, the name
may be changed, but not to a name that is already taken by another CAA Tenant.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The name of the CAA Tenant is required. The name must be between 1 and 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The SIP URI is required and must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The CAA Tenant description must be less than 128 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The value of the passback attribute must be less than 512 characters.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is not specified but conference-template-key-value is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is false but conference-template-key-value is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-conference-template-key-value is true but conference-template-key-value is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is not specified but mcu-pool-queue-uid is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is false but mcu-pool-queue-uid is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-mcu-pool-queue-uid is true but mcu-pool-queue-uid is not specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is not specified but first caller mcu affinity is specified.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is false but first caller mcu affinity is specified with a value other than default.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The override-default-first-caller-mcu-affinity is true but first caller mcu affinity is not specified.

DELETE


Deletes a CAA Tenant.
[tags: DMA]

Request

Response

Status Representation Description
204 CAA Tenant deleted successfully.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request
401 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unauthorized. DMA role required: Administrator
404 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
There is no CAA Tenant with the identifier supplied in the URL.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The ID supplied in the URL cannot be parsed.

https://localhost:8443/api/rest/caa-tenant/default


Methods

GET

Retrieves default values for CAA tenant.
[tags: DMA]

Response

Status Representation Description
200 application/vnd.plcm.plcm-caa-tenant-defaults+xml
application/vnd.plcm.plcm-caa-tenant-defaults+json
Successfully updated.
304
CAA Tenant defaults information has not changed since the last fetch.

Note: The API client must provide the "plcm-caa-tenant-defaults" 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-caa-tenant-defaults" 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 External SIP Peer on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Unable to get permission.