...
This web service acquires a lock for a specified entity, and it or a set of specified entities. It can also, optionally, steal the lock locks of a any specified entity entities that is are already locked at the time this service is run.
...
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Required? | Default | Description | Sample Data |
|---|---|---|---|---|---|
Int32 | No | Click here for more information | 1 | ||
String (50) | Yes | Click here for more information | AYlq2lioh82F1PapkJ+Npg== | ||
LockDurationSeconds | Int32 | Yes | The number of seconds the lock will be held must . Must be between 1 second and 1 day (86400 seconds) | 120 | |
Locks | PwsProjectorLockRequest[1..100] | Yes | The detailed information of the lock locks that is are to be acquired | ||
LocksToSteal | PwsEntityLockSummary[1..100] | No | The detailed information of the lock locks that is are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks. | ||
Int32 | No | Specify an existing Projector Lock Set Id to lock additional entities associated with an existing lock set. If not specified, a new lock set is created. Click here for more information |
...
| Panel | ||
|---|---|---|
| ||
|
...
Element | Data Type | Description | Sample Data |
|---|---|---|---|
Messages | The web service response status and message. Click here for more information | ||
Int32 | Click here for more information | 1 | |
Status | Click here for more information | Ok | |
DateTime | Click here for more information | 2018-10-16T17:28:12.1700152Z | |
Locks | PwsProjectorLock[1..100] | The complete set of information about the lock(s) | |
Int32 | Click here for more information | 2602 |
...
ErrorNumber | ErrorCode | ErrorText |
|---|---|---|
| 10126 | InvalidEnumerationValueSpecified | An invalid value was specified for LockType. Valid values are E, C, P, R, RT, CP, CB, I. |
| 50007 | ItemHasBeenUpdated | Unable to complete request -- another user changed the data while you were editing. |
| 50469 | EntityAlreadyLocked | One or more existing locks prevent acquisition of requested lock. |
| 50483 | InvalidLockDuration | Lock duration must between one second and one day. |
...