Get objecttypeidattributes — rest

v1

latestOpenAPI 3.0.02026-07-136452257.6 KB

Find all attributes for this object type

get/objecttype/{id}/attributes

Query parameters

onlyValueEditableboolean

orderByNameboolean

querystring

includeValuesExistboolean

excludeParentAttributesboolean

includeChildrenboolean

orderByRequiredboolean

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": "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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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": "",
    "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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/4/image.png?size=16"
    },
    "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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/24/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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
  },
  {
    "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/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/objecttype/23/icon.png?size=16",
        "url48": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/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
  }
]