Resource: RecordLock

About this resource

Representation of the lock on a record.

Properties

Property	Description	Type
integrationId	Gets the IntegrationId of this lock.	string
lockedOn	Gets the LockedOn of this lock.	datetime
lockId	Gets the LockId of this lock.	guid
reason	Gets the Reason of this lock.	string
uri	Gets the Uri of this lock.	string

Relations

Method	Name	Select-key	Resource type	Description
GET	self			Provides a link to this resource.

Actions

Method

Action

Description

Response codes

POST /record/{recordId}/locks

add

Creates a new record lock.

201	Request completed successfully
400	Bad request (in general)
403	Insufficient permissions
404	Record not found

Examples

Reading locks using a unique record id

GET /record/{recordId}/locks HTTP/1.1
accept: application/json

Any user with READ permissions on a record can see all the locks that are on a record.

The following example shows the response body for the endpoint:

[
	{
	"lockId": "be94cf247cf846fe85cdaafc010f8d3c",
	"integrationId": "marketingops1",
	"uri": "",
	"reason": "workflow1",
	"lockedOn": "2019-11-05T16:28:41.373"
	},
	{
	"lockId": "d7d5c1d802604d54ac94aafc010f997c",
	"integrationId": "marketingops2",
	"uri": "",
	"reason": "workflow2",
	"lockedOn": "2019-11-05T16:28:51.827"
	},
	{
	"lockId": "ab424fa0ef2c47a9a982aafc010f9f61",
	"integrationId": "marketingops3",
	"uri": "",
	"reason": "workflow3",
	"lockedOn": "2019-11-05T16:28:56.857"
	}
]

Immediate create a lock for record

Any user with READ permission on a record can set a lock.

Post /record/8735a5a3e75a4bc0a2a1a3cd0069b669/locks
{
	"integrationId": "integrationClient",
	"reason": "specific reason",
	"uri": "specific uri"
}