POST api/Project/ForceUnlockMachine

Request Information

URI Parameters

None.

Body Parameters

ForceUnlockMachineParam
NameDescriptionTypeAdditional information
LockWindow

LockWindows

None.

MachineGuid

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "lockWindow": 0,
  "machineGuid": "6198fca4-d6f6-4bd1-8ae3-19693efeff90"
}

application/xml, text/xml

Sample:
<ForceUnlockMachineParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.GlobalCache">
  <LockWindow>wAll</LockWindow>
  <MachineGuid>6198fca4-d6f6-4bd1-8ae3-19693efeff90</MachineGuid>
</ForceUnlockMachineParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MachineLockInformationModel
NameDescriptionTypeAdditional information
IsMachineLocked

boolean

None.

LockedBy

string

None.

Response Formats

application/json, text/json

Sample:
{
  "isMachineLocked": true,
  "lockedBy": "sample string 2"
}

application/xml, text/xml

Sample:
<MachineLockInformationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <IsMachineLocked>true</IsMachineLocked>
  <LockedBy>sample string 2</LockedBy>
</MachineLockInformationModel>