NetworkContainer releaseLock request
Description
This API releases a previously acquired lock on a network container.
This API has been deprecated. Instead, use the LogicalHostingEnvironment.releaseLock API.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/NetworkContainer/guid/releaseLock | void | Not applicable |
HTTP request message
Query string parameters
This API does not use query string parameters.
Request message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Request message body
This API uses the following objects in the request message body JSON.
Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline.
Name | Type | Multi- | Description |
|---|---|---|---|
callbackURL | String | 0..1 | URL to call when the operation finishes |
postCallout | String | 0..1 | Identifier of a callout to run after the operation executes |
preCallout | String | 0..1 | Identifier of a callout to run before the operation executes |
timeout | Integer | 0..1 | Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:
|
operationParams | 1 | Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request. |
The [confluence_table-plus] macro is a standalone macro and it cannot be used inline.
Input parameters to include in operationParamsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline.
Name | Type | Multi- | Description |
|---|---|---|---|
lockId | String | 1 | Lock identifier |
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a Task object.
Example
The following example shows an HTTP request that releases a lock on a network container:
Host: apiServer.calbro.com:8080
Authentication-Token: AQIC5wM2LY4Sfcx705TK5UqUK6Ythuk1tVWjHMl7/rpY0Ys=@REGUSER123091
{
"timeout":100000000,
"preCallout":"",
"postCallout":"",
"callbackURL":"",
"operationParams":[
{
"name":"lockId",
"type":"java.lang.String",
"multiplicity":"1",
"value":"727e3355-35d0-4837-b1ea-b57f531ee5e1"
}
]
}