License

[tags: DMA,PD,RPRM]

Resource Root

https://localhost:8443/api/rest/config/licenses

Summary

Resources	Methods
https://localhost:8443/api/rest/config/licenses
https://localhost:8443/api/rest/config/licenses/poly-license	GET Gets the Poly licensing client config. PUT Configures the instance for Poly licensing.
https://localhost:8443/api/rest/config/licenses/poly-license/status	GET Gets the Poly licensing status, including all licensed features.
https://localhost:8443/api/rest/config/licenses/poly-license/op	GET Gets a Poly licensing request. POST Installs a license response (encoded license) from the server. DELETE Release any installed licenses and generate a 1-time-only release code.
https://localhost:8443/api/rest/config/licenses/poly-license/op/alt	GET Gets an alternate Poly licensing request.
https://localhost:8443/api/rest/config/licenses/poly-license/op/ack	GET Gets an ACK code for an installed Poly license (verifies installation of a license for a server).
https://localhost:8443/api/rest/config/licenses/poly-license/op/update	POST If the system is configured to auto-update licenses then perform an update now.
https://localhost:8443/api/rest/config/licenses/refresh-licenses	POST Instructs the product to contact the license server to check for an update to the license.
https://localhost:8443/api/rest/config/licenses/authority-config	PUT Configures the license authority.
https://localhost:8443/api/rest/config/licenses/disable-licensing-burst-feature	PUT Disable Licensing Burst feature.
https://localhost:8443/api/rest/config/licenses/enable-licensing-burst-feature	PUT Enable Licensing Burst feature.
https://localhost:8443/api/rest/config/licenses/cfs-config	PUT Applies the CFS license.
https://localhost:8443/api/rest/config/licenses/license-status	GET Returns the license status and associated features associated with this product.
https://localhost:8443/api/rest/config/licenses/call-reservation	GET Retrieve a list of all existing license call reservations. POST .
https://localhost:8443/api/rest/config/licenses/call-reservation/{call-id}	GET Retrieve a specific existing license call reservation. PUT Update a specific existing license call reservation. DELETE Delete (release) a specific existing license call reservation.
https://localhost:8443/api/rest/config/licenses/call-reservation/{call-id}/renew	POST Renew a specific existing license call reservation.

Resources

https://localhost:8443/api/rest/config/licenses

https://localhost:8443/api/rest/config/licenses/poly-license

Methods

GET

Gets the Poly licensing client config. Use this value to perform set/reconfigurations.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-config+xml	Gets the configuration value
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving Poly license configuration requires administrator role.

PUT

Configures the instance for Poly licensing.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-poly-license-config+xml

application/vnd.plcm.plcm-poly-license-config+json

Response

Status	Representation	Description
204		Configuration settings were applied successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. UseAutoDiscovery may not be null.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting Poly license config requires administrator role.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. The client should fetch the server resource and try the operation again using the new ETag value. Note: The response will contain the ETag value that reflects the server's resource in the response header. The API client must supply the ETag in either the message body or the "If-Match" header.

https://localhost:8443/api/rest/config/licenses/poly-license/status

Methods

GET

Gets the Poly licensing status, including all licensed features.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-status+xml application/vnd.plcm.plcm-poly-license-status-v2+xml	Gets the status value
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving Poly license status requires administrator role.

https://localhost:8443/api/rest/config/licenses/poly-license/op

Methods

GET

Gets a Poly licensing request. If a previous ALT license is already installed then this will be
the equavalent of getting the alternate license request.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-response+xml application/vnd.plcm.plcm-poly-license-response+json	Gets the request value
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving Poly license request requires administrator role.

POST

Installs a license response (encoded license) from the server.
[tags: DMA]

Request

Representations

text/plain

Response

Status	Representation	Description
204		License was applied successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax/encoding. The client should hot repeat the request without modifications. UseAutoDiscovery may not be null.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting Poly licenses requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There was some problem with the encoded license (unable to decode, incorrect format, wrong product, etc...).

DELETE

Release any installed licenses and generate a 1-time-only release code. After this call the system will have no
installed licenses. The release code returned cannot be regenerated.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-response+xml application/vnd.plcm.plcm-poly-license-response+json	Release verification code if a license was previously installed (empty if not).
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Releasing licenses requires administrator role.

https://localhost:8443/api/rest/config/licenses/poly-license/op/alt

Methods

GET

Gets an alternate Poly licensing request.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-response+xml application/vnd.plcm.plcm-poly-license-response+json	Gets the request value
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving Poly license request requires administrator role.

https://localhost:8443/api/rest/config/licenses/poly-license/op/ack

Methods

GET

Gets an ACK code for an installed Poly license (verifies installation of a license for a server).
This code may be regenerated at any time for normal and alternate licenses.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-poly-license-response+xml application/vnd.plcm.plcm-poly-license-response+json	Gets the ACK value
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving a license ACK requires administrator role.

https://localhost:8443/api/rest/config/licenses/poly-license/op/update

Methods

POST

If the system is configured to auto-update licenses then perform an update now.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Manual update now task as at least started. Use GET status to monitor progress if necessary.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Performing a license update requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Sytem is not configured for auto-updating of licenses.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	There was some error performing update of licenses (server unreachable, incorrect credentials, ...).

https://localhost:8443/api/rest/config/licenses/refresh-licenses

Methods

POST

Instructs the product to contact the license server to check for an update to the license. This method
does not block waiting for the product to contact the license server but instead returns immediately
after notifying the client to perform an update to the license.
[tags: DMA,PD,RPRM]

Response

Status	Representation	Description
204		The product was successfully instructed to contact the license server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. refreshing license requires administrator role.

https://localhost:8443/api/rest/config/licenses/authority-config

Methods

PUT

Configures the license authority.
[tags: DMA,PD,RPRM]

Request

Representations

application/vnd.plcm.plcm-license-authority-config+xml

application/vnd.plcm.plcm-license-authority-config+json

Response

Status	Representation	Description
204		Configuration settings were applied successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. UseAutoDiscovery may not be null.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. MainServerAddress.portNumber must be less than or equal to 65535.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. MainServerAddress.portNumber must be greater than 0.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting license authority config requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Auto-discovery not supported.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	One or more of the servers listed in the license server list was not valid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The server list cannot be empty if use-auto-discovery is false.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The port specified is out of range or invalid.

https://localhost:8443/api/rest/config/licenses/disable-licensing-burst-feature

Methods

PUT

Disable Licensing Burst feature.
[tags: DMA]

Response

Status	Representation	Description
204		Configuration settings were applied successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. UseAutoDiscovery may not be null.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting license authority config requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The feature is not available in the license.

https://localhost:8443/api/rest/config/licenses/enable-licensing-burst-feature

Methods

PUT

Enable Licensing Burst feature.
[tags: DMA]

Response

Status	Representation	Description
204		Configuration settings were applied successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should hot repeat the request without modifications. UseAutoDiscovery may not be null.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting license authority config requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The feature is not available in the license.

https://localhost:8443/api/rest/config/licenses/cfs-config

Methods

PUT

Applies the CFS license.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-license-cfs-config+xml

application/vnd.plcm.plcm-license-cfs-config+json

Response

Status	Representation	Description
204		Configuration settings were applied successfully.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Setting license CFS config requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Activation key entered for 'DMA serial #' is not valid for this system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot switch from Flexera to CFS licensing models once Flexera has been attempted.

https://localhost:8443/api/rest/config/licenses/license-status

Methods

GET

Returns the license status and associated features associated with this product.
[tags: DMA,PD,RPRM]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-status+xml application/vnd.plcm.plcm-license-status+json application/vnd.plcm.plcm-license-status-v2+xml application/vnd.plcm.plcm-license-status-v2+json	The license status and associated features
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving license status requires administrator role.

https://localhost:8443/api/rest/config/licenses/call-reservation

Methods

GET

Retrieve a list of all existing license call reservations.
[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-call-reservation-list+xml application/vnd.plcm.plcm-license-call-reservation-list+json	The current list of license call reservations.
304		Resource has not changed since the last retrieval. Note: The API client should provide the ETag value in the "If-None-Match" 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 retrieval in the "If-None-Match" header, then the response will contain the resource in the message body.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials

POST

Request

Representations

application/vnd.plcm.plcm-license-call-reservation+xml

application/vnd.plcm.plcm-license-call-reservation+json

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-call-reservation+xml application/vnd.plcm.plcm-license-call-reservation+json	Reservation successful. The license call reservation in the body will have the expiration date/time of the reservation set. The client is responsible for for renewing or deleting the reservation prior to the expiration date/time.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation could not be made. Details should be available in the plcm-error indicating the reason.

https://localhost:8443/api/rest/config/licenses/call-reservation/{call-id}

Template Parameters

Name	Type	Description
call-id	xs:string	call-id

Methods

GET

Retrieve a specific existing license call reservation.
[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-call-reservation+xml application/vnd.plcm.plcm-license-call-reservation+json	The license call reservation.
304		Resource has not changed since the last retrieval. Note: The API client should provide the ETag value in the "If-None-Match" 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 retrieval in the "If-None-Match" header, then the response will contain the resource in the message body.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	License call reservation not found

PUT

Update a specific existing license call reservation.
[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-license-call-reservation+xml

application/vnd.plcm.plcm-license-call-reservation+json

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-call-reservation+xml application/vnd.plcm.plcm-license-call-reservation+json	Reservation successful. The license call reservation in the body will have the expiration date/time of the reservation set. The client is responsible for for renewing or deleting the reservation prior to the expiration date/time.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request could not be understood by the server due to malformed syntax. The client should not repeat the request without modifications.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	License call reservation was not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation could not be made. Details should be available in the plcm-error indicating the reason.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. The client should fetch the server resource and try the operation again using the new ETag value. Note: The response will contain the ETag value that reflects the server's resource in the response header. The API client must supply the ETag in either the message body or the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client has not supplied the required ETag in the message body or the "If-Match" header.

DELETE

Delete (release) a specific existing license call reservation.
[tags: DMA_INTERNAL]

Request

Response

Status	Representation	Description
204		Reservation successfully deleted.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	License call reservation was not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation could not be deleted. Details should be available in the plcm-error indicating the reason.

https://localhost:8443/api/rest/config/licenses/call-reservation/{call-id}/renew

Template Parameters

Name	Type	Description
call-id	xs:string	call-id

Methods

POST

Renew a specific existing license call reservation. The client must provide the appropriate ETAG
value in the If-Match header of the request or in the entity-tag field on the body.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-license-call-reservation+xml application/vnd.plcm.plcm-license-call-reservation+json	The license call reservation in the body will have the new expiration date/time.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	License call reservation not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation could not be renewed. Details should be available in the plcm-error indicating the reason.