Rate this page:

Objecttypeattribute

Post objecttypeattribute {objectTypeId}

POST /jsm/insight/workspace/{workspaceId}/v{version}/objecttypeattribute/{objectTypeId}

Create a new attribute on the given object type

Request

Path parameters
objectTypeId Required

string

The object type id that has this object type attribute associated with it

Body parameters

Input entity to create an object type attribute

name Required

string

label

boolean

description

string

type Required

integer

ValueDescription
0Default
1Object reference
2User
4Group
7Status
defaultTypeId

integer

IdDescription (mandatory if type = Default)
-1None
0Text
1Integer
2Boolean
3Double
4Date
5Time
6DateTime
7Url
8Email
9Textarea
10Select
11IP Address
typeValue

string

It is mandatory for Type = Object reference and should point to the referenced object type id

typeValueMulti

Array<string>

Valid for Type User. The Jira groups to restrict selection to

additionalValue

string

Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference

minimumCardinality

integer

Valid for Type Email, Select, Object, User, Group, Version and Project

Default: 0
maximumCardinality

integer

Valid for Type Email, Select, Object, User, Group, Version and Project

Default: 1
suffix

string

Valid for Integer and Double object type attributes

includeChildObjectTypes

boolean

Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well

hidden

boolean

Hide the object type attributes for Insight Users

uniqueAttribute

boolean

Should the values be unique for object attributes associated with this object type attribute

summable

boolean

Valid for Type Integer and Double. Should a sum be included in the view

regexValidation

string

Valid for Type Text and Email

iql

string

Valid for Type object reference

options

string

Valid for Type Select. A comma separated list of all chosable options

Example

1
2
3
4
5
6
7
8
9
curl --request POST \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttypeattribute/{objectTypeId}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Geolocation",
  "type": "0",
  "defaultTypeId": "0"
}'

Responses

Content typeValue
application/json

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
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330",
  "id": "1330",
  "name": "Geolocation",
  "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": 6
}

Put objecttypeattribute {objectTypeId} {id}

PUT /jsm/insight/workspace/{workspaceId}/v{version}/objecttypeattribute/{objectTypeId}/{id}

Update an existing object type attribute

Request

Path parameters
id Required

string

The object type attribute to manipulate

objectTypeId Required

string

The object type id that has this object type attribute associated with it

Body parameters

Input entity to update an object type attribute

name

string

label

boolean

description

string

type

integer

ValueDescription
0Default
1Object reference
2User
4Group
7Status
defaultTypeId

integer

IdDescription (mandatory if type = Default)
-1None
0Text
1Integer
2Boolean
3Double
4Date
5Time
6DateTime
7Url
8Email
9Textarea
10Select
11IP Address
typeValue

string

It is mandatory for Type = Object reference and should point to the referenced object type id

typeValueMulti

Array<string>

Valid for Type User. The Jira groups to restrict selection to

additionalValue

string

Valid for Type Url, User, Object and Confluence. For Url (DISABLED, ENABLED), for Object (ReferenceTypeId), for User (SHOW_PROFILE, HIDE_PROFILE), for Confluence (Confluence Space Id). It is mandatory for Type = Object reference

minimumCardinality

integer

Valid for Type Email, Select, Object, User, Group, Version and Project

Default: 0
maximumCardinality

integer

Valid for Type Email, Select, Object, User, Group, Version and Project

Default: 1
suffix

string

Valid for Integer and Double object type attributes

includeChildObjectTypes

boolean

Valid for Type = Object reference and describes if children object types should be included in the selectable objects as well

hidden

boolean

Hide the object type attributes for Insight Users

uniqueAttribute

boolean

Should the values be unique for object attributes associated with this object type attribute

summable

boolean

Valid for Type Integer and Double. Should a sum be included in the view

regexValidation

string

Valid for Type Text and Email

iql

string

Valid for Type object reference

options

string

Valid for Type Select. A comma separated list of all chosable options

Example

1
2
3
4
5
6
7
curl --request PUT \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttypeattribute/{objectTypeId}/{id}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "GPS coordinates of the office"
}'

Responses

Content typeValue
application/json

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
{
  "workspaceId": "g2778e1d-939d-581d-c8e2-9d5g59de456b",
  "globalId": "g2778e1d-939d-581d-c8e2-9d5g59de456b:1330",
  "id": "1330",
  "name": "Geolocation",
  "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": 6
}

Delete objecttypeattribute {id}

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

Delete an existing object type attribute

Request

Path parameters
id Required

string

The object type attribute id to be manipulated

Example

1
2
curl --request DELETE \
  --url 'https://api.atlassian.com/jsm/insight/workspace/{workspaceId}/v{version}/objecttypeattribute/{id}'

Responses

The object type attribute has been successfully deleted

A schema has not been defined for this response code.

Rate this page: