schemas
AvatarUrlsBean
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
Board
{
"additionalProperties": false,
"description": "Details about a board.",
"properties": {
"admins": {
"allOf": [
{
"additionalProperties": false,
"description": "The users and groups who own the board.",
"properties": {
"groups": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"users": {
"items": {
"additionalProperties": false,
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the user's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the user's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the user's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the user's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user."
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"type": "string"
},
"key": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user.",
"type": "string"
},
"name": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"type": "string"
},
"self": {
"description": "The URL of the user.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"readOnly": true
},
"canEdit": {
"description": "Whether the board can be edited.",
"readOnly": true,
"type": "boolean"
},
"favourite": {
"description": "Whether the board is selected as a favorite.",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "The ID of the board.",
"format": "int64",
"type": "integer"
},
"isPrivate": {
"description": "Whether the board is private.",
"readOnly": true,
"type": "boolean"
},
"location": {
"additionalProperties": false,
"description": "The container that the board is located in.",
"properties": {
"avatarURI": {
"format": "uri",
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"projectId": {
"format": "int64",
"type": "integer"
},
"projectKey": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectTypeKey": {
"type": "string"
},
"userAccountId": {
"type": "string"
},
"userId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the board.",
"type": "string"
},
"self": {
"description": "The URL of the board.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The type the board.",
"type": "string"
}
},
"type": "object"
}
BoardAdminsBean
{
"additionalProperties": false,
"description": "The users and groups who own the board.",
"properties": {
"groups": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"users": {
"items": {
"additionalProperties": false,
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the user's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the user's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the user's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the user's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user."
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"type": "string"
},
"key": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user.",
"type": "string"
},
"name": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"type": "string"
},
"self": {
"description": "The URL of the user.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
BoardConfigBean
{
"additionalProperties": false,
"properties": {
"columnConfig": {
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"statuses": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"constraintType": {
"type": "string"
}
},
"type": "object"
},
"estimation": {
"additionalProperties": false,
"properties": {
"field": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"fieldId": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"filter": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"id": {
"format": "int64",
"type": "integer"
},
"location": {
"additionalProperties": false,
"properties": {
"projectKeyOrId": {
"type": "string"
},
"type": {
"enum": [
"project",
"user"
],
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"ranking": {
"additionalProperties": false,
"properties": {
"rankCustomFieldId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"self": {
"format": "uri",
"type": "string"
},
"subQuery": {
"additionalProperties": false,
"properties": {
"query": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
}
BoardCreateBean
{
"additionalProperties": false,
"properties": {
"filterId": {
"format": "int64",
"type": "integer"
},
"location": {
"additionalProperties": false,
"properties": {
"projectKeyOrId": {
"type": "string"
},
"type": {
"enum": [
"project",
"user"
],
"type": "string"
}
},
"type": "object"
},
"name": {
"type": "string"
},
"type": {
"enum": [
"kanban",
"scrum",
"agility"
],
"type": "string"
}
},
"type": "object"
}
BoardFilterBean
{
"additionalProperties": false,
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
BoardLocationBean
{
"additionalProperties": false,
"description": "The container that the board is located in.",
"properties": {
"avatarURI": {
"format": "uri",
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"projectId": {
"format": "int64",
"type": "integer"
},
"projectKey": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectTypeKey": {
"type": "string"
},
"userAccountId": {
"type": "string"
},
"userId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
ChangeDetails
{
"additionalProperties": false,
"description": "A change item.",
"properties": {
"field": {
"description": "The name of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldId": {
"description": "The ID of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldtype": {
"description": "The type of the field changed.",
"readOnly": true,
"type": "string"
},
"from": {
"description": "The details of the original value.",
"readOnly": true,
"type": "string"
},
"fromString": {
"description": "The details of the original value as a string.",
"readOnly": true,
"type": "string"
},
"to": {
"description": "The details of the new value.",
"readOnly": true,
"type": "string"
},
"toString": {
"description": "The details of the new value as a string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Changelog
{
"additionalProperties": false,
"description": "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
"properties": {
"author": {
"allOf": [
{
"additionalProperties": false,
"description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the user.",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The user who made the change.",
"readOnly": true
},
"created": {
"description": "The date on which the change took place.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"historyMetadata": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of issue history metadata.",
"properties": {
"activityDescription": {
"description": "The activity described in the history record.",
"type": "string"
},
"activityDescriptionKey": {
"description": "The key of the activity described in the history record.",
"type": "string"
},
"actor": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the user whose action created the history record."
},
"cause": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the cause that triggered the creation the history record."
},
"description": {
"description": "The description of the history record.",
"type": "string"
},
"descriptionKey": {
"description": "The description key of the history record.",
"type": "string"
},
"emailDescription": {
"description": "The description of the email address associated the history record.",
"type": "string"
},
"emailDescriptionKey": {
"description": "The description key of the email address associated the history record.",
"type": "string"
},
"extraData": {
"additionalProperties": {
"type": "string"
},
"description": "Additional arbitrary information about the history record.",
"type": "object"
},
"generator": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the system that generated the history record."
},
"type": {
"description": "The type of the history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "The history metadata associated with the changed.",
"readOnly": true
},
"id": {
"description": "The ID of the changelog.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "The list of items changed.",
"items": {
"additionalProperties": false,
"description": "A change item.",
"properties": {
"field": {
"description": "The name of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldId": {
"description": "The ID of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldtype": {
"description": "The type of the field changed.",
"readOnly": true,
"type": "string"
},
"from": {
"description": "The details of the original value.",
"readOnly": true,
"type": "string"
},
"fromString": {
"description": "The details of the original value as a string.",
"readOnly": true,
"type": "string"
},
"to": {
"description": "The details of the new value.",
"readOnly": true,
"type": "string"
},
"toString": {
"description": "The details of the new value as a string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
ColorBean
{
"additionalProperties": false,
"properties": {
"key": {
"enum": [
"color_1",
"color_2",
"color_3",
"color_4",
"color_5",
"color_6",
"color_7",
"color_8",
"color_9",
"color_10",
"color_11",
"color_12",
"color_13",
"color_14"
],
"type": "string"
}
},
"type": "object"
}
ColumnBean
{
"additionalProperties": false,
"properties": {
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"statuses": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
ColumnConfigBean
{
"additionalProperties": false,
"properties": {
"columns": {
"items": {
"additionalProperties": false,
"properties": {
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
},
"name": {
"type": "string"
},
"statuses": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"constraintType": {
"type": "string"
}
},
"type": "object"
}
Entry
{
"additionalProperties": false,
"properties": {
"errors": {
"items": {
"type": "string"
},
"type": "array"
},
"issueId": {
"format": "int64",
"type": "integer"
},
"issueKey": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
EpicRankRequestBean
{
"additionalProperties": false,
"properties": {
"rankAfterEpic": {
"type": "string"
},
"rankBeforeEpic": {
"type": "string"
},
"rankCustomFieldId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
EpicUpdateBean
{
"additionalProperties": false,
"properties": {
"color": {
"additionalProperties": false,
"properties": {
"key": {
"enum": [
"color_1",
"color_2",
"color_3",
"color_4",
"color_5",
"color_6",
"color_7",
"color_8",
"color_9",
"color_10",
"color_11",
"color_12",
"color_13",
"color_14"
],
"type": "string"
}
},
"type": "object"
},
"done": {
"type": "boolean"
},
"name": {
"type": "string"
},
"summary": {
"type": "string"
}
},
"type": "object"
}
EstimationConfigBean
{
"additionalProperties": false,
"properties": {
"field": {
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"fieldId": {
"type": "string"
}
},
"type": "object"
},
"type": {
"type": "string"
}
},
"type": "object"
}
EstimationConfigurationBean
{
"additionalProperties": false,
"properties": {
"localisedDescription": {
"type": "string"
},
"localisedName": {
"type": "string"
},
"value": {
"enum": [
"STORY_POINTS",
"ORIGINAL_ESTIMATE"
],
"type": "string"
}
},
"type": "object"
}
EstimationFieldBean
{
"additionalProperties": false,
"properties": {
"displayName": {
"type": "string"
},
"fieldId": {
"type": "string"
}
},
"type": "object"
}
FeatureBean
{
"additionalProperties": false,
"properties": {
"boardFeature": {
"enum": [
"SIMPLE_ROADMAP",
"BACKLOG",
"SPRINTS",
"CALENDAR",
"DEVTOOLS",
"REPORTS",
"ESTIMATION",
"PAGES",
"CODE",
"SECURITY",
"REQUESTS",
"INCIDENTS",
"RELEASES",
"DEPLOYMENTS",
"ISSUE_NAVIGATOR",
"ON_CALL_SCHEDULE",
"BOARD",
"GOALS",
"LIST_VIEW"
],
"type": "string"
},
"boardId": {
"format": "int64",
"type": "integer"
},
"featureId": {
"type": "string"
},
"featureType": {
"enum": [
"BASIC",
"ESTIMATION"
],
"type": "string"
},
"imageUri": {
"type": "string"
},
"learnMoreArticleId": {
"type": "string"
},
"learnMoreLink": {
"type": "string"
},
"localisedDescription": {
"type": "string"
},
"localisedGroup": {
"type": "string"
},
"localisedName": {
"type": "string"
},
"permissibleEstimationTypes": {
"items": {
"additionalProperties": false,
"properties": {
"localisedDescription": {
"type": "string"
},
"localisedName": {
"type": "string"
},
"value": {
"enum": [
"STORY_POINTS",
"ORIGINAL_ESTIMATE"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"state": {
"enum": [
"ENABLED",
"DISABLED",
"COMING_SOON"
],
"type": "string"
},
"toggleLocked": {
"type": "boolean"
}
},
"type": "object"
}
FeatureResponseBean
{
"additionalProperties": false,
"properties": {
"features": {
"items": {
"additionalProperties": false,
"properties": {
"boardFeature": {
"enum": [
"SIMPLE_ROADMAP",
"BACKLOG",
"SPRINTS",
"CALENDAR",
"DEVTOOLS",
"REPORTS",
"ESTIMATION",
"PAGES",
"CODE",
"SECURITY",
"REQUESTS",
"INCIDENTS",
"RELEASES",
"DEPLOYMENTS",
"ISSUE_NAVIGATOR",
"ON_CALL_SCHEDULE",
"BOARD",
"GOALS",
"LIST_VIEW"
],
"type": "string"
},
"boardId": {
"format": "int64",
"type": "integer"
},
"featureId": {
"type": "string"
},
"featureType": {
"enum": [
"BASIC",
"ESTIMATION"
],
"type": "string"
},
"imageUri": {
"type": "string"
},
"learnMoreArticleId": {
"type": "string"
},
"learnMoreLink": {
"type": "string"
},
"localisedDescription": {
"type": "string"
},
"localisedGroup": {
"type": "string"
},
"localisedName": {
"type": "string"
},
"permissibleEstimationTypes": {
"items": {
"additionalProperties": false,
"properties": {
"localisedDescription": {
"type": "string"
},
"localisedName": {
"type": "string"
},
"value": {
"enum": [
"STORY_POINTS",
"ORIGINAL_ESTIMATE"
],
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"state": {
"enum": [
"ENABLED",
"DISABLED",
"COMING_SOON"
],
"type": "string"
},
"toggleLocked": {
"type": "boolean"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
FeatureToggleRequestBean
{
"additionalProperties": false,
"properties": {
"boardId": {
"format": "int64",
"type": "integer"
},
"enabling": {
"type": "boolean"
},
"feature": {
"type": "string"
}
},
"type": "object"
}
FieldEditBean
{
"additionalProperties": false,
"properties": {
"value": {
"type": "string"
}
},
"type": "object"
}
FieldMetadata
{
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
}
GroupBean
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
HistoryMetadata
{
"additionalProperties": true,
"description": "Details of issue history metadata.",
"properties": {
"activityDescription": {
"description": "The activity described in the history record.",
"type": "string"
},
"activityDescriptionKey": {
"description": "The key of the activity described in the history record.",
"type": "string"
},
"actor": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the user whose action created the history record."
},
"cause": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the cause that triggered the creation the history record."
},
"description": {
"description": "The description of the history record.",
"type": "string"
},
"descriptionKey": {
"description": "The description key of the history record.",
"type": "string"
},
"emailDescription": {
"description": "The description of the email address associated the history record.",
"type": "string"
},
"emailDescriptionKey": {
"description": "The description key of the email address associated the history record.",
"type": "string"
},
"extraData": {
"additionalProperties": {
"type": "string"
},
"description": "Additional arbitrary information about the history record.",
"type": "object"
},
"generator": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the system that generated the history record."
},
"type": {
"description": "The type of the history record.",
"type": "string"
}
},
"type": "object"
}
HistoryMetadataParticipant
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
IncludedFields
{
"additionalProperties": false,
"properties": {
"actuallyIncluded": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"excluded": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"included": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
IssueAssignRequestBean
{
"additionalProperties": false,
"properties": {
"issues": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
}
IssueBean
{
"additionalProperties": false,
"description": "Details about an issue.",
"properties": {
"changelog": {
"allOf": [
{
"additionalProperties": false,
"description": "A page of changelogs.",
"properties": {
"histories": {
"description": "The list of changelogs.",
"items": {
"additionalProperties": false,
"description": "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
"properties": {
"author": {
"allOf": [
{
"additionalProperties": false,
"description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the user.",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The user who made the change.",
"readOnly": true
},
"created": {
"description": "The date on which the change took place.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"historyMetadata": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of issue history metadata.",
"properties": {
"activityDescription": {
"description": "The activity described in the history record.",
"type": "string"
},
"activityDescriptionKey": {
"description": "The key of the activity described in the history record.",
"type": "string"
},
"actor": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the user whose action created the history record."
},
"cause": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the cause that triggered the creation the history record."
},
"description": {
"description": "The description of the history record.",
"type": "string"
},
"descriptionKey": {
"description": "The description key of the history record.",
"type": "string"
},
"emailDescription": {
"description": "The description of the email address associated the history record.",
"type": "string"
},
"emailDescriptionKey": {
"description": "The description key of the email address associated the history record.",
"type": "string"
},
"extraData": {
"additionalProperties": {
"type": "string"
},
"description": "Additional arbitrary information about the history record.",
"type": "object"
},
"generator": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the system that generated the history record."
},
"type": {
"description": "The type of the history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "The history metadata associated with the changed.",
"readOnly": true
},
"id": {
"description": "The ID of the changelog.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "The list of items changed.",
"items": {
"additionalProperties": false,
"description": "A change item.",
"properties": {
"field": {
"description": "The name of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldId": {
"description": "The ID of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldtype": {
"description": "The type of the field changed.",
"readOnly": true,
"type": "string"
},
"from": {
"description": "The details of the original value.",
"readOnly": true,
"type": "string"
},
"fromString": {
"description": "The details of the original value as a string.",
"readOnly": true,
"type": "string"
},
"to": {
"description": "The details of the new value.",
"readOnly": true,
"type": "string"
},
"toString": {
"description": "The details of the new value as a string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"maxResults": {
"description": "The maximum number of results that could be on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"startAt": {
"description": "The index of the first item returned on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of results on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
],
"description": "Details of changelogs associated with the issue.",
"readOnly": true
},
"editmeta": {
"allOf": [
{
"description": "A list of editable field details.",
"properties": {
"fields": {
"additionalProperties": {
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
],
"description": "The metadata for the fields on the issue that can be amended.",
"readOnly": true
},
"expand": {
"description": "Expand options that include additional issue details in the response.",
"readOnly": true,
"type": "string",
"xml": {
"attribute": true
}
},
"fields": {
"additionalProperties": {},
"type": "object"
},
"fieldsToInclude": {
"additionalProperties": false,
"properties": {
"actuallyIncluded": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"excluded": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"included": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"id": {
"description": "The ID of the issue.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "The key of the issue.",
"readOnly": true,
"type": "string"
},
"names": {
"additionalProperties": {
"readOnly": true,
"type": "string"
},
"description": "The ID and name of each field present on the issue.",
"readOnly": true,
"type": "object"
},
"operations": {
"allOf": [
{
"$ref": "#/components/schemas/Operations"
}
],
"description": "The operations that can be performed on the issue.",
"readOnly": true
},
"properties": {
"additionalProperties": {
"readOnly": true
},
"description": "Details of the issue properties identified in the request.",
"readOnly": true,
"type": "object"
},
"renderedFields": {
"additionalProperties": {
"readOnly": true
},
"description": "The rendered value of each field present on the issue.",
"readOnly": true,
"type": "object"
},
"schema": {
"additionalProperties": {
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "The schema describing each field present on the issue.",
"readOnly": true,
"type": "object"
},
"self": {
"description": "The URL of the issue details.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"transitions": {
"description": "The transitions that can be performed on the issue.",
"items": {
"additionalProperties": true,
"description": "Details of an issue transition.",
"properties": {
"expand": {
"description": "Expand options that include additional transition details in the response.",
"readOnly": true,
"type": "string"
},
"fields": {
"additionalProperties": {
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
},
"description": "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
"readOnly": true,
"type": "object"
},
"hasScreen": {
"description": "Whether there is a screen associated with the issue transition.",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "The ID of the issue transition. Required when specifying a transition to undertake.",
"type": "string"
},
"isAvailable": {
"description": "Whether the transition is available to be performed.",
"readOnly": true,
"type": "boolean"
},
"isConditional": {
"description": "Whether the issue has to meet criteria before the issue transition is applied.",
"readOnly": true,
"type": "boolean"
},
"isGlobal": {
"description": "Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"readOnly": true,
"type": "boolean"
},
"isInitial": {
"description": "Whether this is the initial issue transition for the workflow.",
"readOnly": true,
"type": "boolean"
},
"looped": {
"type": "boolean"
},
"name": {
"description": "The name of the issue transition.",
"readOnly": true,
"type": "string"
},
"to": {
"allOf": [
{
"additionalProperties": true,
"description": "A status.",
"properties": {
"description": {
"description": "The description of the status.",
"readOnly": true,
"type": "string"
},
"iconUrl": {
"description": "The URL of the icon used to represent the status.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status.",
"readOnly": true,
"type": "string"
},
"scope": {
"allOf": [
{
"additionalProperties": true,
"description": "The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
"properties": {
"project": {
"allOf": [
{
"additionalProperties": false,
"description": "Details about a project.",
"properties": {
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The URLs of the project's avatars.",
"readOnly": true
},
"id": {
"description": "The ID of the project.",
"type": "string"
},
"key": {
"description": "The key of the project.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the project.",
"readOnly": true,
"type": "string"
},
"projectCategory": {
"allOf": [
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category the project belongs to.",
"readOnly": true
},
"projectTypeKey": {
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business"
],
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project details.",
"readOnly": true,
"type": "string"
},
"simplified": {
"description": "Whether or not the project is simplified.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
],
"description": "The project the item has scope in.",
"readOnly": true
},
"type": {
"description": "The type of scope.",
"enum": [
"PROJECT",
"TEMPLATE"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The scope of the field.",
"readOnly": true
},
"self": {
"description": "The URL of the status.",
"readOnly": true,
"type": "string"
},
"statusCategory": {
"allOf": [
{
"additionalProperties": true,
"description": "A status category.",
"properties": {
"colorName": {
"description": "The name of the color used to represent the status category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status category.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"key": {
"description": "The key of the status category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the status category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category assigned to the status.",
"readOnly": true
}
},
"type": "object"
}
],
"description": "Details of the issue status after the transition.",
"readOnly": true
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"versionedRepresentations": {
"additionalProperties": {
"additionalProperties": {
"readOnly": true
},
"readOnly": true,
"type": "object"
},
"description": "The versions of each field on the issue.",
"readOnly": true,
"type": "object"
}
},
"type": "object",
"xml": {
"name": "issue"
}
}
IssueRankRequestBean
{
"additionalProperties": false,
"properties": {
"issues": {
"items": {
"type": "string"
},
"type": "array"
},
"rankAfterIssue": {
"type": "string"
},
"rankBeforeIssue": {
"type": "string"
},
"rankCustomFieldId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
IssueTransition
{
"additionalProperties": true,
"description": "Details of an issue transition.",
"properties": {
"expand": {
"description": "Expand options that include additional transition details in the response.",
"readOnly": true,
"type": "string"
},
"fields": {
"additionalProperties": {
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
},
"description": "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
"readOnly": true,
"type": "object"
},
"hasScreen": {
"description": "Whether there is a screen associated with the issue transition.",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "The ID of the issue transition. Required when specifying a transition to undertake.",
"type": "string"
},
"isAvailable": {
"description": "Whether the transition is available to be performed.",
"readOnly": true,
"type": "boolean"
},
"isConditional": {
"description": "Whether the issue has to meet criteria before the issue transition is applied.",
"readOnly": true,
"type": "boolean"
},
"isGlobal": {
"description": "Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
"readOnly": true,
"type": "boolean"
},
"isInitial": {
"description": "Whether this is the initial issue transition for the workflow.",
"readOnly": true,
"type": "boolean"
},
"looped": {
"type": "boolean"
},
"name": {
"description": "The name of the issue transition.",
"readOnly": true,
"type": "string"
},
"to": {
"allOf": [
{
"additionalProperties": true,
"description": "A status.",
"properties": {
"description": {
"description": "The description of the status.",
"readOnly": true,
"type": "string"
},
"iconUrl": {
"description": "The URL of the icon used to represent the status.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status.",
"readOnly": true,
"type": "string"
},
"scope": {
"allOf": [
{
"additionalProperties": true,
"description": "The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
"properties": {
"project": {
"allOf": [
{
"additionalProperties": false,
"description": "Details about a project.",
"properties": {
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The URLs of the project's avatars.",
"readOnly": true
},
"id": {
"description": "The ID of the project.",
"type": "string"
},
"key": {
"description": "The key of the project.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the project.",
"readOnly": true,
"type": "string"
},
"projectCategory": {
"allOf": [
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category the project belongs to.",
"readOnly": true
},
"projectTypeKey": {
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business"
],
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project details.",
"readOnly": true,
"type": "string"
},
"simplified": {
"description": "Whether or not the project is simplified.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
],
"description": "The project the item has scope in.",
"readOnly": true
},
"type": {
"description": "The type of scope.",
"enum": [
"PROJECT",
"TEMPLATE"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The scope of the field.",
"readOnly": true
},
"self": {
"description": "The URL of the status.",
"readOnly": true,
"type": "string"
},
"statusCategory": {
"allOf": [
{
"additionalProperties": true,
"description": "A status category.",
"properties": {
"colorName": {
"description": "The name of the color used to represent the status category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status category.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"key": {
"description": "The key of the status category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the status category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category assigned to the status.",
"readOnly": true
}
},
"type": "object"
}
],
"description": "Details of the issue status after the transition.",
"readOnly": true
}
},
"type": "object"
}
IssueUpdateMetadata
{
"description": "A list of editable field details.",
"properties": {
"fields": {
"additionalProperties": {
"additionalProperties": false,
"description": "The metadata describing an issue field.",
"properties": {
"allowedValues": {
"description": "The list of values allowed in the field.",
"items": {
"readOnly": true
},
"readOnly": true,
"type": "array"
},
"autoCompleteUrl": {
"description": "The URL that can be used to automatically complete the field.",
"readOnly": true,
"type": "string"
},
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "The configuration properties.",
"readOnly": true,
"type": "object"
},
"defaultValue": {
"description": "The default value of the field.",
"readOnly": true
},
"hasDefaultValue": {
"description": "Whether the field has a default value.",
"readOnly": true,
"type": "boolean"
},
"key": {
"description": "The key of the field.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the field.",
"readOnly": true,
"type": "string"
},
"operations": {
"description": "The list of operations that can be performed on the field.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
},
"required": {
"description": "Whether the field is required.",
"readOnly": true,
"type": "boolean"
},
"schema": {
"allOf": [
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"description": "The data type of the field.",
"readOnly": true
}
},
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"type": "object",
"xml": {
"name": "availableField"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
}
JsonTypeBean
{
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
LinkGroup
{
"additionalProperties": false,
"description": "Details a link group, which defines issue operations.",
"properties": {
"groups": {
"items": {
"$ref": "#/components/schemas/LinkGroup"
},
"type": "array"
},
"header": {
"additionalProperties": false,
"description": "Details about the operations available in this version.",
"properties": {
"href": {
"type": "string"
},
"iconClass": {
"type": "string"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"styleClass": {
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"format": "int32",
"type": "integer"
}
},
"type": "object",
"xml": {
"name": "link"
}
},
"id": {
"type": "string"
},
"links": {
"items": {
"additionalProperties": false,
"description": "Details about the operations available in this version.",
"properties": {
"href": {
"type": "string"
},
"iconClass": {
"type": "string"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"styleClass": {
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"format": "int32",
"type": "integer"
}
},
"type": "object",
"xml": {
"name": "link"
}
},
"type": "array"
},
"styleClass": {
"type": "string"
},
"weight": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
LocationBean
{
"additionalProperties": false,
"properties": {
"projectKeyOrId": {
"type": "string"
},
"type": {
"enum": [
"project",
"user"
],
"type": "string"
}
},
"type": "object"
}
Operations
{
"additionalProperties": true,
"description": "Details of the operations that can be performed on the issue.",
"properties": {
"linkGroups": {
"description": "Details of the link groups defining issue operations.",
"items": {
"$ref": "#/components/schemas/LinkGroup"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
PageBeanBoard
{
"additionalProperties": false,
"properties": {
"isLast": {
"type": "boolean"
},
"maxResults": {
"format": "int32",
"type": "integer"
},
"startAt": {
"format": "int64",
"type": "integer"
},
"total": {
"format": "int64",
"type": "integer"
},
"values": {
"items": {
"additionalProperties": false,
"description": "Details about a board.",
"properties": {
"admins": {
"allOf": [
{
"additionalProperties": false,
"description": "The users and groups who own the board.",
"properties": {
"groups": {
"items": {
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"users": {
"items": {
"additionalProperties": false,
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the user's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the user's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the user's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the user's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user."
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"type": "string"
},
"key": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user.",
"type": "string"
},
"name": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"type": "string"
},
"self": {
"description": "The URL of the user.",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
],
"readOnly": true
},
"canEdit": {
"description": "Whether the board can be edited.",
"readOnly": true,
"type": "boolean"
},
"favourite": {
"description": "Whether the board is selected as a favorite.",
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "The ID of the board.",
"format": "int64",
"type": "integer"
},
"isPrivate": {
"description": "Whether the board is private.",
"readOnly": true,
"type": "boolean"
},
"location": {
"additionalProperties": false,
"description": "The container that the board is located in.",
"properties": {
"avatarURI": {
"format": "uri",
"type": "string"
},
"displayName": {
"type": "string"
},
"name": {
"type": "string"
},
"projectId": {
"format": "int64",
"type": "integer"
},
"projectKey": {
"type": "string"
},
"projectName": {
"type": "string"
},
"projectTypeKey": {
"type": "string"
},
"userAccountId": {
"type": "string"
},
"userId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"name": {
"description": "The name of the board.",
"type": "string"
},
"self": {
"description": "The URL of the board.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The type the board.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
PageBeanBoardFilterBean
{
"additionalProperties": false,
"properties": {
"isLast": {
"type": "boolean"
},
"maxResults": {
"format": "int32",
"type": "integer"
},
"startAt": {
"format": "int64",
"type": "integer"
},
"total": {
"format": "int64",
"type": "integer"
},
"values": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
PageBeanQuickFilterBean
{
"additionalProperties": false,
"properties": {
"isLast": {
"type": "boolean"
},
"maxResults": {
"format": "int32",
"type": "integer"
},
"startAt": {
"format": "int64",
"type": "integer"
},
"total": {
"format": "int64",
"type": "integer"
},
"values": {
"items": {
"additionalProperties": false,
"properties": {
"boardId": {
"format": "int64",
"type": "integer"
},
"description": {
"type": "string"
},
"id": {
"format": "int64",
"type": "integer"
},
"jql": {
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
PageOfChangelogs
{
"additionalProperties": false,
"description": "A page of changelogs.",
"properties": {
"histories": {
"description": "The list of changelogs.",
"items": {
"additionalProperties": false,
"description": "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
"properties": {
"author": {
"allOf": [
{
"additionalProperties": false,
"description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the user.",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The user who made the change.",
"readOnly": true
},
"created": {
"description": "The date on which the change took place.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"historyMetadata": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of issue history metadata.",
"properties": {
"activityDescription": {
"description": "The activity described in the history record.",
"type": "string"
},
"activityDescriptionKey": {
"description": "The key of the activity described in the history record.",
"type": "string"
},
"actor": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the user whose action created the history record."
},
"cause": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the cause that triggered the creation the history record."
},
"description": {
"description": "The description of the history record.",
"type": "string"
},
"descriptionKey": {
"description": "The description key of the history record.",
"type": "string"
},
"emailDescription": {
"description": "The description of the email address associated the history record.",
"type": "string"
},
"emailDescriptionKey": {
"description": "The description key of the email address associated the history record.",
"type": "string"
},
"extraData": {
"additionalProperties": {
"type": "string"
},
"description": "Additional arbitrary information about the history record.",
"type": "object"
},
"generator": {
"allOf": [
{
"additionalProperties": true,
"description": "Details of user or system associated with a issue history metadata item.",
"properties": {
"avatarUrl": {
"description": "The URL to an avatar for the user or system associated with a history record.",
"type": "string"
},
"displayName": {
"description": "The display name of the user or system associated with a history record.",
"type": "string"
},
"displayNameKey": {
"description": "The key of the display name of the user or system associated with a history record.",
"type": "string"
},
"id": {
"description": "The ID of the user or system associated with a history record.",
"type": "string"
},
"type": {
"description": "The type of the user or system associated with a history record.",
"type": "string"
},
"url": {
"description": "The URL of the user or system associated with a history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "Details of the system that generated the history record."
},
"type": {
"description": "The type of the history record.",
"type": "string"
}
},
"type": "object"
}
],
"description": "The history metadata associated with the changed.",
"readOnly": true
},
"id": {
"description": "The ID of the changelog.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "The list of items changed.",
"items": {
"additionalProperties": false,
"description": "A change item.",
"properties": {
"field": {
"description": "The name of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldId": {
"description": "The ID of the field changed.",
"readOnly": true,
"type": "string"
},
"fieldtype": {
"description": "The type of the field changed.",
"readOnly": true,
"type": "string"
},
"from": {
"description": "The details of the original value.",
"readOnly": true,
"type": "string"
},
"fromString": {
"description": "The details of the original value as a string.",
"readOnly": true,
"type": "string"
},
"to": {
"description": "The details of the new value.",
"readOnly": true,
"type": "string"
},
"toString": {
"description": "The details of the new value as a string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
},
"maxResults": {
"description": "The maximum number of results that could be on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"startAt": {
"description": "The index of the first item returned on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of results on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
}
PartialSuccessBean
{
"additionalProperties": false,
"properties": {
"entries": {
"items": {
"additionalProperties": false,
"properties": {
"errors": {
"items": {
"type": "string"
},
"type": "array"
},
"issueId": {
"format": "int64",
"type": "integer"
},
"issueKey": {
"type": "string"
},
"status": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
ProjectDetails
{
"additionalProperties": false,
"description": "Details about a project.",
"properties": {
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The URLs of the project's avatars.",
"readOnly": true
},
"id": {
"description": "The ID of the project.",
"type": "string"
},
"key": {
"description": "The key of the project.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the project.",
"readOnly": true,
"type": "string"
},
"projectCategory": {
"allOf": [
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category the project belongs to.",
"readOnly": true
},
"projectTypeKey": {
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business"
],
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project details.",
"readOnly": true,
"type": "string"
},
"simplified": {
"description": "Whether or not the project is simplified.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
QuickFilterBean
{
"additionalProperties": false,
"properties": {
"boardId": {
"format": "int64",
"type": "integer"
},
"description": {
"type": "string"
},
"id": {
"format": "int64",
"type": "integer"
},
"jql": {
"type": "string"
},
"name": {
"type": "string"
},
"position": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
}
RankingConfigBean
{
"additionalProperties": false,
"properties": {
"rankCustomFieldId": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
RelationBean
{
"additionalProperties": false,
"properties": {
"id": {
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"type": "object"
}
ReportBean
{
"additionalProperties": false,
"type": "object"
}
ReportsResponseBean
{
"additionalProperties": false,
"properties": {
"reports": {
"items": {
"additionalProperties": false,
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
Scope
{
"additionalProperties": true,
"description": "The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
"properties": {
"project": {
"allOf": [
{
"additionalProperties": false,
"description": "Details about a project.",
"properties": {
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The URLs of the project's avatars.",
"readOnly": true
},
"id": {
"description": "The ID of the project.",
"type": "string"
},
"key": {
"description": "The key of the project.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the project.",
"readOnly": true,
"type": "string"
},
"projectCategory": {
"allOf": [
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category the project belongs to.",
"readOnly": true
},
"projectTypeKey": {
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business"
],
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project details.",
"readOnly": true,
"type": "string"
},
"simplified": {
"description": "Whether or not the project is simplified.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
],
"description": "The project the item has scope in.",
"readOnly": true
},
"type": {
"description": "The type of scope.",
"enum": [
"PROJECT",
"TEMPLATE"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
SearchResults
{
"additionalProperties": false,
"description": "The result of a JQL search.",
"properties": {
"expand": {
"description": "Expand options that include additional search result details in the response.",
"readOnly": true,
"type": "string"
},
"issues": {
"description": "The list of issues found by the search.",
"items": {
"$ref": "#/components/schemas/IssueBean"
},
"readOnly": true,
"type": "array"
},
"maxResults": {
"description": "The maximum number of results that could be on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"names": {
"additionalProperties": {
"readOnly": true,
"type": "string"
},
"description": "The ID and name of each field in the search results.",
"readOnly": true,
"type": "object"
},
"schema": {
"additionalProperties": {
"additionalProperties": false,
"description": "The schema of a field.",
"properties": {
"configuration": {
"additionalProperties": {
"readOnly": true
},
"description": "If the field is a custom field, the configuration of the field.",
"readOnly": true,
"type": "object"
},
"custom": {
"description": "If the field is a custom field, the URI of the field.",
"readOnly": true,
"type": "string"
},
"customId": {
"description": "If the field is a custom field, the custom ID of the field.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"items": {
"description": "When the data type is an array, the name of the field items within the array.",
"readOnly": true,
"type": "string"
},
"system": {
"description": "If the field is a system field, the name of the field.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The data type of the field.",
"readOnly": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"description": "The schema describing the field types in the search results.",
"readOnly": true,
"type": "object"
},
"startAt": {
"description": "The index of the first item returned on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of results on the page.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"warningMessages": {
"description": "Any warnings related to the JQL query.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
SimpleLink
{
"additionalProperties": false,
"description": "Details about the operations available in this version.",
"properties": {
"href": {
"type": "string"
},
"iconClass": {
"type": "string"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"styleClass": {
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"format": "int32",
"type": "integer"
}
},
"type": "object",
"xml": {
"name": "link"
}
}
SprintBean
{
"additionalProperties": false,
"properties": {
"completeDate": {
"type": "string"
},
"createdDate": {
"type": "string"
},
"endDate": {
"type": "string"
},
"goal": {
"type": "string"
},
"id": {
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"originBoardId": {
"format": "int64",
"type": "integer"
},
"self": {
"format": "uri",
"type": "string"
},
"startDate": {
"type": "string"
},
"state": {
"type": "string"
}
},
"type": "object"
}
SprintCreateBean
{
"additionalProperties": false,
"properties": {
"endDate": {
"type": "string"
},
"goal": {
"type": "string"
},
"name": {
"type": "string"
},
"originBoardId": {
"format": "int64",
"type": "integer"
},
"startDate": {
"type": "string"
}
},
"type": "object"
}
SprintSwapBean
{
"additionalProperties": false,
"properties": {
"sprintToSwapWith": {
"format": "int64",
"type": "integer"
}
},
"type": "object"
}
StatusCategory
{
"additionalProperties": true,
"description": "A status category.",
"properties": {
"colorName": {
"description": "The name of the color used to represent the status category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status category.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"key": {
"description": "The key of the status category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the status category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
StatusDetails
{
"additionalProperties": true,
"description": "A status.",
"properties": {
"description": {
"description": "The description of the status.",
"readOnly": true,
"type": "string"
},
"iconUrl": {
"description": "The URL of the icon used to represent the status.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status.",
"readOnly": true,
"type": "string"
},
"scope": {
"allOf": [
{
"additionalProperties": true,
"description": "The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
"properties": {
"project": {
"allOf": [
{
"additionalProperties": false,
"description": "Details about a project.",
"properties": {
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The URLs of the project's avatars.",
"readOnly": true
},
"id": {
"description": "The ID of the project.",
"type": "string"
},
"key": {
"description": "The key of the project.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the project.",
"readOnly": true,
"type": "string"
},
"projectCategory": {
"allOf": [
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category the project belongs to.",
"readOnly": true
},
"projectTypeKey": {
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.",
"enum": [
"software",
"service_desk",
"business"
],
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project details.",
"readOnly": true,
"type": "string"
},
"simplified": {
"description": "Whether or not the project is simplified.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
}
],
"description": "The project the item has scope in.",
"readOnly": true
},
"type": {
"description": "The type of scope.",
"enum": [
"PROJECT",
"TEMPLATE"
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The scope of the field.",
"readOnly": true
},
"self": {
"description": "The URL of the status.",
"readOnly": true,
"type": "string"
},
"statusCategory": {
"allOf": [
{
"additionalProperties": true,
"description": "A status category.",
"properties": {
"colorName": {
"description": "The name of the color used to represent the status category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the status category.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"key": {
"description": "The key of the status category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the status category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the status category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
],
"description": "The category assigned to the status.",
"readOnly": true
}
},
"type": "object"
}
StringList
{
"additionalProperties": false,
"type": "object"
}
SubqueryBean
{
"additionalProperties": false,
"properties": {
"query": {
"type": "string"
}
},
"type": "object"
}
UpdatedProjectCategory
{
"additionalProperties": false,
"description": "A project category.",
"properties": {
"description": {
"description": "The name of the project category.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "The ID of the project category.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The description of the project category.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the project category.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
UserBean
{
"additionalProperties": false,
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the user's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the user's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the user's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the user's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user."
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.",
"type": "string"
},
"key": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe key of the user.",
"type": "string"
},
"name": {
"description": "This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. \nThe username of the user.",
"type": "string"
},
"self": {
"description": "The URL of the user.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
UserBeanAvatarUrls
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the user's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the user's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the user's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the user's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
UserDetails
{
"additionalProperties": false,
"description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"16x16": {
"description": "The URL of the item's 16x16 pixel avatar.",
"format": "uri",
"type": "string"
},
"24x24": {
"description": "The URL of the item's 24x24 pixel avatar.",
"format": "uri",
"type": "string"
},
"32x32": {
"description": "The URL of the item's 32x32 pixel avatar.",
"format": "uri",
"type": "string"
},
"48x48": {
"description": "The URL of the item's 48x48 pixel avatar.",
"format": "uri",
"type": "string"
}
},
"type": "object"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the user.",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
IssueIdOrKeysAssociation
{
"description": "An association type referencing issues in Jira.\n",
"required": [
"associationType",
"values"
],
"type": "object",
"properties": {
"associationType": {
"description": "Defines the association type.\n",
"type": "string",
"enum": [
"issueKeys",
"issueIdOrKeys"
],
"example": "issueIdOrKeys"
},
"values": {
"description": "The Jira issue keys or IDs to associate the entity with.\n\nThe number of values counted across all associationTypes must not exceed a limit of 500.\n",
"type": "array",
"items": {
"description": "An issue key or ID that references an issue in Jira.\n",
"type": "string",
"pattern": "(\\w{1,255}-\\d{1,255}|\\d{1,255})",
"example": "ABC-123"
},
"minItems": 1,
"maxItems": 500
}
},
"example": {
"associationType": "issueIdOrKeys",
"values": [
"ABC-123",
"ABC-456"
]
}
}
ServiceIdOrKeysAssociation
{
"description": "An association type referencing service ID or keys.\n",
"type": "object",
"required": [
"associationType",
"values"
],
"properties": {
"associationType": {
"description": "Defines the association type.\n",
"type": "string",
"enum": [
"serviceIdOrKeys"
],
"example": "serviceIdOrKeys"
},
"values": {
"description": "The service ID or keys to associate the entity with.\n\nThe number of values counted across all associationTypes must not exceed a limit of 500.\n",
"type": "array",
"items": {
"description": "A service ID or service key.\n",
"type": "string",
"maxLength": 255,
"example": "some-service-key"
},
"minItems": 1,
"maxItems": 500
}
},
"example": {
"associationType": "serviceIdOrKeys",
"values": [
"some-service-key"
]
}
}
EntityAssociation
{
"description": "An association type referencing another entity\n",
"title": "EntityAssociation",
"type": "object",
"required": [
"associationType",
"values"
],
"properties": {
"associationType": {
"description": "Defines the association type. Currently supported entities can be found in this field's value enums list.\n",
"type": "string",
"maxLength": 255,
"enum": [
"commit",
"repository"
]
},
"values": {
"description": "The entity keys that represent the entities to be associated.\nThe number of values counted across all associationTypes must not exceed a limit of 500.\n",
"type": "array",
"items": {
"anyOf": [
{
"description": "Identifies an individual commit in a repository.\n",
"type": "object",
"title": "Commit",
"required": [
"commitHash",
"repositoryId"
],
"properties": {
"commitHash": {
"description": "The hash for the Commit.\n",
"type": "string",
"maxLength": 255,
"example": "b00152456cf4"
},
"repositoryId": {
"description": "The ID of the Repository that the Commit belongs to.\n",
"type": "string",
"maxLength": 255,
"example": "de7fbebffabe"
}
}
},
{
"description": "Identifies an individual repository.\n",
"type": "object",
"title": "Repository",
"required": [
"repositoryId"
],
"properties": {
"repositoryId": {
"description": "",
"type": "string",
"maxLength": 255,
"example": "de7fbebffaba"
}
}
}
]
},
"minItems": 1,
"maxItems": 500
}
}
}
SoftwareIssueResults
{
"additionalProperties": false,
"description": "The result of an issue search in Jira Software APIs.",
"properties": {
"expand": {
"description": "Expand options that include additional search result details in the response.",
"readOnly": true,
"type": "string"
},
"isLast": {
"description": "Indicates whether this is the last page of the paginated response.",
"readOnly": true,
"type": "boolean"
},
"issues": {
"description": "The list of issues found by the search.",
"items": {
"$ref": "#/components/schemas/IssueBean"
},
"readOnly": true,
"type": "array"
},
"names": {
"additionalProperties": {
"readOnly": true,
"type": "string"
},
"description": "The ID and name of each field in the search results.",
"readOnly": true,
"type": "object"
},
"nextPageToken": {
"description": "Continuation token to fetch the next page. If this result represents the last or only page, this token will be null.",
"readOnly": true,
"type": "string"
},
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonTypeBean"
},
"description": "The schema describing the field types in the search results.",
"readOnly": true,
"type": "object"
},
"warningMessages": {
"description": "Any warnings related to the JQL query.",
"items": {
"readOnly": true,
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}
IssueCountBean
{
"additionalProperties": false,
"properties": {
"count": {
"description": "Number of issues.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
}