Shared Templates

URL:
https://<root>/services/<serviceName>/sharedTemplates
Methods:
GET
Version Introduced:
11.3

Description

The sharedTemplates resource allows you to access editing templates that have been authored and persisted in the backend data store (e.g. enterprise geodatabase). These editing templates can be accessed by any feature service which references the same backend datasets. The sharedTemplates resource describes the schema of the shared templates in the data store.

Shared templates include feature, group and preset types of editing templates. Also note that editing templates accessed from the shared templates REST API are independent from editing templates that are described in layer resources.

If the service's hasSharedTemplates property is true, this indicates that there are shared editing templates available.

Request parameters

ParameterDetails

f

The response format. The default format is html.

Values: html | json | pjson

Response properties

ParameterDetails

templateId

An integer unique identifier. The value is system maintained.

globalId

A global unique identifier. The value is system maintained.

type

The type of editing template.

Values: feature | group | preset

name

The name assigned to the template.

defaultTool

Identifies the default drawing tool that was authored with the template.

layerId

The layer for which the template is assigned. For group and preset templates this is the layer referenced by the base part.

subtype

Describes the subtype for which the template was authored for layers that have subtypes. The value is null for layers that do not have subtypes.

definition

The full definition of the template. This is needed when a client uses the template to create a feature. The definition can be accessed from the templates resource.

description

Describes the template.

thumbnail

Optional base 64 image that can be used as a thumbnail in a template picker.

tags

Optional tags which can be assigned to more easily organize and search for templates associated around a common theme. Tags are semi-colon ( ; ) delimited.

visible

Editing templates that are set as true are designed to be used directly by the end user to create features. These would appear in a template picker for example. Editing templates that are set as false are not designed to be used directly by the end user to create features. These are referenced by group or preset templates and are not meant to be used outside of workflows involving the group or preset template.

Values: true | false

hash

A value that describes the template. The value is updated when the definition of the template is modified. Clients can use the hash to know if a templates definition has changed since it was last used by the client.

userIdentity

The ArcGIS Enterprise user who owns the shared editing template. An editing template with a userIdentity of null can be accessed by anyone that has access to the service.

status

Editing templates with status of protected or null can be accessed by anyone that has access to the service. Editing templates with status of private can only be accessed by the ArcGIS Enterprise user described in the userIdentity field.

Values: protected | private | null

Example usage

The following is a sample request URL used to access the sharedTemplates resource:

Use dark colors for code blocksCopy
1
https://machine.domain.com/webadaptor/rest/services/sharedtemplate_line/FeatureServer/sharedTemplates?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
{
  "templatesFields": <templateFields>
}

JSON Response example

Use dark colors for code blocksCopy
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
{
  "templateFields": [
    {
      "name": "templateId",
      "type": "esriFieldTypeOID",
      "alias": "templateId",
      "domain": null,
      "editable": false,
      "nullable": false,
      "defaultValue": null
    },
    {
      "name": "globalId",
      "type": "esriFieldTypeGlobalID",
      "alias": "globalId",
      "domain": null,
      "editable": false,
      "nullable": false,
      "length": 38,
      "defaultValue": null
    },
    {
      "name": "type",
      "type": "esriFieldTypeSmallInteger",
      "alias": "type",
      "domain": null,
      "editable": false,
      "nullable": false,
      "defaultValue": null
    },
    {
      "name": "name",
      "type": "esriFieldTypeString",
      "alias": "name",
      "domain": null,
      "editable": false,
      "nullable": false,
      "length": 255,
      "defaultValue": null
    },
    {
      "name": "defaultTool",
      "type": "esriFieldTypeGUID",
      "alias": "defaultTool",
      "domain": null,
      "editable": false,
      "nullable": true,
      "length": 38,
      "defaultValue": null
    },
    {
      "name": "layerId",
      "type": "esriFieldTypeInteger",
      "alias": "layerId",
      "domain": null,
      "editable": false,
      "nullable": true,
      "defaultValue": null
    },
    {
      "name": "subtype",
      "type": "esriFieldTypeInteger",
      "alias": "subtype",
      "domain": null,
      "editable": false,
      "nullable": true,
      "defaultValue": null
    },
    {
      "name": "definition",
      "type": "esriFieldTypeBlob",
      "alias": "definition",
      "domain": null,
      "editable": false,
      "nullable": false,
      "defaultValue": null
    },
    {
      "name": "description",
      "type": "esriFieldTypeString",
      "alias": "description",
      "domain": null,
      "editable": false,
      "nullable": true,
      "length": 1024,
      "defaultValue": null
    },
    {
      "name": "thumbnail",
      "type": "esriFieldTypeBlob",
      "alias": "thumbnail",
      "domain": null,
      "editable": false,
      "nullable": true,
      "defaultValue": null
    },
    {
      "name": "tags",
      "type": "esriFieldTypeString",
      "alias": "tags",
      "domain": null,
      "editable": false,
      "nullable": true,
      "length": 2000,
      "defaultValue": null
    },
    {
      "name": "visible",
      "type": "esriFieldTypeSmallInteger",
      "alias": "visible",
      "domain": null,
      "editable": false,
      "nullable": false,
      "defaultValue": null
    },
    {
      "name": "hash",
      "type": "esriFieldTypeString",
      "alias": "hash",
      "domain": null,
      "editable": false,
      "nullable": false,
      "length": 64,
      "defaultValue": null
    },
    {
      "name": "userIdentity",
      "type": "esriFieldTypeString",
      "alias": "userIdentity",
      "domain": null,
      "editable": false,
      "nullable": true,
      "length": 255,
      "defaultValue": null
    },
    {
      "name": "status",
      "type": "esriFieldTypeInteger",
      "alias": "status",
      "domain": null,
      "editable": false,
      "nullable": true,
      "defaultValue": null
    }
  ]
}

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