Rate this page:

Objecttype

Get objecttype {id}

GET /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}

Find an object type by id

Request

Path parameters
id Required

string

Example

1
2
3
curl --request GET \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ObjectType

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
  "id": "23",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
  "icon": {
    "id": "13",
    "name": "Building",
    "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
    "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
  },
  "position": 2,
  "created": "2021-02-16T19:36:51.951Z",
  "updated": "2021-04-16T15:17:03.384Z",
  "objectCount": 4,
  "objectSchemaId": "6",
  "inherited": false,
  "abstractObjectType": false,
  "parentObjectTypeInherited": false
}

Put objecttype {id}

PUT /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}

Update an existing object type

Request

Path parameters
id Required

string

Body parameters

The Insight object type input used for creating and updating object types

name Required

string

description

string

iconId Required

string

objectSchemaId Required

string

parentObjectTypeId

string

The id of the parent object type

inherited

boolean

Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type

abstractObjectType

boolean

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "iconId": "<string>",
  "objectSchemaId": "<string>",
  "parentObjectTypeId": "<string>",
  "inherited": true,
  "abstractObjectType": true
}'

Responses

Content typeValue
application/json

ObjectType

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
  "id": "23",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
  "icon": {
    "id": "13",
    "name": "Building",
    "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
    "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
  },
  "position": 2,
  "created": "2021-02-16T19:36:51.951Z",
  "updated": "2021-04-16T15:17:03.384Z",
  "objectCount": 4,
  "objectSchemaId": "6",
  "inherited": false,
  "abstractObjectType": false,
  "parentObjectTypeInherited": false
}

Delete objecttype {id}

DELETE /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}

Delete an object type

Request

Path parameters
id Required

string

Example

1
2
3
curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

ObjectType

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
  "id": "23",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
  "icon": {
    "id": "13",
    "name": "Building",
    "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
    "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
  },
  "position": 2,
  "created": "2021-02-16T19:36:51.951Z",
  "updated": "2021-04-16T15:17:03.384Z",
  "objectCount": 4,
  "objectSchemaId": "6",
  "inherited": false,
  "abstractObjectType": false,
  "parentObjectTypeInherited": false
}

Get objecttype {id} attributes

GET /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}/attributes

Find all attributes for this object type

Request

Path parameters
id Required

string

Query parameters
onlyValueEditable

boolean

Default: false
orderByName

boolean

Default: false
query

string

Default: ""
includeValuesExist

boolean

Default: false
excludeParentAttributes

boolean

Default: false
includeChildren

boolean

Default: false
orderByRequired

boolean

Default: false

Example

1
2
3
curl --request GET \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}/attributes' \
  --header 'Accept: application/json'

Responses

Content typeValue
application/json

Array<ObjectTypeAttribute>

Example response (application/json)

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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
[
  {
    "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:134",
    "id": "134",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Key",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 0
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:135",
    "id": "135",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Name",
    "label": true,
    "description": "The name of the object",
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "suffix": "",
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": true,
    "regexValidation": "",
    "iql": "",
    "options": "",
    "position": 1
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:136",
    "id": "136",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Created",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 2
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:137",
    "id": "137",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Updated",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 3
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:144",
    "id": "144",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "City",
    "label": false,
    "referenceType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:4",
      "id": "4",
      "name": "Reference",
      "description": "Reference",
      "color": "49a6ed",
      "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16",
      "removable": false
    },
    "referenceObjectTypeId": "24",
    "referenceObjectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:24",
      "id": "24",
      "name": "City",
      "type": 0,
      "icon": {
        "id": "28",
        "name": "Cottage",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=48"
      },
      "position": 3,
      "created": "2021-02-16T19:58:45.698Z",
      "updated": "2021-04-16T15:17:03.393Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 0,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 4,
    "x-type": 1
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:265",
    "id": "265",
    "objectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:23",
      "id": "23",
      "name": "Office",
      "type": 0,
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
      "icon": {
        "id": "13",
        "name": "Building",
        "url16": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/jsm/insight/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=48"
      },
      "position": 2,
      "created": "2021-02-16T19:36:51.951Z",
      "updated": "2021-04-16T15:17:03.384Z",
      "objectCount": 0,
      "objectSchemaId": "6",
      "inherited": false,
      "abstractObjectType": false,
      "parentObjectTypeInherited": false
    },
    "name": "Placeholder",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 0,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 5
  }
]

Post objecttype {id} position

POST /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}/position

Change position of this object type

Request

Path parameters
id Required

string

Body parameters
toObjectTypeId

string

The desired new parent of the object type

position Required

integer

The preffered position

Example

1
2
3
4
5
6
7
8
curl --request POST \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/{id}/position' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "toObjectTypeId": "2",
  "position": 0
}'

Responses

Content typeValue
application/json

ObjectType

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
  "id": "23",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
  "icon": {
    "id": "13",
    "name": "Building",
    "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
    "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
  },
  "position": 2,
  "created": "2021-02-16T19:36:51.951Z",
  "updated": "2021-04-16T15:17:03.384Z",
  "objectCount": 4,
  "objectSchemaId": "6",
  "inherited": false,
  "abstractObjectType": false,
  "parentObjectTypeInherited": false
}

Post objecttype create

POST /jsm/insight/workspace/{workspaceId}/v{version}/objecttype/create

Create a new object type

Request

Body parameters

The Insight object type input used for creating and updating object types

name Required

string

description

string

iconId Required

string

objectSchemaId Required

string

parentObjectTypeId

string

The id of the parent object type

inherited

boolean

Describes if this object type is configured for inheritance i.e. it's children inherits the attributes of this object type

abstractObjectType

boolean

Example

1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttype/create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "inherited": false,
  "abstractObjectType": false,
  "objectSchemaId": "6",
  "iconId": "13",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex."
}'

Responses

Content typeValue
application/json

ObjectType

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:23",
  "id": "23",
  "name": "Office",
  "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.",
  "icon": {
    "id": "13",
    "name": "Building",
    "url16": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=16",
    "url48": "https://api.atlassian.com/jsm/insight/workspace/g2778e1d-939d-581d-c8e2-9d5g59de456b/v1/objecttype/23/icon.png?size=48"
  },
  "position": 2,
  "created": "2021-02-16T19:36:51.951Z",
  "updated": "2021-04-16T15:17:03.384Z",
  "objectCount": 4,
  "objectSchemaId": "6",
  "inherited": false,
  "abstractObjectType": false,
  "parentObjectTypeInherited": false
}

Rate this page: