Acquire Locks

URL:
https://<locks-url>/acquire
Methods:
GET
Required Capability:
The ArcGIS Location Referencing license is required to use this resource.
Version Introduced:
10.7

Description

This operation acquires a set of LRS locks to enable edits on the editable LRS layers in the service.

An error response is returned when conflict prevention is not enabled on the LRS. Refer to the conflictPreventionEnabled property of the Locks resource.

Request parameters

ParameterDetails

f

(Optional)

Specifies the response format. The default response format is html.

Values: html | json | pjson

editVersion

(Required)

The name of the geodatabase version to associate with the locks.

Syntax:

1
editVersion=<version>

Example:

1
editVersion="user1.version1"

acquireLocks

(Optional)

Specifies locks to acquire. You can lock a network or an event layer on a route or line. Derived network layers cannot be locked.

Syntax:

1
2
3
4
5
6
7
8
9
10
11
[
  {
    "routeId": "<routeId>",
    "layerId": <layerId>
  }|
  {
    "lineId": "<lineId>",
    "layerId": <layerId>
  },
  ...
]

Example usage

The following are sample URLs for acquiring locks.

Example 1

The following is a URL for acquiring a single lock.

1
https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/locks/acquire?f=json&editVersion=sde.job_42&acquireLocks=[{"routeId":"I90","layerId":3}]

Example 2

The following is a URL for acquiring multiple locks.

1
https://sampleserver/arcgis/rest/services/MyLRS/MapServer/exts/LRServer/locks/acquire?f=json&editVersion=sde.job_42&acquireLocks=[{"routeId":"I90","layerId":3},{"lineId":"NWS Line A","layerId":4}]

JSON Response syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
  "acquireStatus": "<status>",  // one of: esriSuccess, esriReconcileRequired, esriCouldNotAcquireAllLocks
  "acquiredLocks": [
    {
      "routeId": "<routeId>",
      "layerId": <layerId>
    },
    {
      "lineId": "<lineId>",
      "layerId": <layerId>
    },
    ...
  ] |
  "unavailableLocks": [
    {
    ...
    },
    {
      "lineId": "<lineId>",
      "lineName": "<lineName>",
      "layerId": <layerId>,
      "lrsNetworkId": <networkId>,
      "lrsNetworkName": "<networkName>",
      "user": "<username>",
      "versionName": "<versionName>",
      "versionGuid": "<versionGuid>",
      "lockDate": <timestamp>,
      "eventFeatureClassName": "<eventFeatureClassName>"
    },
    ...
  ]
}

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "acquireStatus": "esriCouldNotAcquireAllLocks",

  "unavailableLocks": [
    {
      "routeId": "{50918F06-7D4C-43D4-B39A-3AA02E9CF075}",
      "routeName": "RouteA",
      "layerId": 2,
      "lrsNetworkId": 1,
      "lrsNetworkName" : "LRSN_Cont",
      "user": "alice",
      "versionName": "alice.job_65",
      "versionGuid": "{DA09CF20-D98A-4F80-8599-061C21B2C3D9}",
      "lockDate": 1397509340000,
      "eventFeatureClassName": ""
    },
    {
      "lineId": "{9AF33B43-2BFE-4EA1-96FB-152E6CF7CA3B}",
      "lineName": "LineB",
      "layerId": 6,
      "lrsNetworkId": 2,
      "lrsNetworkName" : "LRSN_Engg",
      "user": "bob",
      "versionName": "bob.job_67",
      "versionGuid": "{FC4818D6-974E-4020-85C5-9DAA0FD539E0}",
      "lockDate": 1397509340000,
      "eventFeatureClassName": "P_Anomaly"
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close