ATatlassian

Changed on

Get reference type

get/config/referencetype

Request

  • Base URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1
  • URL
    https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/workspaceId/v1/config/referencetype
  • Auth
    • OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:cmdb-config:jira
    • or HTTP bearer

Query parameters

objectSchemaIdstring

Include reference types for the object schema id. If supplied reference types for the object schema will be returned otherwise all global will be returned

includeAllboolean

Include all reference types. Defaults to false

Response

workspaceIdstring required
globalIdstring required
idstring
namestring required
displayNamestring
descriptionstring
colorstring
url16string
removableboolean
objectSchemaIdstring

Example response

[
  {
    "id": "4",
    "name": "Reference",
    "displayName": "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",
    "removable": false,
    "objectSchemaId": null
  },
  {
    "id": "7",
    "name": "Work At",
    "displayName": "Work At",
    "description": "",
    "color": "688E6E",
    "url16": "https://api.atlassian.com/ex/jira/{cloudId}/jsm/assets/workspace/f1668d0c-828c-470c-b7d1-8c4f48cd345a/v1/config/referencetype/7/image.png?size=16",
    "removable": true,
    "objectSchemaId": "6"
  }
]

Changes