{"components":{"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"}},"securitySchemes":{"OAuth2":{"description":"OAuth2 scopes for Jira","flows":{"authorizationCode":{"authorizationUrl":"https://auth.atlassian.com/authorize","scopes":{"delete:board-scope.admin:jira-software":"Remove board configuration, features, and properties.","delete:sprint:jira-software":"Delete sprints and their properties.","manage:jira-configuration":"Configure Jira settings that require the Jira administrators permission, for example, create projects and custom fields, view workflows, manage issue link types.","manage:jira-project":"Create and edit project settings and create new project-level objects, for example, versions, components.","manage:jira-webhook":"Manage Jira webhooks. Enables an OAuth app to register and unregister dynamic webhooks in Jira. It also provides for fetching of registered webhooks.","read:board-scope.admin:jira-software":"View configuration, features, filters, project, properties and quick filters related to the given board.","read:board-scope:jira-software":"View board and issues from a board, view issues from a backlog and view reports and versions.","read:build:jira-software":"View builds.","read:deployment:jira-software":"View deployments.","read:epic:jira-software":"View and search for epics, view issues related to an epic and issues without an epic.","read:feature-flag:jira-software":"View feature flags.","read:issue:jira-software":"View issues, issue estimations and field used for estimations.","read:jira-user":"View user information in Jira that you have access to, including usernames, email addresses, and avatars.","read:jira-work":"Read project and issue data. Search for issues and objects associated with issues (such as attachments and worklogs).","read:remote-link:jira-software":"View remote links.","read:source-code:jira-software":"View repositories and check if data exists for the supplied properties.","read:sprint:jira-software":"View sprints and sprint related issues and properties.","write:board-scope.admin:jira-software":"Create board, toggle features and set and delete properties.","write:board-scope:jira-software":"Move issues to a backlog and move issues from a backlog to a board.","write:build:jira-software":"Submit and delete build.","write:deployment:jira-software":"Submit and delete deployment.","write:epic:jira-software":"Remove issues from epic, move issues to epic, rank epics and partially update epics. A partial update means that fields not present in the request JSON will not be updated.","write:feature-flag:jira-software":"Submit and delete feature flag.","write:issue:jira-software":"Move (rank) issues and update estimation of the issue.","write:jira-work":"Create and edit issues in Jira, post comments, create worklogs, and delete issues.","write:remote-link:jira-software":"Submit and delete remote link.","write:source-code:jira-software":"Store and delete development information, delete repository and delete development information entity.","write:sprint:jira-software":"Save, move issues to sprints, and change the order of sprints.","read:dev-info:jira":"Read development information","write:dev-info:jira":"Write development information","delete:dev-info:jira":"Delete development information","read:feature-flag-info:jira":"Read feature flag information","write:feature-flag-info:jira":"Write feature flag information","delete:feature-flag-info:jira":"Delete feature flag information","read:deployment-info:jira":"Read deployment information","write:deployment-info:jira":"Write deployment information","delete:deployment-info:jira":"Delete deployment information","read:build-info:jira":"Read build information","write:build-info:jira":"Write build information","delete:build-info:jira":"Delete build information","read:remote-link-info:jira":"Read remote link information","write:remote-link-info:jira":"Write remote link information","delete:remote-link-info:jira":"Delete remote link information","read:security:jira":"Read security information","write:security:jira":"Write security information","delete:security:jira":"Delete security information"},"tokenUrl":"https://auth.atlassian.com/oauth/token"}},"type":"oauth2"},"basicAuth":{"description":"Basic authentication using email and API token","scheme":"basic","type":"http"}}},"externalDocs":{"description":"Find out more about Atlassian products and services.","url":"http://www.atlassian.com"},"info":{"contact":{"url":"https://getsupport.atlassian.com"},"description":"Jira Software Cloud REST API documentation","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"http://atlassian.com/terms/","title":"Jira agile — PurpleSuite executable core","version":"1001.0.0"},"openapi":"3.0.1","paths":{"/rest/agile/1.0/backlog/issue":{"post":{"deprecated":false,"description":"Move issues to the backlog.  \nThis operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may be moved at once.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"moveIssuesToBacklog","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"issues":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}}},"required":["issues"]}}}},"responses":{"204":{"description":"Empty response is returned if operation was successful."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license or does not have permission to assign issues."},"404":{"description":"Returned if sprint does not exist or the user cannot view it."}},"security":[{"basicAuth":[]}],"summary":"Move issues to backlog","tags":["Backlog"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE","parameters":[],"x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board":{"get":{"deprecated":false,"description":"Returns all boards. This only includes boards that the user has permission to view.\n\n**Deprecation notice:** The required OAuth 2.0 scopes will be updated on February 15, 2024.\n\n *  `read:board-scope:jira-software`, `read:project:jira`\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getAllBoards","parameters":[{"description":"The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"maxResults","schema":{"default":50,"format":"int32","type":"integer"}},{"description":"Filters results to boards of the specified types. Valid values: scrum, kanban, simple.","in":"query","name":"type","schema":{"additionalProperties":false,"type":"object"}},{"description":"Filters results to boards that match or partially match the specified name.","in":"query","name":"name","schema":{"type":"string"}},{"description":"Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.","in":"query","name":"projectKeyOrId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"isLast\":false,\"maxResults\":2,\"startAt\":1,\"total\":5,\"values\":[{\"id\":84,\"name\":\"scrum board\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/84\",\"type\":\"scrum\"},{\"id\":92,\"name\":\"kanban board\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92\",\"type\":\"kanban\"}]}","schema":{"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"}}},"description":"Returns the requested boards, at the specified page of the results."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have valid license."}},"security":[{"basicAuth":[]}],"summary":"Get all boards","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}":{"get":{"deprecated":false,"description":"Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getBoard","parameters":[{"description":"The ID of the requested board.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"id\":84,\"location\":{\"displayName\":\"Example Project\",\"name\":\"Example Project\",\"projectId\":10040,\"projectKey\":\"Example Project Key\",\"projectName\":\"Example Project\",\"projectTypeKey\":\"KEY\",\"userAccountId\":\"5b10a2844c20165700ede21g\",\"userId\":10040},\"name\":\"scrum board\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/84\",\"type\":\"scrum\"}","schema":{"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"}}},"description":"Returns the requested board."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get board","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}/backlog":{"get":{"deprecated":true,"description":"Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getIssuesForBacklog","parameters":[{"description":"The ID of the board that has the backlog containing the requested issues.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"format":"int64","type":"integer"}},{"description":"The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.  \nNote that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.","in":"query","name":"jql","schema":{"type":"string"}},{"description":"The list of fields to return for each issue. By default, all navigable and Agile fields are returned.","in":"query","name":"fields","schema":{"items":{"additionalProperties":false,"type":"object"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"expand\":\"names,schema\",\"issues\":[{\"expand\":\"\",\"fields\":{\"flagged\":true,\"sprint\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/13\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"},\"closedSprints\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"goal\":\"sprint 1 goal\"}],\"description\":\"example bug report\",\"project\":{\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\"},\"id\":\"10000\",\"insight\":{\"lastIssueUpdateTime\":\"2021-04-22T05:37:05.000+0000\",\"totalIssueCount\":100},\"key\":\"EX\",\"name\":\"Example\",\"projectCategory\":{\"description\":\"First Project Category\",\"id\":\"10000\",\"name\":\"FIRST\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\"},\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"created\":\"2021-01-17T12:34:00.000+0000\",\"id\":\"10000\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"Administrators\",\"type\":\"role\",\"value\":\"Administrators\"}}],\"epic\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/epic/23\",\"name\":\"epic 1\",\"summary\":\"epic 1 summary\",\"color\":{\"key\":\"color_4\"},\"done\":true},\"worklog\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"id\":\"100028\",\"issueId\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"type\":\"group\",\"value\":\"jira-developers\"}}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"originalEstimateSeconds\":600,\"remainingEstimate\":\"3m\",\"remainingEstimateSeconds\":200,\"timeSpent\":\"6m\",\"timeSpentSeconds\":400}},\"id\":\"10001\",\"key\":\"HSP-1\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001\"}],\"maxResults\":50,\"startAt\":0,\"total\":1}","schema":{"$ref":"#/components/schemas/SearchResults"}}},"description":"Returns the requested issues, at the specified page of the results."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get issues for backlog","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}/configuration":{"get":{"deprecated":false,"description":"Get the board configuration. The response contains the following fields:\n\n *  `id` \\- ID of the board.\n *  `name` \\- Name of the board.\n *  `filter` \\- Reference to the filter used by the given board.\n *  `location` \\- Reference to the container that the board is located in. Includes the container type (Valid values: project, user).\n *  `subQuery` (Kanban only) - JQL subquery used by the given board.\n *  `columnConfig` \\- The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the \"Done\" column, which means that issues in that column will be marked as already completed.\n *  `estimation` (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is \"field\", the ID and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/3/issue/\\{issueIdOrKey\\} request, however the fields must be on the screen. \"timeoriginalestimate\" field will never be on the screen, so in order to update it \"originalEstimate\" in \"timetracking\" field should be updated.\n *  `ranking` \\- Contains information about custom field used for ranking in the given board.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getConfiguration","parameters":[{"description":"The ID of the board for which configuration is requested.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"columnConfig\":{\"columns\":[{\"name\":\"To Do\",\"statuses\":[{\"id\":\"1\",\"self\":\"https://your-domain.atlassian.net/status/1\"},{\"id\":\"4\",\"self\":\"https://your-domain.atlassian.net/status/4\"}]},{\"max\":4,\"min\":2,\"name\":\"In progress\",\"statuses\":[{\"id\":\"3\",\"self\":\"https://your-domain.atlassian.net/status/3\"}]},{\"name\":\"Done\",\"statuses\":[{\"id\":\"5\",\"self\":\"https://your-domain.atlassian.net/status/5\"}]}],\"constraintType\":\"issueCount\"},\"estimation\":{\"field\":{\"displayName\":\"Story Points\",\"fieldId\":\"customfield_10002\"},\"type\":\"field\"},\"filter\":{\"id\":\"1001\",\"self\":\"https://your-domain.atlassian.net/filter/1001\"},\"id\":10000,\"location\":{\"id\":\"10010\",\"key\":\"PROJ\",\"name\":\"name\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/10010\",\"type\":\"project\"},\"name\":\"Board\",\"ranking\":{\"rankCustomFieldId\":10020},\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/84/config\"}","schema":{"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"}}},"description":"Returns the configuration of the board for given boardId."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if board does not exist or the user cannot view it."}},"security":[{"basicAuth":[]}],"summary":"Get configuration","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}/issue":{"get":{"deprecated":true,"description":"Returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getIssuesForBoard","parameters":[{"description":"The ID of the board that contains the requested issues.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"format":"int64","type":"integer"}},{"description":"The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.  \nNote that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.","in":"query","name":"jql","schema":{"type":"string"}},{"description":"The list of fields to return for each issue. By default, all navigable and Agile fields are returned.","in":"query","name":"fields","schema":{"items":{"additionalProperties":false,"type":"object"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"expand\":\"names,schema\",\"issues\":[{\"expand\":\"\",\"fields\":{\"flagged\":true,\"sprint\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/13\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"},\"closedSprints\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"goal\":\"sprint 1 goal\"}],\"description\":\"example bug report\",\"project\":{\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\"},\"id\":\"10000\",\"insight\":{\"lastIssueUpdateTime\":\"2021-04-22T05:37:05.000+0000\",\"totalIssueCount\":100},\"key\":\"EX\",\"name\":\"Example\",\"projectCategory\":{\"description\":\"First Project Category\",\"id\":\"10000\",\"name\":\"FIRST\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\"},\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"created\":\"2021-01-17T12:34:00.000+0000\",\"id\":\"10000\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"Administrators\",\"type\":\"role\",\"value\":\"Administrators\"}}],\"epic\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/epic/23\",\"name\":\"epic 1\",\"summary\":\"epic 1 summary\",\"color\":{\"key\":\"color_4\"},\"done\":true},\"worklog\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"id\":\"100028\",\"issueId\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"type\":\"group\",\"value\":\"jira-developers\"}}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"originalEstimateSeconds\":600,\"remainingEstimate\":\"3m\",\"remainingEstimateSeconds\":200,\"timeSpent\":\"6m\",\"timeSpentSeconds\":400}},\"id\":\"10001\",\"key\":\"HSP-1\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001\"}],\"maxResults\":50,\"startAt\":0,\"total\":1}","schema":{"$ref":"#/components/schemas/SearchResults"}}},"description":"Returns the requested issues, at the specified page of the results."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get issues for board","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}/sprint":{"get":{"deprecated":false,"description":"Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getAllSprints","parameters":[{"description":"The ID of the board that contains the requested sprints.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The starting index of the returned sprints. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"format":"int64","type":"integer"}},{"description":"The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed","in":"query","name":"state","schema":{"additionalProperties":false,"type":"object"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"isLast\":false,\"maxResults\":2,\"startAt\":1,\"total\":5,\"values\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"originBoardId\":5,\"goal\":\"sprint 1 goal\"},{\"id\":72,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/73\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"}]}"}},"description":"Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get all sprints","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue":{"get":{"deprecated":true,"description":"Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getBoardIssuesForSprint","parameters":[{"description":"The ID of the board that contains requested issues.","in":"path","name":"boardId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The ID of the sprint that contains requested issues.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"format":"int64","type":"integer"}},{"description":"The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.  \nNote that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.","in":"query","name":"jql","schema":{"type":"string"}},{"description":"The list of fields to return for each issue. By default, all navigable and Agile fields are returned.","in":"query","name":"fields","schema":{"items":{"additionalProperties":false,"type":"object"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"expand\":\"names,schema\",\"issues\":[{\"expand\":\"\",\"fields\":{\"flagged\":true,\"sprint\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/13\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"},\"closedSprints\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"goal\":\"sprint 1 goal\"}],\"description\":\"example bug report\",\"project\":{\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\"},\"id\":\"10000\",\"insight\":{\"lastIssueUpdateTime\":\"2021-04-22T05:37:05.000+0000\",\"totalIssueCount\":100},\"key\":\"EX\",\"name\":\"Example\",\"projectCategory\":{\"description\":\"First Project Category\",\"id\":\"10000\",\"name\":\"FIRST\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\"},\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"created\":\"2021-01-17T12:34:00.000+0000\",\"id\":\"10000\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"Administrators\",\"type\":\"role\",\"value\":\"Administrators\"}}],\"epic\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/epic/23\",\"name\":\"epic 1\",\"summary\":\"epic 1 summary\",\"color\":{\"key\":\"color_4\"},\"done\":true},\"worklog\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"id\":\"100028\",\"issueId\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"type\":\"group\",\"value\":\"jira-developers\"}}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"originalEstimateSeconds\":600,\"remainingEstimate\":\"3m\",\"remainingEstimateSeconds\":200,\"timeSpent\":\"6m\",\"timeSpentSeconds\":400}},\"id\":\"10001\",\"key\":\"HSP-1\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001\"}],\"maxResults\":50,\"startAt\":0,\"total\":1}"}},"description":"Returns the requested issues, at the specified page of the results."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get board issues for sprint","tags":["Board"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/issue/{issueIdOrKey}":{"get":{"deprecated":false,"description":"Returns a single issue, for a given issue ID or issue key. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getIssue","parameters":[{"description":"The ID or key of the requested issue.","in":"path","name":"issueIdOrKey","required":true,"schema":{"type":"string"}},{"description":"The list of fields to return for each issue. By default, all navigable and Agile fields are returned.","in":"query","name":"fields","schema":{"items":{"additionalProperties":false,"type":"object"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"expand\":\"\",\"fields\":{\"flagged\":true,\"sprint\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/13\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"},\"closedSprints\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"goal\":\"sprint 1 goal\"}],\"description\":\"example bug report\",\"project\":{\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\"},\"id\":\"10000\",\"insight\":{\"lastIssueUpdateTime\":\"2021-04-22T05:37:05.000+0000\",\"totalIssueCount\":100},\"key\":\"EX\",\"name\":\"Example\",\"projectCategory\":{\"description\":\"First Project Category\",\"id\":\"10000\",\"name\":\"FIRST\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\"},\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"created\":\"2021-01-17T12:34:00.000+0000\",\"id\":\"10000\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"Administrators\",\"type\":\"role\",\"value\":\"Administrators\"}}],\"epic\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/epic/23\",\"name\":\"epic 1\",\"summary\":\"epic 1 summary\",\"color\":{\"key\":\"color_4\"},\"done\":true},\"worklog\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"id\":\"100028\",\"issueId\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"type\":\"group\",\"value\":\"jira-developers\"}}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"originalEstimateSeconds\":600,\"remainingEstimate\":\"3m\",\"remainingEstimateSeconds\":200,\"timeSpent\":\"6m\",\"timeSpentSeconds\":400}},\"id\":\"10001\",\"key\":\"HSP-1\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001\"}"}},"description":"Returns the requested issue."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned in these cases:\n\n *  the issue does not exist\n *  the user does not have permission to view issue"}},"security":[{"basicAuth":[]}],"summary":"Get issue","tags":["Issue"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/sprint":{"post":{"deprecated":false,"description":"Creates a future sprint. Sprint name and origin board id are required. Start date, end date, and goal are optional.\n\nNote that the sprint name is trimmed. Also, when starting sprints from the UI, the \"endDate\" set through this call is ignored and instead the last sprint's duration is used to fill the form.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"createSprint","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1},"goal":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"originBoardId":{"type":"integer","minimum":1}},"required":["name","originBoardId"]}}}},"responses":{"201":{"content":{"application/json":{"example":"{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"future\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"originBoardId\":5,\"goal\":\"sprint 1 goal\"}"}},"description":"Created sprint"},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the board does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Create sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE","parameters":[],"x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/sprint/{sprintId}":{"delete":{"deprecated":false,"description":"Deletes a sprint. Once a sprint is deleted, all open issues in the sprint will be moved to the backlog.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"deleteSprint","parameters":[{"description":"The ID of the sprint to delete.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"Returned if the sprint was deleted successfully"},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license or does not have permission to delete sprints."},"404":{"description":"Returned if the sprint does not exist."}},"security":[{"basicAuth":[]}],"summary":"Delete sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"DELETE","x-purplesuite-classification":"modeled-core"},"get":{"deprecated":false,"description":"Returns the sprint for a given sprint ID. The sprint will only be returned if the user can view the board that the sprint was created on, or view at least one of the issues in the sprint.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getSprint","parameters":[{"description":"The ID of the requested sprint.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"originBoardId\":5,\"goal\":\"sprint 1 goal\"}"}},"description":"Returns the requested sprint."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the sprint does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Get sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"},"post":{"deprecated":false,"description":"Performs a partial update of a sprint. A partial update means that fields not present in the request JSON will not be updated.\n\nNotes:\n\n *  For closed sprints, only the name and goal can be updated; changes to other fields will be ignored.\n *  A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.\n *  A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.\n *  Other changes to state are not allowed.\n *  The completeDate field cannot be updated manually.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"partiallyUpdateSprint","parameters":[{"description":"The ID of the sprint to update.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1},"goal":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"state":{"type":"string","enum":["future","active","closed"]}}}}}},"responses":{"200":{"content":{"application/json":{"example":"{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"originBoardId\":5,\"goal\":\"sprint 1 goal\"}"}},"description":"Updated sprint"},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the sprint does not exist."}},"security":[{"basicAuth":[]}],"summary":"Partially update sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE","x-purplesuite-classification":"modeled-core"},"put":{"deprecated":false,"description":"Performs a full update of a sprint. A full update means that the result will be exactly the same as the request body. Any fields not present in the request JSON will be set to null.\n\nNotes:\n\n *  For closed sprints, only the name and goal can be updated; changes to other fields will be ignored.\n *  A sprint can be started by updating the state to 'active'. This requires the sprint to be in the 'future' state and have a startDate and endDate set.\n *  A sprint can be completed by updating the state to 'closed'. This action requires the sprint to be in the 'active' state. This sets the completeDate to the time of the request.\n *  Other changes to state are not allowed.\n *  The completeDate field cannot be updated manually.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"updateSprint","parameters":[{"description":"the ID of the sprint to update.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1},"goal":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"state":{"type":"string","enum":["future","active","closed"]}},"required":["name","state"]}}}},"responses":{"200":{"content":{"application/json":{"example":"{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"originBoardId\":5,\"goal\":\"sprint 1 goal\"}"}},"description":"Updated sprint"},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if the sprint does not exist."}},"security":[{"basicAuth":[]}],"summary":"Update sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE","x-purplesuite-classification":"modeled-core"}},"/rest/agile/1.0/sprint/{sprintId}/issue":{"get":{"deprecated":true,"description":"Returns all issues in a sprint, for a given sprint ID. This only includes issues that the user has permission to view. By default, the returned issues are ordered by rank.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"getIssuesForSprint","parameters":[{"description":"The ID of the sprint that contains the requested issues.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.","in":"query","name":"startAt","schema":{"format":"int64","type":"integer"}},{"description":"The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.  \nNote that `username` and `userkey` can't be used as search terms for this parameter due to privacy reasons. Use `accountId` instead.","in":"query","name":"jql","schema":{"type":"string"}},{"description":"The list of fields to return for each issue. By default, all navigable and Agile fields are returned.","in":"query","name":"fields","schema":{"items":{"additionalProperties":false,"type":"object"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"example":"{\"expand\":\"\",\"fields\":{\"flagged\":true,\"sprint\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/13\",\"state\":\"future\",\"name\":\"sprint 2\",\"goal\":\"sprint 2 goal\"},\"closedSprints\":[{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/sprint/23\",\"state\":\"closed\",\"name\":\"sprint 1\",\"startDate\":\"2015-04-11T15:22:00.000+10:00\",\"endDate\":\"2015-04-20T01:22:00.000+10:00\",\"completeDate\":\"2015-04-20T11:04:00.000+10:00\",\"goal\":\"sprint 1 goal\"}],\"description\":\"example bug report\",\"project\":{\"avatarUrls\":{\"16x16\":\"https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000\",\"24x24\":\"https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000\",\"32x32\":\"https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000\",\"48x48\":\"https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000\"},\"id\":\"10000\",\"insight\":{\"lastIssueUpdateTime\":\"2021-04-22T05:37:05.000+0000\",\"totalIssueCount\":100},\"key\":\"EX\",\"name\":\"Example\",\"projectCategory\":{\"description\":\"First Project Category\",\"id\":\"10000\",\"name\":\"FIRST\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/projectCategory/10000\"},\"self\":\"https://your-domain.atlassian.net/rest/api/3/project/EX\",\"simplified\":false,\"style\":\"classic\"},\"comment\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"body\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.\"}]}]},\"created\":\"2021-01-17T12:34:00.000+0000\",\"id\":\"10000\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000\",\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"Administrators\",\"type\":\"role\",\"value\":\"Administrators\"}}],\"epic\":{\"id\":37,\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/epic/23\",\"name\":\"epic 1\",\"summary\":\"epic 1 summary\",\"color\":{\"key\":\"color_4\"},\"done\":true},\"worklog\":[{\"author\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"comment\":{\"type\":\"doc\",\"version\":1,\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"I did some work here.\"}]}]},\"id\":\"100028\",\"issueId\":\"10002\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000\",\"started\":\"2021-01-17T12:34:00.000+0000\",\"timeSpent\":\"3h 20m\",\"timeSpentSeconds\":12000,\"updateAuthor\":{\"accountId\":\"5b10a2844c20165700ede21g\",\"active\":false,\"displayName\":\"Mia Krystof\",\"self\":\"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g\"},\"updated\":\"2021-01-18T23:45:00.000+0000\",\"visibility\":{\"identifier\":\"276f955c-63d7-42c8-9520-92d01dca0625\",\"type\":\"group\",\"value\":\"jira-developers\"}}],\"updated\":1,\"timetracking\":{\"originalEstimate\":\"10m\",\"originalEstimateSeconds\":600,\"remainingEstimate\":\"3m\",\"remainingEstimateSeconds\":200,\"timeSpent\":\"6m\",\"timeSpentSeconds\":400}},\"id\":\"10001\",\"key\":\"HSP-1\",\"self\":\"https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001\"}"}},"description":"Returns the requested issues, at the specified page of the results."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license."},"404":{"description":"Returned if sprint does not exist or the user cannot view it."}},"security":[{"basicAuth":[]}],"summary":"Get issues for sprint","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":false}],"x-atlassian-connect-scope":"READ","x-purplesuite-classification":"modeled-core"},"post":{"deprecated":false,"description":"Moves issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. The maximum number of issues that can be moved in one operation is 50.\n\nPurpleSuite executable core: only the published request fields/query parameters are implemented. JQL supports AND, equality/IN/EMPTY and single-field ordering; other syntax is rejected. Tenant-specific workflows, permissions, fields, admin configuration and outbound delivery are not replicated.","operationId":"moveIssuesToSprintAndRank","parameters":[{"description":"The ID of the sprint that you want to assign issues to.","in":"path","name":"sprintId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"issues":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string"}}},"required":["issues"]}}}},"responses":{"204":{"description":"Empty response is returned if operation was successful."},"400":{"description":"Returned if the request is invalid."},"401":{"description":"Returned if the user is not logged in."},"403":{"description":"Returned if the user does not have a valid license or does not have permission to assign issues."},"404":{"description":"Returned if the sprint does not exist or the user does not have permission to view it."}},"security":[{"basicAuth":[]}],"summary":"Move issues to sprint and rank","tags":["Sprint"],"x-atlassian-data-security-policy":[{"app-access-rule-exempt":true}],"x-atlassian-connect-scope":"WRITE","x-purplesuite-classification":"modeled-core"}}},"servers":[{"url":"/api/purple-suite/{instanceId}/contracts/pm/jira","variables":{"instanceId":{"default":"instance-id"}}}],"tags":[{"description":"Apis related to the backlog","name":"Backlog"},{"description":"Apis related to boards","name":"Board"},{"description":"Apis related to epics","name":"Epic"},{"description":"Apis related to issues","name":"Issue"},{"description":"Apis related to sprints","name":"Sprint"},{"name":"Development Information","description":"APIs related to integrating development information (commits, branches and pull requests) with Jira.\n\nThese APIs are available to Atlassian Connect apps and on-premise integrations using OAuth. Connect apps using these APIs must have the `jiraDevelopmentTool` module in the Connect app descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/development-tool/. For more details on integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials, see https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.\n\nThese APIs are available to Forge apps with the `devops:developmentInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-development-info/."},{"name":"Feature Flags","description":"APIs related to integrating feature flags with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraFeatureFlagInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/feature-flag/.\n\nThese APIs are available to Forge apps with the `devops:featureFlagInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-feature-flag-info/."},{"name":"Deployments","description":"APIs related to integrating deployment data with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraDeploymentInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/deployment/. They are also related to integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.\n\nThese APIs are available to Forge apps with the `devops:deploymentInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-deployment-info/."},{"name":"Builds","description":"APIs related to integrating build data with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraBuildInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/build/. They are also related to integrating Jira Software Cloud with on-premises tools using OAuth 2.0 credentials. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.\n\nThese APIs are available to Forge apps with the `devops:buildInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-build-info/."},{"name":"Remote Links","description":"APIs related to integrating remote link data with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraRemoteLinkInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/remote-link/.\n\nThese APIs are available to Forge apps with the `devops:remoteLinkInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-remote-link-info/."},{"name":"Security Information","description":"Send security information to Jira Software and enable your teams to turn unplanned vulnerabilities into planned and tracked work.\n\nSecurity is everyone's responsibility, and the security feature in Jira lets you triage and track relevant vulnerabilities as a team. Discuss and prioritise issues, minimise errors and duplication, and plan security work to complete in your sprints.\n\nAPIs related to integrating Security information with Jira Software are available to Atlassian Connect apps. To use these APIs you must have a security info provider module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/security-information/.\n\nThese APIs are available to Forge apps with the `devops:securityInfoProvider` module in the Forge app's manifest. See https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-software-security-info/."},{"name":"Operations","description":"APIs related to integrating Incident and Post-Incident Review (PIR) data with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraOperationsInfoProvider` module in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/operations-information/."},{"name":"DevOps Components","description":"APIs related to integrating Dev Ops Components affected by Incident data with Jira Software.\n\nThese APIs are available to Atlassian Connect apps. To use these APIs you must have the `jiraDevOpsComponentProvider` in your Connect app's descriptor. See https://developer.atlassian.com/cloud/jira/software/modules/devops-components/."}],"x-atlassian-narrative":{"documents":[{"anchor":"introduction","body":"Welcome to the Jira Software Cloud REST API reference. You can use this REST API to build add-ons for Jira Software,\ndevelop integrations between Jira Software and other applications, or script interactions with Jira Software. This page\ndocuments the REST resources available in Jira Software Cloud, along with expected HTTP response codes and sample\nrequests.\n\nJira Software is built on the Jira platform. As such, there is an overlap in functionality\nbetween what is provided by Jira Software and what is provided by the Jira platform. The REST API reference for the\nJira Cloud platform is here: [Jira Cloud platform REST API](https://developer.atlassian.com/cloud/jira/platform/rest).\n\n## Authentication\n\n### Authentication for Atlassian Connect add-ons\n\nIf you are integrating with the Jira REST APIs via an Atlassian Connect add-on, API calls are authenticated via JWT\n(JSON Web Tokens). This is built into the supported Atlassian Connect libraries. At a high level, authentication works\nby the add-on exchanging a security context with the application. This context is used to create and validate JWT\ntokens, embedded in API calls. To learn more, read the [Atlassian Connect authentication documentation](https://developer.atlassian.com/cloud/jira/platform/authentication-for-apps/).\n\nSome integration APIs such as [Feature Flags](#api-group-Feature-Flags) are only available to Atlassian Connect apps that\ndefine the relevant [module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) related to that API.\nOther APIs, such as the [Development Information](#api-group-Development-Information), [Builds](#api-group-Builds), and [Deployments](#api-group-Deployments) APIs\nare available to both Atlassian Connect apps and on-premises tools using Jira Software's\n[OAuth credentials](https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/) for system-to-system integration.\n\n### Authentication for REST API requests\n\nIf you are integrating directly with the REST APIs, rather than via an Atlassian Connect add-on, use one of the\nauthentication methods listed below:\n* [OAuth 2.0](https://developer.atlassian.com/cloud/jira/software/scopes-for-oauth-2-3LO-and-forge-apps/) -\n  This token-based method is the recommended method. It is more flexible and secure than other options.\n * [OAuth 1.0a](https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-oauth-authentication) -\n This is a legacy authentication method and, therefore, isn't recommended. Instead use OAuth 2.0.\n * [Basic HTTP](https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-basic-authentication/) -\n This method is only recommended for tools like scripts or bots. It is easier to implement, but much less secure.\n\nNote, Jira itself uses cookie-based authentication in the browser, so you can call REST from Javascript on the page and\nrely on the authentication that the browser has established. To reproduce the behavior of the Jira log-in page (for\nexample, to display authentication error messages to users) can `POST` to the `/auth/1/session` [resource](https://docs.atlassian.com/jira/REST/cloud/#auth/1/session).\n\n### Authentication for on-premises integrations\n\nIf you are integrating an on-premises app with the Jira REST APIs, API calls are authenticated via an OAuth token.\nTo obtain a token, create a set of OAuth credentials with permissions for the APIs that app needs to access.\nUse the credentials to request a token by calling `https://api.atlassian.com/oauth/token`.\nSee [Integrating Jira Software Cloud with on-premises tools](https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/) for details.\nNote that only the [Development Information](#api-group-Development-Information), [Builds](#api-group-Builds), and [Deployments](#api-group-Deployments) APIs are currently available for on-premises integrations.\nTo simplify development, we have a separate [downloadable API spec](https://developer.atlassian.com/cloud/jira/software/on-premise-swagger.json).\n\nAtlassian has developed an [open source plugin for Jenkins](https://github.com/jenkinsci/atlassian-jira-software-cloud-plugin), which you can use to bootstrap development.\nThis plugin uses the authentication method described above and calls the Builds and Deployments APIs.\n\n\n#### Base URL differences\n\nWhen building an on-premises integration, the base URL for API operations is different to the base URL used for Connect apps. This is because requests from on-premises integrations (OAuth) need to be sent via the Atlassian API proxy at `https://api.atlassian.com`.\n\nThis document does not display the base URLs used by on-premises integrations. Therefore, when using an operation, you must replace `https://your-domain.atlassian.net/rest/{type}/{version}/{operation}`\nwith `https://api.atlassian.com/jira/{type}/{version}/cloud/{cloudId}/{operation}`.\n\nFor example:\n* Builds API: Change the path from `https://your-domain.atlassian.net/rest/builds/0.1/bulk` to `https://api.atlassian.com/jira/builds/0.1/cloud/{cloudId}/bulk`.\n* Development Information: Change the path from `https://your-domain.atlassian.net/rest/devinfo/0.10/bulk` to `https://api.atlassian.com/jira/devinfo/0.1/cloud/{cloudId}/bulk`. Note the version change.\n* Deployments: Change the path from `https://your-domain.atlassian.net/rest/deployments/0.1/bulk` to `https://api.atlassian.com/jira/deployments/0.1/cloud/{cloudId}/bulk`.\n\nNote, get the `cloudId` for a Jira instance by calling `https://your-domain.atlassian.net/_edge/tenant_info`.\n\n\n## URI structure\n\nJira Agile's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application\nwill make an HTTP request and parse the response. The Jira Agile REST API uses [JSON](http://en.wikipedia.org/wiki/JSON)\nas its communication format, and the standard HTTP methods like `GET`, `PUT`, `POST` and `DELETE` (see API descriptions\nbelow for which methods are available for each resource). URIs for Jira Agile's REST API resource have the following\nstructure:\n\n    http://host:port/context/rest/api-name/api-version/resource-name\n\nCurrently there are two API names available, which will be discussed further below:\n\n * `auth` - for authentication-related operations, and\n * `api` - for everything else.\n\nThe current API version is `1`. However, there is also a symbolic version, called `latest`, which resolves to the\nlatest version supported by the given Jira Software Cloud instance. For example, if you wanted to retrieve the JSON\nrepresentation of a board with `boardId=123`, from a Jira Software Cloud instance at `https://jira.atlassian.net`, you\nwould access:\n\n    https://jira.atlassian.net/rest/agile/latest/board/123\n\n## Pagination\n\nPagination is used for the Jira REST APIs to conserve server resources and limit response size for resources that\nreturn potentially large collection of items. A request to a pages API will result in a values array wrapped in a JSON\nobject with some paging metadata, like this:\n\n#### Request\n\n    http://host:port/context/rest/api-name/api-version/resource-name?startAt=0&maxResults=10\n\n#### Response\n\n```javascript\n{\n    \"startAt\" : 0,\n    \"maxResults\" : 10,\n    \"total\": 200,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n    ]\n}\n```\n\n * `startAt` - the item used as the first item in the page of results.\n * `maxResults` - how many results to return per page.\n * `total` - the number of items that the calling user has permissions for. This number *may change* while the client requests the next pages. A client should always assume that the requested page can be empty. REST API consumers should also consider the field to be optional. This value may not be included in the response, if it is too expensive to calculate.\n\nClients can use the `startAt`, `maxResults`, and `total` parameters to retrieve the desired number of results. Note,\neach API resource or method may have a different limit on the number of items returned, which means you can ask for\nmore than you are given. The actual number of items returned is an implementation detail and this can be changed over\ntime.\n\n## Experimental methods\n\nMethods marked as experimental may change without an earlier notice. We are looking for your feedback for these methods.\n\n## Query parameters\n\nAll query parameters for the resources described below are optional, unless specified otherwise.\n\n## Special Request and Response headers\n\n -   **X-Atlassian-Token** (request): Operations that accept multipart/form-data must include the `X-Atlassian-Token: no-check` header in requests.\nOtherwise the request will be blocked by XSRF protection.\n-   **X-AACCOUNTID** (response): This response header contains the Atlassian account ID of the authenticated user.\n\n## Jira Software field input formats\n\nJira Software provides a number of custom fields, which are made available in the Jira platform REST API. The custom\nfields are: `Sprint`, `Epic link`, `Epic name`, and `Story points`.\n\nYou can read and edit these custom fields via the [issue resource](https://docs.atlassian.com/jira/REST/cloud/#api/2/issue)\nof the Jira Platform REST API. In order to identify the custom field that you want to read or edit, you'll need the\ncustom field id. To obtain the custom field id, retrieve the list of fields from the [fields resource](https://docs.atlassian.com/jira/REST/latest/#api/2/field-getFields)\nand search for the custom field. It's better to find the field based on the schema where possible (e.g. the Sprint\nfield is identified by \"`com.pyxis.greenhopper.jira:gh-sprint`\"), as custom field names are mutable. The custom field\nid will be in the id, (e.g. `id: customfield_10007`).\n\nIf you only need to get the value of the custom field for a single issue, you may want to use the [issue resource](https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/issue-getIssue)\nprovided by the Jira Software REST API instead. This resource returns the issue with all Jira Software-specific fields,\nincluding the fields listed above. These fields will also be formatted as proper fields with keys, in the response.\n\nNote, Jira Software also has a number of internal custom fields, which are: `Epic Color`, `Epic Status`, `Flag`, `Rank`.\nThese internal fields shouldn't be read or updated using the REST API and are not documented below.\n\n##### Sprint custom field\n\nThe Sprint custom field contains a list of sprints for a given issue. This list includes the active/future sprint that\nthe issue is currently in, as well as any closed sprints that the issue was in previously.\n\nFor legacy reasons, the [Get issue (Jira platform) method](https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-getIssue)\nreturns the Sprint custom field with sprints in a `toString` format, which is difficult to parse. See the example below.\n\n_**Deprecation notice:** The `toString` representation of sprints in the Sprint custom field that is returned by Get\nissue (Jira platform) will soon be removed. See the [notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-tostring-representation-of-sprints-in-get-issue-response/)._\n\n###### Example - Get issue (Jira platform) response\n\n```javascript\ncustomfield_11458\": [\n    \"com.atlassian.greenhopper.service.sprint.Sprint@1bf75fd[id=1,rapidViewId=1,state=CLOSED,name=Sprint 1,goal=Sprint 1 goal,startDate=2016-06-06T21:30:53.537+10:00,endDate=2016-06-20T21:30:00.000+10:00,completeDate=2016-06-06T21:30:57.523+10:00,sequence=1]\",\n    \"com.atlassian.greenhopper.service.sprint.Sprint@1689feb[id=2,rapidViewId=1,state=FUTURE,name=Sprint 2,goal=Sprint 2 goal,startDate=<null>,endDate=<null>,completeDate=<null>,sequence=2]\"\n]\n```\n\nIf you want to parse the sprint information, use either the [Get issue (Jira Software) method](https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/issue-getIssue)\nor [Get issue (Jira platform) method](https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-getIssue) with expanded\n`versionedRepresentations` instead, both of which return sprints in a proper format. See the example below.\n\n###### Example - Get issue (Jira platform) response with expanded versionedRepresentations\n\n```javascript\n\"customfield_10021\": {\n    \"1\": [\n        \"com.atlassian.greenhopper.service.sprint.Sprint@1bf75fd[id=1,rapidViewId=1,state=CLOSED,name=Sprint 1,goal=Sprint 1 goal,startDate=2016-06-06T21:30:53.537+10:00,endDate=2016-06-20T21:30:00.000+10:00,completeDate=2016-06-06T21:30:57.523+10:00,sequence=1]\",\n        \"com.atlassian.greenhopper.service.sprint.Sprint@1689feb[id=2,rapidViewId=1,state=FUTURE,name=Sprint 2,goal=Sprint 2 goal,startDate=<null>,endDate=<null>,completeDate=<null>,sequence=2]\"\n    ],\n    \"2\": [\n        {\n            \"id\": 1,\n            \"name\": \"Sprint 1\",\n            \"state\": \"closed\",\n            \"boardId\": 1\n        },\n        {\n            \"id\": 2,\n            \"name\": \"Sprint 2\",\n            \"state\": \"future\",\n            \"boardId\": 1\n        }\n    ]\n}\n```\n\nIf you want to update a sprint, you need to know the sprint id, which is a number. See the example below. Note, an\nissue can only be in one active or future sprint at a time, and only the active/future sprint can edited.\n\n###### Example - Update issue request\n\n```javascript\n\"customfield_10021\": 2\n```\n\n##### Epic link custom field\n\nThe Epic link custom field contains the key of an epic that a given issue belongs to. Be aware that only the issue key\nof the existing epic can be set. Also, the Epic link cannot be set for sub-tasks and epics.\n\n###### Example\n\n```javascript\n\"customfield_11458\": \"EPIC-1\"\n```\n\n##### Epic Name\n\nThe Epic name custom field contains the name of an epic that a given issue belongs to. Be aware that only the issue key\nof the existing epic can be set. Also, the epic link cannot be set for sub-tasks and epics.\n\n###### Example\n\n```javascript\n\"customfield_11410\": \"Epic Name\"\n```\n\n##### Estimation\n\nJira Software provides a `Story Points` custom field, however the field is just a regular numeric field. The type of\nestimation and field used for estimation is determined by the board configuration. You can get this from the\n[board configuration resource](https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/board-getConfiguration).\nNote that if the estimation field is not on a screen, it cannot be edited, and you should use the\n[Estimate issue for board method](https://docs.atlassian.com/jira-software/REST/cloud/#agile/1.0/issue-estimateIssueForBoard) instead.\n","title":"Introduction"}]},"security":[{"basicAuth":[]}]}