Atlassian: Issue link types schemas
3 Atlassian schemas with complete fields and constraints.
← Issue link types operations · All schemas
Create issue link type — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get). * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types. Additional keys: not allowed |
id | string | Optional | The ID of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only. |
inward | string | Optional | The description of the issue link type inward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
name | string | Optional | The name of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
outward | string | Optional | The description of the issue link type outward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
self | string | Optional | The URL of the issue link type. Read only. Format: uri Read only: true |
Get issue link type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get). * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types. |
id | JSON | Optional | |
id (anyOf 1) | string | Alternative | The ID of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only. |
id (anyOf 2) | null | Alternative | |
inward | JSON | Optional | |
inward (anyOf 1) | string | Alternative | The description of the issue link type inward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
inward (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
name (anyOf 2) | null | Alternative | |
outward | JSON | Optional | |
outward (anyOf 1) | string | Alternative | The description of the issue link type outward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only. |
outward (anyOf 2) | null | Alternative | |
self | JSON | Optional | |
self (anyOf 1) | string | Alternative | The URL of the issue link type. Read only. Format: uri Read only: true |
self (anyOf 2) | null | Alternative |
Get issue link types — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of issue link type beans. |
issueLinkTypes | JSON | Optional | |
issueLinkTypes (anyOf 1) | array | Alternative | The issue link type bean. Read only: true |
issueLinkTypes (anyOf 1)[] | Model | Each item | Expand Get issue link type — response body |
issueLinkTypes (anyOf 2) | null | Alternative |
Referenced models: Get issue link type — response body