Get objectschemaidattributes — rest

v1

latestOpenAPI 3.0.02026-07-136452257.6 KB

Find all object type attributes for this object schema

get/objectschema/{id}/attributes

Query parameters

onlyValueEditableboolean

Return only values that are associated with values that can be edited

extendedboolean

Include the object type with each object type attribute

querystring

A query that will be used to filter object type attributes by their name

Response

workspaceIdstring required

globalIdstring required

idstring required

namestring

labelboolean required

typeinteger

Value	Description
0	Default
1	Object reference
2	User
4	Group
7	Status

descriptionstring

Id	Description
-1	None
0	Text
1	Integer
2	Boolean
3	Double
4	Date
5	Time
6	DateTime
7	Url
8	Email
9	Textarea
10	Select
11	IP Address

typeValuestring

typeValueMultistring[]

additionalValuestring

referenceObjectTypeIdstring

editableboolean

systemboolean

indexedboolean required

Describes if this object type attribute is indexed. For an indexed attribute the AQL search will be faster, but this will affect memory consumption.

sortableboolean

summableboolean

minimumCardinalityinteger

maximumCardinalityinteger

suffixstring

removableboolean

objectAttributeExistsboolean

hiddenboolean

includeChildObjectTypesboolean

uniqueAttributeboolean

regexValidationstring

iqlstring

Deprecated. Use qlQuery instead.

qlQuerystring

optionsstring

positioninteger required

Example response

[
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:868",
    "id": "868",
    "name": "Tier",
    "label": false,
    "defaultType": {
      "id": 10,
      "name": "Select"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "Tier 1,Tier 2,Tier 3,Tier 4",
    "position": 5
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:867",
    "id": "867",
    "name": "Description",
    "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": 4
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:869",
    "id": "869",
    "name": "Service relationships",
    "label": false,
    "referenceType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:36",
      "id": "36",
      "name": "Depends on",
      "color": "42526E",
      "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/36/image.png?size=16",
      "objectSchemaId": "27"
    },
    "referenceObjectTypeId": "122",
    "referenceObjectType": {
      "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
      "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:122",
      "id": "122",
      "name": "Service",
      "type": 0,
      "description": "This object type contains the services your site uses across projects.",
      "icon": {
        "id": "164",
        "name": "Service",
        "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/122/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/122/icon.png?size=48"
      },
      "position": 0,
      "created": "2021-03-19T04:52:40.472Z",
      "updated": "2021-03-19T04:52:40.472Z",
      "objectCount": 0,
      "objectSchemaId": "27",
      "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": 6
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:866",
    "id": "866",
    "name": "Updated",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 0,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 3
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:865",
    "id": "865",
    "name": "Created",
    "label": false,
    "defaultType": {
      "id": 6,
      "name": "DateTime"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 2
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:863",
    "id": "863",
    "name": "Key",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": false,
    "system": true,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 0
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:870",
    "id": "870",
    "name": "Service ID",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": true,
    "options": "",
    "position": 7
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:864",
    "id": "864",
    "name": "Name",
    "label": true,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": false,
    "hidden": false,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 1
  },
  {
    "workspaceId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a",
    "globalId": "f1668d0c-828c-470c-b7d1-8c4f48cd345a:871",
    "id": "871",
    "name": "Revision",
    "label": false,
    "defaultType": {
      "id": 0,
      "name": "Text"
    },
    "editable": true,
    "system": false,
    "sortable": true,
    "summable": false,
    "indexed": true,
    "minimumCardinality": 1,
    "maximumCardinality": 1,
    "removable": true,
    "hidden": true,
    "includeChildObjectTypes": false,
    "uniqueAttribute": false,
    "options": "",
    "position": 8
  }
]