Object Locks

List Object Locks

GET /api/.../objectlocks

Returns list of all current object locks for the requesting user and workstation.

Request Information

Parameters

None

Response Information

Example
application/json, text/json 
 [
    {
        "ObjectTypeID":3,"ObjectID":9945830,
        "PolarisUserID":1,"WorkstationID":1205,
        "LockDate":"2016-01-27T13:27:11.76-05:00",
        "PolarisUserName":"PolarisExec",
        "WorkstationName":"ramarao-vm7",
        "ExistingLock":false,
        "StaffEmail":"vanaja.ramarao@iii.com",
        "LockExistsInDatabase": false
    },
    {
        "ObjectTypeID":42,
        "ObjectID":787713,
        "PolarisUserID":1,
        "WorkstationID":1205,
        "LockDate":"2016-01-27T13:42:12.24-05:00",
        "PolarisUserName":"PolarisExec",
        "WorkstationName":"ramarao-vm7",
        "ExistingLock":false,
        "StaffEmail":"vanaja.ramarao@iii.com",
        "LockExistsInDatabase": false

    }
]

List Object Locks in the system

GET /api/.../objectlocks?getAllLocks=true

Returns list of all current object locks in the system.

Request Information

Parameters
Name Type Required Description
getAllLocks Boolean No Set to 'true' to return all the object locks exist.

Response Information

Example
application/json, text/json 
[
    {
        "ObjectTypeID":27,
        "ObjectID":357374,
        "PolarisUserID":1029,
        "WorkstationID":1205,
        "LockDate":"2017-09-01T15:56:23.353-04:00",
        "PolarisUserName":"vanaja.ramarao",
        "WorkstationName":"ramarao-vm7",
        "ExistingLock":false,
        "StaffEmail":"vanaja.ramarao@iii.com",
        "LockExistsInDatabase": false
    },
    {
        "ObjectTypeID":27,
        "ObjectID":358255,"PolarisUserID":1,
        "WorkstationID":1218,        
        "LockDate":"2017-09-01T16:22:05.433-04:00", 
        "PolarisUserName":"PolarisExec",   
        "WorkstationName":"Young-w10",  
        "ExistingLock":false,
        "StaffEmail":"",
        "LockExistsInDatabase": false
    },
    {
        "ObjectTypeID":28,
        "ObjectID":817985,
        "PolarisUserID":1029,
        "WorkstationID":1205,
        "LockDate":"2017-09-01T16:43:55.827-04:00",
        "PolarisUserName":"vanaja.ramarao",
        "WorkstationName":"ramarao-vm7",
        "ExistingLock":false,
        "StaffEmail":"vanaja.ramarao@iii.com",
        "LockExistsInDatabase": false
    },
    {
        "ObjectTypeID":30,
        "ObjectID":1144,
        "PolarisUserID":1,
        "WorkstationID":1218,
        "LockDate":"2017-09-01T16:28:55.197-04:00",
        "PolarisUserName":"PolarisExec",
        "WorkstationName":"Young-w10",
        "ExistingLock":false,"StaffEmail":"",
        "LockExistsInDatabase": false
    },
    {
        "ObjectTypeID":42,
        "ObjectID":67134210,
        "PolarisUserID":1019,
        "WorkstationID":1204,
        "LockDate":"2017-09-01T16:16:30.61-04:00",
        "PolarisUserName":"sharon.purdy",
        "WorkstationName":"purdy-vm7",
        "ExistingLock":false,
        "StaffEmail":"sharon.purdy@iii.com",
        "LockExistsInDatabase": false
    },
]

HTTP Response Codes

Code Description
200 OK. Success

Get an Object Lock

GET /api/.../objectlocks/{objecttypeid}/{objectid}

Checks to see if an object is currently locked. Returns object lock data if is, a 404 error if it is not.

Request Information

Parameters
Name Type Required Description
objecttypeid Integer Yes The id of the type of object.
objecttid Integer Yes The id of the object.

Response Information

Example
application/json, text/json 
{
    "ObjectTypeID" : 1,
    "ObjectID" : 10,
    "PolarisUserID" : 101,
    "WorkstationID" : 1,
    "LockDate" : "2013-04-03T09:06:33.367"
}

HTTP Response Codes

Code Description
200 Object is currently locked. Success
404 Object is NOT currently locked. Success