|
FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE |
FlexNet Operations Web Services Guide |
The generateCapabilityResponse operation generates capability responses for one or more devices, either from a submitted capability request or from input data that comprises a capability request. This operation optionally maps activation IDs and generates a buffer response for client devices; in the absence of optional input parameters, a capability response is generated. The generateCapabilityResponse operation returns an error for requests to:
generate a buffer response for a server device
generate a buffer response for a client device that previously received a capability response
generate a capability response for a client device that previously received a buffer response
remove or decrease copies of client device buffer licenses
Note: This operation is only for client and server devices, not served clients.
The generateCapabilityResponse operation can also be used to remove metered licenses. In this case, as a prerequisite, the configuration Allow Removing or Reducing Metered Features From a License Server must be selected (under System > Configure > Embedded Devices > Host Options) in the Producer Portal.
This mode allows a collection of base-64 encoded binary capability requests to be uploaded in one web service operation, licenses (capability and buffer responses) generated or re-generated, as appropriate, and returned to the caller. In this mode, the behavior is identical to the devices being directly connected and receiving responses (or as if requests were uploaded for offline activation), including the ability to register unknown devices if FlexNet Operations is configured to allow adding unknown devices. Confirmation of license removal is possible, and empty responses are returned if nothing changes on the client. In the case of a buffer response, a license cannot be returned (in other words, the count cannot be decreased). The binary responses are returned with base-64 encoding, and wrapped in XML elements that identify the device for which they are intended.
This mode bypasses the need for the caller to get or create binary capability requests. The caller specifies the hostid of each device to be processed, and optionally supplies the force generation flag, the last update time, and vendor dictionary entries.
Note: If the last update time information is not supplied, the time used is the logical beginning of time. In this case, it is not possible to confirm removal of licenses in the usual way. To support return operations without the last update time, either set the configuration parameter to skip confirmation (which applies to all devices) or define the DeviceRequestHandler.handleResponse call-out to skip confirmation for devices that require special treatment. For example, the handleResponse call-out could be used to skip confirmation only for node-locked licenses (requests coming from clients) but not for served licenses.
| Name | Type | Direction | Description |
|---|---|---|---|
| msgparameters | generateCapabilityResponseRequestType | Input |
A generateCapabilityResponseResponse element having the structure defined by the following table.
| Name | Type | Description |
|---|---|---|
| statusInfo | OpsEmbeddedStatusInfoType | See OpsEmbeddedStatusInfoType. |
| failedData | failedGenerateCapabilityResponseDataType | See failedGenerateCapabilityResponseDataType. |
| responseData | generateCapabilityResponseDataType | See generateCapabilityResponseDataType. |