Issue tracking and project management tool
developer.atlassian.com/cloud/jira/platform/rest/v3 ↗Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://your-domain.atlassian.net
No endpoints found for this provider.
ActorInputBean
{
"type": "object",
"properties": {
"user": {
"type": "array",
"items": {
"type": "string"
},
"description": "The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example, `\"user\":[\"5b10a2844c20165700ede21g\", \"5b109f2e9729b51b54dc274d\"]`."
},
"group": {
"type": "array",
"items": {
"type": "string"
},
"description": "The name of the group to add as a default actor. This parameter cannot be used with the `groupId` parameter. As a group's name can change,use of `groupId` is recommended. This parameter accepts a comma-separated list. For example, `\"group\":[\"project-admin\", \"jira-developers\"]`."
},
"groupId": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the group to add as a default actor. This parameter cannot be used with the `group` parameter This parameter accepts a comma-separated list. For example, `\"groupId\":[\"77f6ab39-e755-4570-a6ae-2d7a8df0bcb8\", \"0c011f85-69ed-49c4-a801-3b18d0f771bc\"]`."
}
}
}
ActorsMap
{
"type": "object",
"properties": {
"user": {
"type": "array",
"items": {
"type": "string"
},
"description": "The user account ID of the user to add."
},
"group": {
"type": "array",
"items": {
"type": "string"
},
"description": "The name of the group to add. This parameter cannot be used with the `groupId` parameter. As a group's name can change, use of `groupId` is recommended."
},
"groupId": {
"type": "array",
"items": {
"type": "string"
},
"description": "The ID of the group to add. This parameter cannot be used with the `group` parameter."
}
}
}
AddFieldBean
{
"type": "object",
"required": [
"fieldId"
],
"properties": {
"fieldId": {
"type": "string",
"description": "The ID of the field to add."
}
}
}
AddGroupBean
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the group."
}
},
"additionalProperties": true
}
AddNotificationsDetails
{
"type": "object",
"required": [
"notificationSchemeEvents"
],
"properties": {
"notificationSchemeEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSchemeEventDetails"
},
"writeOnly": true,
"description": "The list of notifications which should be added to the notification scheme."
}
},
"description": "Details of notifications which should be added to the notification scheme.",
"additionalProperties": true
}
AddSecuritySchemeLevelsRequestBean
{
"type": "object",
"properties": {
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecuritySchemeLevelBean"
},
"writeOnly": true,
"description": "The list of scheme levels which should be added to the security scheme."
}
}
}
AnnouncementBannerConfiguration
{
"type": "object",
"properties": {
"hashId": {
"type": "string",
"readOnly": true,
"description": "Hash of the banner data. The client detects updates by comparing hash IDs."
},
"message": {
"type": "string",
"readOnly": true,
"description": "The text on the announcement banner."
},
"isEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Flag indicating if the announcement banner is enabled or not."
},
"visibility": {
"enum": [
"PUBLIC",
"PRIVATE"
],
"type": "string",
"readOnly": true,
"description": "Visibility of the announcement banner."
},
"isDismissible": {
"type": "boolean",
"readOnly": true,
"description": "Flag indicating if the announcement banner can be dismissed by the user."
}
},
"description": "Announcement banner configuration."
}
AnnouncementBannerConfigurationUpdate
{
"type": "object",
"writeOnly": true,
"properties": {
"message": {
"type": "string",
"description": "The text on the announcement banner."
},
"isEnabled": {
"type": "boolean",
"description": "Flag indicating if the announcement banner is enabled or not."
},
"visibility": {
"type": "string",
"description": "Visibility of the announcement banner. Can be public or private."
},
"isDismissible": {
"type": "boolean",
"description": "Flag indicating if the announcement banner can be dismissed by the user."
}
},
"description": "Configuration of the announcement banner."
}
AppWorkflowTransitionRule
{
"type": "object",
"required": [
"configuration",
"id",
"key"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the transition rule."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the rule, as defined in the Connect or the Forge app descriptor."
},
"transition": {
"$ref": "#/components/schemas/WorkflowTransition"
},
"configuration": {
"$ref": "#/components/schemas/RuleConfiguration"
}
},
"description": "A workflow transition rule.",
"x-konfig-properties": {
"transition": {
"readOnly": true
}
}
}
Application
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\". Grouping and sorting of links may place links without an application name last."
},
"type": {
"type": "string",
"description": "The name-spaced type of the application, used by registered rendering apps."
}
},
"description": "The application the linked item is in.",
"additionalProperties": true
}
ApplicationProperty
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application property. The ID and key are the same."
},
"key": {
"type": "string",
"description": "The key of the application property. The ID and key are the same."
},
"desc": {
"type": "string",
"description": "The description of the application property."
},
"name": {
"type": "string",
"description": "The name of the application property."
},
"type": {
"type": "string",
"description": "The data type of the application property."
},
"value": {
"type": "string",
"description": "The new value."
},
"example": {
"type": "string"
},
"defaultValue": {
"type": "string",
"description": "The default value of the application property."
},
"allowedValues": {
"type": "array",
"items": {
"type": "string"
},
"description": "The allowed values, if applicable."
}
},
"description": "Details of an application property."
}
ApplicationRole
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the application role."
},
"name": {
"type": "string",
"description": "The display name of the application role."
},
"groups": {
"type": "array",
"items": {
"type": "string"
},
"description": "The groups associated with the application role. As a group's name can change, use of `groupDetails` is recommended to identify a groups.",
"uniqueItems": true
},
"defined": {
"type": "boolean",
"description": "Deprecated."
},
"platform": {
"type": "boolean",
"description": "Indicates if the application role belongs to Jira platform (`jira-core`)."
},
"userCount": {
"type": "integer",
"format": "int32",
"description": "The number of users counting against your license."
},
"groupDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupName"
},
"description": "The groups associated with the application role."
},
"defaultGroups": {
"type": "array",
"items": {
"type": "string"
},
"description": "The groups that are granted default access for this application role. As a group's name can change, use of `defaultGroupsDetails` is recommended to identify a groups.",
"uniqueItems": true
},
"numberOfSeats": {
"type": "integer",
"format": "int32",
"description": "The maximum count of users on your license."
},
"remainingSeats": {
"type": "integer",
"format": "int32",
"description": "The count of users remaining on your license."
},
"hasUnlimitedSeats": {
"type": "boolean"
},
"selectedByDefault": {
"type": "boolean",
"description": "Determines whether this application role should be selected by default on user creation."
},
"defaultGroupsDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupName"
},
"description": "The groups that are granted default access for this application role."
},
"userCountDescription": {
"type": "string",
"description": "The [type of users](https://confluence.atlassian.com/x/lRW3Ng) being counted against your license."
}
},
"description": "Details of an application role."
}
ArchiveIssueAsyncRequest
{
"type": "object",
"properties": {
"jql": {
"type": "string"
}
}
}
ArchivedIssuesFilterRequest
{
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"type": "string"
},
"description": "List archived issues with a specified project key."
},
"reporters": {
"type": "array",
"items": {
"type": "string"
},
"description": "List archived issues where the reporter is a specified account ID."
},
"archivedBy": {
"type": "array",
"items": {
"type": "string"
},
"description": "List archived issues archived by a specified account ID."
},
"issueTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List archived issues with a specified issue type ID."
},
"archivedDateRange": {
"$ref": "#/components/schemas/DateRangeFilterRequest"
}
},
"description": "Details of a filter for exporting archived issues.",
"additionalProperties": true
}
AssociateFieldConfigurationsWithIssueTypesRequest
{
"type": "object",
"required": [
"mappings"
],
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationToIssueTypeMapping"
},
"writeOnly": true,
"description": "Field configuration to issue type mappings.",
"uniqueItems": true
}
},
"description": "Details of a field configuration to issue type mappings."
}
AssociateSecuritySchemeWithProjectDetails
{
"type": "object",
"required": [
"projectId",
"schemeId"
],
"properties": {
"schemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue security scheme. Providing null will clear the association with the issue security scheme."
},
"projectId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the project."
},
"oldToNewSecurityLevelMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OldToNewSecurityLevelMappingsBean"
},
"writeOnly": true,
"description": "The list of scheme levels which should be remapped to new levels of the issue security scheme."
}
},
"description": "Issue security scheme, project, and remapping details."
}
AssociatedItemBean
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the associated record."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the associated record."
},
"parentId": {
"type": "string",
"readOnly": true,
"description": "The ID of the associated parent record."
},
"typeName": {
"type": "string",
"readOnly": true,
"description": "The type of the associated record."
},
"parentName": {
"type": "string",
"readOnly": true,
"description": "The name of the associated parent record."
}
},
"description": "Details of an item associated with the changed record."
}
Attachment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the attachment."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the attachment details response."
},
"size": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The size of the attachment."
},
"author": {
"$ref": "#/components/schemas/UserDetails"
},
"content": {
"type": "string",
"readOnly": true,
"description": "The content of the attachment."
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The datetime the attachment was created."
},
"filename": {
"type": "string",
"readOnly": true,
"description": "The file name of the attachment."
},
"mimeType": {
"type": "string",
"readOnly": true,
"description": "The MIME type of the attachment."
},
"thumbnail": {
"type": "string",
"readOnly": true,
"description": "The URL of a thumbnail representing the attachment."
}
},
"description": "Details about an attachment.",
"x-konfig-properties": {
"author": {
"readOnly": true,
"description": "Details of the user who added the attachment."
}
},
"additionalProperties": true
}
AttachmentArchive
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentArchiveEntry"
}
},
"moreAvailable": {
"type": "boolean"
},
"totalEntryCount": {
"type": "integer",
"format": "int32"
},
"totalNumberOfEntriesAvailable": {
"type": "integer",
"format": "int32"
}
}
}
AttachmentArchiveEntry
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"mediaType": {
"type": "string"
},
"entryIndex": {
"type": "integer",
"format": "int64"
},
"abbreviatedName": {
"type": "string"
}
}
}
AttachmentArchiveImpl
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentArchiveEntry"
},
"description": "The list of the items included in the archive."
},
"totalEntryCount": {
"type": "integer",
"format": "int32",
"description": "The number of items in the archive."
}
}
}
AttachmentArchiveItemReadable
{
"type": "object",
"properties": {
"path": {
"type": "string",
"readOnly": true,
"description": "The path of the archive item."
},
"size": {
"type": "string",
"readOnly": true,
"description": "The size of the archive item."
},
"index": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The position of the item within the archive."
},
"label": {
"type": "string",
"readOnly": true,
"description": "The label for the archive item."
},
"mediaType": {
"type": "string",
"readOnly": true,
"description": "The MIME type of the archive item."
}
},
"description": "Metadata for an item in an attachment archive."
}
AttachmentArchiveMetadataReadable
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the attachment."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the archive file."
},
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentArchiveItemReadable"
},
"readOnly": true,
"description": "The list of the items included in the archive."
},
"mediaType": {
"type": "string",
"readOnly": true,
"description": "The MIME type of the attachment."
},
"totalEntryCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items included in the archive."
}
},
"description": "Metadata for an archive (for example a zip) and its contents."
}
AttachmentMetadata
{
"xml": {
"name": "attachment"
},
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the attachment."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the attachment metadata details."
},
"size": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The size of the attachment."
},
"author": {
"$ref": "#/components/schemas/User"
},
"content": {
"type": "string",
"readOnly": true,
"description": "The URL of the attachment."
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The datetime the attachment was created."
},
"filename": {
"type": "string",
"readOnly": true,
"description": "The name of the attachment file."
},
"mimeType": {
"type": "string",
"readOnly": true,
"description": "The MIME type of the attachment."
},
"thumbnail": {
"type": "string",
"readOnly": true,
"description": "The URL of a thumbnail representing the attachment."
},
"properties": {
"type": "object",
"readOnly": true,
"description": "Additional properties of the attachment.",
"additionalProperties": {
"readOnly": true
}
}
},
"description": "Metadata for an issue attachment.",
"x-konfig-properties": {
"author": {
"readOnly": true,
"description": "Details of the user who attached the file."
}
}
}
AttachmentSettings
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to add attachments is enabled."
},
"uploadLimit": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The maximum size of attachments permitted, in bytes."
}
},
"description": "Details of the instance's attachment settings."
}
AuditRecordBean
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the audit record."
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time on which the audit record was created."
},
"summary": {
"type": "string",
"readOnly": true,
"description": "The summary of the audit record."
},
"category": {
"type": "string",
"readOnly": true,
"description": "The category of the audit record. For a list of these categories, see the help article [Auditing in Jira applications](https://confluence.atlassian.com/x/noXKM)."
},
"authorKey": {
"type": "string",
"readOnly": true,
"description": "Deprecated, use `authorAccountId` instead. The key of the user who created the audit record."
},
"objectItem": {
"$ref": "#/components/schemas/AssociatedItemBean"
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the audit record."
},
"eventSource": {
"type": "string",
"readOnly": true,
"description": "The event the audit record originated from."
},
"changedValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangedValueBean"
},
"readOnly": true,
"description": "The list of values changed in the record event."
},
"remoteAddress": {
"type": "string",
"readOnly": true,
"description": "The URL of the computer where the creation of the audit record was initiated."
},
"associatedItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AssociatedItemBean"
},
"readOnly": true,
"description": "The list of items associated with the changed record."
}
},
"description": "An audit record."
}
AuditRecords
{
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The requested or default limit on the number of audit items to be returned."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The total number of audit items returned."
},
"offset": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of audit items skipped before the first item in this list."
},
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditRecordBean"
},
"readOnly": true,
"description": "The list of audit items."
}
},
"description": "Container for a list of audit records."
}
AutoCompleteSuggestion
{
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The value of a suggested item."
},
"displayName": {
"type": "string",
"description": "The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag."
}
},
"description": "A field auto-complete suggestion."
}
AutoCompleteSuggestions
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCompleteSuggestion"
},
"description": "The list of suggested item."
}
},
"description": "The results from a JQL query."
}
AvailableDashboardGadget
{
"type": "object",
"required": [
"title"
],
"properties": {
"uri": {
"type": "string",
"readOnly": true,
"description": "The URI of the gadget type."
},
"title": {
"type": "string",
"readOnly": true,
"description": "The title of the gadget."
},
"moduleKey": {
"type": "string",
"readOnly": true,
"description": "The module key of the gadget type."
}
},
"description": "The details of the available dashboard gadget."
}
AvailableDashboardGadgetsResponse
{
"type": "object",
"required": [
"gadgets"
],
"properties": {
"gadgets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableDashboardGadget"
},
"readOnly": true,
"description": "The list of available gadgets."
}
},
"description": "The list of available gadgets."
}
AvailableWorkflowConnectRule
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The rule name."
},
"editUrl": {
"type": "string",
"description": "The URL edit path segment defined in the Connect module."
},
"ruleKey": {
"type": "string",
"description": "The rule key."
},
"viewUrl": {
"type": "string",
"description": "The URL view path segment defined in the Connect module."
},
"addonKey": {
"type": "string",
"description": "The add-on providing the rule."
},
"ruleType": {
"enum": [
"Condition",
"Validator",
"Function",
"Screen"
],
"type": "string",
"description": "The rule type."
},
"createUrl": {
"type": "string",
"description": "The URL creation path segment defined in the Connect module."
},
"moduleKey": {
"type": "string",
"description": "The module providing the rule."
},
"description": {
"type": "string",
"description": "The rule description."
}
},
"description": "The Connect provided ecosystem rules available."
}
AvailableWorkflowForgeRule
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique ARI of the forge rule type."
},
"name": {
"type": "string",
"description": "The rule name."
},
"ruleKey": {
"type": "string",
"description": "The rule key."
},
"ruleType": {
"enum": [
"Condition",
"Validator",
"Function",
"Screen"
],
"type": "string",
"description": "The rule type."
},
"description": {
"type": "string",
"description": "The rule description."
}
},
"description": "The Forge provided ecosystem rules available."
}
AvailableWorkflowSystemRule
{
"type": "object",
"required": [
"description",
"incompatibleRuleKeys",
"isAvailableForInitialTransition",
"isVisible",
"name",
"ruleKey",
"ruleType"
],
"properties": {
"name": {
"type": "string",
"description": "The rule name."
},
"ruleKey": {
"type": "string",
"description": "The rule key."
},
"ruleType": {
"enum": [
"Condition",
"Validator",
"Function",
"Screen"
],
"type": "string",
"description": "The rule type."
},
"isVisible": {
"type": "boolean",
"description": "Whether the rule is visible."
},
"description": {
"type": "string",
"description": "The rule description."
},
"incompatibleRuleKeys": {
"type": "array",
"items": {
"type": "string",
"description": "List of rules that conflict with this one."
},
"description": "List of rules that conflict with this one."
},
"isAvailableForInitialTransition": {
"type": "boolean",
"description": "Whether the rule can be added added to an initial transition."
}
},
"description": "The Atlassian provided system rules available."
}
AvailableWorkflowTriggerTypes
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the trigger rule."
},
"type": {
"type": "string",
"description": "The type identifier of trigger rule."
},
"description": {
"type": "string",
"description": "The description of the trigger rule."
}
},
"description": "The list of available trigger types."
}
AvailableWorkflowTriggers
{
"type": "object",
"required": [
"availableTypes",
"ruleKey"
],
"properties": {
"ruleKey": {
"type": "string",
"description": "The rule key of the rule."
},
"availableTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableWorkflowTriggerTypes"
},
"description": "The list of available trigger types."
}
},
"description": "The trigger rules available."
}
Avatar
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the avatar."
},
"urls": {
"type": "object",
"readOnly": true,
"description": "The list of avatar icon URLs.",
"additionalProperties": {
"type": "string",
"format": "uri",
"readOnly": true
}
},
"owner": {
"type": "string",
"readOnly": true,
"description": "The owner of the avatar. For a system avatar the owner is null (and nothing is returned). For non-system avatars this is the appropriate identifier, such as the ID for a project or the account ID for a user."
},
"fileName": {
"type": "string",
"readOnly": true,
"description": "The file name of the avatar icon. Returned for system avatars."
},
"isSelected": {
"type": "boolean",
"readOnly": true,
"description": "Whether the avatar is used in Jira. For example, shown as a project's avatar."
},
"isDeletable": {
"type": "boolean",
"readOnly": true,
"description": "Whether the avatar can be deleted."
},
"isSystemAvatar": {
"type": "boolean",
"readOnly": true,
"description": "Whether the avatar is a system avatar."
}
},
"description": "Details of an avatar.",
"additionalProperties": true
}
AvatarUrlsBean
{
"type": "object",
"properties": {
"16x16": {
"type": "string",
"format": "uri",
"description": "The URL of the item's 16x16 pixel avatar."
},
"24x24": {
"type": "string",
"format": "uri",
"description": "The URL of the item's 24x24 pixel avatar."
},
"32x32": {
"type": "string",
"format": "uri",
"description": "The URL of the item's 32x32 pixel avatar."
},
"48x48": {
"type": "string",
"format": "uri",
"description": "The URL of the item's 48x48 pixel avatar."
}
}
}
Avatars
{
"type": "object",
"properties": {
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Avatar"
},
"readOnly": true,
"description": "Custom avatars list."
},
"system": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Avatar"
},
"readOnly": true,
"description": "System avatars list."
}
},
"description": "Details about system and custom avatars."
}
BulkChangeOwnerDetails
{
"type": "object",
"required": [
"autofixName",
"newOwner"
],
"properties": {
"newOwner": {
"type": "string",
"description": "The account id of the new owner."
},
"autofixName": {
"type": "boolean",
"description": "Whether the name is fixed automatically if it's duplicated after changing owner."
}
},
"description": "Details for changing owners of shareable entities"
}
BulkCustomFieldOptionCreateRequest
{
"type": "object",
"writeOnly": true,
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldOptionCreate"
},
"description": "Details of options to create."
}
},
"description": "Details of the options to create for a custom field."
}
BulkCustomFieldOptionUpdateRequest
{
"type": "object",
"writeOnly": true,
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldOptionUpdate"
},
"description": "Details of the options to update."
}
},
"description": "Details of the options to update for a custom field."
}
BulkEditActionError
{
"type": "object",
"required": [
"errorMessages",
"errors"
],
"properties": {
"errors": {
"type": "object",
"description": "The errors.",
"additionalProperties": {
"type": "string"
}
},
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The error messages."
}
},
"description": "Errors of bulk edit action."
}
BulkEditShareableEntityRequest
{
"type": "object",
"required": [
"action",
"entityIds"
],
"properties": {
"action": {
"enum": [
"changeOwner",
"changePermission",
"addPermission",
"removePermission"
],
"type": "string",
"description": "Allowed action for bulk edit shareable entity"
},
"entityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The id list of shareable entities to be changed.",
"uniqueItems": true
},
"permissionDetails": {
"$ref": "#/components/schemas/PermissionDetails"
},
"changeOwnerDetails": {
"$ref": "#/components/schemas/BulkChangeOwnerDetails"
},
"extendAdminPermissions": {
"type": "boolean",
"description": "Whether the actions are executed by users with Administer Jira global permission."
}
},
"description": "Details of a request to bulk edit shareable entity.",
"x-konfig-properties": {
"permissionDetails": {
"description": "The permission details to be changed."
},
"changeOwnerDetails": {
"description": "The details of change owner action."
}
}
}
BulkEditShareableEntityResponse
{
"type": "object",
"required": [
"action"
],
"properties": {
"action": {
"enum": [
"changeOwner",
"changePermission",
"addPermission",
"removePermission"
],
"type": "string",
"description": "Allowed action for bulk edit shareable entity"
},
"entityErrors": {
"type": "object",
"description": "The mapping dashboard id to errors if any.",
"additionalProperties": {
"$ref": "#/components/schemas/BulkEditActionError"
}
}
},
"description": "Details of a request to bulk edit shareable entity."
}
BulkIssueIsWatching
{
"type": "object",
"properties": {
"issuesIsWatching": {
"type": "object",
"readOnly": true,
"description": "The map of issue ID to boolean watch status.",
"additionalProperties": {
"type": "boolean",
"readOnly": true
}
}
},
"description": "A container for the watch status of a list of issues."
}
BulkIssuePropertyUpdateRequest
{
"type": "object",
"properties": {
"value": {
"description": "The value of the property. The value must be a [valid](https://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters."
},
"filter": {
"$ref": "#/components/schemas/IssueFilterForBulkPropertySet"
},
"expression": {
"type": "string",
"description": "EXPERIMENTAL. The Jira expression to calculate the value of the property. The value of the expression must be an object that can be converted to JSON, such as a number, boolean, string, list, or map. The context variables available to the expression are `issue` and `user`. Issues for which the expression returns a value whose JSON representation is longer than 32768 characters are ignored."
}
},
"description": "Bulk issue property update request details.",
"x-konfig-properties": {
"filter": {
"description": "The bulk operation filter."
}
}
}
BulkOperationErrorResult
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32"
},
"elementErrors": {
"$ref": "#/components/schemas/ErrorCollection"
},
"failedElementNumber": {
"type": "integer",
"format": "int32"
}
}
}
BulkPermissionGrants
{
"type": "object",
"required": [
"globalPermissions",
"projectPermissions"
],
"properties": {
"globalPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of permissions granted to the user.",
"uniqueItems": true
},
"projectPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkProjectPermissionGrants"
},
"description": "List of project permissions and the projects and issues those permissions provide access to.",
"uniqueItems": true
}
},
"description": "Details of global and project permissions granted to the user."
}
BulkPermissionsRequestBean
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"description": "The account ID of a user."
},
"globalPermissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Global permissions to look up.",
"uniqueItems": true
},
"projectPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkProjectPermissions"
},
"description": "Project permissions with associated projects and issues to look up.",
"uniqueItems": true
}
},
"description": "Details of global permissions to look up and project permissions with associated projects and issues to look up."
}
BulkProjectPermissionGrants
{
"type": "object",
"required": [
"issues",
"permission",
"projects"
],
"properties": {
"issues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the issues the user has the permission for.",
"uniqueItems": true
},
"projects": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "IDs of the projects the user has the permission for.",
"uniqueItems": true
},
"permission": {
"type": "string",
"description": "A project permission,"
}
},
"description": "List of project permissions and the projects and issues those permissions grant access to."
}
BulkProjectPermissions
{
"type": "object",
"required": [
"permissions"
],
"properties": {
"issues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of issue IDs.",
"uniqueItems": true
},
"projects": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of project IDs.",
"uniqueItems": true
},
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of project permissions.",
"uniqueItems": true
}
},
"description": "Details of project permissions and associated issues and projects to look up."
}
ChangeDetails
{
"type": "object",
"properties": {
"to": {
"type": "string",
"readOnly": true,
"description": "The details of the new value."
},
"from": {
"type": "string",
"readOnly": true,
"description": "The details of the original value."
},
"field": {
"type": "string",
"readOnly": true,
"description": "The name of the field changed."
},
"fieldId": {
"type": "string",
"readOnly": true,
"description": "The ID of the field changed."
},
"toString": {
"type": "string",
"readOnly": true,
"description": "The details of the new value as a string."
},
"fieldtype": {
"type": "string",
"readOnly": true,
"description": "The type of the field changed."
},
"fromString": {
"type": "string",
"readOnly": true,
"description": "The details of the original value as a string."
}
},
"description": "A change item."
}
ChangeFilterOwner
{
"type": "object",
"required": [
"accountId"
],
"writeOnly": true,
"properties": {
"accountId": {
"type": "string",
"description": "The account ID of the new owner."
}
},
"description": "The account ID of the new owner."
}
ChangedValueBean
{
"type": "object",
"properties": {
"changedTo": {
"type": "string",
"readOnly": true,
"description": "The value of the field after the change."
},
"fieldName": {
"type": "string",
"readOnly": true,
"description": "The name of the field changed."
},
"changedFrom": {
"type": "string",
"readOnly": true,
"description": "The value of the field before the change."
}
},
"description": "Details of names changed in the record event."
}
ChangedWorklog
{
"type": "object",
"properties": {
"worklogId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the worklog."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityProperty"
},
"readOnly": true,
"description": "Details of properties associated with the change."
},
"updatedTime": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The datetime of the change."
}
},
"description": "Details of a changed worklog."
}
ChangedWorklogs
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of this changed worklogs list."
},
"since": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The datetime of the first worklog item in the list."
},
"until": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The datetime of the last worklog item in the list."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangedWorklog"
},
"readOnly": true,
"description": "Changed worklog list."
},
"lastPage": {
"type": "boolean"
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the next list of changed worklogs."
}
},
"description": "List of changed worklogs."
}
Changelog
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the changelog."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangeDetails"
},
"readOnly": true,
"description": "The list of items changed."
},
"author": {
"$ref": "#/components/schemas/UserDetails"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date on which the change took place."
},
"historyMetadata": {
"$ref": "#/components/schemas/HistoryMetadata"
}
},
"description": "A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.",
"x-konfig-properties": {
"author": {
"readOnly": true,
"description": "The user who made the change."
},
"historyMetadata": {
"readOnly": true,
"description": "The history metadata associated with the changed."
}
}
}
ColumnItem
{
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "The issue navigator column label."
},
"value": {
"type": "string",
"description": "The issue navigator column value."
}
},
"description": "Details of an issue navigator column item."
}
ColumnRequestBody
{
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Comment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the comment."
},
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the comment."
},
"author": {
"$ref": "#/components/schemas/UserDetails"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time at which the comment was created."
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date and time at which the comment was updated last."
},
"jsdPublic": {
"type": "boolean",
"readOnly": true,
"description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityProperty"
},
"description": "A list of comment properties. Optional on create and update."
},
"visibility": {
"$ref": "#/components/schemas/Visibility"
},
"renderedBody": {
"type": "string",
"readOnly": true,
"description": "The rendered version of the comment."
},
"updateAuthor": {
"$ref": "#/components/schemas/UserDetails"
},
"jsdAuthorCanSeeRequest": {
"type": "boolean",
"readOnly": true,
"description": "Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature."
}
},
"description": "A comment.",
"x-konfig-properties": {
"author": {
"readOnly": true,
"description": "The ID of the user who created the comment."
},
"visibility": {
"description": "The group or role to which this comment is visible. Optional on create and update."
},
"updateAuthor": {
"readOnly": true,
"description": "The ID of the user who updated the comment last."
}
},
"additionalProperties": true
}
ComponentIssuesCount
{
"xml": {
"name": "component"
},
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL for this count of issues for a component."
},
"issueCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The count of issues assigned to a component."
}
},
"description": "Count of issues assigned to a component."
}
ComponentJsonBean
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ari": {
"type": "string"
},
"name": {
"type": "string"
},
"self": {
"type": "string"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
ComponentWithIssueCount
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The unique identifier for the component."
},
"lead": {
"$ref": "#/components/schemas/User"
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name for the component."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL for this count of the issues contained in the component."
},
"project": {
"type": "string",
"readOnly": true,
"description": "The key of the project to which the component is assigned."
},
"assignee": {
"$ref": "#/components/schemas/User"
},
"projectId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Not used."
},
"issueCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues for the component."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description for the component."
},
"assigneeType": {
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"readOnly": true,
"description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Takes the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in."
},
"realAssignee": {
"$ref": "#/components/schemas/User"
},
"realAssigneeType": {
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"readOnly": true,
"description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true."
},
"isAssigneeTypeValid": {
"type": "boolean",
"readOnly": true,
"description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned."
}
},
"description": "Details about a component with a count of the issues it contains.",
"x-konfig-properties": {
"lead": {
"description": "The user details for the component's lead user."
},
"assignee": {
"description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component."
},
"realAssignee": {
"description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee."
}
}
}
CompoundClause
{
"type": "object",
"required": [
"clauses",
"operator"
],
"properties": {
"clauses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryClause"
},
"description": "The list of nested clauses."
},
"operator": {
"enum": [
"and",
"or",
"not"
],
"type": "string",
"description": "The operator between the clauses."
}
},
"description": "A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator precedence. For example, \"A OR B AND C\" is parsed as \"(A OR B) AND C\". See Setting the precedence of operators for more information about precedence in JQL queries.`"
}
ConditionGroupConfiguration
{
"type": "object",
"nullable": true,
"properties": {
"operation": {
"enum": [
"ANY",
"ALL"
],
"type": "string",
"description": "Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The rules for this condition."
},
"conditionGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionGroupConfiguration"
},
"description": "The nested conditions of the condition group."
}
},
"description": "The conditions group associated with the transition."
}
ConditionGroupUpdate
{
"type": "object",
"nullable": true,
"required": [
"operation"
],
"properties": {
"operation": {
"enum": [
"ANY",
"ALL"
],
"type": "string",
"description": "Determines how the conditions in the group are evaluated. Accepts either `ANY` or `ALL`. If `ANY` is used, at least one condition in the group must be true for the group to evaluate to true. If `ALL` is used, all conditions in the group must be true for the group to evaluate to true."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The rules for this condition."
},
"conditionGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConditionGroupUpdate"
},
"description": "The nested conditions of the condition group."
}
},
"description": "The conditions group associated with the transition."
}
Configuration
{
"type": "object",
"properties": {
"votingEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability for users to vote on issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details."
},
"subTasksEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to create subtasks for issues is enabled."
},
"watchingEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability for users to watch issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details."
},
"attachmentsEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to add attachments to issues is enabled."
},
"issueLinkingEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to link issues is enabled."
},
"timeTrackingEnabled": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to track time is enabled. This property is deprecated."
},
"unassignedIssuesAllowed": {
"type": "boolean",
"readOnly": true,
"description": "Whether the ability to create unassigned issues is enabled. See [Configuring Jira application options](https://confluence.atlassian.com/x/uYXKM) for details."
},
"timeTrackingConfiguration": {
"$ref": "#/components/schemas/TimeTrackingConfiguration"
}
},
"description": "Details about the configuration of Jira.",
"x-konfig-properties": {
"timeTrackingConfiguration": {
"readOnly": true,
"description": "The configuration of time tracking."
}
}
}
ConnectCustomFieldValue
{
"type": "object",
"required": [
"_type",
"fieldID",
"issueID"
],
"writeOnly": true,
"properties": {
"text": {
"type": "string",
"description": "The value of of text custom field type when `_type` is `TextIssueField`."
},
"_type": {
"enum": [
"StringIssueField",
"NumberIssueField",
"RichTextIssueField",
"SingleSelectIssueField",
"MultiSelectIssueField",
"TextIssueField"
],
"type": "string",
"writeOnly": true,
"description": "The type of custom field."
},
"number": {
"type": "number",
"description": "The value of number type custom field when `_type` is `NumberIssueField`."
},
"string": {
"type": "string",
"description": "The value of string type custom field when `_type` is `StringIssueField`."
},
"fieldID": {
"type": "integer",
"writeOnly": true,
"description": "The custom field ID."
},
"issueID": {
"type": "integer",
"writeOnly": true,
"description": "The issue ID."
},
"optionID": {
"type": "string",
"description": "The value of single select and multiselect custom field type when `_type` is `SingleSelectIssueField` or `MultiSelectIssueField`."
},
"richText": {
"type": "string",
"description": "The value of richText type custom field when `_type` is `RichTextIssueField`."
}
},
"description": "A list of custom field details."
}
ConnectCustomFieldValues
{
"type": "object",
"writeOnly": true,
"properties": {
"updateValueList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectCustomFieldValue"
},
"description": "The list of custom field update details."
}
},
"description": "Details of updates for a custom field."
}
ConnectModule
{
"type": "object",
"example": {
"key": "team-field",
"name": {
"value": "Team"
},
"type": "single_select",
"description": {
"value": "field with team"
},
"extractions": [
{
"name": "categoryName",
"path": "category",
"type": "text"
}
]
},
"description": "A [Connect module](https://developer.atlassian.com/cloud/jira/platform/about-jira-modules/) in the same format as in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/)."
}
ConnectModules
{
"type": "object",
"example": {
"jiraIssueFields": [
{
"key": "dynamic-select-field",
"name": {
"value": "Dynamic single select"
},
"type": "single_select",
"description": {
"value": "A dynamically added single-select field"
},
"extractions": [
{
"name": "categoryName",
"path": "category",
"type": "text"
}
]
}
],
"jiraEntityProperties": [
{
"key": "dynamic-attachment-entity-property",
"name": {
"value": "Attachment Index Document"
},
"entityType": "issue",
"keyConfigurations": [
{
"extractions": [
{
"type": "text",
"alias": "attachmentExtension",
"objectName": "extension"
}
],
"propertyKey": "attachment"
}
]
}
]
},
"required": [
"modules"
],
"properties": {
"modules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectModule"
},
"description": "A list of app modules in the same format as the `modules` property in the\n[app descriptor](https://developer.atlassian.com/cloud/jira/platform/app-descriptor/)."
}
}
}
ConnectWorkflowTransitionRule
{
"type": "object",
"required": [
"configuration",
"id",
"key"
],
"properties": {
"id": {
"type": "string",
"example": "123",
"description": "The ID of the transition rule."
},
"key": {
"type": "string",
"example": "WorkflowKey",
"description": "The key of the rule, as defined in the Connect app descriptor."
},
"transition": {
"$ref": "#/components/schemas/WorkflowTransition"
},
"configuration": {
"$ref": "#/components/schemas/RuleConfiguration"
}
},
"description": "A workflow transition rule."
}
ContainerForProjectFeatures
{
"type": "object",
"properties": {
"features": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectFeature"
},
"description": "The project features."
}
},
"description": "The list of features on a project."
}
ContainerForRegisteredWebhooks
{
"type": "object",
"properties": {
"webhookRegistrationResult": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RegisteredWebhook"
},
"description": "A list of registered webhooks."
}
},
"description": "Container for a list of registered webhooks. Webhook details are returned in the same order as the request."
}
ContainerForWebhookIDs
{
"type": "object",
"required": [
"webhookIds"
],
"properties": {
"webhookIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": "A list of webhook IDs."
},
"description": "A list of webhook IDs."
}
},
"description": "Container for a list of webhook IDs."
}
ContainerOfWorkflowSchemeAssociations
{
"type": "object",
"required": [
"values"
],
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowSchemeAssociations"
},
"description": "A list of workflow schemes together with projects they are associated with."
}
},
"description": "A container for a list of workflow schemes together with the projects they are associated with."
}
Context
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the context."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the context."
},
"scope": {
"$ref": "#/components/schemas/Scope"
}
},
"description": "A context.",
"x-konfig-properties": {
"scope": {
"description": "The scope of the context."
}
}
}
ContextForProjectAndIssueType
{
"type": "object",
"required": [
"contextId",
"issueTypeId",
"projectId"
],
"properties": {
"contextId": {
"type": "string",
"description": "The ID of the custom field context."
},
"projectId": {
"type": "string",
"description": "The ID of the project."
},
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
}
},
"description": "The project and issue type mapping with a matching custom field context."
}
ContextualConfiguration
{
"type": "object",
"required": [
"fieldContextId",
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the configuration."
},
"schema": {
"description": "The field value schema."
},
"configuration": {
"description": "The field configuration."
},
"fieldContextId": {
"type": "string",
"readOnly": true,
"description": "The ID of the field context the configuration is associated with."
}
},
"description": "Details of the contextual configuration for a custom field."
}
ConvertedJQLQueries
{
"type": "object",
"properties": {
"queryStrings": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of converted query strings with account IDs in place of user identifiers."
},
"queriesWithUnknownUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JQLQueryWithUnknownUsers"
},
"description": "List of queries containing user information that could not be mapped to an existing user"
}
},
"description": "The converted JQL queries."
}
CreateCustomFieldContext
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the context."
},
"name": {
"type": "string",
"description": "The name of the context."
},
"projectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of project IDs associated with the context. If the list is empty, the context is global."
},
"description": {
"type": "string",
"description": "The description of the context."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of issue types IDs for the context. If the list is empty, the context refers to all issue types."
}
},
"description": "The details of a created custom field context."
}
CreateIssueSecuritySchemeDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the issue security scheme. Must be unique (case-insensitive)."
},
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecuritySchemeLevelBean"
},
"writeOnly": true,
"description": "The list of scheme levels which should be added to the security scheme."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the issue security scheme."
}
},
"description": "Issue security scheme and it's details",
"additionalProperties": true
}
CreateNotificationSchemeDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The name of the notification scheme. Must be unique (case-insensitive)."
},
"description": {
"type": "string",
"maxLength": 4000,
"writeOnly": true,
"description": "The description of the notification scheme."
},
"notificationSchemeEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSchemeEventDetails"
},
"writeOnly": true,
"description": "The list of notifications which should be added to the notification scheme."
}
},
"description": "Details of an notification scheme.",
"additionalProperties": true
}
CreatePriorityDetails
{
"type": "object",
"required": [
"name",
"statusColor"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the priority. Must be unique."
},
"iconUrl": {
"enum": [
"/images/icons/priorities/blocker.png",
"/images/icons/priorities/critical.png",
"/images/icons/priorities/high.png",
"/images/icons/priorities/highest.png",
"/images/icons/priorities/low.png",
"/images/icons/priorities/lowest.png",
"/images/icons/priorities/major.png",
"/images/icons/priorities/medium.png",
"/images/icons/priorities/minor.png",
"/images/icons/priorities/trivial.png"
],
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the priority."
},
"statusColor": {
"type": "string",
"writeOnly": true,
"description": "The status color of the priority in 3-digit or 6-digit hexadecimal format."
}
},
"description": "Details of an issue priority.",
"additionalProperties": true
}
CreateProjectDetails
{
"type": "object",
"required": [
"key",
"name"
],
"properties": {
"key": {
"type": "string",
"description": "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters."
},
"url": {
"type": "string",
"description": "A link to information about this project, such as project documentation"
},
"lead": {
"type": "string",
"description": "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `leadAccountId`."
},
"name": {
"type": "string",
"description": "The name of the project."
},
"avatarId": {
"type": "integer",
"format": "int64",
"description": "An integer value for the project's avatar."
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](https://dac-static.atlassian.com) operation."
},
"description": {
"type": "string",
"description": "A brief description of the project."
},
"assigneeType": {
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"description": "The default assignee when creating issues for this project."
},
"leadAccountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be provided with `lead`."
},
"projectTypeKey": {
"enum": [
"software",
"service_desk",
"business"
],
"type": "string",
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which defines the application-specific feature set. If you don't specify the project template you have to specify the project type."
},
"workflowScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the workflow scheme for the project. Use the [Get all workflow schemes](https://dac-static.atlassian.com) operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key."
},
"issueTypeScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue type scheme for the project. Use the [Get all issue type schemes](https://dac-static.atlassian.com) operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key."
},
"permissionScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the permission scheme for the project. Use the [Get all permission schemes](https://dac-static.atlassian.com) resource to see a list of all permission scheme IDs."
},
"notificationScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the notification scheme for the project. Use the [Get notification schemes](https://dac-static.atlassian.com) resource to get a list of notification scheme IDs."
},
"projectTemplateKey": {
"enum": [
"com.pyxis.greenhopper.jira:gh-simplified-agility-kanban",
"com.pyxis.greenhopper.jira:gh-simplified-agility-scrum",
"com.pyxis.greenhopper.jira:gh-simplified-basic",
"com.pyxis.greenhopper.jira:gh-simplified-kanban-classic",
"com.pyxis.greenhopper.jira:gh-simplified-scrum-classic",
"com.pyxis.greenhopper.jira:gh-cross-team-template",
"com.pyxis.greenhopper.jira:gh-cross-team-planning-template",
"com.atlassian.servicedesk:simplified-it-service-management",
"com.atlassian.servicedesk:simplified-general-service-desk",
"com.atlassian.servicedesk:simplified-general-service-desk-it",
"com.atlassian.servicedesk:simplified-general-service-desk-business",
"com.atlassian.servicedesk:simplified-internal-service-desk",
"com.atlassian.servicedesk:simplified-external-service-desk",
"com.atlassian.servicedesk:simplified-hr-service-desk",
"com.atlassian.servicedesk:simplified-facilities-service-desk",
"com.atlassian.servicedesk:simplified-legal-service-desk",
"com.atlassian.servicedesk:simplified-marketing-service-desk",
"com.atlassian.servicedesk:simplified-finance-service-desk",
"com.atlassian.servicedesk:simplified-analytics-service-desk",
"com.atlassian.servicedesk:simplified-design-service-desk",
"com.atlassian.servicedesk:simplified-sales-service-desk",
"com.atlassian.servicedesk:simplified-halp-service-desk",
"com.atlassian.servicedesk:simplified-blank-project-it",
"com.atlassian.servicedesk:simplified-blank-project-business",
"com.atlassian.servicedesk:next-gen-it-service-desk",
"com.atlassian.servicedesk:next-gen-hr-service-desk",
"com.atlassian.servicedesk:next-gen-legal-service-desk",
"com.atlassian.servicedesk:next-gen-marketing-service-desk",
"com.atlassian.servicedesk:next-gen-facilities-service-desk",
"com.atlassian.servicedesk:next-gen-general-service-desk",
"com.atlassian.servicedesk:next-gen-general-it-service-desk",
"com.atlassian.servicedesk:next-gen-general-business-service-desk",
"com.atlassian.servicedesk:next-gen-analytics-service-desk",
"com.atlassian.servicedesk:next-gen-finance-service-desk",
"com.atlassian.servicedesk:next-gen-design-service-desk",
"com.atlassian.servicedesk:next-gen-sales-service-desk",
"com.atlassian.jira-core-project-templates:jira-core-simplified-content-management",
"com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval",
"com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking",
"com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
"com.atlassian.jira-core-project-templates:jira-core-simplified-procurement",
"com.atlassian.jira-core-project-templates:jira-core-simplified-project-management",
"com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment",
"com.atlassian.jira-core-project-templates:jira-core-simplified-task-"
],
"type": "string",
"description": "A predefined configuration for a project. The type of the `projectTemplateKey` must match with the type of the `projectTypeKey`."
},
"issueSecurityScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](https://dac-static.atlassian.com) resource to get all issue security scheme IDs."
},
"issueTypeScreenScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue type screen scheme for the project. Use the [Get all issue type screen schemes](https://dac-static.atlassian.com) operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key."
},
"fieldConfigurationScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the field configuration scheme for the project. Use the [Get all field configuration schemes](https://dac-static.atlassian.com) operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key."
}
},
"description": "Details about the project."
}
CreateResolutionDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the resolution. Must be unique (case-insensitive)."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the resolution."
}
},
"description": "Details of an issue resolution.",
"additionalProperties": true
}
CreateUiModificationDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"data": {
"type": "string",
"writeOnly": true,
"description": "The data of the UI modification. The maximum size of the data is 50000 characters."
},
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the UI modification. The maximum length is 255 characters."
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UiModificationContextDetails"
},
"writeOnly": true,
"description": "List of contexts of the UI modification. The maximum number of contexts is 1000."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the UI modification. The maximum length is 255 characters."
}
},
"description": "The details of a UI modification."
}
CreateUpdateRoleRequestBean
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 characters. Required when creating a project role. Optional when partially updating a project role."
},
"description": {
"type": "string",
"description": "A description of the project role. Required when fully updating a project role. Optional when creating or partially updating a project role."
}
}
}
CreateWorkflowCondition
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the transition rule."
},
"operator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "The compound condition operator."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateWorkflowCondition"
},
"description": "The list of workflow conditions."
},
"configuration": {
"type": "object",
"description": "EXPERIMENTAL. The configuration of the transition rule.",
"additionalProperties": {
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
}
},
"description": "A workflow transition condition."
}
CreateWorkflowDetails
{
"type": "object",
"required": [
"name",
"statuses",
"transitions"
],
"writeOnly": true,
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow. The name must be unique. The maximum length is 255 characters. Characters can be separated by a whitespace but the name cannot start or end with a whitespace."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateWorkflowStatusDetails"
},
"description": "The statuses of the workflow. Any status that does not include a transition is added to the workflow without a transition.",
"uniqueItems": true
},
"description": {
"type": "string",
"description": "The description of the workflow. The maximum length is 1000 characters."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateWorkflowTransitionDetails"
},
"description": "The transitions of the workflow. For the request to be valid, these transitions must:\n\n * include one *initial* transition.\n * not use the same name for a *global* and *directed* transition.\n * have a unique name for each *global* transition.\n * have a unique 'to' status for each *global* transition.\n * have unique names for each transition from a status.\n * not have a 'from' status on *initial* and *global* transitions.\n * have a 'from' status on *directed* transitions.\n\nAll the transition statuses must be included in `statuses`."
}
},
"description": "The details of a workflow."
}
CreateWorkflowStatusDetails
{
"type": "object",
"required": [
"id"
],
"writeOnly": true,
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"properties": {
"type": "object",
"description": "The properties of the status.",
"additionalProperties": {
"type": "string"
}
}
},
"description": "The details of a transition status."
}
CreateWorkflowTransitionDetails
{
"type": "object",
"required": [
"name",
"to",
"type"
],
"writeOnly": true,
"properties": {
"to": {
"type": "string",
"description": "The status the transition goes to."
},
"from": {
"type": "array",
"items": {
"type": "string"
},
"description": "The statuses the transition can start from."
},
"name": {
"type": "string",
"description": "The name of the transition. The maximum length is 60 characters."
},
"type": {
"enum": [
"global",
"initial",
"directed"
],
"type": "string",
"description": "The type of the transition."
},
"rules": {
"$ref": "#/components/schemas/CreateWorkflowTransitionRulesDetails"
},
"screen": {
"$ref": "#/components/schemas/CreateWorkflowTransitionScreenDetails"
},
"properties": {
"type": "object",
"description": "The properties of the transition.",
"additionalProperties": {
"type": "string"
}
},
"description": {
"type": "string",
"description": "The description of the transition. The maximum length is 1000 characters."
}
},
"description": "The details of a workflow transition.",
"x-konfig-properties": {
"rules": {
"description": "The rules of the transition."
},
"screen": {
"description": "The screen of the transition."
}
}
}
CreateWorkflowTransitionRule
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the transition rule."
},
"configuration": {
"type": "object",
"description": "EXPERIMENTAL. The configuration of the transition rule.",
"additionalProperties": {
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
}
},
"description": "A workflow transition rule."
}
CreateWorkflowTransitionRulesDetails
{
"type": "object",
"writeOnly": true,
"properties": {
"conditions": {
"$ref": "#/components/schemas/CreateWorkflowCondition"
},
"validators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateWorkflowTransitionRule"
},
"description": "The workflow validators.\n\n**Note:** The default permission validator is always added to the *initial* transition, as in:\n\n \"validators\": [\n {\n \"type\": \"PermissionValidator\",\n \"configuration\": {\n \"permissionKey\": \"CREATE_ISSUES\"\n }\n }\n ]"
},
"postFunctions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateWorkflowTransitionRule"
},
"description": "The workflow post functions.\n\n**Note:** The default post functions are always added to the *initial* transition, as in:\n\n \"postFunctions\": [\n {\n \"type\": \"IssueCreateFunction\"\n },\n {\n \"type\": \"IssueReindexFunction\"\n },\n {\n \"type\": \"FireIssueEventFunction\",\n \"configuration\": {\n \"event\": {\n \"id\": \"1\",\n \"name\": \"issue_created\"\n }\n }\n }\n ]\n\n**Note:** The default post functions are always added to the *global* and *directed* transitions, as in:\n\n \"postFunctions\": [\n {\n \"type\": \"UpdateIssueStatusFunction\"\n },\n {\n \"type\": \"CreateCommentFunction\"\n },\n {\n \"type\": \"GenerateChangeHistoryFunction\"\n },\n {\n \"type\": \"IssueReindexFunction\"\n },\n {\n \"type\": \"FireIssueEventFunction\",\n \"configuration\": {\n \"event\": {\n \"id\": \"13\",\n \"name\": \"issue_generic\"\n }\n }\n }\n ]"
}
},
"description": "The details of a workflow transition rules.",
"x-konfig-properties": {
"conditions": {
"description": "The workflow conditions."
}
}
}
CreateWorkflowTransitionScreenDetails
{
"type": "object",
"required": [
"id"
],
"writeOnly": true,
"properties": {
"id": {
"type": "string",
"description": "The ID of the screen."
}
},
"description": "The details of a transition screen."
}
CreatedIssue
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the created issue or subtask."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the created issue or subtask."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the created issue or subtask."
},
"watchers": {
"$ref": "#/components/schemas/NestedResponse"
},
"transition": {
"$ref": "#/components/schemas/NestedResponse"
}
},
"description": "Details about a created issue or subtask.",
"x-konfig-properties": {
"watchers": {
"readOnly": true,
"description": "The response code and messages related to any requested watchers."
},
"transition": {
"readOnly": true,
"description": "The response code and messages related to any requested transition."
}
}
}
CreatedIssues
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkOperationErrorResult"
},
"readOnly": true,
"description": "Error details for failed issue creation requests."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreatedIssue"
},
"readOnly": true,
"description": "Details of the issues created."
}
},
"description": "Details about the issues created and the errors for requests that failed."
}
CustomContextVariable
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/UserContextVariable"
},
{
"$ref": "#/components/schemas/IssueContextVariable"
},
{
"$ref": "#/components/schemas/JsonContextVariable"
}
],
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Type of custom context variable."
}
},
"discriminator": {
"mapping": {
"json": "#/components/schemas/JsonContextVariable",
"user": "#/components/schemas/UserContextVariable",
"issue": "#/components/schemas/IssueContextVariable"
},
"propertyName": "type"
}
}
CustomFieldConfigurations
{
"type": "object",
"required": [
"configurations"
],
"writeOnly": true,
"properties": {
"configurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextualConfiguration"
},
"maxItems": 1000,
"minItems": 1,
"description": "The list of custom field configuration details.",
"uniqueItems": true
}
},
"description": "Details of configurations for a custom field."
}
CustomFieldContext
{
"type": "object",
"required": [
"description",
"id",
"isAnyIssueType",
"isGlobalContext",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the context."
},
"name": {
"type": "string",
"description": "The name of the context."
},
"description": {
"type": "string",
"description": "The description of the context."
},
"isAnyIssueType": {
"type": "boolean",
"description": "Whether the context apply to all issue types."
},
"isGlobalContext": {
"type": "boolean",
"description": "Whether the context is global."
}
},
"description": "The details of a custom field context."
}
CustomFieldContextDefaultValue
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueCascadingOption"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueMultipleOption"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueSingleOption"
},
{
"$ref": "#/components/schemas/CustomFieldContextSingleUserPickerDefaults"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueDate"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueDateTime"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueURL"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueProject"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueFloat"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueLabels"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueTextField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueTextArea"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueReadOnly"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeStringField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeObjectField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeGroupField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeNumberField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeUserField"
},
{
"$ref": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField"
}
],
"discriminator": {
"mapping": {
"url": "#/components/schemas/CustomFieldContextDefaultValueURL",
"float": "#/components/schemas/CustomFieldContextDefaultValueFloat",
"labels": "#/components/schemas/CustomFieldContextDefaultValueLabels",
"project": "#/components/schemas/CustomFieldContextDefaultValueProject",
"readonly": "#/components/schemas/CustomFieldContextDefaultValueReadOnly",
"textarea": "#/components/schemas/CustomFieldContextDefaultValueTextArea",
"textfield": "#/components/schemas/CustomFieldContextDefaultValueTextField",
"datepicker": "#/components/schemas/CustomFieldContextDefaultValueDate",
"forge.user": "#/components/schemas/CustomFieldContextDefaultValueForgeUserField",
"forge.group": "#/components/schemas/CustomFieldContextDefaultValueForgeGroupField",
"forge.number": "#/components/schemas/CustomFieldContextDefaultValueForgeNumberField",
"forge.object": "#/components/schemas/CustomFieldContextDefaultValueForgeObjectField",
"forge.string": "#/components/schemas/CustomFieldContextDefaultValueForgeStringField",
"option.single": "#/components/schemas/CustomFieldContextDefaultValueSingleOption",
"datetimepicker": "#/components/schemas/CustomFieldContextDefaultValueDateTime",
"forge.datetime": "#/components/schemas/CustomFieldContextDefaultValueForgeDateTimeField",
"version.single": "#/components/schemas/CustomFieldContextDefaultValueSingleVersionPicker",
"forge.user.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiUserField",
"option.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleOption",
"forge.group.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiGroupField",
"option.cascading": "#/components/schemas/CustomFieldContextDefaultValueCascadingOption",
"version.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleVersionPicker",
"forge.string.list": "#/components/schemas/CustomFieldContextDefaultValueForgeMultiStringField",
"multi.user.select": "#/components/schemas/CustomFieldContextDefaultValueMultiUserPicker",
"grouppicker.single": "#/components/schemas/CustomFieldContextDefaultValueSingleGroupPicker",
"single.user.select": "#/components/schemas/CustomFieldContextSingleUserPickerDefaults",
"grouppicker.multiple": "#/components/schemas/CustomFieldContextDefaultValueMultipleGroupPicker"
},
"propertyName": "type"
}
}
CustomFieldContextDefaultValueCascadingOption
{
"type": "object",
"required": [
"contextId",
"optionId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"optionId": {
"type": "string",
"description": "The ID of the default option."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"cascadingOptionId": {
"type": "string",
"description": "The ID of the default cascading option."
}
},
"description": "The default value for a cascading select custom field."
}
CustomFieldContextDefaultValueDate
{
"type": "object",
"required": [
"type"
],
"properties": {
"date": {
"type": "string",
"description": "The default date in ISO format. Ignored if `useCurrent` is true."
},
"type": {
"type": "string"
},
"useCurrent": {
"type": "boolean",
"default": false,
"description": "Whether to use the current date."
}
},
"description": "The default value for a Date custom field."
}
CustomFieldContextDefaultValueDateTime
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"dateTime": {
"type": "string",
"description": "The default date-time in ISO format. Ignored if `useCurrent` is true."
},
"useCurrent": {
"type": "boolean",
"default": false,
"description": "Whether to use the current date."
}
},
"description": "The default value for a date time custom field."
}
CustomFieldContextDefaultValueFloat
{
"type": "object",
"required": [
"number",
"type"
],
"properties": {
"type": {
"type": "string"
},
"number": {
"type": "number",
"format": "double",
"description": "The default floating-point number."
}
},
"description": "Default value for a float (number) custom field."
}
CustomFieldContextDefaultValueForgeDateTimeField
{
"type": "object",
"required": [
"contextId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"dateTime": {
"type": "string",
"description": "The default date-time in ISO format. Ignored if `useCurrent` is true."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"useCurrent": {
"type": "boolean",
"default": false,
"description": "Whether to use the current date."
}
},
"description": "The default value for a Forge date time custom field."
}
CustomFieldContextDefaultValueForgeGroupField
{
"type": "object",
"required": [
"contextId",
"groupId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"groupId": {
"type": "string",
"description": "The ID of the the default group."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a Forge group custom field."
}
CustomFieldContextDefaultValueForgeMultiGroupField
{
"type": "object",
"required": [
"contextId",
"groupIds",
"type"
],
"properties": {
"type": {
"type": "string"
},
"groupIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of the default groups."
},
"description": "The IDs of the default groups.",
"uniqueItems": true
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a Forge collection of groups custom field."
}
CustomFieldContextDefaultValueForgeMultiStringField
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "string",
"description": "List of string values. The maximum length for a value is 254 characters."
},
"description": "List of string values. The maximum length for a value is 254 characters."
}
},
"description": "The default text for a Forge collection of strings custom field."
}
CustomFieldContextDefaultValueForgeMultiUserField
{
"type": "object",
"required": [
"accountIds",
"contextId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of the default users."
},
"description": "The IDs of the default users."
}
},
"description": "Defaults for a Forge collection of users custom field."
}
CustomFieldContextDefaultValueForgeNumberField
{
"type": "object",
"required": [
"contextId",
"number",
"type"
],
"properties": {
"type": {
"type": "string"
},
"number": {
"type": "number",
"format": "double",
"description": "The default floating-point number."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "Default value for a Forge number custom field."
}
CustomFieldContextDefaultValueForgeObjectField
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"object": {
"type": "object",
"description": "The default JSON object."
}
},
"description": "The default value for a Forge object custom field."
}
CustomFieldContextDefaultValueForgeStringField
{
"type": "object",
"required": [
"contextId",
"type"
],
"properties": {
"text": {
"type": "string",
"description": "The default text. The maximum length is 254 characters."
},
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default text for a Forge string custom field."
}
CustomFieldContextDefaultValueForgeUserField
{
"type": "object",
"required": [
"accountId",
"contextId",
"type",
"userFilter"
],
"properties": {
"type": {
"type": "string"
},
"accountId": {
"type": "string",
"description": "The ID of the default user."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"userFilter": {
"$ref": "#/components/schemas/UserFilter"
}
},
"description": "Defaults for a Forge user custom field."
}
CustomFieldContextDefaultValueLabels
{
"type": "object",
"required": [
"labels",
"type"
],
"properties": {
"type": {
"type": "string"
},
"labels": {
"type": "array",
"items": {
"type": "string",
"description": "The default labels value."
},
"description": "The default labels value."
}
},
"description": "Default value for a labels custom field."
}
CustomFieldContextDefaultValueMultiUserPicker
{
"type": "object",
"required": [
"accountIds",
"contextId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"accountIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of the default users."
},
"description": "The IDs of the default users."
}
},
"description": "The default value for a User Picker (multiple) custom field."
}
CustomFieldContextDefaultValueMultipleGroupPicker
{
"type": "object",
"required": [
"contextId",
"groupIds",
"type"
],
"properties": {
"type": {
"type": "string"
},
"groupIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of the default groups."
},
"description": "The IDs of the default groups.",
"uniqueItems": true
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a multiple group picker custom field."
}
CustomFieldContextDefaultValueMultipleOption
{
"type": "object",
"required": [
"contextId",
"optionIds",
"type"
],
"properties": {
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"optionIds": {
"type": "array",
"items": {
"type": "string",
"description": "The list of IDs of the default options."
},
"description": "The list of IDs of the default options."
}
},
"description": "The default value for a multi-select custom field."
}
CustomFieldContextDefaultValueMultipleVersionPicker
{
"type": "object",
"required": [
"type",
"versionIds"
],
"properties": {
"type": {
"type": "string"
},
"versionIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of the default versions."
},
"description": "The IDs of the default versions.",
"uniqueItems": true
},
"versionOrder": {
"type": "string",
"description": "The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `\"releasedFirst\"` and `\"unreleasedFirst\"`."
}
},
"description": "The default value for a multiple version picker custom field."
}
CustomFieldContextDefaultValueProject
{
"type": "object",
"required": [
"contextId",
"projectId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"projectId": {
"type": "string",
"description": "The ID of the default project."
}
},
"description": "The default value for a project custom field."
}
CustomFieldContextDefaultValueReadOnly
{
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string",
"description": "The default text. The maximum length is 255 characters."
},
"type": {
"type": "string"
}
},
"description": "The default text for a read only custom field."
}
CustomFieldContextDefaultValueSingleGroupPicker
{
"type": "object",
"required": [
"contextId",
"groupId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"groupId": {
"type": "string",
"description": "The ID of the the default group."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a group picker custom field."
}
CustomFieldContextDefaultValueSingleOption
{
"type": "object",
"required": [
"contextId",
"optionId",
"type"
],
"properties": {
"type": {
"type": "string"
},
"optionId": {
"type": "string",
"description": "The ID of the default option."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a single select custom field."
}
CustomFieldContextDefaultValueSingleVersionPicker
{
"type": "object",
"required": [
"type",
"versionId"
],
"properties": {
"type": {
"type": "string"
},
"versionId": {
"type": "string",
"description": "The ID of the default version."
},
"versionOrder": {
"type": "string",
"description": "The order the pickable versions are displayed in. If not provided, the released-first order is used. Available version orders are `\"releasedFirst\"` and `\"unreleasedFirst\"`."
}
},
"description": "The default value for a version picker custom field."
}
CustomFieldContextDefaultValueTextArea
{
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string",
"description": "The default text. The maximum length is 32767 characters."
},
"type": {
"type": "string"
}
},
"description": "The default text for a text area custom field."
}
CustomFieldContextDefaultValueTextField
{
"type": "object",
"required": [
"type"
],
"properties": {
"text": {
"type": "string",
"description": "The default text. The maximum length is 254 characters."
},
"type": {
"type": "string"
}
},
"description": "The default text for a text custom field."
}
CustomFieldContextDefaultValueURL
{
"type": "object",
"required": [
"contextId",
"type",
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The default URL."
},
"type": {
"type": "string"
},
"contextId": {
"type": "string",
"description": "The ID of the context."
}
},
"description": "The default value for a URL custom field."
}
CustomFieldContextDefaultValueUpdate
{
"type": "object",
"properties": {
"defaultValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContextDefaultValue"
}
}
},
"description": "Default values to update."
}
CustomFieldContextOption
{
"type": "object",
"required": [
"disabled",
"id",
"value"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the custom field option."
},
"value": {
"type": "string",
"description": "The value of the custom field option."
},
"disabled": {
"type": "boolean",
"description": "Whether the option is disabled."
},
"optionId": {
"type": "string",
"description": "For cascading options, the ID of the custom field option containing the cascading option."
}
},
"description": "Details of the custom field options for a context."
}
CustomFieldContextProjectMapping
{
"type": "object",
"required": [
"contextId"
],
"properties": {
"contextId": {
"type": "string",
"readOnly": true,
"description": "The ID of the context."
},
"projectId": {
"type": "string",
"readOnly": true,
"description": "The ID of the project."
},
"isGlobalContext": {
"type": "boolean",
"readOnly": true,
"description": "Whether context is global."
}
},
"description": "Details of a context to project association."
}
CustomFieldContextSingleUserPickerDefaults
{
"type": "object",
"required": [
"accountId",
"contextId",
"type",
"userFilter"
],
"properties": {
"type": {
"type": "string"
},
"accountId": {
"type": "string",
"description": "The ID of the default user."
},
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"userFilter": {
"$ref": "#/components/schemas/UserFilter"
}
},
"description": "Defaults for a User Picker (single) custom field."
}
CustomFieldContextUpdateDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the custom field context. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the custom field context. The maximum length is 255 characters."
}
},
"description": "Details of a custom field context."
}
CustomFieldCreatedContextOptionsList
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContextOption"
},
"description": "The created custom field options."
}
},
"description": "A list of custom field options for a context."
}
CustomFieldDefinitionJsonBean
{
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the custom field, which is displayed in Jira. This is not the unique identifier."
},
"type": {
"type": "string",
"description": "The type of the custom field. These built-in custom field types are available:\n\n * `cascadingselect`: Enables values to be selected from two levels of select lists (value: `com.atlassian.jira.plugin.system.customfieldtypes:cascadingselect`)\n * `datepicker`: Stores a date using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:datepicker`)\n * `datetime`: Stores a date with a time component (value: `com.atlassian.jira.plugin.system.customfieldtypes:datetime`)\n * `float`: Stores and validates a numeric (floating point) input (value: `com.atlassian.jira.plugin.system.customfieldtypes:float`)\n * `grouppicker`: Stores a user group using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:grouppicker`)\n * `importid`: A read-only field that stores the ID the issue had in the system it was imported from (value: `com.atlassian.jira.plugin.system.customfieldtypes:importid`)\n * `labels`: Stores labels (value: `com.atlassian.jira.plugin.system.customfieldtypes:labels`)\n * `multicheckboxes`: Stores multiple values using checkboxes (value: ``)\n * `multigrouppicker`: Stores multiple user groups using a picker control (value: ``)\n * `multiselect`: Stores multiple values using a select list (value: `com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes`)\n * `multiuserpicker`: Stores multiple users using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:multigrouppicker`)\n * `multiversion`: Stores multiple versions from the versions available in a project using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:multiversion`)\n * `project`: Stores a project from a list of projects that the user is permitted to view (value: `com.atlassian.jira.plugin.system.customfieldtypes:project`)\n * `radiobuttons`: Stores a value using radio buttons (value: `com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons`)\n * `readonlyfield`: Stores a read-only text value, which can only be populated via the API (value: `com.atlassian.jira.plugin.system.customfieldtypes:readonlyfield`)\n * `select`: Stores a value from a configurable list of options (value: `com.atlassian.jira.plugin.system.customfieldtypes:select`)\n * `textarea`: Stores a long text string using a multiline text area (value: `com.atlassian.jira.plugin.system.customfieldtypes:textarea`)\n * `textfield`: Stores a text string using a single-line text box (value: `com.atlassian.jira.plugin.system.customfieldtypes:textfield`)\n * `url`: Stores a URL (value: `com.atlassian.jira.plugin.system.customfieldtypes:url`)\n * `userpicker`: Stores a user using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:userpicker`)\n * `version`: Stores a version using a picker control (value: `com.atlassian.jira.plugin.system.customfieldtypes:version`)\n\nTo create a field based on a [Forge custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-), use the ID of the Forge custom field type as the value. For example, `ari:cloud:ecosystem::extension/e62f20a2-4b61-4dbe-bfb9-9a88b5e3ac84/548c5df1-24aa-4f7c-bbbb-3038d947cb05/static/my-cf-type-key`."
},
"description": {
"type": "string",
"description": "The description of the custom field, which is displayed in Jira."
},
"searcherKey": {
"enum": [
"com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:daterange",
"com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
"com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
"com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
"com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"
],
"type": "string",
"description": "The searcher defines the way the field is searched in Jira. For example, *com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher*. \nThe search UI (basic search and JQL search) will display different operations and values for the field, based on the field searcher. You must specify a searcher that is valid for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`\n\nIf no searcher is provided, the field isn't searchable. However, [Forge custom fields](https://developer.atlassian.com/platform/forge/manifest-reference/modules/#jira-custom-field-type--beta-) have a searcher set automatically, so are always searchable."
}
}
}
CustomFieldOption
{
"xml": {
"name": "customFieldOption"
},
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of these custom field option details."
},
"value": {
"type": "string",
"readOnly": true,
"description": "The value of the custom field option."
}
},
"description": "Details of a custom option for a field."
}
CustomFieldOptionCreate
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The value of the custom field option."
},
"disabled": {
"type": "boolean",
"description": "Whether the option is disabled."
},
"optionId": {
"type": "string",
"description": "For cascading options, the ID of the custom field object containing the cascading option."
}
},
"description": "Details of a custom field option to create."
}
CustomFieldOptionUpdate
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the custom field option."
},
"value": {
"type": "string",
"description": "The value of the custom field option."
},
"disabled": {
"type": "boolean",
"description": "Whether the option is disabled."
}
},
"description": "Details of a custom field option for a context."
}
CustomFieldReplacement
{
"type": "object",
"properties": {
"moveTo": {
"type": "integer",
"format": "int64",
"description": "The version number to use as a replacement for the deleted version."
},
"customFieldId": {
"type": "integer",
"format": "int64",
"description": "The ID of the custom field in which to replace the version number."
}
},
"description": "Details about the replacement for a deleted version."
}
CustomFieldUpdatedContextOptionsList
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldOptionUpdate"
},
"description": "The updated custom field options."
}
},
"description": "A list of custom field options for a context."
}
CustomFieldValueUpdate
{
"type": "object",
"required": [
"issueIds",
"value"
],
"writeOnly": true,
"properties": {
"value": {
"description": "The value for the custom field. The value must be compatible with the [custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types) as follows:\n\n * `string` the value must be a string.\n * `number` the value must be a number.\n * `datetime` the value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example, `\"2023-01-18T12:00:00-03:00\"` or `\"2023-01-18T12:00:00.000Z\"`. However, the milliseconds part is ignored.\n * `user` the value must be an object that contains the `accountId` field.\n * `group` the value must be an object that contains the group `name` or `groupId` field. Because group names can change, we recommend using `groupId`.\n\nA list of appropriate values must be provided if the field is of the `list` [collection type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#collection-types)."
},
"issueIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of issue IDs."
}
},
"description": "A list of issue IDs and the value to update a custom field to."
}
CustomFieldValueUpdateDetails
{
"type": "object",
"writeOnly": true,
"properties": {
"updates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldValueUpdate"
},
"description": "The list of custom field update details."
}
},
"description": "Details of updates for a custom field."
}
Dashboard
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the dashboard."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the dashboard."
},
"rank": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The rank of this dashboard."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of these dashboard details."
},
"view": {
"type": "string",
"readOnly": true,
"description": "The URL of the dashboard."
},
"owner": {
"$ref": "#/components/schemas/UserBean"
},
"isWritable": {
"type": "boolean",
"readOnly": true,
"description": "Whether the current user has permission to edit the dashboard."
},
"popularity": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of users who have this dashboard as a favorite."
},
"description": {
"type": "string"
},
"isFavourite": {
"type": "boolean",
"readOnly": true,
"description": "Whether the dashboard is selected as a favorite by the user."
},
"editPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"readOnly": true,
"description": "The details of any edit share permissions for the dashboard."
},
"systemDashboard": {
"type": "boolean",
"readOnly": true,
"description": "Whether the current dashboard is system dashboard."
},
"sharePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"readOnly": true,
"description": "The details of any view share permissions for the dashboard."
},
"automaticRefreshMs": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The automatic refresh interval for the dashboard in milliseconds."
}
},
"description": "Details of a dashboard.",
"x-konfig-properties": {
"owner": {
"readOnly": true,
"description": "The owner of the dashboard."
}
}
}
DashboardDetails
{
"type": "object",
"required": [
"editPermissions",
"name",
"sharePermissions"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the dashboard."
},
"description": {
"type": "string",
"description": "The description of the dashboard."
},
"editPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The edit permissions for the dashboard."
},
"sharePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The share permissions for the dashboard."
}
},
"description": "Details of a dashboard."
}
DashboardGadget
{
"type": "object",
"required": [
"color",
"id",
"position",
"title"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the gadget instance."
},
"uri": {
"type": "string",
"readOnly": true,
"description": "The URI of the gadget type."
},
"color": {
"enum": [
"blue",
"red",
"yellow",
"green",
"cyan",
"purple",
"gray",
"white"
],
"type": "string",
"readOnly": true,
"description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`."
},
"title": {
"type": "string",
"readOnly": true,
"description": "The title of the gadget."
},
"position": {
"$ref": "#/components/schemas/DashboardGadgetPosition"
},
"moduleKey": {
"type": "string",
"readOnly": true,
"description": "The module key of the gadget type."
}
},
"description": "Details of a gadget.",
"x-konfig-properties": {
"position": {
"readOnly": true,
"description": "The position of the gadget."
}
}
}
DashboardGadgetPosition
{
"type": "object",
"required": [
"The column position of the gadget.",
"The row position of the gadget."
],
"writeOnly": true,
"properties": {
"The row position of the gadget.": {
"type": "integer",
"format": "int32"
},
"The column position of the gadget.": {
"type": "integer",
"format": "int32"
}
},
"description": "Details of a gadget position."
}
DashboardGadgetResponse
{
"type": "object",
"required": [
"gadgets"
],
"properties": {
"gadgets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardGadget"
},
"readOnly": true,
"description": "The list of gadgets."
}
},
"description": "The list of gadgets on the dashboard."
}
DashboardGadgetSettings
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"writeOnly": true,
"description": "The URI of the gadget type. Can't be provided with `moduleKey`."
},
"color": {
"type": "string",
"writeOnly": true,
"description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`."
},
"title": {
"type": "string",
"writeOnly": true,
"description": "The title of the gadget."
},
"position": {
"$ref": "#/components/schemas/DashboardGadgetPosition"
},
"moduleKey": {
"type": "string",
"writeOnly": true,
"description": "The module key of the gadget type. Can't be provided with `uri`."
},
"ignoreUriAndModuleKeyValidation": {
"type": "boolean",
"writeOnly": true,
"description": "Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed."
}
},
"description": "Details of the settings for a dashboard gadget.",
"x-konfig-properties": {
"position": {
"description": "The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it."
}
}
}
DashboardGadgetUpdateRequest
{
"type": "object",
"properties": {
"color": {
"type": "string",
"writeOnly": true,
"description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`."
},
"title": {
"type": "string",
"writeOnly": true,
"description": "The title of the gadget."
},
"position": {
"$ref": "#/components/schemas/DashboardGadgetPosition"
}
},
"description": "The details of the gadget to update.",
"x-konfig-properties": {
"position": {
"description": "The position of the gadget."
}
}
}
DataClassificationLevelsBean
{
"type": "object",
"properties": {
"classifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DataClassificationTagBean"
},
"description": "The data classifications."
}
},
"description": "The data classification."
}
DataClassificationTagBean
{
"type": "object",
"required": [
"id",
"status"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the data classification object."
},
"name": {
"type": "string",
"description": "The name of the data classification object."
},
"rank": {
"type": "integer",
"format": "int32",
"description": "The rank of the data classification object."
},
"color": {
"type": "string",
"description": "The color of the data classification object."
},
"status": {
"type": "string",
"description": "The status of the data classification object."
},
"guideline": {
"type": "string",
"description": "The guideline of the data classification object."
},
"description": {
"type": "string",
"description": "The description of the data classification object."
}
},
"description": "The data classification."
}
DateRangeFilterRequest
{
"type": "object",
"required": [
"dateAfter",
"dateBefore"
],
"properties": {
"dateAfter": {
"type": "string",
"description": "List issues archived after a specified date, passed in the YYYY-MM-DD format."
},
"dateBefore": {
"type": "string",
"description": "List issues archived before a specified date provided in the YYYY-MM-DD format."
}
},
"description": "List issues archived within a specified date range."
}
DefaultLevelValue
{
"type": "object",
"required": [
"defaultLevelId",
"issueSecuritySchemeId"
],
"maxLength": 1000,
"writeOnly": true,
"properties": {
"defaultLevelId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue security level to set as default for the specified scheme. Providing null will reset the default level."
},
"issueSecuritySchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue security scheme to set default level for."
}
},
"description": "Details of scheme and new default level.",
"additionalProperties": true
}
DefaultShareScope
{
"xml": {
"name": "defaultShareScope"
},
"type": "object",
"required": [
"scope"
],
"properties": {
"scope": {
"enum": [
"GLOBAL",
"AUTHENTICATED",
"PRIVATE"
],
"type": "string",
"description": "The scope of the default sharing for new filters and dashboards:\n\n * `AUTHENTICATED` Shared with all logged-in users.\n * `GLOBAL` Shared with all logged-in users. This shows as `AUTHENTICATED` in the response.\n * `PRIVATE` Not shared with any users."
}
},
"description": "Details of the scope of the default sharing for new filters and dashboards."
}
DefaultWorkflow
{
"type": "object",
"required": [
"workflow"
],
"properties": {
"workflow": {
"type": "string",
"description": "The name of the workflow to set as the default workflow."
},
"updateDraftIfNeeded": {
"type": "boolean",
"description": "Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new default workflow. Defaults to `false`."
}
},
"description": "Details about the default workflow."
}
DeleteAndReplaceVersionBean
{
"type": "object",
"properties": {
"moveFixIssuesTo": {
"type": "integer",
"format": "int64",
"description": "The ID of the version to update `fixVersion` to when the field contains the deleted version."
},
"moveAffectedIssuesTo": {
"type": "integer",
"format": "int64",
"description": "The ID of the version to update `affectedVersion` to when the field contains the deleted version."
},
"customFieldReplacementList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldReplacement"
},
"description": "An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the deleted version."
}
}
}
DeprecatedWorkflow
{
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the workflow."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"steps": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of steps included in the workflow."
},
"default": {
"type": "boolean"
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the workflow."
},
"lastModifiedDate": {
"type": "string",
"readOnly": true,
"description": "The datetime the workflow was last modified."
},
"lastModifiedUser": {
"type": "string",
"readOnly": true,
"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."
},
"lastModifiedUserAccountId": {
"type": "string",
"readOnly": true,
"description": "The account ID of the user that last modified the workflow."
}
},
"description": "Details about a workflow.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "The scope where this workflow applies"
}
}
}
DetailedErrorCollection
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"",
"additionalProperties": {
"type": "string"
}
},
"details": {
"type": "object",
"description": "Map of objects representing additional details for an error",
"additionalProperties": {}
},
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\""
}
}
}
DocumentVersion
{
"type": "object",
"required": [
"id",
"versionNumber"
],
"properties": {
"id": {
"type": "string",
"description": "The version UUID."
},
"versionNumber": {
"type": "integer",
"format": "int64",
"description": "The version number."
}
},
"description": "The current version details of this workflow scheme."
}
EntityProperty
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
},
"description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."
}
EntityPropertyDetails
{
"type": "object",
"required": [
"entityId",
"key",
"value"
],
"properties": {
"key": {
"type": "string",
"example": "mykey",
"description": "The entity property key."
},
"value": {
"type": "string",
"example": "newValue",
"description": "The new value of the entity property."
},
"entityId": {
"type": "number",
"example": 123,
"description": "The entity property ID."
}
}
}
Error
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64"
},
"message": {
"type": "string"
},
"issueIdsOrKeys": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
}
ErrorCollection
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"",
"additionalProperties": {
"type": "string"
}
},
"status": {
"type": "integer",
"format": "int32"
},
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\""
}
},
"description": "Error messages from an operation."
}
ErrorCollections
{
"type": "object"
}
ErrorMessage
{
"type": "object",
"example": {
"message": "The request is not from a Connect app."
},
"required": [
"message"
],
"properties": {
"message": {
"type": "string",
"description": "The error message."
}
}
}
Errors
{
"type": "object",
"properties": {
"issueIsSubtask": {
"$ref": "#/components/schemas/Error"
},
"issuesNotFound": {
"$ref": "#/components/schemas/Error"
},
"issuesInArchivedProjects": {
"$ref": "#/components/schemas/Error"
},
"issuesInUnlicensedProjects": {
"$ref": "#/components/schemas/Error"
}
}
}
EventNotification
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the notification."
},
"user": {
"$ref": "#/components/schemas/UserDetails"
},
"field": {
"$ref": "#/components/schemas/FieldDetails"
},
"group": {
"$ref": "#/components/schemas/GroupName"
},
"expand": {
"type": "string",
"description": "Expand options that include additional event notification details in the response."
},
"parameter": {
"type": "string",
"description": "As a group's name can change, use of `recipient` is recommended. The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by `notificationType` value. So, when `notificationType` is:\n\n * `User` The `parameter` is the user account ID.\n * `Group` The `parameter` is the group name.\n * `ProjectRole` The `parameter` is the project role ID.\n * `UserCustomField` The `parameter` is the ID of the custom field.\n * `GroupCustomField` The `parameter` is the ID of the custom field."
},
"recipient": {
"type": "string",
"description": "The identifier associated with the `notificationType` value that defines the receiver of the notification, where the receiver isn't implied by the `notificationType` value. So, when `notificationType` is:\n\n * `User`, `recipient` is the user account ID.\n * `Group`, `recipient` is the group ID.\n * `ProjectRole`, `recipient` is the project role ID.\n * `UserCustomField`, `recipient` is the ID of the custom field.\n * `GroupCustomField`, `recipient` is the ID of the custom field."
},
"projectRole": {
"$ref": "#/components/schemas/ProjectRole"
},
"emailAddress": {
"type": "string",
"description": "The email address."
},
"notificationType": {
"enum": [
"CurrentAssignee",
"Reporter",
"CurrentUser",
"ProjectLead",
"ComponentLead",
"User",
"Group",
"ProjectRole",
"EmailAddress",
"AllWatchers",
"UserCustomField",
"GroupCustomField"
],
"type": "string",
"description": "Identifies the recipients of the notification."
}
},
"description": "Details about a notification associated with an event.",
"x-konfig-properties": {
"user": {
"description": "The specified user."
},
"field": {
"description": "The custom user or group field."
},
"group": {
"description": "The specified group."
},
"projectRole": {
"description": "The specified project role."
}
}
}
ExpandPrioritySchemeBean
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the priority scheme."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the priority scheme."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the priority scheme."
}
},
"description": "A priority scheme with less fields to be used in for an API expand response."
}
ExpandPrioritySchemePage
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"startAt": {
"type": "integer",
"format": "int64"
},
"maxResults": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": true
}
ExportArchivedIssuesTaskProgressResponse
{
"type": "object",
"properties": {
"status": {
"type": "string"
},
"taskId": {
"type": "string"
},
"fileUrl": {
"type": "string"
},
"payload": {
"type": "string"
},
"progress": {
"type": "integer",
"format": "int64"
},
"submittedTime": {
"type": "string",
"format": "date-time"
}
},
"description": "The response for status request for a running/completed export task."
}
FailedWebhook
{
"type": "object",
"required": [
"failureTime",
"id",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "The webhook ID, as sent in the `X-Atlassian-Webhook-Identifier` header with the webhook."
},
"url": {
"type": "string",
"description": "The original webhook destination."
},
"body": {
"type": "string",
"description": "The webhook body."
},
"failureTime": {
"type": "integer",
"format": "int64",
"description": "The time the webhook was added to the list of failed webhooks (that is, the time of the last failed retry)."
}
},
"description": "Details about a failed webhook."
}
FailedWebhooks
{
"type": "object",
"required": [
"maxResults",
"values"
],
"properties": {
"next": {
"type": "string",
"format": "uri",
"description": "The URL to the next page of results. Present only if the request returned at least one result.The next page may be empty at the time of receiving the response, but new failed webhooks may appear in time. You can save the URL to the next page and query for new results periodically (for example, every hour)."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FailedWebhook"
},
"description": "The list of webhooks."
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of items on the page. If the list of values is shorter than this number, then there are no more pages."
}
},
"description": "A page of failed webhooks."
}
Field
{
"type": "object",
"required": [
"id",
"name",
"schema"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the field."
},
"key": {
"type": "string",
"description": "The key of the field."
},
"name": {
"type": "string",
"description": "The name of the field."
},
"schema": {
"$ref": "#/components/schemas/JsonTypeBean"
},
"isLocked": {
"type": "boolean",
"description": "Whether the field is locked."
},
"lastUsed": {
"$ref": "#/components/schemas/FieldLastUsed"
},
"description": {
"type": "string",
"description": "The description of the field."
},
"searcherKey": {
"type": "string",
"description": "The searcher key of the field. Returned for custom fields."
},
"screensCount": {
"type": "integer",
"format": "int64",
"description": "Number of screens where the field is used."
},
"contextsCount": {
"type": "integer",
"format": "int64",
"description": "Number of contexts where the field is used."
},
"projectsCount": {
"type": "integer",
"format": "int64",
"description": "Number of projects where the field is used."
},
"isUnscreenable": {
"type": "boolean",
"description": "Whether the field is shown on screen or not."
}
},
"description": "Details of a field."
}
FieldChangedClause
{
"type": "object",
"required": [
"field",
"operator",
"predicates"
],
"properties": {
"field": {
"$ref": "#/components/schemas/JqlQueryField"
},
"operator": {
"enum": [
"changed"
],
"type": "string",
"description": "The operator applied to the field."
},
"predicates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryClauseTimePredicate"
},
"description": "The list of time predicates."
}
},
"description": "A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more information about the CHANGED operator."
}
FieldConfiguration
{
"type": "object",
"required": [
"description",
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the field configuration."
},
"name": {
"type": "string",
"description": "The name of the field configuration."
},
"isDefault": {
"type": "boolean",
"description": "Whether the field configuration is the default."
},
"description": {
"type": "string",
"description": "The description of the field configuration."
}
},
"description": "Details of a field configuration."
}
FieldConfigurationDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The name of the field configuration. Must be unique."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the field configuration."
}
},
"description": "Details of a field configuration."
}
FieldConfigurationIssueTypeItem
{
"type": "object",
"required": [
"fieldConfigurationId",
"fieldConfigurationSchemeId",
"issueTypeId"
],
"properties": {
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration."
},
"fieldConfigurationId": {
"type": "string",
"description": "The ID of the field configuration."
},
"fieldConfigurationSchemeId": {
"type": "string",
"description": "The ID of the field configuration scheme."
}
},
"description": "The field configuration for an issue type."
}
FieldConfigurationItem
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the field within the field configuration."
},
"isHidden": {
"type": "boolean",
"description": "Whether the field is hidden in the field configuration."
},
"renderer": {
"type": "string",
"description": "The renderer type for the field within the field configuration."
},
"isRequired": {
"type": "boolean",
"description": "Whether the field is required in the field configuration."
},
"description": {
"type": "string",
"description": "The description of the field within the field configuration."
}
},
"description": "A field within a field configuration."
}
FieldConfigurationItemsDetails
{
"type": "object",
"required": [
"fieldConfigurationItems"
],
"properties": {
"fieldConfigurationItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationItem"
},
"writeOnly": true,
"description": "Details of fields in a field configuration."
}
},
"description": "Details of field configuration items."
}
FieldConfigurationScheme
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the field configuration scheme."
},
"name": {
"type": "string",
"description": "The name of the field configuration scheme."
},
"description": {
"type": "string",
"description": "The description of the field configuration scheme."
}
},
"description": "Details of a field configuration scheme."
}
FieldConfigurationSchemeProjectAssociation
{
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the project."
},
"fieldConfigurationSchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the field configuration scheme. If the field configuration scheme ID is `null`, the operation assigns the default field configuration scheme."
}
},
"description": "Associated field configuration scheme and project."
}
FieldConfigurationSchemeProjects
{
"type": "object",
"required": [
"projectIds"
],
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of projects using the field configuration scheme."
},
"description": "The IDs of projects using the field configuration scheme."
},
"fieldConfigurationScheme": {
"$ref": "#/components/schemas/FieldConfigurationScheme"
}
},
"description": "Project list with assigned field configuration schema."
}
FieldConfigurationToIssueTypeMapping
{
"type": "object",
"required": [
"fieldConfigurationId",
"issueTypeId"
],
"writeOnly": true,
"properties": {
"issueTypeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type or *default*. When set to *default* this field configuration issue type item applies to all issue types without a field configuration. An issue type can be included only once in a request."
},
"fieldConfigurationId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the field configuration."
}
},
"description": "The field configuration to issue type mapping."
}
FieldCreateMetadata
{
"xml": {
"name": "availableField"
},
"type": "object",
"required": [
"fieldId",
"key",
"name",
"operations",
"required",
"schema"
],
"properties": {
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the field."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the field."
},
"schema": {
"$ref": "#/components/schemas/JsonTypeBean"
},
"fieldId": {
"type": "string",
"readOnly": true,
"description": "The field id."
},
"required": {
"type": "boolean",
"readOnly": true,
"description": "Whether the field is required."
},
"operations": {
"type": "array",
"items": {
"type": "string",
"readOnly": true
},
"readOnly": true,
"description": "The list of operations that can be performed on the field."
},
"defaultValue": {
"readOnly": true,
"description": "The default value of the field."
},
"allowedValues": {
"type": "array",
"items": {
"readOnly": true
},
"readOnly": true,
"description": "The list of values allowed in the field."
},
"configuration": {
"type": "object",
"readOnly": true,
"description": "The configuration properties.",
"additionalProperties": {
"readOnly": true
}
},
"autoCompleteUrl": {
"type": "string",
"readOnly": true,
"description": "The URL that can be used to automatically complete the field."
},
"hasDefaultValue": {
"type": "boolean",
"readOnly": true,
"description": "Whether the field has a default value."
}
},
"description": "The metadata describing an issue field for createmeta.",
"x-konfig-properties": {
"schema": {
"readOnly": true,
"description": "The data type of the field."
}
}
}
FieldDetails
{
"xml": {
"name": "field"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the field."
},
"key": {
"type": "string",
"description": "The key of the field."
},
"name": {
"type": "string",
"description": "The name of the field."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"custom": {
"type": "boolean",
"description": "Whether the field is a custom field."
},
"schema": {
"$ref": "#/components/schemas/JsonTypeBean"
},
"navigable": {
"type": "boolean",
"description": "Whether the field can be used as a column on the issue navigator."
},
"orderable": {
"type": "boolean",
"description": "Whether the content of the field can be used to order lists."
},
"searchable": {
"type": "boolean",
"description": "Whether the content of the field can be searched."
},
"clauseNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).",
"uniqueItems": true
}
},
"description": "Details about a field.",
"x-konfig-properties": {
"scope": {
"description": "The scope of the field."
},
"schema": {
"description": "The data schema for the field."
}
}
}
FieldLastUsed
{
"type": "object",
"properties": {
"type": {
"enum": [
"TRACKED",
"NOT_TRACKED",
"NO_INFORMATION"
],
"type": "string",
"description": "Last used value type:\n\n * *TRACKED*: field is tracked and a last used date is available.\n * *NOT\\_TRACKED*: field is not tracked, last used date is not available.\n * *NO\\_INFORMATION*: field is tracked, but no last used date is available."
},
"value": {
"type": "string",
"format": "date-time",
"description": "The date when the value of the field last changed."
}
},
"description": "Information about the most recent use of a field."
}
FieldMetadata
{
"xml": {
"name": "availableField"
},
"type": "object",
"required": [
"key",
"name",
"operations",
"required",
"schema"
],
"properties": {
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the field."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the field."
},
"schema": {
"$ref": "#/components/schemas/JsonTypeBean"
},
"required": {
"type": "boolean",
"readOnly": true,
"description": "Whether the field is required."
},
"operations": {
"type": "array",
"items": {
"type": "string",
"readOnly": true
},
"readOnly": true,
"description": "The list of operations that can be performed on the field."
},
"defaultValue": {
"readOnly": true,
"description": "The default value of the field."
},
"allowedValues": {
"type": "array",
"items": {
"readOnly": true
},
"readOnly": true,
"description": "The list of values allowed in the field."
},
"configuration": {
"type": "object",
"readOnly": true,
"description": "The configuration properties.",
"additionalProperties": {
"readOnly": true
}
},
"autoCompleteUrl": {
"type": "string",
"readOnly": true,
"description": "The URL that can be used to automatically complete the field."
},
"hasDefaultValue": {
"type": "boolean",
"readOnly": true,
"description": "Whether the field has a default value."
}
},
"description": "The metadata describing an issue field.",
"x-konfig-properties": {
"schema": {
"readOnly": true,
"description": "The data type of the field."
}
}
}
FieldReferenceData
{
"type": "object",
"properties": {
"auto": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether the field provide auto-complete suggestions."
},
"cfid": {
"type": "string",
"description": "If the item is a custom field, the ID of the custom field."
},
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "The data types of items in the field."
},
"value": {
"type": "string",
"description": "The field identifier."
},
"operators": {
"type": "array",
"items": {
"type": "string"
},
"description": "The valid search operators for the field."
},
"orderable": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether the field can be used in a query's `ORDER BY` clause."
},
"deprecated": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether this field has been deprecated."
},
"searchable": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether the content of this field can be searched."
},
"displayName": {
"type": "string",
"description": "The display name contains the following:\n\n * for system fields, the field name. For example, `Summary`.\n * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`.\n * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`."
},
"deprecatedSearcherKey": {
"type": "string",
"description": "The searcher key of the field, only passed when the field is deprecated."
}
},
"description": "Details of a field that can be used in advanced searches."
}
FieldUpdateOperation
{
"type": "object",
"properties": {
"add": {
"example": "triaged",
"description": "The value to add to the field."
},
"set": {
"example": "A new summary",
"description": "The value to set in the field."
},
"copy": {
"example": {
"issuelinks": {
"sourceIssues": [
{
"key": "FP-5"
}
]
}
},
"description": "The field value to copy from another issue."
},
"edit": {
"example": {
"originalEstimate": "1w 1d",
"remainingEstimate": "4d"
},
"description": "The value to edit in the field."
},
"remove": {
"example": "blocker",
"description": "The value to removed from the field."
}
},
"description": "Details of an operation to perform on a field."
}
FieldValueClause
{
"type": "object",
"required": [
"field",
"operand",
"operator"
],
"properties": {
"field": {
"$ref": "#/components/schemas/JqlQueryField"
},
"operand": {
"$ref": "#/components/schemas/JqlQueryClauseOperand"
},
"operator": {
"enum": [
"=",
"!=",
">",
"<",
">=",
"<=",
"in",
"not in",
"~",
"~=",
"is",
"is not"
],
"type": "string",
"description": "The operator between the field and operand."
}
},
"description": "A clause that asserts the current value of a field. For example, `summary ~ test`."
}
FieldWasClause
{
"type": "object",
"required": [
"field",
"operand",
"operator",
"predicates"
],
"properties": {
"field": {
"$ref": "#/components/schemas/JqlQueryField"
},
"operand": {
"$ref": "#/components/schemas/JqlQueryClauseOperand"
},
"operator": {
"enum": [
"was",
"was in",
"was not in",
"was not"
],
"type": "string",
"description": "The operator between the field and operand."
},
"predicates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryClauseTimePredicate"
},
"description": "The list of time predicates."
}
},
"description": "A clause that asserts a previous value of a field. For example, `status WAS \"Resolved\" BY currentUser() BEFORE \"2019/02/02\"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for more information about the WAS operator."
}
Fields
{
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/StatusDetails"
},
"summary": {
"type": "string",
"readOnly": true,
"description": "The summary description of the linked issue."
},
"assignee": {
"$ref": "#/components/schemas/UserDetails"
},
"priority": {
"$ref": "#/components/schemas/Priority"
},
"issueType": {
"$ref": "#/components/schemas/IssueTypeDetails"
},
"issuetype": {
"$ref": "#/components/schemas/IssueTypeDetails",
"description": "The type of the linked issue."
},
"timetracking": {
"$ref": "#/components/schemas/TimeTrackingDetails"
}
},
"description": "Key fields from the linked issue.",
"x-konfig-properties": {
"status": {
"readOnly": true,
"description": "The status of the linked issue."
},
"assignee": {
"readOnly": true,
"description": "The assignee of the linked issue."
},
"priority": {
"readOnly": true,
"description": "The priority of the linked issue."
},
"issueType": {
"readOnly": true,
"description": "The type of the linked issue."
},
"timetracking": {
"readOnly": true,
"description": "The time tracking of the linked issue."
}
}
}
Filter
{
"xml": {
"name": "filter"
},
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The unique identifier for the filter."
},
"jql": {
"type": "string",
"description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
},
"name": {
"type": "string",
"description": "The name of the filter. Must be unique."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the filter."
},
"owner": {
"$ref": "#/components/schemas/User"
},
"viewUrl": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*."
},
"favourite": {
"type": "boolean",
"description": "Whether the filter is selected as a favorite."
},
"searchUrl": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](https://dac-static.atlassian.com) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*."
},
"description": {
"type": "string",
"description": "A description of the filter."
},
"sharedUsers": {
"$ref": "#/components/schemas/UserList"
},
"subscriptions": {
"$ref": "#/components/schemas/FilterSubscriptionsList"
},
"editPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The groups and projects that can edit the filter."
},
"favouritedCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The count of how many users have selected this filter as a favorite, including the filter owner."
},
"sharePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The groups and projects that the filter is shared with."
},
"approximateLastUsed": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "\\[Experimental\\] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate."
}
},
"description": "Details about a filter.",
"x-konfig-properties": {
"owner": {
"readOnly": true,
"description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings."
},
"sharedUsers": {
"readOnly": true,
"description": "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with."
},
"subscriptions": {
"readOnly": true,
"description": "A paginated list of the users that are subscribed to the filter."
}
}
}
FilterDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The unique identifier for the filter."
},
"jql": {
"type": "string",
"readOnly": true,
"description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
},
"name": {
"type": "string",
"description": "The name of the filter."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the filter."
},
"owner": {
"$ref": "#/components/schemas/User"
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional filter details in the response."
},
"viewUrl": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*."
},
"favourite": {
"type": "boolean",
"readOnly": true,
"description": "Whether the filter is selected as a favorite by any users, not including the filter owner."
},
"searchUrl": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](https://dac-static.atlassian.com) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*."
},
"description": {
"type": "string",
"description": "The description of the filter."
},
"subscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterSubscription"
},
"readOnly": true,
"description": "The users that are subscribed to the filter."
},
"editPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter."
},
"favouritedCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The count of how many users have selected this filter as a favorite, including the filter owner."
},
"sharePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter."
},
"approximateLastUsed": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "\\[Experimental\\] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate."
}
},
"description": "Details of a filter.",
"x-konfig-properties": {
"owner": {
"readOnly": true,
"description": "The user who owns the filter. Defaults to the creator of the filter, however, Jira administrators can change the owner of a shared filter in the admin settings."
}
}
}
FilterSubscription
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the filter subscription."
},
"user": {
"$ref": "#/components/schemas/User"
},
"group": {
"$ref": "#/components/schemas/GroupName"
}
},
"description": "Details of a user or group subscribing to a filter.",
"x-konfig-properties": {
"user": {
"readOnly": true,
"description": "The user subscribing to filter."
},
"group": {
"readOnly": true,
"description": "The group subscribing to filter."
}
}
}
FilterSubscriptionsList
{
"type": "object",
"properties": {
"size": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of items on the page."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterSubscription"
},
"readOnly": true,
"description": "The list of items."
},
"end-index": {
"xml": {
"name": "end-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the last item returned on the page."
},
"max-results": {
"xml": {
"name": "max-results",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
},
"start-index": {
"xml": {
"name": "start-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
}
},
"description": "A paginated list of subscriptions to a filter."
}
FoundGroup
{
"xml": {
"name": "group"
},
"type": "object",
"properties": {
"html": {
"type": "string",
"description": "The group name with the matched query string highlighted with the HTML bold tag."
},
"name": {
"type": "string",
"description": "The name of the group. The name of a group is mutable, to reliably identify a group use ``groupId`.`"
},
"labels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupLabel"
}
},
"groupId": {
"type": "string",
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*."
}
},
"description": "A group found in a search."
}
FoundGroups
{
"xml": {
"name": "groupsuggestions"
},
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"description": "The total number of groups found in the search."
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FoundGroup"
}
},
"header": {
"type": "string",
"description": "Header text indicating the number of groups in the response and the total number of groups found in the search."
}
},
"description": "The list of groups found in a search, including header text (Showing X of Y matching groups) and total of matched groups."
}
FoundUsers
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"description": "The total number of users found in the search."
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserPickerUser"
}
},
"header": {
"type": "string",
"description": "Header text indicating the number of users in the response and the total number of users found in the search."
}
},
"description": "The list of users found in a search, including header text (Showing X of Y matching users) and total of matched users."
}
FoundUsersAndGroups
{
"type": "object",
"properties": {
"users": {
"$ref": "#/components/schemas/FoundUsers"
},
"groups": {
"$ref": "#/components/schemas/FoundGroups"
}
},
"description": "List of users and groups found in a search."
}
FunctionOperand
{
"type": "object",
"required": [
"arguments",
"function"
],
"properties": {
"function": {
"type": "string",
"description": "The name of the function."
},
"arguments": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of function arguments."
},
"encodedOperand": {
"type": "string",
"description": "Encoded operand, which can be used directly in a JQL query."
}
},
"description": "An operand that is a function. See [Advanced searching - functions reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions."
}
FunctionReferenceData
{
"type": "object",
"properties": {
"types": {
"type": "array",
"items": {
"type": "string"
},
"description": "The data types returned by the function."
},
"value": {
"type": "string",
"description": "The function identifier."
},
"isList": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether the function can take a list of arguments."
},
"displayName": {
"type": "string",
"description": "The display name of the function."
},
"supportsListAndSingleValueOperators": {
"enum": [
"true",
"false"
],
"type": "string",
"description": "Whether the function supports both single and list value operators."
}
},
"description": "Details of functions that can be used in advanced searches."
}
GlobalScopeBean
{
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"enum": [
"notSelectable",
"defaultValue"
],
"type": "string"
},
"description": "Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.",
"uniqueItems": true
}
}
}
Group
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of group."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL for these group details."
},
"users": {
"$ref": "#/components/schemas/PagedListUserDetailsApplicationUser"
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional group details in the response."
},
"groupId": {
"type": "string",
"nullable": true,
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*."
}
},
"x-konfig-properties": {
"users": {
"readOnly": true,
"description": "A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`."
}
}
}
GroupDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the group."
},
"groupId": {
"type": "string",
"nullable": true,
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*."
}
},
"description": "Details about a group."
}
GroupLabel
{
"xml": {
"name": "grouplabel"
},
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The group label name."
},
"type": {
"enum": [
"ADMIN",
"SINGLE",
"MULTIPLE"
],
"type": "string",
"description": "The type of the group label."
},
"title": {
"type": "string",
"description": "The title of the group label."
}
},
"description": "A group label."
}
GroupName
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of group."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL for these group details."
},
"groupId": {
"type": "string",
"nullable": true,
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*."
}
},
"description": "Details about a group."
}
HealthCheckResult
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Jira health check item."
},
"passed": {
"type": "boolean",
"description": "Whether the Jira health check item passed or failed."
},
"description": {
"type": "string",
"description": "The description of the Jira health check item."
}
},
"description": "Jira instance health check results. Deprecated and no longer returned."
}
Hierarchy
{
"xml": {
"name": "hierarchy"
},
"type": "object",
"properties": {
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimplifiedHierarchyLevel"
},
"readOnly": true,
"description": "Details about the hierarchy level."
},
"baseLevelId": {
"type": "integer",
"format": "int64",
"description": "The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
}
},
"description": "The project issue type hierarchy."
}
HistoryMetadata
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of the history record."
},
"actor": {
"$ref": "#/components/schemas/HistoryMetadataParticipant"
},
"cause": {
"$ref": "#/components/schemas/HistoryMetadataParticipant"
},
"extraData": {
"type": "object",
"description": "Additional arbitrary information about the history record.",
"additionalProperties": {
"type": "string"
}
},
"generator": {
"$ref": "#/components/schemas/HistoryMetadataParticipant"
},
"description": {
"type": "string",
"description": "The description of the history record."
},
"descriptionKey": {
"type": "string",
"description": "The description key of the history record."
},
"emailDescription": {
"type": "string",
"description": "The description of the email address associated the history record."
},
"activityDescription": {
"type": "string",
"description": "The activity described in the history record."
},
"emailDescriptionKey": {
"type": "string",
"description": "The description key of the email address associated the history record."
},
"activityDescriptionKey": {
"type": "string",
"description": "The key of the activity described in the history record."
}
},
"description": "Details of issue history metadata.",
"x-konfig-properties": {
"actor": {
"description": "Details of the user whose action created the history record."
},
"cause": {
"description": "Details of the cause that triggered the creation the history record."
},
"generator": {
"description": "Details of the system that generated the history record."
}
},
"additionalProperties": true
}
HistoryMetadataParticipant
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the user or system associated with a history record."
},
"url": {
"type": "string",
"description": "The URL of the user or system associated with a history record."
},
"type": {
"type": "string",
"description": "The type of the user or system associated with a history record."
},
"avatarUrl": {
"type": "string",
"description": "The URL to an avatar for the user or system associated with a history record."
},
"displayName": {
"type": "string",
"description": "The display name of the user or system associated with a history record."
},
"displayNameKey": {
"type": "string",
"description": "The key of the display name of the user or system associated with a history record."
}
},
"description": "Details of user or system associated with a issue history metadata item.",
"additionalProperties": true
}
Icon
{
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable."
},
"title": {
"type": "string",
"description": "The title of the icon. This is used as follows:\n\n * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira.\n * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format \"\\[application name\\] icon title\". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as \"Web Link\"."
},
"url16x16": {
"type": "string",
"description": "The URL of an icon that displays at 16x16 pixel in Jira."
}
},
"description": "An icon. If no icon is defined:\n\n * for a status icon, no status icon displays in Jira.\n * for the remote object icon, the default link icon displays in Jira.",
"additionalProperties": true
}
IconBean
{
"xml": {
"name": "icon"
},
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "The URL of the tooltip, used only for a status icon."
},
"title": {
"type": "string",
"description": "The title of the icon, for use as a tooltip on the icon."
},
"url16x16": {
"type": "string",
"description": "The URL of a 16x16 pixel icon."
}
},
"description": "An icon."
}
IdBean
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the permission scheme to associate with the project. Use the [Get all permission schemes](https://dac-static.atlassian.com) resource to get a list of permission scheme IDs."
}
}
}
IdOrKeyBean
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the referenced item."
},
"key": {
"type": "string",
"description": "The key of the referenced item."
}
}
}
IdSearchRequestBean
{
"type": "object",
"properties": {
"jql": {
"type": "string",
"description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. Order by clauses are not allowed."
},
"maxResults": {
"type": "integer",
"format": "int32",
"default": 1000,
"description": "The maximum number of items to return per page."
},
"nextPageToken": {
"type": "string",
"description": "The continuation token to fetch the next page. This token is provided by the response of this endpoint."
}
}
}
IdSearchResults
{
"type": "object",
"properties": {
"issueIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"readOnly": true,
"description": "The list of issue IDs found by the search."
},
"nextPageToken": {
"type": "string",
"readOnly": true,
"description": "Continuation token to fetch the next page. If this result represents the last or the only page this token will be null."
}
},
"description": "Result of your JQL search. Returns a list of issue IDs and a token to fetch the next page if one exists."
}
IncludedFields
{
"type": "object",
"properties": {
"excluded": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"included": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"actuallyIncluded": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
}
InputStreamSource
{
"type": "object",
"properties": {
"inputStream": {
"type": "object"
}
}
}
IssueArchivalSyncRequest
{
"type": "object",
"properties": {
"issueIdsOrKeys": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "List of Issue Ids Or Keys that are to be archived or unarchived"
}
IssueArchivalSyncResponse
{
"type": "object",
"properties": {
"errors": {
"$ref": "#/components/schemas/Errors"
},
"numberOfIssuesUpdated": {
"type": "integer",
"format": "int64"
}
},
"description": "Number of archived/unarchived issues and list of errors that occurred during the action, if any."
}
IssueBean
{
"xml": {
"name": "issue"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the issue."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the issue details."
},
"names": {
"type": "object",
"readOnly": true,
"description": "The ID and name of each field present on the issue.",
"additionalProperties": {
"type": "string",
"readOnly": true
}
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional issue details in the response."
},
"fields": {
"type": "object",
"additionalProperties": {}
},
"schema": {
"type": "object",
"readOnly": true,
"description": "The schema describing each field present on the issue.",
"additionalProperties": {
"$ref": "#/components/schemas/JsonTypeBean"
}
},
"editmeta": {
"$ref": "#/components/schemas/IssueUpdateMetadata"
},
"changelog": {
"$ref": "#/components/schemas/PageOfChangelogs"
},
"operations": {
"$ref": "#/components/schemas/Operations"
},
"properties": {
"type": "object",
"readOnly": true,
"description": "Details of the issue properties identified in the request.",
"additionalProperties": {
"readOnly": true
}
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTransition"
},
"readOnly": true,
"description": "The transitions that can be performed on the issue."
},
"renderedFields": {
"type": "object",
"readOnly": true,
"description": "The rendered value of each field present on the issue.",
"additionalProperties": {
"readOnly": true
}
},
"fieldsToInclude": {
"$ref": "#/components/schemas/IncludedFields"
},
"versionedRepresentations": {
"type": "object",
"readOnly": true,
"description": "The versions of each field on the issue.",
"additionalProperties": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"readOnly": true
}
}
}
},
"description": "Details about an issue.",
"x-konfig-properties": {
"editmeta": {
"readOnly": true,
"description": "The metadata for the fields on the issue that can be amended."
},
"changelog": {
"readOnly": true,
"description": "Details of changelogs associated with the issue."
},
"operations": {
"readOnly": true,
"description": "The operations that can be performed on the issue."
}
}
}
IssueChangelogIds
{
"type": "object",
"required": [
"changelogIds"
],
"properties": {
"changelogIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of changelog IDs.",
"uniqueItems": true
}
},
"description": "A list of changelog IDs."
}
IssueCommentListRequestBean
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of comment IDs. A maximum of 1000 IDs can be specified.",
"uniqueItems": true
}
}
}
IssueContextVariable
{
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The issue ID."
},
"key": {
"type": "string",
"description": "The issue key."
},
"type": {
"type": "string",
"description": "Type of custom context variable."
}
},
"description": "An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression."
}
IssueCreateMetadata
{
"type": "object",
"properties": {
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional project details in the response."
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueCreateMetadata"
},
"readOnly": true,
"description": "List of projects and their issue creation metadata."
}
},
"description": "The wrapper for the issue creation metadata for a list of projects."
}
IssueEntityProperties
{
"type": "object",
"properties": {
"properties": {
"type": "object",
"description": "A list of entity property keys and values.",
"maxProperties": 10,
"minProperties": 1,
"additionalProperties": {
"$ref": "#/components/schemas/JsonNode"
}
},
"entitiesIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"maxItems": 10000,
"minItems": 1,
"description": "A list of entity property IDs.",
"uniqueItems": true
}
},
"description": "Lists of issues and entity properties. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more information."
}
IssueEntityPropertiesForMultiUpdate
{
"type": "object",
"properties": {
"issueID": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue."
},
"properties": {
"type": "object",
"description": "Entity properties to set on the issue. The maximum length of an issue property value is 32768 characters.",
"maxProperties": 10,
"minProperties": 1,
"additionalProperties": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"description": "An issue ID with entity property values. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more information.",
"maxProperties": 100,
"minProperties": 1
}
IssueEvent
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the event."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the event."
}
},
"description": "Details about an issue event."
}
IssueFieldOption
{
"type": "object",
"required": [
"id",
"value"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the option. This is only unique within the select field's set of options."
},
"value": {
"type": "string",
"description": "The option's name, which is displayed in Jira."
},
"config": {
"$ref": "#/components/schemas/IssueFieldOptionConfiguration"
},
"properties": {
"type": "object",
"description": "The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see [Issue Field Option Property Index](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/)) are defined in the descriptor for the issue field module.",
"additionalProperties": {}
}
},
"description": "Details of the options for a select list issue field."
}
IssueFieldOptionConfiguration
{
"type": "object",
"properties": {
"scope": {
"$ref": "#/components/schemas/IssueFieldOptionScopeBean"
},
"attributes": {
"type": "array",
"items": {
"enum": [
"notSelectable",
"defaultValue"
],
"type": "string"
},
"description": "DEPRECATED",
"uniqueItems": true
}
},
"description": "Details of the projects the option is available in.",
"x-konfig-properties": {
"scope": {
"description": "Defines the projects that the option is available in. If the scope is not defined, then the option is available in all projects."
}
}
}
IssueFieldOptionCreateBean
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The option's name, which is displayed in Jira."
},
"config": {
"$ref": "#/components/schemas/IssueFieldOptionConfiguration"
},
"properties": {
"type": "object",
"description": "The properties of the option as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see https://developer.atlassian.com/cloud/jira/platform/modules/issue-field-option-property-index/) are defined in the descriptor for the issue field module.",
"additionalProperties": {}
}
},
"additionalProperties": true
}
IssueFieldOptionScopeBean
{
"type": "object",
"properties": {
"global": {
"$ref": "#/components/schemas/GlobalScopeBean"
},
"projects": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "DEPRECATED",
"uniqueItems": true
},
"projects2": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectScopeBean"
},
"description": "Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.",
"uniqueItems": true
}
},
"x-konfig-properties": {
"global": {
"description": "Defines the behavior of the option within the global context. If this property is set, even if set to an empty object, then the option is available in all projects."
}
}
}
IssueFilterForBulkPropertyDelete
{
"type": "object",
"properties": {
"entityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of issues to perform the bulk delete operation on.",
"uniqueItems": true
},
"currentValue": {
"description": "The value of properties to perform the bulk operation on."
}
},
"description": "Bulk operation filter details."
}
IssueFilterForBulkPropertySet
{
"type": "object",
"properties": {
"entityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of issues to perform the bulk operation on.",
"uniqueItems": true
},
"hasProperty": {
"type": "boolean",
"description": "Whether the bulk operation occurs only when the property is present on or absent from an issue."
},
"currentValue": {
"description": "The value of properties to perform the bulk operation on."
}
},
"description": "Bulk operation filter details."
}
IssueLimitReportRequest
{
"type": "object",
"properties": {
"issuesApproachingLimitParams": {
"type": "object",
"description": "A list of fields and their respective approaching limit threshold. Required for querying issues approaching limits. Optional for querying issues breaching limits. For example: \"issuesApproachingLimitParams\": \\{\"comment\": 4500\\}",
"additionalProperties": {
"type": "integer",
"format": "int32"
}
}
}
}
IssueLimitReportResponseBean
{
"type": "object",
"properties": {
"limits": {
"type": "object",
"description": "The fields and their defined limits",
"additionalProperties": {
"type": "integer",
"format": "int32"
}
},
"issuesBreachingLimit": {
"type": "object",
"description": "A list of ids of issues breaching the limit and their field count",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
},
"issuesApproachingLimit": {
"type": "object",
"description": "A list of ids of issues approaching the limit and their field count",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
}
}
IssueLink
{
"xml": {
"name": "issueLinks"
},
"type": "object",
"required": [
"inwardIssue",
"outwardIssue",
"type"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue link."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the issue link."
},
"type": {
"$ref": "#/components/schemas/IssueLinkType"
},
"inwardIssue": {
"$ref": "#/components/schemas/LinkedIssue"
},
"outwardIssue": {
"$ref": "#/components/schemas/LinkedIssue"
}
},
"description": "Details of a link between issues.",
"x-konfig-properties": {
"type": {
"description": "The type of link between the issues."
},
"inwardIssue": {
"description": "Provides details about the linked issue. If presenting this link in a user interface, use the `inward` field of the issue link type to label the link."
},
"outwardIssue": {
"description": "Provides details about the linked issue. If presenting this link in a user interface, use the `outward` field of the issue link type to label the link."
}
}
}
IssueLinkType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue link type and is used as follows:\n\n * In the [issueLink](https://dac-static.atlassian.com) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only.\n * In the [issueLinkType](https://dac-static.atlassian.com) resource it is read only."
},
"name": {
"type": "string",
"description": "The name of the issue link type and is used as follows:\n\n * In the [issueLink](https://dac-static.atlassian.com) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only.\n * In the [issueLinkType](https://dac-static.atlassian.com) resource it is required on create and optional on update. Otherwise, read only."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the issue link type. Read only."
},
"inward": {
"type": "string",
"description": "The description of the issue link type inward link and is used as follows:\n\n * In the [issueLink](https://dac-static.atlassian.com) resource it is read only.\n * In the [issueLinkType](https://dac-static.atlassian.com) resource it is required on create and optional on update. Otherwise, read only."
},
"outward": {
"type": "string",
"description": "The description of the issue link type outward link and is used as follows:\n\n * In the [issueLink](https://dac-static.atlassian.com) resource it is read only.\n * In the [issueLinkType](https://dac-static.atlassian.com) resource it is required on create and optional on update. Otherwise, read only."
}
},
"description": "This object is used as follows:\n\n * In the [issueLink](https://dac-static.atlassian.com) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](https://dac-static.atlassian.com).\n * In the [issueLinkType](https://dac-static.atlassian.com) resource it defines and reports on issue link types."
}
IssueLinkTypes
{
"xml": {
"name": "issueLinkTypes"
},
"type": "object",
"properties": {
"issueLinkTypes": {
"xml": {
"name": "issueLinkTypes"
},
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueLinkType"
},
"readOnly": true,
"description": "The issue link type bean."
}
},
"description": "A list of issue link type beans."
}
IssueList
{
"type": "object",
"required": [
"issueIds"
],
"properties": {
"issueIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of issue IDs."
}
},
"description": "A list of issue IDs."
}
IssueMatches
{
"type": "object",
"required": [
"matches"
],
"properties": {
"matches": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueMatchesForJQL"
}
}
},
"description": "A list of matched issues or errors for each JQL query, in the order the JQL queries were passed."
}
IssueMatchesForJQL
{
"type": "object",
"required": [
"errors",
"matchedIssues"
],
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"description": "A list of errors."
},
"description": "A list of errors.",
"uniqueItems": true
},
"matchedIssues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": "A list of issue IDs."
},
"description": "A list of issue IDs.",
"uniqueItems": true
}
},
"description": "A list of the issues matched to a JQL query or details of errors encountered during matching."
}
IssuePickerSuggestions
{
"type": "object",
"properties": {
"sections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssuePickerSuggestionsIssueType"
},
"readOnly": true,
"description": "A list of issues for an issue type suggested for use in auto-completion."
}
},
"description": "A list of issues suggested for use in auto-completion."
}
IssuePickerSuggestionsIssueType
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the type of issues suggested for use in auto-completion."
},
"msg": {
"type": "string",
"readOnly": true,
"description": "If no issue suggestions are found, returns a message indicating no suggestions were found,"
},
"sub": {
"type": "string",
"readOnly": true,
"description": "If issue suggestions are found, returns a message indicating the number of issues suggestions found and returned."
},
"label": {
"type": "string",
"readOnly": true,
"description": "The label of the type of issues suggested for use in auto-completion."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SuggestedIssue"
},
"readOnly": true,
"description": "A list of issues suggested for use in auto-completion."
}
},
"description": "A type of issue suggested for use in auto-completion."
}
IssueSecurityLevelMember
{
"type": "object",
"required": [
"holder",
"id",
"issueSecurityLevelId"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue security level member."
},
"holder": {
"$ref": "#/components/schemas/PermissionHolder"
},
"managed": {
"type": "boolean",
"writeOnly": true
},
"issueSecurityLevelId": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue security level."
}
},
"description": "Issue security level member.",
"x-konfig-properties": {
"holder": {
"description": "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information."
}
}
}
IssueSecuritySchemeToProjectMapping
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"readOnly": true
},
"issueSecuritySchemeId": {
"type": "string",
"readOnly": true
}
},
"description": "Details about an project using security scheme mapping.",
"additionalProperties": true
}
IssueTransition
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue transition. Required when specifying a transition to undertake."
},
"to": {
"$ref": "#/components/schemas/StatusDetails"
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue transition."
},
"expand": {
"type": "string",
"readOnly": true,
"description": "Expand options that include additional transition details in the response."
},
"fields": {
"type": "object",
"readOnly": true,
"description": "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
"additionalProperties": {
"$ref": "#/components/schemas/FieldMetadata"
}
},
"looped": {
"type": "boolean"
},
"isGlobal": {
"type": "boolean",
"readOnly": true,
"description": "Whether the issue transition is global, that is, the transition is applied to issues regardless of their status."
},
"hasScreen": {
"type": "boolean",
"readOnly": true,
"description": "Whether there is a screen associated with the issue transition."
},
"isInitial": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the initial issue transition for the workflow."
},
"isAvailable": {
"type": "boolean",
"readOnly": true,
"description": "Whether the transition is available to be performed."
},
"isConditional": {
"type": "boolean",
"readOnly": true,
"description": "Whether the issue has to meet criteria before the issue transition is applied."
}
},
"description": "Details of an issue transition.",
"x-konfig-properties": {
"to": {
"readOnly": true,
"description": "Details of the issue status after the transition."
}
},
"additionalProperties": true
}
IssueTypeCreateBean
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The unique name for the issue type. The maximum length is 60 characters."
},
"type": {
"enum": [
"subtask",
"standard"
],
"type": "string",
"description": "Deprecated. Use `hierarchyLevel` instead. See the [deprecation notice](https://community.developer.atlassian.com/t/deprecation-of-the-epic-link-parent-link-and-other-related-fields-in-rest-apis-and-webhooks/54048) for details.\n\nWhether the issue type is `subtype` or `standard`. Defaults to `standard`."
},
"description": {
"type": "string",
"description": "The description of the issue type."
},
"hierarchyLevel": {
"type": "integer",
"format": "int32",
"description": "The hierarchy level of the issue type. Use:\n\n * `-1` for Subtask.\n * `0` for Base.\n\nDefaults to `0`."
}
}
}
IssueTypeDetails
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue type."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue type."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of these issue type details."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"iconUrl": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue type's avatar."
},
"subtask": {
"type": "boolean",
"readOnly": true,
"description": "Whether this issue type is used to create subtasks."
},
"avatarId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue type's avatar."
},
"entityId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "Unique ID for next-gen projects."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the issue type."
},
"hierarchyLevel": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "Hierarchy level of the issue type."
}
},
"description": "Details about an issue type.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "Details of the next-gen projects the issue type is available in."
}
}
}
IssueTypeIds
{
"type": "object",
"required": [
"issueTypeIds"
],
"properties": {
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of issue type IDs."
}
},
"description": "The list of issue type IDs."
}
IssueTypeIdsToRemove
{
"type": "object",
"required": [
"issueTypeIds"
],
"properties": {
"issueTypeIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of issue type IDs. Must contain unique values not longer than 255 characters and not be empty. Maximum of 100 IDs."
}
},
"description": "The list of issue type IDs to be removed from the field configuration scheme."
}
IssueTypeInfo
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue type."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue type."
},
"avatarId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The avatar of the issue type."
}
},
"description": "Details of an issue type."
}
IssueTypeIssueCreateMetadata
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue type."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue type."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of these issue type details."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional issue type metadata details in the response."
},
"fields": {
"type": "object",
"readOnly": true,
"description": "List of the fields available when creating an issue for the issue type.",
"additionalProperties": {
"$ref": "#/components/schemas/FieldMetadata"
}
},
"iconUrl": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue type's avatar."
},
"subtask": {
"type": "boolean",
"readOnly": true,
"description": "Whether this issue type is used to create subtasks."
},
"avatarId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue type's avatar."
},
"entityId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "Unique ID for next-gen projects."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the issue type."
},
"hierarchyLevel": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "Hierarchy level of the issue type."
}
},
"description": "Details of the issue creation metadata for an issue type.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "Details of the next-gen projects the issue type is available in."
}
}
}
IssueTypeScheme
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue type scheme."
},
"name": {
"type": "string",
"description": "The name of the issue type scheme."
},
"isDefault": {
"type": "boolean",
"description": "Whether the issue type scheme is the default."
},
"description": {
"type": "string",
"description": "The description of the issue type scheme."
},
"defaultIssueTypeId": {
"type": "string",
"description": "The ID of the default issue type of the issue type scheme."
}
},
"description": "Details of an issue type scheme."
}
IssueTypeSchemeDetails
{
"type": "object",
"required": [
"issueTypeIds",
"name"
],
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the issue type scheme. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the issue type scheme. The maximum length is 4000 characters."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of issue types IDs of the issue type scheme. At least one standard issue type ID is required."
},
"defaultIssueTypeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the default issue type of the issue type scheme. This ID must be included in `issueTypeIds`."
}
},
"description": "Details of an issue type scheme and its associated issue types."
}
IssueTypeSchemeID
{
"type": "object",
"required": [
"issueTypeSchemeId"
],
"properties": {
"issueTypeSchemeId": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue type scheme."
}
},
"description": "The ID of an issue type scheme."
}
IssueTypeSchemeMapping
{
"type": "object",
"required": [
"issueTypeId",
"issueTypeSchemeId"
],
"properties": {
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
},
"issueTypeSchemeId": {
"type": "string",
"description": "The ID of the issue type scheme."
}
},
"description": "Issue type scheme item."
}
IssueTypeSchemeProjectAssociation
{
"type": "object",
"required": [
"issueTypeSchemeId",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the project."
},
"issueTypeSchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type scheme."
}
},
"description": "Details of the association between an issue type scheme and project."
}
IssueTypeSchemeProjects
{
"type": "object",
"required": [
"issueTypeScheme",
"projectIds"
],
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the projects using the issue type scheme."
},
"issueTypeScheme": {
"$ref": "#/components/schemas/IssueTypeScheme"
}
},
"description": "Issue type scheme with a list of the projects that use it.",
"x-konfig-properties": {
"issueTypeScheme": {
"description": "Details of an issue type scheme."
}
}
}
IssueTypeSchemeUpdateDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the issue type scheme. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the issue type scheme. The maximum length is 4000 characters."
},
"defaultIssueTypeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the default issue type of the issue type scheme."
}
},
"description": "Details of the name, description, and default issue type for an issue type scheme."
}
IssueTypeScreenScheme
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue type screen scheme."
},
"name": {
"type": "string",
"description": "The name of the issue type screen scheme."
},
"description": {
"type": "string",
"description": "The description of the issue type screen scheme."
}
},
"description": "Details of an issue type screen scheme."
}
IssueTypeScreenSchemeDetails
{
"type": "object",
"required": [
"issueTypeMappings",
"name"
],
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the issue type screen scheme. The maximum length is 255 characters."
},
"issueTypeMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScreenSchemeMapping"
},
"writeOnly": true,
"description": "The IDs of the screen schemes for the issue type IDs and *default*. A *default* entry is required to create an issue type screen scheme, it defines the mapping for all issue types without a screen scheme."
}
},
"description": "The details of an issue type screen scheme."
}
IssueTypeScreenSchemeId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue type screen scheme."
}
},
"description": "The ID of an issue type screen scheme."
}
IssueTypeScreenSchemeItem
{
"type": "object",
"required": [
"issueTypeId",
"issueTypeScreenSchemeId",
"screenSchemeId"
],
"properties": {
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type or *default*. Only issue types used in classic projects are accepted. When creating an issue screen scheme, an entry for *default* must be provided and defines the mapping for all issue types without a screen scheme. Otherwise, a *default* entry can't be provided."
},
"screenSchemeId": {
"type": "string",
"description": "The ID of the screen scheme."
},
"issueTypeScreenSchemeId": {
"type": "string",
"description": "The ID of the issue type screen scheme."
}
},
"description": "The screen scheme for an issue type."
}
IssueTypeScreenSchemeMapping
{
"type": "object",
"required": [
"issueTypeId",
"screenSchemeId"
],
"writeOnly": true,
"properties": {
"issueTypeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type or *default*. Only issue types used in classic projects are accepted. An entry for *default* must be provided and defines the mapping for all issue types without a screen scheme."
},
"screenSchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the screen scheme. Only screen schemes used in classic projects are accepted."
}
},
"description": "The IDs of the screen schemes for the issue type IDs."
}
IssueTypeScreenSchemeMappingDetails
{
"type": "object",
"required": [
"issueTypeMappings"
],
"properties": {
"issueTypeMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScreenSchemeMapping"
},
"writeOnly": true,
"description": "The list of issue type to screen scheme mappings. A *default* entry cannot be specified because a default entry is added when an issue type screen scheme is created."
}
},
"description": "A list of issue type screen scheme mappings."
}
IssueTypeScreenSchemeProjectAssociation
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the project."
},
"issueTypeScreenSchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type screen scheme."
}
},
"description": "Associated issue type screen scheme and project."
}
IssueTypeScreenSchemeUpdateDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the issue type screen scheme. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the issue type screen scheme. The maximum length is 255 characters."
}
},
"description": "Details of an issue type screen scheme."
}
IssueTypeScreenSchemesProjects
{
"type": "object",
"required": [
"issueTypeScreenScheme",
"projectIds"
],
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of the projects using the issue type screen scheme."
},
"issueTypeScreenScheme": {
"$ref": "#/components/schemas/IssueTypeScreenScheme"
}
},
"description": "Issue type screen scheme with a list of the projects that use it.",
"x-konfig-properties": {
"issueTypeScreenScheme": {
"description": "Details of an issue type screen scheme."
}
}
}
IssueTypeToContextMapping
{
"type": "object",
"required": [
"contextId"
],
"properties": {
"contextId": {
"type": "string",
"description": "The ID of the context."
},
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
},
"isAnyIssueType": {
"type": "boolean",
"description": "Whether the context is mapped to any issue type."
}
},
"description": "Mapping of an issue type to a context."
}
IssueTypeUpdateBean
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The unique name for the issue type. The maximum length is 60 characters."
},
"avatarId": {
"type": "integer",
"format": "int64",
"description": "The ID of an issue type avatar."
},
"description": {
"type": "string",
"description": "The description of the issue type."
}
}
}
IssueTypeWithStatus
{
"type": "object",
"required": [
"id",
"name",
"self",
"statuses",
"subtask"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue type."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue type."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue type's status details."
},
"subtask": {
"type": "boolean",
"readOnly": true,
"description": "Whether this issue type represents subtasks."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusDetails"
},
"readOnly": true,
"description": "List of status details for the issue type."
}
},
"description": "Status details for an issue type."
}
IssueTypeWorkflowMapping
{
"type": "object",
"properties": {
"workflow": {
"type": "string",
"description": "The name of the workflow."
},
"issueType": {
"type": "string",
"description": "The ID of the issue type. Not required if updating the issue type-workflow mapping."
},
"updateDraftIfNeeded": {
"type": "boolean",
"description": "Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to `false`. Only applicable when updating the workflow-issue types mapping."
}
},
"description": "Details about the mapping between an issue type and a workflow."
}
IssueTypesWorkflowMapping
{
"type": "object",
"properties": {
"workflow": {
"type": "string",
"description": "The name of the workflow. Optional if updating the workflow-issue types mapping."
},
"issueTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of issue type IDs."
},
"defaultMapping": {
"type": "boolean",
"description": "Whether the workflow is the default workflow for the workflow scheme."
},
"updateDraftIfNeeded": {
"type": "boolean",
"description": "Whether a draft workflow scheme is created or updated when updating an active workflow scheme. The draft is updated with the new workflow-issue types mapping. Defaults to `false`."
}
},
"description": "Details about the mapping between issue types and a workflow."
}
IssueUpdateDetails
{
"type": "object",
"properties": {
"fields": {
"type": "object",
"description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`.",
"additionalProperties": {}
},
"update": {
"type": "object",
"description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`.",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldUpdateOperation"
}
}
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityProperty"
},
"description": "Details of issue properties to be add or update."
},
"transition": {
"$ref": "#/components/schemas/IssueTransition"
},
"historyMetadata": {
"$ref": "#/components/schemas/HistoryMetadata"
}
},
"description": "Details of an issue update request.",
"x-konfig-properties": {
"transition": {
"description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue."
},
"historyMetadata": {
"description": "Additional issue history details."
}
},
"additionalProperties": true
}
IssueUpdateMetadata
{
"type": "object",
"properties": {
"fields": {
"type": "object",
"readOnly": true,
"additionalProperties": {
"$ref": "#/components/schemas/FieldMetadata"
}
}
},
"description": "A list of editable field details."
}
IssuesAndJQLQueries
{
"type": "object",
"required": [
"issueIds",
"jqls"
],
"properties": {
"jqls": {
"type": "array",
"items": {
"type": "string",
"description": "A list of JQL queries."
},
"description": "A list of JQL queries."
},
"issueIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": "A list of issue IDs."
},
"description": "A list of issue IDs.",
"uniqueItems": true
}
},
"description": "List of issues and JQL queries."
}
IssuesJqlMetaDataBean
{
"type": "object",
"required": [
"count",
"maxResults",
"startAt",
"totalCount"
],
"properties": {
"count": {
"type": "integer",
"format": "int32",
"description": "The number of issues that were loaded in this evaluation."
},
"startAt": {
"type": "integer",
"format": "int64",
"description": "The index of the first issue."
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of issues that could be loaded in this evaluation."
},
"totalCount": {
"type": "integer",
"format": "int64",
"description": "The total number of issues the JQL returned."
},
"validationWarnings": {
"type": "array",
"items": {
"type": "string"
},
"description": "Any warnings related to the JQL query. Present only if the validation mode was set to `warn`."
}
},
"description": "The description of the page of issues loaded by the provided JQL query."
}
IssuesMetaBean
{
"type": "object",
"properties": {
"jql": {
"$ref": "#/components/schemas/IssuesJqlMetaDataBean"
}
},
"description": "Meta data describing the `issues` context variable."
}
IssuesUpdateBean
{
"type": "object",
"properties": {
"issueUpdates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueUpdateDetails"
}
}
},
"additionalProperties": true
}
JQLPersonalDataMigrationRequest
{
"type": "object",
"properties": {
"queryStrings": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of queries with user identifiers. Maximum of 100 queries."
}
},
"description": "The JQL queries to be converted."
}
JQLQueryWithUnknownUsers
{
"type": "object",
"properties": {
"originalQuery": {
"type": "string",
"description": "The original query, for reference"
},
"convertedQuery": {
"type": "string",
"description": "The converted query, with accountIDs instead of user identifiers, or 'unknown' for users that could not be found"
}
},
"description": "JQL queries that contained users that could not be found"
}
JQLReferenceData
{
"type": "object",
"properties": {
"jqlReservedWords": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of JQL query reserved words."
},
"visibleFieldNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldReferenceData"
},
"description": "List of fields usable in JQL queries."
},
"visibleFunctionNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FunctionReferenceData"
},
"description": "List of functions usable in JQL queries."
}
},
"description": "Lists of JQL reference data."
}
JexpIssues
{
"type": "object",
"properties": {
"jql": {
"$ref": "#/components/schemas/JexpJqlIssues"
}
},
"description": "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable.",
"x-konfig-properties": {
"jql": {
"description": "The JQL query that specifies the set of issues available in the Jira expression."
}
}
}
JexpJqlIssues
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "The JQL query."
},
"startAt": {
"type": "integer",
"format": "int64",
"description": "The index of the first issue to return from the JQL query."
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of issues to return from the JQL query. Inspect `meta.issues.jql.maxResults` in the response to ensure the maximum value has not been exceeded."
},
"validation": {
"enum": [
"strict",
"warn",
"none"
],
"type": "string",
"default": "strict",
"description": "Determines how to validate the JQL query and treat the validation results."
}
},
"description": "The JQL specifying the issues available in the evaluated Jira expression under the `issues` context variable. Not all issues returned by the JQL query are loaded, only those described by the `startAt` and `maxResults` properties. To determine whether it is necessary to iterate to ensure all the issues returned by the JQL query are evaluated, inspect `meta.issues.jql.count` in the response."
}
JiraExpressionAnalysis
{
"type": "object",
"required": [
"expression",
"valid"
],
"properties": {
"type": {
"type": "string",
"description": "EXPERIMENTAL. The inferred type of the expression."
},
"valid": {
"type": "boolean",
"description": "Whether the expression is valid and the interpreter will evaluate it. Note that the expression may fail at runtime (for example, if it executes too many expensive operations)."
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraExpressionValidationError"
},
"description": "A list of validation errors. Not included if the expression is valid."
},
"complexity": {
"$ref": "#/components/schemas/JiraExpressionComplexity"
},
"expression": {
"type": "string",
"description": "The analysed expression."
}
},
"description": "Details about the analysed Jira expression."
}
JiraExpressionComplexity
{
"type": "object",
"required": [
"expensiveOperations"
],
"properties": {
"variables": {
"type": "object",
"description": "Variables used in the formula, mapped to the parts of the expression they refer to.",
"additionalProperties": {
"type": "string",
"description": "Variables used in the formula, mapped to the parts of the expression they refer to."
}
},
"expensiveOperations": {
"type": "string",
"description": "Information that can be used to determine how many [expensive operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) the evaluation of the expression will perform. This information may be a formula or number. For example:\n\n * `issues.map(i => i.comments)` performs as many expensive operations as there are issues on the issues list. So this parameter returns `N`, where `N` is the size of issue list.\n * `new Issue(10010).comments` gets comments for one issue, so its complexity is `2` (`1` to retrieve issue 10010 from the database plus `1` to get its comments)."
}
},
"description": "Details about the complexity of the analysed Jira expression."
}
JiraExpressionEvalContextBean
{
"type": "object",
"properties": {
"board": {
"type": "integer",
"format": "int64",
"description": "The ID of the board that is available under the `board` variable when evaluating the expression."
},
"issue": {
"$ref": "#/components/schemas/IdOrKeyBean"
},
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomContextVariable"
},
"description": "Custom context variables and their types. These variable types are available for use in a custom context:\n\n * `user`: A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID.\n * `issue`: An [issue](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#issue) specified by ID or key. All the fields of the issue object are available in the Jira expression.\n * `json`: A JSON object containing custom content.\n * `list`: A JSON list of `user`, `issue`, or `json` variable types."
},
"issues": {
"$ref": "#/components/schemas/JexpIssues"
},
"sprint": {
"type": "integer",
"format": "int64",
"description": "The ID of the sprint that is available under the `sprint` variable when evaluating the expression."
},
"project": {
"$ref": "#/components/schemas/IdOrKeyBean"
},
"serviceDesk": {
"type": "integer",
"format": "int64",
"description": "The ID of the service desk that is available under the `serviceDesk` variable when evaluating the expression."
},
"customerRequest": {
"type": "integer",
"format": "int64",
"description": "The ID of the customer request that is available under the `customerRequest` variable when evaluating the expression. This is the same as the ID of the underlying Jira issue, but the customer request context variable will have a different type."
}
},
"x-konfig-properties": {
"issue": {
"description": "The issue that is available under the `issue` variable when evaluating the expression."
},
"issues": {
"description": "The collection of issues that is available under the `issues` variable when evaluating the expression."
},
"project": {
"description": "The project that is available under the `project` variable when evaluating the expression."
}
}
}
JiraExpressionEvalRequestBean
{
"type": "object",
"required": [
"expression"
],
"properties": {
"context": {
"$ref": "#/components/schemas/JiraExpressionEvalContextBean"
},
"expression": {
"type": "string",
"example": "{ key: issue.key, type: issue.issueType.name, links: issue.links.map(link => link.linkedIssue.id) }",
"description": "The Jira expression to evaluate."
}
},
"x-konfig-properties": {
"context": {
"description": "The context in which the Jira expression is evaluated."
}
}
}
JiraExpressionEvaluationMetaDataBean
{
"type": "object",
"properties": {
"issues": {
"$ref": "#/components/schemas/IssuesMetaBean"
},
"complexity": {
"$ref": "#/components/schemas/JiraExpressionsComplexityBean"
}
},
"x-konfig-properties": {
"issues": {
"description": "Contains information about the `issues` variable in the context. For example, is the issues were loaded with JQL, information about the page will be included here."
},
"complexity": {
"description": "Contains information about the expression complexity. For example, the number of steps it took to evaluate the expression."
}
}
}
JiraExpressionForAnalysis
{
"type": "object",
"required": [
"expressions"
],
"properties": {
"expressions": {
"type": "array",
"items": {
"type": "string",
"example": "issues.map(issue => issue.properties['property_key'])",
"description": "The list of Jira expressions to analyse."
},
"example": "issues.map(issue => issue.properties['property_key'])",
"description": "The list of Jira expressions to analyse."
},
"contextVariables": {
"type": "object",
"description": "Context variables and their types. The type checker assumes that [common context variables](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables), such as `issue` or `project`, are available in context and sets their type. Use this property to override the default types or provide details of new variables.",
"additionalProperties": {
"type": "string",
"description": "Context variables and their types. The type checker assumes that <a href=\"https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables\">common context variables</a>, such as <code>issue</code> or <code>project</code>, are available in context and sets their type. Use this property to override the default types or provide details of new variables."
}
}
},
"description": "Details of Jira expressions for analysis."
}
JiraExpressionResult
{
"type": "object",
"required": [
"value"
],
"properties": {
"meta": {
"$ref": "#/components/schemas/JiraExpressionEvaluationMetaDataBean"
},
"value": {
"description": "The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if that's the case a simple string representation is returned. These string representations should not be relied upon and may change without notice.)"
}
},
"description": "The result of evaluating a Jira expression.",
"x-konfig-properties": {
"meta": {
"description": "Contains various characteristics of the performed expression evaluation."
}
}
}
JiraExpressionValidationError
{
"type": "object",
"required": [
"message",
"type"
],
"properties": {
"line": {
"type": "integer",
"format": "int32",
"description": "The text line in which the error occurred."
},
"type": {
"enum": [
"syntax",
"type",
"other"
],
"type": "string",
"description": "The error type."
},
"column": {
"type": "integer",
"format": "int32",
"description": "The text column in which the error occurred."
},
"message": {
"type": "string",
"example": "!, -, typeof, (, IDENTIFIER, null, true, false, NUMBER, STRING, TEMPLATE_LITERAL, new, [ or { expected, > encountered.",
"description": "Details about the error."
},
"expression": {
"type": "string",
"description": "The part of the expression in which the error occurred."
}
},
"description": "Details about syntax and type errors. The error details apply to the entire expression, unless the object includes:\n\n * `line` and `column`\n * `expression`"
}
JiraExpressionsAnalysis
{
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraExpressionAnalysis"
},
"description": "The results of Jira expressions analysis."
}
},
"description": "Details about the analysed Jira expression."
}
JiraExpressionsComplexityBean
{
"type": "object",
"required": [
"beans",
"expensiveOperations",
"primitiveValues",
"steps"
],
"properties": {
"beans": {
"$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
},
"steps": {
"$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
},
"primitiveValues": {
"$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
},
"expensiveOperations": {
"$ref": "#/components/schemas/JiraExpressionsComplexityValueBean"
}
},
"x-konfig-properties": {
"beans": {
"description": "The number of Jira REST API beans returned in the response."
},
"steps": {
"description": "The number of steps it took to evaluate the expression, where a step is a high-level operation performed by the expression. A step is an operation such as arithmetic, accessing a property, accessing a context variable, or calling a function."
},
"primitiveValues": {
"description": "The number of primitive values returned in the response."
},
"expensiveOperations": {
"description": "The number of expensive operations executed while evaluating the expression. Expensive operations are those that load additional data, such as entity properties, comments, or custom fields."
}
}
}
JiraExpressionsComplexityValueBean
{
"type": "object",
"required": [
"limit",
"value"
],
"properties": {
"limit": {
"type": "integer",
"format": "int32",
"description": "The maximum allowed complexity. The evaluation will fail if this value is exceeded."
},
"value": {
"type": "integer",
"format": "int32",
"description": "The complexity value of the current expression."
}
}
}
JiraStatus
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"name": {
"type": "string",
"description": "The name of the status."
},
"scope": {
"$ref": "#/components/schemas/StatusScope"
},
"usages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueTypes"
},
"description": "Projects and issue types where the status is used. Only available if the `usages` expand is requested.",
"uniqueItems": true
},
"description": {
"type": "string",
"description": "The description of the status."
},
"statusCategory": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
},
"workflowUsages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowUsages"
},
"description": "The workflows that use this status. Only available if the `workflowUsages` expand is requested.",
"uniqueItems": true
}
},
"description": "Details of a status."
}
JiraWorkflow
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the workflow."
},
"name": {
"type": "string",
"description": "The name of the workflow."
},
"scope": {
"$ref": "#/components/schemas/WorkflowScope"
},
"taskId": {
"type": "string",
"nullable": true,
"description": "If there is a current [asynchronous task](https://dac-static.atlassian.com) operation for this workflow."
},
"usages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueTypes"
},
"description": "Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the requested workflows.",
"uniqueItems": true
},
"version": {
"$ref": "#/components/schemas/DocumentVersion"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowReferenceStatus"
},
"description": "The statuses referenced in this workflow.",
"uniqueItems": true
},
"isEditable": {
"type": "boolean",
"description": "Indicates if the workflow can be edited."
},
"description": {
"type": "string",
"description": "The description of the workflow."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitions"
},
"description": "The transitions of the workflow.",
"uniqueItems": true
},
"startPointLayout": {
"$ref": "#/components/schemas/WorkflowLayout"
}
},
"description": "Details of a workflow."
}
JiraWorkflowStatus
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"name": {
"type": "string",
"description": "The name of the status."
},
"scope": {
"$ref": "#/components/schemas/WorkflowScope"
},
"usages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueTypes"
},
"description": "The `statuses.usages` expand is an optional parameter that can be used when reading and updating statuses in Jira. It provides additional information about the projects and issue types associated with the requested statuses.",
"uniqueItems": true
},
"description": {
"type": "string",
"description": "The description of the status."
},
"statusCategory": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
},
"statusReference": {
"type": "string",
"description": "The reference of the status."
}
},
"description": "Details of a status."
}
JqlFunctionPrecomputationBean
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The id of the precomputation."
},
"used": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The timestamp of the precomputation last usage."
},
"error": {
"type": "string",
"readOnly": true,
"description": "The error message to be displayed to the user."
},
"field": {
"type": "string",
"readOnly": true,
"description": "The field the function was executed against."
},
"value": {
"type": "string",
"readOnly": true,
"description": "The JQL fragment stored as the precomputation."
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The timestamp of the precomputation creation."
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The timestamp of the precomputation last update."
},
"operator": {
"type": "string",
"readOnly": true,
"description": "The operator in context of which function was executed."
},
"arguments": {
"type": "array",
"items": {
"type": "string",
"readOnly": true
},
"readOnly": true,
"description": "The list of arguments function was invoked with."
},
"functionKey": {
"type": "string",
"readOnly": true,
"description": "The function key."
},
"functionName": {
"type": "string",
"readOnly": true,
"description": "The name of the function."
}
},
"description": "Jql function precomputation."
}
JqlFunctionPrecomputationUpdateBean
{
"type": "object",
"required": [
"id"
],
"writeOnly": true,
"properties": {
"id": {
"type": "string",
"writeOnly": true,
"description": "The id of the precomputation to update."
},
"error": {
"type": "string",
"writeOnly": true,
"description": "The error message to be displayed to the user if the given function clause is no longer valid during recalculation of the precomputation."
},
"value": {
"type": "string",
"writeOnly": true,
"description": "The new value of the precomputation."
}
},
"description": "Precomputation id and its new value."
}
JqlFunctionPrecomputationUpdateRequestBean
{
"type": "object",
"writeOnly": true,
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlFunctionPrecomputationUpdateBean"
}
}
},
"description": "List of pairs (id and value) for precomputation updates."
}
JqlQueriesToParse
{
"type": "object",
"required": [
"queries"
],
"writeOnly": true,
"properties": {
"queries": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minLength": 1,
"description": "A list of queries to parse."
}
},
"description": "A list of JQL queries to parse."
}
JqlQueriesToSanitize
{
"type": "object",
"required": [
"queries"
],
"writeOnly": true,
"properties": {
"queries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryToSanitize"
},
"description": "The list of JQL queries to sanitize. Must contain unique values. Maximum of 20 queries."
}
},
"description": "The list of JQL queries to sanitize for the given account IDs."
}
JqlQuery
{
"type": "object",
"properties": {
"where": {
"$ref": "#/components/schemas/JqlQueryClause"
},
"orderBy": {
"$ref": "#/components/schemas/JqlQueryOrderByClause"
}
},
"description": "A parsed JQL query."
}
JqlQueryClause
{
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/CompoundClause"
},
{
"$ref": "#/components/schemas/FieldValueClause"
},
{
"$ref": "#/components/schemas/FieldWasClause"
},
{
"$ref": "#/components/schemas/FieldChangedClause"
}
],
"description": "A JQL query clause."
}
JqlQueryClauseOperand
{
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/ListOperand"
},
{
"$ref": "#/components/schemas/ValueOperand"
},
{
"$ref": "#/components/schemas/FunctionOperand"
},
{
"$ref": "#/components/schemas/KeywordOperand"
}
],
"description": "Details of an operand in a JQL clause."
}
JqlQueryClauseTimePredicate
{
"type": "object",
"required": [
"operand",
"operator"
],
"properties": {
"operand": {
"$ref": "#/components/schemas/JqlQueryClauseOperand"
},
"operator": {
"enum": [
"before",
"after",
"from",
"to",
"on",
"during",
"by"
],
"type": "string",
"description": "The operator between the field and the operand."
}
},
"description": "A time predicate for a temporal JQL clause."
}
JqlQueryField
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the field."
},
"property": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryFieldEntityProperty"
},
"description": "When the field refers to a value in an entity property, details of the entity property value."
},
"encodedName": {
"type": "string",
"description": "The encoded name of the field, which can be used directly in a JQL query."
}
},
"description": "A field used in a JQL query. See [Advanced searching - fields reference](https://confluence.atlassian.com/x/dAiiLQ) for more information about fields in JQL queries."
}
JqlQueryFieldEntityProperty
{
"type": "object",
"required": [
"entity",
"key",
"path"
],
"properties": {
"key": {
"type": "string",
"example": "stats",
"description": "The key of the property."
},
"path": {
"type": "string",
"example": "comments.count",
"description": "The path in the property value to query."
},
"type": {
"enum": [
"number",
"string",
"text",
"date",
"user"
],
"type": "string",
"example": "number",
"description": "The type of the property value extraction. Not available if the extraction for the property is not registered on the instance with the [Entity property](https://developer.atlassian.com/cloud/jira/platform/modules/entity-property/) module."
},
"entity": {
"type": "string",
"example": "issue",
"description": "The object on which the property is set."
}
},
"description": "Details of an entity property."
}
JqlQueryOrderByClause
{
"type": "object",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryOrderByClauseElement"
},
"description": "The list of order-by clause fields and their ordering directives."
}
},
"description": "Details of the order-by JQL clause."
}
JqlQueryOrderByClauseElement
{
"type": "object",
"required": [
"field"
],
"properties": {
"field": {
"$ref": "#/components/schemas/JqlQueryField"
},
"direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "The direction in which to order the results."
}
},
"description": "An element of the order-by JQL clause."
}
JqlQueryToSanitize
{
"type": "object",
"required": [
"query"
],
"writeOnly": true,
"properties": {
"query": {
"type": "string",
"description": "The query to sanitize."
},
"accountId": {
"type": "string",
"nullable": true,
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
}
},
"description": "The JQL query to sanitize for the account ID. If the account ID is null, sanitizing is performed for an anonymous user."
}
JqlQueryUnitaryOperand
{
"type": "object",
"anyOf": [
{
"$ref": "#/components/schemas/ValueOperand"
},
{
"$ref": "#/components/schemas/FunctionOperand"
},
{
"$ref": "#/components/schemas/KeywordOperand"
}
],
"description": "An operand that can be part of a list operand."
}
JsonContextVariable
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Type of custom context variable."
},
"value": {
"type": "object",
"description": "A JSON object containing custom content."
}
},
"description": "A JSON object with custom content."
}
JsonNode
{
"type": "object",
"properties": {
"int": {
"type": "boolean"
},
"long": {
"type": "boolean"
},
"null": {
"type": "boolean"
},
"pojo": {
"type": "boolean"
},
"array": {
"type": "boolean"
},
"binary": {
"type": "boolean"
},
"double": {
"type": "boolean"
},
"fields": {
"type": "object"
},
"number": {
"type": "boolean"
},
"object": {
"type": "boolean"
},
"boolean": {
"type": "boolean"
},
"textual": {
"type": "boolean"
},
"elements": {
"type": "object"
},
"intValue": {
"type": "integer",
"format": "int32"
},
"longValue": {
"type": "integer",
"format": "int64"
},
"textValue": {
"type": "string"
},
"valueNode": {
"type": "boolean"
},
"bigDecimal": {
"type": "boolean"
},
"bigInteger": {
"type": "boolean"
},
"fieldNames": {
"type": "object"
},
"numberType": {
"enum": [
"INT",
"LONG",
"BIG_INTEGER",
"FLOAT",
"DOUBLE",
"BIG_DECIMAL"
],
"type": "string"
},
"valueAsInt": {
"type": "integer",
"format": "int32"
},
"binaryValue": {
"type": "array",
"items": {
"type": "string",
"format": "byte"
}
},
"doubleValue": {
"type": "number",
"format": "double"
},
"missingNode": {
"type": "boolean"
},
"numberValue": {
"type": "number"
},
"valueAsLong": {
"type": "integer",
"format": "int64"
},
"valueAsText": {
"type": "string"
},
"booleanValue": {
"type": "boolean"
},
"decimalValue": {
"type": "number"
},
"containerNode": {
"type": "boolean"
},
"valueAsDouble": {
"type": "number",
"format": "double"
},
"integralNumber": {
"type": "boolean"
},
"valueAsBoolean": {
"type": "boolean"
},
"bigIntegerValue": {
"type": "integer"
},
"floatingPointNumber": {
"type": "boolean"
}
},
"maxProperties": 10,
"minProperties": 1
}
JsonTypeBean
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"readOnly": true,
"description": "The data type of the field."
},
"items": {
"type": "string",
"readOnly": true,
"description": "When the data type is an array, the name of the field items within the array."
},
"custom": {
"type": "string",
"readOnly": true,
"description": "If the field is a custom field, the URI of the field."
},
"system": {
"type": "string",
"readOnly": true,
"description": "If the field is a system field, the name of the field."
},
"customId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "If the field is a custom field, the custom ID of the field."
},
"configuration": {
"type": "object",
"readOnly": true,
"description": "If the field is a custom field, the configuration of the field.",
"additionalProperties": {
"readOnly": true
}
}
},
"description": "The schema of a field."
}
KeywordOperand
{
"type": "object",
"required": [
"keyword"
],
"properties": {
"keyword": {
"enum": [
"empty"
],
"type": "string",
"description": "The keyword that is the operand value."
}
},
"description": "An operand that is a JQL keyword. See [Advanced searching - keywords reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) for more information about operand keywords."
}
LegacyJackson1ListAttachment
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Attachment"
}
}
LegacyJackson1ListColumnItem
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ColumnItem"
}
}
LegacyJackson1ListIssueEvent
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueEvent"
}
}
LegacyJackson1ListIssueTypeWithStatus
{
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeWithStatus"
}
}
LegacyJackson1ListProject
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
}
}
LegacyJackson1ListProjectComponent
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectComponent"
}
}
LegacyJackson1ListProjectRoleDetails
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectRoleDetails"
}
}
LegacyJackson1ListProjectType
{
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectType"
}
}
LegacyJackson1ListUserMigrationBean
{
"type": "array",
"items": {
"$ref": "#/components/schemas/UserMigrationBean"
}
}
LegacyJackson1ListVersion
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
}
}
LegacyJackson1ListWorklog
{
"type": "array",
"items": {
"$ref": "#/components/schemas/Worklog"
}
}
License
{
"type": "object",
"required": [
"applications"
],
"properties": {
"applications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicensedApplication"
},
"readOnly": true,
"description": "The applications under this license."
}
},
"description": "Details about a license for the Jira instance."
}
LicenseMetric
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of a specific license metric."
},
"value": {
"type": "string",
"description": "The calculated value of a licence metric linked to the key. An example licence metric is the approximate number of user accounts."
}
},
"description": "A metric that provides insight into the active licence details"
}
LicensedApplication
{
"type": "object",
"required": [
"id",
"plan"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the application."
},
"plan": {
"enum": [
"UNLICENSED",
"FREE",
"PAID"
],
"type": "string",
"readOnly": true,
"description": "The licensing plan."
}
},
"description": "Details about a licensed Jira application."
}
LinkGroup
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleLink"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkGroup"
}
},
"header": {
"$ref": "#/components/schemas/SimpleLink"
},
"weight": {
"type": "integer",
"format": "int32"
},
"styleClass": {
"type": "string"
}
},
"description": "Details a link group, which defines issue operations."
}
LinkIssueRequestJsonBean
{
"type": "object",
"required": [
"inwardIssue",
"outwardIssue",
"type"
],
"properties": {
"type": {
"$ref": "#/components/schemas/IssueLinkType"
},
"comment": {
"$ref": "#/components/schemas/Comment"
},
"inwardIssue": {
"$ref": "#/components/schemas/LinkedIssue"
},
"outwardIssue": {
"$ref": "#/components/schemas/LinkedIssue"
}
}
}
LinkedIssue
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of an issue. Required if `key` isn't provided."
},
"key": {
"type": "string",
"description": "The key of an issue. Required if `id` isn't provided."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the issue."
},
"fields": {
"$ref": "#/components/schemas/Fields"
}
},
"description": "The ID or key of a linked issue.",
"x-konfig-properties": {
"fields": {
"readOnly": true,
"description": "The fields associated with the issue."
}
}
}
ListOperand
{
"type": "object",
"required": [
"values"
],
"properties": {
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlQueryUnitaryOperand"
},
"minLength": 1,
"description": "The list of operand values."
},
"encodedOperand": {
"type": "string",
"description": "Encoded operand, which can be used directly in a JQL query."
}
},
"description": "An operand that is a list of values."
}
ListWrapperCallbackApplicationRole
{
"type": "object"
}
ListWrapperCallbackGroupName
{
"type": "object"
}
Locale
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"description": "The locale code. The Java the locale format is used: a two character language code (ISO 639), an underscore, and two letter country code (ISO 3166). For example, en\\_US represents a locale of English (United States). Required on create."
}
},
"description": "Details of a locale."
}
MappingsByIssueTypeOverride
{
"type": "object",
"required": [
"issueTypeId",
"statusMappings"
],
"properties": {
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type for this mapping."
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowAssociationStatusMapping"
},
"description": "The list of status mappings."
}
},
"description": "Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`."
}
MappingsByWorkflow
{
"type": "object",
"required": [
"newWorkflowId",
"oldWorkflowId",
"statusMappings"
],
"properties": {
"newWorkflowId": {
"type": "string",
"description": "The ID of the new workflow."
},
"oldWorkflowId": {
"type": "string",
"description": "The ID of the old workflow."
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowAssociationStatusMapping"
},
"description": "The list of status mappings."
}
},
"description": "The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`."
}
MoveFieldBean
{
"type": "object",
"properties": {
"after": {
"type": "string",
"format": "uri",
"description": "The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't provided."
},
"position": {
"enum": [
"Earlier",
"Later",
"First",
"Last"
],
"type": "string",
"description": "The named position to which the screen tab field should be moved. Required if `after` isn't provided."
}
}
}
MultiIssueEntityProperties
{
"type": "object",
"properties": {
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueEntityPropertiesForMultiUpdate"
},
"description": "A list of issue IDs and their respective properties.",
"maxProperties": 100,
"minProperties": 1
}
},
"description": "A list of issues and their respective properties to set or update. See [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/) for more information."
}
MultipartFile
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"size": {
"type": "integer",
"format": "int64"
},
"bytes": {
"type": "array",
"items": {
"type": "string",
"format": "byte"
}
},
"empty": {
"type": "boolean"
},
"resource": {
"$ref": "#/components/schemas/Resource"
},
"contentType": {
"type": "string"
},
"inputStream": {
"type": "object"
},
"originalFilename": {
"type": "string"
}
}
}
MultipleCustomFieldValuesUpdate
{
"type": "object",
"required": [
"customField",
"issueIds",
"value"
],
"writeOnly": true,
"properties": {
"value": {
"description": "The value for the custom field. The value must be compatible with the [custom field type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#data-types) as follows:\n\n * `string` the value must be a string.\n * `number` the value must be a number.\n * `datetime` the value must be a string that represents a date in the ISO format or the simplified extended ISO format. For example, `\"2023-01-18T12:00:00-03:00\"` or `\"2023-01-18T12:00:00.000Z\"`. However, the milliseconds part is ignored.\n * `user` the value must be an object that contains the `accountId` field.\n * `group` the value must be an object that contains the group `name` or `groupId` field. Because group names can change, we recommend using `groupId`.\n\nA list of appropriate values must be provided if the field is of the `list` [collection type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field/#collection-types)."
},
"issueIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of issue IDs."
},
"customField": {
"type": "string",
"writeOnly": true,
"description": "The ID or key of the custom field. For example, `customfield_10010`."
}
},
"description": "A custom field and its new value with a list of issue to update."
}
MultipleCustomFieldValuesUpdateDetails
{
"type": "object",
"writeOnly": true,
"properties": {
"updates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultipleCustomFieldValuesUpdate"
}
}
},
"description": "List of updates for a custom fields."
}
NestedResponse
{
"type": "object",
"properties": {
"status": {
"type": "integer",
"format": "int32"
},
"errorCollection": {
"$ref": "#/components/schemas/ErrorCollection"
},
"warningCollection": {
"$ref": "#/components/schemas/WarningCollection"
}
}
}
NewUserDetails
{
"type": "object",
"required": [
"emailAddress"
],
"properties": {
"key": {
"type": "string",
"description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"name": {
"type": "string",
"description": "This property is no longer available. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the user."
},
"password": {
"type": "string",
"description": "This property is no longer available. If the user has an Atlassian account, their password is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account."
},
"products": {
"type": "array",
"items": {
"type": "string"
},
"description": "Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery, jira-software. If left empty, the user will get default product access. To create a user without product access, set this field to be an empty array.",
"uniqueItems": true
},
"displayName": {
"type": "string",
"description": "This property is no longer available. If the user has an Atlassian account, their display name is not changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account."
},
"emailAddress": {
"type": "string",
"description": "The email address for the user."
},
"applicationKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "Deprecated, do not use."
}
},
"description": "The user details.",
"additionalProperties": true
}
Notification
{
"type": "object",
"properties": {
"to": {
"$ref": "#/components/schemas/NotificationRecipients"
},
"subject": {
"type": "string",
"description": "The subject of the email notification for the issue. If this is not specified, then the subject is set to the issue key and summary."
},
"htmlBody": {
"type": "string",
"description": "The HTML body of the email notification for the issue."
},
"restrict": {
"$ref": "#/components/schemas/NotificationRecipientsRestrictions"
},
"textBody": {
"type": "string",
"description": "The plain text body of the email notification for the issue."
}
},
"description": "Details about a notification.",
"x-konfig-properties": {
"to": {
"description": "The recipients of the email notification for the issue."
},
"restrict": {
"description": "Restricts the notifications to users with the specified permissions."
}
},
"additionalProperties": true
}
NotificationEvent
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the event. The event can be a [Jira system event](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-eventsEvents) or a [custom event](https://confluence.atlassian.com/x/AIlKLg)."
},
"name": {
"type": "string",
"description": "The name of the event."
},
"description": {
"type": "string",
"description": "The description of the event."
},
"templateEvent": {
"$ref": "#/components/schemas/NotificationEvent"
}
},
"description": "Details about a notification event.",
"x-konfig-properties": {
"templateEvent": {
"description": "The template of the event. Only custom events configured by Jira administrators have template."
}
}
}
NotificationRecipients
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetails"
},
"description": "List of users to receive the notification."
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupName"
},
"description": "List of groups to receive the notification."
},
"voters": {
"type": "boolean",
"description": "Whether the notification should be sent to the issue's voters."
},
"assignee": {
"type": "boolean",
"description": "Whether the notification should be sent to the issue's assignees."
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of groupIds to receive the notification."
},
"reporter": {
"type": "boolean",
"description": "Whether the notification should be sent to the issue's reporter."
},
"watchers": {
"type": "boolean",
"description": "Whether the notification should be sent to the issue's watchers."
}
},
"description": "Details of the users and groups to receive the notification.",
"additionalProperties": true
}
NotificationRecipientsRestrictions
{
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupName"
},
"description": "List of group memberships required to receive the notification."
},
"groupIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of groupId memberships required to receive the notification."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RestrictedPermission"
},
"description": "List of permissions required to receive the notification."
}
},
"description": "Details of the group membership or permissions needed to receive the notification."
}
NotificationScheme
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the notification scheme."
},
"name": {
"type": "string",
"description": "The name of the notification scheme."
},
"self": {
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"expand": {
"type": "string",
"description": "Expand options that include additional notification scheme details in the response."
},
"projects": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of project IDs associated with the notification scheme."
},
"description": {
"type": "string",
"description": "The description of the notification scheme."
},
"notificationSchemeEvents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSchemeEvent"
},
"description": "The notification events and associated recipients."
}
},
"description": "Details about a notification scheme.",
"x-konfig-properties": {
"scope": {
"description": "The scope of the notification scheme."
}
}
}
NotificationSchemeAndProjectMappingJsonBean
{
"type": "object",
"properties": {
"projectId": {
"type": "string"
},
"notificationSchemeId": {
"type": "string"
}
}
}
NotificationSchemeEvent
{
"type": "object",
"properties": {
"event": {
"$ref": "#/components/schemas/NotificationEvent"
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventNotification"
}
}
},
"description": "Details about a notification scheme event."
}
NotificationSchemeEventDetails
{
"type": "object",
"required": [
"event",
"notifications"
],
"writeOnly": true,
"properties": {
"event": {
"$ref": "#/components/schemas/NotificationSchemeEventTypeId"
},
"notifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSchemeNotificationDetails"
},
"maxLength": 255,
"writeOnly": true,
"description": "The list of notifications mapped to a specified event."
}
},
"description": "Details of a notification scheme event.",
"x-konfig-properties": {
"event": {
"description": "The ID of the event."
}
},
"additionalProperties": true
}
NotificationSchemeEventTypeId
{
"type": "object",
"required": [
"id"
],
"writeOnly": true,
"properties": {
"id": {
"type": "string",
"writeOnly": true,
"description": "The ID of the notification scheme event."
}
},
"description": "The ID of an event that is being mapped to notifications.",
"additionalProperties": true
}
NotificationSchemeId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of a notification scheme."
}
},
"description": "The ID of a notification scheme.",
"additionalProperties": true
}
NotificationSchemeNotificationDetails
{
"type": "object",
"required": [
"notificationType"
],
"maxLength": 255,
"writeOnly": true,
"properties": {
"parameter": {
"type": "string",
"writeOnly": true,
"description": "The value corresponding to the specified notification type."
},
"notificationType": {
"type": "string",
"writeOnly": true,
"description": "The notification type, e.g `CurrentAssignee`, `Group`, `EmailAddress`."
}
},
"description": "Details of a notification within a notification scheme.",
"additionalProperties": true
}
OldToNewSecurityLevelMappingsBean
{
"type": "object",
"required": [
"newLevelId",
"oldLevelId"
],
"writeOnly": true,
"properties": {
"newLevelId": {
"type": "string",
"writeOnly": true,
"description": "The new issue security level ID. Providing null will clear the assigned old level from issues."
},
"oldLevelId": {
"type": "string",
"writeOnly": true,
"description": "The old issue security level ID. Providing null will remap all issues without any assigned levels."
}
}
}
OperationMessage
{
"type": "object",
"example": {
"message": "An example message.",
"statusCode": 200
},
"required": [
"message",
"statusCode"
],
"properties": {
"message": {
"type": "string",
"description": "The human-readable message that describes the result."
},
"statusCode": {
"type": "integer",
"description": "The status code of the response."
}
}
}
Operations
{
"type": "object",
"properties": {
"linkGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LinkGroup"
},
"readOnly": true,
"description": "Details of the link groups defining issue operations."
}
},
"description": "Details of the operations that can be performed on the issue.",
"additionalProperties": true
}
OrderOfCustomFieldOptions
{
"type": "object",
"required": [
"customFieldOptionIds"
],
"properties": {
"after": {
"type": "string",
"writeOnly": true,
"description": "The ID of the custom field option or cascading option to place the moved options after. Required if `position` isn't provided."
},
"position": {
"enum": [
"First",
"Last"
],
"type": "string",
"writeOnly": true,
"description": "The position the custom field options should be moved to. Required if `after` isn't provided."
},
"customFieldOptionIds": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "A list of IDs of custom field options to move. The order of the custom field option IDs in the list is the order they are given after the move. The list must contain custom field options or cascading options, but not both."
}
},
"description": "An ordered list of custom field option IDs and information on where to move them."
}
OrderOfIssueTypes
{
"type": "object",
"required": [
"issueTypeIds"
],
"properties": {
"after": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type to place the moved issue types after. Required if `position` isn't provided."
},
"position": {
"enum": [
"First",
"Last"
],
"type": "string",
"writeOnly": true,
"description": "The position the issue types should be moved to. Required if `after` isn't provided."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "A list of the issue type IDs to move. The order of the issue type IDs in the list is the order they are given after the move."
}
},
"description": "An ordered list of issue type IDs and information about where to move them."
}
PageBean2ComponentJsonBean
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentJsonBean"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanChangelog
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Changelog"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanComment
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanComponentWithIssueCount
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ComponentWithIssueCount"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanContext
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Context"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanContextForProjectAndIssueType
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextForProjectAndIssueType"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanContextualConfiguration
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContextualConfiguration"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanCustomFieldContext
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContext"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanCustomFieldContextDefaultValue
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContextDefaultValue"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanCustomFieldContextOption
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContextOption"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanCustomFieldContextProjectMapping
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomFieldContextProjectMapping"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanDashboard
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dashboard"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanField
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Field"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFieldConfigurationDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFieldConfigurationIssueTypeItem
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationIssueTypeItem"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFieldConfigurationItem
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationItem"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFieldConfigurationScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFieldConfigurationSchemeProjects
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldConfigurationSchemeProjects"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanFilterDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanGroupDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueFieldOption
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueFieldOption"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueSecurityLevelMember
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueSecurityLevelMember"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueSecuritySchemeToProjectMapping
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueSecuritySchemeToProjectMapping"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeSchemeMapping
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeSchemeMapping"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeSchemeProjects
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeSchemeProjects"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeScreenScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScreenScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeScreenSchemeItem
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScreenSchemeItem"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeScreenSchemesProjects
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeScreenSchemesProjects"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanIssueTypeToContextMapping
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeToContextMapping"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanJqlFunctionPrecomputationBean
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JqlFunctionPrecomputationBean"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanNotificationScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanNotificationSchemeAndProjectMappingJsonBean
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSchemeAndProjectMappingJsonBean"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanPriority
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Priority"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanProject
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Project"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanProjectDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanResolutionJsonBean
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResolutionJsonBean"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanScreen
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Screen"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanScreenScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreenScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanScreenWithTab
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreenWithTab"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanSecurityLevel
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityLevel"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanSecurityLevelMember
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityLevelMember"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanSecuritySchemeWithProjects
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecuritySchemeWithProjects"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanString
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"type": "string",
"readOnly": true
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanUiModificationDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UiModificationDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanUser
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanUserDetails
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetails"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanUserKey
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserKey"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanVersion
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanWebhook
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanWorkflow
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workflow"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanWorkflowScheme
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowScheme"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageBeanWorkflowTransitionRules
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the page."
},
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"isLast": {
"type": "boolean",
"readOnly": true,
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRules"
},
"readOnly": true,
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"nextPage": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "If there is another page of results, the URL of the next page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of items."
}
PageOfChangelogs
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of results on the page."
},
"startAt": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
},
"histories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Changelog"
},
"readOnly": true,
"description": "The list of changelogs."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
}
},
"description": "A page of changelogs."
}
PageOfComments
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of items returned."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
},
"readOnly": true,
"description": "The list of comments."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items that could be returned."
}
},
"description": "A page of comments.",
"additionalProperties": true
}
PageOfCreateMetaIssueTypeWithField
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The total number of items in all pages."
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldCreateMetadata"
},
"readOnly": true,
"description": "The collection of FieldCreateMetaBeans."
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldCreateMetadata"
}
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items to return per page."
}
},
"description": "A page of CreateMetaIssueType with Field.",
"additionalProperties": true
}
PageOfCreateMetaIssueTypes
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The total number of items in all pages."
},
"startAt": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The index of the first item returned."
},
"issueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeIssueCreateMetadata"
},
"readOnly": true,
"description": "The list of CreateMetaIssueType."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of items to return per page."
},
"createMetaIssueType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeIssueCreateMetadata"
},
"writeOnly": true
}
},
"description": "A page of CreateMetaIssueTypes.",
"additionalProperties": true
}
PageOfDashboards
{
"type": "object",
"properties": {
"next": {
"type": "string",
"readOnly": true,
"description": "The URL of the next page of results, if any."
},
"prev": {
"type": "string",
"readOnly": true,
"description": "The URL of the previous page of results, if any."
},
"total": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of results on the page."
},
"startAt": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
},
"dashboards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Dashboard"
},
"readOnly": true,
"description": "List of dashboards."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
}
},
"description": "A page containing dashboard details."
}
PageOfStatuses
{
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "The URL of this page."
},
"total": {
"type": "integer",
"format": "int64",
"description": "Number of items that satisfy the search."
},
"isLast": {
"type": "boolean",
"description": "Whether this is the last page."
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraStatus"
},
"description": "The list of items."
},
"startAt": {
"type": "integer",
"format": "int64",
"description": "The index of the first item returned on the page."
},
"nextPage": {
"type": "string",
"description": "The URL of the next page of results, if any."
},
"maxResults": {
"type": "integer",
"format": "int32",
"description": "The maximum number of items that could be returned."
}
}
}
PageOfWorklogs
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of results on the page."
},
"startAt": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
},
"worklogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Worklog"
},
"readOnly": true,
"description": "List of worklogs."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
}
},
"description": "Paginated list of worklog details",
"additionalProperties": true
}
PagedListUserDetailsApplicationUser
{
"type": "object",
"properties": {
"size": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of items on the page."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetails"
},
"readOnly": true,
"description": "The list of items."
},
"end-index": {
"xml": {
"name": "end-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the last item returned on the page."
},
"max-results": {
"xml": {
"name": "max-results",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
},
"start-index": {
"xml": {
"name": "start-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
}
},
"description": "A paged list. To access additional details append `[start-index:end-index]` to the expand request. For example, `?expand=sharedUsers[10:40]` returns a list starting at item 10 and finishing at item 40."
}
PaginatedResponseComment
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
}
},
"startAt": {
"type": "integer",
"format": "int64"
},
"maxResults": {
"type": "integer",
"format": "int32"
}
}
}
PaginatedResponseFieldCreateMetadata
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldCreateMetadata"
}
},
"startAt": {
"type": "integer",
"format": "int64"
},
"maxResults": {
"type": "integer",
"format": "int32"
}
}
}
PaginatedResponseIssueTypeIssueCreateMetadata
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"format": "int64"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeIssueCreateMetadata"
}
},
"startAt": {
"type": "integer",
"format": "int64"
},
"maxResults": {
"type": "integer",
"format": "int32"
}
}
}
ParsedJqlQueries
{
"type": "object",
"required": [
"queries"
],
"properties": {
"queries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParsedJqlQuery"
},
"minLength": 1,
"description": "A list of parsed JQL queries."
}
},
"description": "A list of parsed JQL queries."
}
ParsedJqlQuery
{
"type": "object",
"required": [
"query"
],
"minLength": 1,
"properties": {
"query": {
"type": "string",
"description": "The JQL query that was parsed and validated."
},
"errors": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of syntax or validation errors.",
"uniqueItems": true
},
"structure": {
"$ref": "#/components/schemas/JqlQuery"
}
},
"description": "Details of a parsed JQL query.",
"x-konfig-properties": {
"structure": {
"description": "The syntax tree of the query. Empty if the query was invalid."
}
}
}
PermissionDetails
{
"type": "object",
"required": [
"editPermissions",
"sharePermissions"
],
"properties": {
"editPermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The edit permissions for the shareable entities."
},
"sharePermissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SharePermission"
},
"description": "The share permissions for the shareable entities."
}
},
"description": "Details for permissions of shareable entities"
}
PermissionGrant
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the permission granted details."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the permission granted details."
},
"holder": {
"$ref": "#/components/schemas/PermissionHolder"
},
"permission": {
"type": "string",
"description": "The permission to grant. This permission can be one of the built-in permissions or a custom permission added by an app. See [Built-in permissions](../api-group-permission-schemes/#built-in-permissions) in *Get all permission schemes* for more information about the built-in permissions. See the [project permission](https://developer.atlassian.com/cloud/jira/platform/modules/project-permission/) and [global permission](https://developer.atlassian.com/cloud/jira/platform/modules/global-permission/) module documentation for more information about custom permissions."
}
},
"description": "Details about a permission granted to a user or group.",
"x-konfig-properties": {
"holder": {
"description": "The user or group being granted the permission. It consists of a `type`, a type-dependent `parameter` and a type-dependent `value`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information."
}
},
"additionalProperties": true
}
PermissionGrants
{
"type": "object",
"properties": {
"expand": {
"type": "string",
"readOnly": true,
"description": "Expand options that include additional permission grant details in the response."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGrant"
},
"readOnly": true,
"description": "Permission grants list."
}
},
"description": "List of permission grants."
}
PermissionHolder
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of permission holder."
},
"value": {
"type": "string",
"description": "The identifier associated with the `type` value that defines the holder of the permission."
},
"expand": {
"type": "string",
"readOnly": true,
"description": "Expand options that include additional permission holder details in the response."
},
"parameter": {
"type": "string",
"description": "As a group's name can change, use of `value` is recommended. The identifier associated withthe `type` value that defines the holder of the permission."
}
},
"description": "Details of a user, group, field, or project role that holds a permission. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information."
}
PermissionScheme
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the permission scheme."
},
"name": {
"type": "string",
"description": "The name of the permission scheme. Must be unique."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the permission scheme."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"expand": {
"type": "string",
"readOnly": true,
"description": "The expand options available for the permission scheme."
},
"description": {
"type": "string",
"description": "A description for the permission scheme."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionGrant"
},
"description": "The permission scheme to create or update. See [About permission schemes and grants](../api-group-permission-schemes/#about-permission-schemes-and-grants) for more information."
}
},
"description": "Details of a permission scheme.",
"x-konfig-properties": {
"scope": {
"description": "The scope of the permission scheme."
}
},
"additionalProperties": true
}
PermissionSchemes
{
"type": "object",
"properties": {
"permissionSchemes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionScheme"
},
"readOnly": true,
"description": "Permission schemes list."
}
},
"description": "List of all permission schemes."
}
Permissions
{
"type": "object",
"properties": {
"permissions": {
"type": "object",
"readOnly": true,
"description": "List of permissions.",
"additionalProperties": {
"$ref": "#/components/schemas/UserPermission"
}
}
},
"description": "Details about permissions."
}
PermissionsKeysBean
{
"type": "object",
"required": [
"permissions"
],
"properties": {
"permissions": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of permission keys."
}
}
}
PermittedProjects
{
"type": "object",
"properties": {
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIdentifierBean"
},
"readOnly": true,
"description": "A list of projects."
}
},
"description": "A list of projects in which a user is granted permissions."
}
Priority
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue priority."
},
"name": {
"type": "string",
"description": "The name of the issue priority."
},
"self": {
"type": "string",
"description": "The URL of the issue priority."
},
"iconUrl": {
"type": "string",
"description": "The URL of the icon for the issue priority."
},
"schemes": {
"$ref": "#/components/schemas/ExpandPrioritySchemePage"
},
"isDefault": {
"type": "boolean",
"description": "Whether this priority is the default."
},
"description": {
"type": "string",
"description": "The description of the issue priority."
},
"statusColor": {
"type": "string",
"description": "The color used to indicate the issue priority."
}
},
"description": "An issue priority.",
"x-konfig-properties": {
"schemes": {
"description": "Priority schemes associated with the issue priority."
}
},
"additionalProperties": true
}
PriorityId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue priority."
}
},
"description": "The ID of an issue priority.",
"additionalProperties": true
}
Project
{
"xml": {
"name": "project"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the project."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the project."
},
"url": {
"type": "string",
"readOnly": true,
"description": "A link to information about this project, such as project documentation."
},
"lead": {
"$ref": "#/components/schemas/User"
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the project."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the project details."
},
"uuid": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "Unique ID for next-gen projects."
},
"email": {
"type": "string",
"description": "An email address associated with the project."
},
"roles": {
"type": "object",
"readOnly": true,
"description": "The name and self URL for each role defined in the project. For more information, see [Create project role](https://dac-static.atlassian.com).",
"additionalProperties": {
"type": "string",
"format": "uri",
"readOnly": true
}
},
"style": {
"enum": [
"classic",
"next-gen"
],
"type": "string",
"readOnly": true,
"description": "The type of the project."
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional project details in the response."
},
"deleted": {
"type": "boolean",
"readOnly": true,
"description": "Whether the project is marked as deleted."
},
"insight": {
"$ref": "#/components/schemas/ProjectInsight"
},
"archived": {
"type": "boolean",
"readOnly": true,
"description": "Whether the project is archived."
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Version"
},
"readOnly": true,
"description": "The versions defined in the project. For more information, see [Create version](https://dac-static.atlassian.com)."
},
"deletedBy": {
"$ref": "#/components/schemas/User"
},
"favourite": {
"type": "boolean",
"description": "Whether the project is selected as a favorite."
},
"isPrivate": {
"type": "boolean",
"readOnly": true,
"description": "Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues."
},
"archivedBy": {
"$ref": "#/components/schemas/User"
},
"avatarUrls": {
"$ref": "#/components/schemas/AvatarUrlsBean"
},
"components": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectComponent"
},
"readOnly": true,
"description": "List of the components contained in the project."
},
"issueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeDetails"
},
"readOnly": true,
"description": "List of the issue types available in the project."
},
"properties": {
"type": "object",
"readOnly": true,
"description": "Map of project properties",
"additionalProperties": {
"readOnly": true
}
},
"simplified": {
"type": "boolean",
"readOnly": true,
"description": "Whether the project is simplified."
},
"deletedDate": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date when the project was marked as deleted."
},
"description": {
"type": "string",
"readOnly": true,
"description": "A brief description of the project."
},
"permissions": {
"$ref": "#/components/schemas/ProjectPermissions"
},
"archivedDate": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date when the project was archived."
},
"assigneeType": {
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"readOnly": true,
"description": "The default assignee when creating issues for this project."
},
"projectTypeKey": {
"enum": [
"software",
"service_desk",
"business"
],
"type": "string",
"readOnly": true,
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project."
},
"landingPageInfo": {
"$ref": "#/components/schemas/ProjectLandingPageInfo"
},
"projectCategory": {
"$ref": "#/components/schemas/ProjectCategory"
},
"retentionTillDate": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The date when the project is deleted permanently."
},
"issueTypeHierarchy": {
"$ref": "#/components/schemas/Hierarchy"
}
},
"description": "Details about a project.",
"x-konfig-properties": {
"lead": {
"readOnly": true,
"description": "The username of the project lead."
},
"insight": {
"readOnly": true,
"description": "Insights about the project."
},
"deletedBy": {
"readOnly": true,
"description": "The user who marked the project as deleted."
},
"archivedBy": {
"readOnly": true,
"description": "The user who archived the project."
},
"avatarUrls": {
"readOnly": true,
"description": "The URLs of the project's avatars."
},
"permissions": {
"readOnly": true,
"description": "User permissions on the project"
},
"landingPageInfo": {
"readOnly": true,
"description": "The project landing page info."
},
"projectCategory": {
"readOnly": true,
"description": "The category the project belongs to."
},
"issueTypeHierarchy": {
"readOnly": true,
"description": "The issue type hierarchy for the project."
}
}
}
ProjectAndIssueTypePair
{
"type": "object",
"required": [
"issueTypeId",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project."
},
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
}
},
"description": "A project and issueType ID pair that identifies a status mapping."
}
ProjectAvatars
{
"type": "object",
"properties": {
"custom": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Avatar"
},
"readOnly": true,
"description": "List of avatars added to Jira. These avatars may be deleted."
},
"system": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Avatar"
},
"readOnly": true,
"description": "List of avatars included with Jira. These avatars cannot be deleted."
}
},
"description": "List of project avatars."
}
ProjectCategory
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the project category."
},
"name": {
"type": "string",
"description": "The name of the project category. Required on create, optional on update."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the project category."
},
"description": {
"type": "string",
"description": "The description of the project category."
}
},
"description": "A project category."
}
ProjectComponent
{
"xml": {
"name": "component"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The unique identifier for the component."
},
"ari": {
"type": "string",
"readOnly": true,
"description": "Compass component's ID. Can't be updated. Not required for creating a Project Component."
},
"lead": {
"$ref": "#/components/schemas/User"
},
"name": {
"type": "string",
"description": "The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the component."
},
"project": {
"type": "string",
"description": "The key of the project the component is assigned to. Required when creating a component. Can't be updated."
},
"assignee": {
"$ref": "#/components/schemas/User"
},
"metadata": {
"type": "object",
"readOnly": true,
"description": "Compass component's metadata. Can't be updated. Not required for creating a Project Component.",
"additionalProperties": {
"type": "string",
"readOnly": true
}
},
"projectId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project the component is assigned to."
},
"description": {
"type": "string",
"description": "The description for the component. Optional when creating or updating a component."
},
"assigneeType": {
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"description": "The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:\n\n * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the component is in.\n * `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for the component.\n * `UNASSIGNED` an assignee is not set for issues created with this component.\n * `PROJECT_DEFAULT` the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.\n\nDefault value: `PROJECT_DEFAULT`. \nOptional when creating or updating a component."
},
"leadUserName": {
"type": "string",
"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."
},
"realAssignee": {
"$ref": "#/components/schemas/User"
},
"leadAccountId": {
"type": "string",
"maxLength": 128,
"writeOnly": true,
"description": "The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"realAssigneeType": {
"enum": [
"PROJECT_DEFAULT",
"COMPONENT_LEAD",
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"readOnly": true,
"description": "The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This property is set to one of the following values:\n\n * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in the project that the component is in.\n * `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component lead has permission to be assigned issues in the project that the component is in.\n * `UNASSIGNED` when `assigneeType` is `UNASSIGNED` and Jira is configured to allow unassigned issues.\n * `PROJECT_DEFAULT` when none of the preceding cases are true."
},
"isAssigneeTypeValid": {
"type": "boolean",
"readOnly": true,
"description": "Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but the component lead is not set, then `false` is returned."
}
},
"description": "Details about a project component.",
"x-konfig-properties": {
"lead": {
"readOnly": true,
"description": "The user details for the component's lead user."
},
"assignee": {
"readOnly": true,
"description": "The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned to issues created with this component."
},
"realAssignee": {
"readOnly": true,
"description": "The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee."
}
}
}
ProjectDataPolicies
{
"type": "object",
"properties": {
"projectDataPolicies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectWithDataPolicy"
},
"readOnly": true,
"description": "List of projects with data policies."
}
},
"description": "Details about data policies for a list of projects."
}
ProjectDataPolicy
{
"type": "object",
"properties": {
"anyContentBlocked": {
"type": "boolean",
"readOnly": true,
"description": "Whether the project contains any content inaccessible to the requesting application."
}
},
"description": "Details about data policy."
}
ProjectDetails
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the project."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the project."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the project."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the project details."
},
"avatarUrls": {
"$ref": "#/components/schemas/AvatarUrlsBean"
},
"simplified": {
"type": "boolean",
"readOnly": true,
"description": "Whether or not the project is simplified."
},
"projectTypeKey": {
"enum": [
"software",
"service_desk",
"business"
],
"type": "string",
"readOnly": true,
"description": "The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project."
},
"projectCategory": {
"$ref": "#/components/schemas/UpdatedProjectCategory"
}
},
"description": "Details about a project.",
"x-konfig-properties": {
"avatarUrls": {
"readOnly": true,
"description": "The URLs of the project's avatars."
},
"projectCategory": {
"readOnly": true,
"description": "The category the project belongs to."
}
}
}
ProjectEmailAddress
{
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"description": "The email address."
},
"emailAddressStatus": {
"type": "array",
"items": {
"type": "string"
},
"description": "When using a custom domain, the status of the email address."
}
},
"description": "A project's sender email address."
}
ProjectFeature
{
"type": "object",
"properties": {
"state": {
"enum": [
"ENABLED",
"DISABLED",
"COMING_SOON"
],
"type": "string",
"description": "The state of the feature. When updating the state of a feature, only ENABLED and DISABLED are supported. Responses can contain all values"
},
"feature": {
"type": "string",
"description": "The key of the feature."
},
"imageUri": {
"type": "string",
"description": "URI for the image representing the feature."
},
"projectId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project."
},
"toggleLocked": {
"type": "boolean",
"description": "Whether the state of the feature can be updated."
},
"localisedName": {
"type": "string",
"description": "Localized display name for the feature."
},
"prerequisites": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of keys of the features required to enable the feature."
},
"localisedDescription": {
"type": "string",
"description": "Localized display description for the feature."
}
},
"description": "Details of a project feature."
}
ProjectFeatureState
{
"type": "object",
"properties": {
"state": {
"enum": [
"ENABLED",
"DISABLED",
"COMING_SOON"
],
"type": "string",
"description": "The feature state."
}
},
"description": "Details of the feature state."
}
ProjectId
{
"type": "object",
"nullable": true,
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the project."
}
},
"description": "Project ID details."
}
ProjectIdentifierBean
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the project."
}
},
"description": "The identifiers for a project."
}
ProjectIdentifiers
{
"type": "object",
"required": [
"id",
"key",
"self"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the created project."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the created project."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the created project."
}
},
"description": "Identifiers for a project."
}
ProjectIds
{
"type": "object",
"required": [
"projectIds"
],
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "The IDs of projects."
}
},
"description": "A list of project IDs."
}
ProjectInsight
{
"type": "object",
"properties": {
"totalIssueCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Total issue count."
},
"lastIssueUpdateTime": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The last issue update time."
}
},
"description": "Additional details about a project."
}
ProjectIssueCreateMetadata
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the project."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the project."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the project."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the project."
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional project issue create metadata details in the response."
},
"avatarUrls": {
"$ref": "#/components/schemas/AvatarUrlsBean"
},
"issuetypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeIssueCreateMetadata"
},
"readOnly": true,
"description": "List of the issue types supported by the project."
}
},
"description": "Details of the issue creation metadata for a project.",
"x-konfig-properties": {
"avatarUrls": {
"readOnly": true,
"description": "List of the project's avatars, returning the avatar size and associated URL."
}
}
}
ProjectIssueSecurityLevels
{
"type": "object",
"required": [
"levels"
],
"properties": {
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityLevel"
},
"readOnly": true,
"description": "Issue level security items list."
}
},
"description": "List of issue level security items in a project."
}
ProjectIssueTypeHierarchy
{
"type": "object",
"properties": {
"hierarchy": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueTypesHierarchyLevel"
},
"readOnly": true,
"description": "Details of an issue type hierarchy level."
},
"projectId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project."
}
},
"description": "The hierarchy of issue types within a project."
}
ProjectIssueTypeMapping
{
"type": "object",
"required": [
"issueTypeId",
"projectId"
],
"writeOnly": true,
"properties": {
"projectId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the project."
},
"issueTypeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the issue type."
}
},
"description": "The project and issue type mapping."
}
ProjectIssueTypeMappings
{
"type": "object",
"required": [
"mappings"
],
"properties": {
"mappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectIssueTypeMapping"
},
"writeOnly": true,
"description": "The project and issue type mappings."
}
},
"description": "The project and issue type mappings."
}
ProjectIssueTypes
{
"type": "object",
"properties": {
"project": {
"$ref": "#/components/schemas/ProjectId"
},
"issueTypes": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"description": "IDs of the issue types"
},
"nullable": true,
"description": "IDs of the issue types",
"uniqueItems": true
}
},
"description": "Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the requested workflows."
}
ProjectIssueTypesHierarchyLevel
{
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue type hierarchy level."
},
"level": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The level of the issue type hierarchy level."
},
"entityId": {
"type": "string",
"format": "uuid",
"readOnly": true,
"description": "The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
},
"issueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTypeInfo"
},
"readOnly": true,
"description": "The list of issue types in the hierarchy level."
}
},
"description": "Details of an issue type hierarchy level."
}
ProjectLandingPageInfo
{
"type": "object",
"properties": {
"url": {
"type": "string"
},
"boardId": {
"type": "integer",
"format": "int64"
},
"queueId": {
"type": "integer",
"format": "int64"
},
"boardName": {
"type": "string"
},
"queueName": {
"type": "string"
},
"attributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"projectKey": {
"type": "string"
},
"simplified": {
"type": "boolean"
},
"projectType": {
"type": "string"
},
"simpleBoard": {
"type": "boolean"
},
"queueCategory": {
"type": "string"
}
}
}
ProjectPermissions
{
"type": "object",
"properties": {
"canEdit": {
"type": "boolean",
"readOnly": true,
"description": "Whether the logged user can edit the project."
}
},
"description": "Permissions which a user has on a project."
}
ProjectRole
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project role."
},
"name": {
"type": "string",
"description": "The name of the project role."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL the project role details."
},
"admin": {
"type": "boolean",
"readOnly": true,
"description": "Whether this role is the admin role for the project."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"actors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleActor"
},
"readOnly": true,
"description": "The list of users who act in this role."
},
"default": {
"type": "boolean",
"readOnly": true,
"description": "Whether this role is the default role for the project"
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the project role."
},
"translatedName": {
"type": "string",
"description": "The translated name of the project role."
},
"currentUserRole": {
"type": "boolean",
"description": "Whether the calling user is part of this role."
},
"roleConfigurable": {
"type": "boolean",
"readOnly": true,
"description": "Whether the roles are configurable for this project."
}
},
"description": "Details about the roles in a project.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO)."
}
}
}
ProjectRoleActorsUpdateBean
{
"xml": {
"name": "actor"
},
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project role. Use [Get all project roles](https://dac-static.atlassian.com) to get a list of project role IDs."
},
"categorisedActors": {
"type": "object",
"description": "The actors to add to the project role.\n\nAdd groups using:\n\n * `atlassian-group-role-actor` and a list of group names.\n * `atlassian-group-role-actor-id` and a list of group IDs.\n\nAs a group's name can change, use of `atlassian-group-role-actor-id` is recommended. For example, `\"atlassian-group-role-actor-id\":[\"eef79f81-0b89-4fca-a736-4be531a10869\",\"77f6ab39-e755-4570-a6ae-2d7a8df0bcb8\"]`.\n\nAdd users using `atlassian-user-role-actor` and a list of account IDs. For example, `\"atlassian-user-role-actor\":[\"12345678-9abc-def1-2345-6789abcdef12\", \"abcdef12-3456-789a-bcde-f123456789ab\"]`.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
ProjectRoleDetails
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the project role."
},
"name": {
"type": "string",
"description": "The name of the project role."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL the project role details."
},
"admin": {
"type": "boolean",
"readOnly": true,
"description": "Whether this role is the admin role for the project."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"default": {
"type": "boolean",
"readOnly": true,
"description": "Whether this role is the default role for the project."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the project role."
},
"translatedName": {
"type": "string",
"description": "The translated name of the project role."
},
"roleConfigurable": {
"type": "boolean",
"readOnly": true,
"description": "Whether the roles are configurable for this project."
}
},
"description": "Details about a project role.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO)."
}
}
}
ProjectRoleGroup
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the group. As a group's name can change, use of `groupId` is recommended to identify the group."
},
"groupId": {
"type": "string",
"description": "The ID of the group."
},
"displayName": {
"type": "string",
"description": "The display name of the group."
}
},
"description": "Details of the group associated with the role."
}
ProjectRoleUser
{
"type": "object",
"properties": {
"accountId": {
"type": "string",
"readOnly": true,
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import."
}
},
"description": "Details of the user associated with the role."
}
ProjectScopeBean
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the project that the option's behavior applies to."
},
"attributes": {
"type": "array",
"items": {
"enum": [
"notSelectable",
"defaultValue"
],
"type": "string"
},
"description": "Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.",
"uniqueItems": true
}
}
}
ProjectType
{
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the project type."
},
"icon": {
"type": "string",
"readOnly": true,
"description": "The icon of the project type."
},
"color": {
"type": "string",
"readOnly": true,
"description": "The color of the project type."
},
"formattedKey": {
"type": "string",
"readOnly": true,
"description": "The formatted key of the project type."
},
"descriptionI18nKey": {
"type": "string",
"readOnly": true,
"description": "The key of the project type's description."
}
},
"description": "Details about a project type."
}
ProjectWithDataPolicy
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The project ID."
},
"dataPolicy": {
"$ref": "#/components/schemas/ProjectDataPolicy"
}
},
"description": "Details about data policies for a project.",
"x-konfig-properties": {
"dataPolicy": {
"readOnly": true,
"description": "Data policy."
}
}
}
PropertyKey
{
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the property."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the property."
}
},
"description": "Property key details."
}
PropertyKeys
{
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PropertyKey"
},
"readOnly": true,
"description": "Property key details."
}
},
"description": "List of property keys."
}
PublishDraftWorkflowScheme
{
"type": "object",
"properties": {
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMapping"
},
"description": "Mappings of statuses to new statuses for issue types.",
"uniqueItems": true
}
},
"description": "Details about the status mappings for publishing a draft workflow scheme."
}
PublishedWorkflowId
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow."
},
"entityId": {
"type": "string",
"description": "The entity ID of the workflow."
}
},
"description": "Properties that identify a published workflow."
}
RegisteredWebhook
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"description": "Error messages specifying why the webhook creation failed."
},
"description": "Error messages specifying why the webhook creation failed."
},
"createdWebhookId": {
"type": "integer",
"format": "int64",
"description": "The ID of the webhook. Returned if the webhook is created."
}
},
"description": "ID of a registered webhook or error messages explaining why a webhook wasn't registered."
}
RemoteIssueLink
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the link."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the link."
},
"object": {
"$ref": "#/components/schemas/RemoteObject"
},
"globalId": {
"type": "string",
"description": "The global ID of the link, such as the ID of the item on the remote system."
},
"application": {
"$ref": "#/components/schemas/Application"
},
"relationship": {
"type": "string",
"description": "Description of the relationship between the issue and the linked item."
}
},
"description": "Details of an issue remote link.",
"x-konfig-properties": {
"object": {
"description": "Details of the item linked to."
},
"application": {
"description": "Details of the remote application the linked item is in."
}
}
}
RemoteIssueLinkIdentifies
{
"type": "object",
"properties": {
"id": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the remote issue link, such as the ID of the item on the remote system."
},
"self": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "The URL of the remote issue link."
}
},
"description": "Details of the identifiers for a created or updated remote issue link."
}
RemoteIssueLinkRequest
{
"type": "object",
"required": [
"object"
],
"properties": {
"object": {
"$ref": "#/components/schemas/RemoteObject"
},
"globalId": {
"type": "string",
"description": "An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: `appId=456&pageId=123`.\n\nSetting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.\n\nThe maximum length is 255 characters."
},
"application": {
"$ref": "#/components/schemas/Application"
},
"relationship": {
"type": "string",
"description": "Description of the relationship between the issue and the linked item. If not set, the relationship description \"links to\" is used in Jira."
}
},
"description": "Details of a remote issue link.",
"x-konfig-properties": {
"object": {
"description": "Details of the item linked to."
},
"application": {
"description": "Details of the remote application the linked item is in. For example, trello."
}
},
"additionalProperties": true
}
RemoteObject
{
"type": "object",
"required": [
"title",
"url"
],
"properties": {
"url": {
"type": "string",
"description": "The URL of the item."
},
"icon": {
"$ref": "#/components/schemas/Icon"
},
"title": {
"type": "string",
"description": "The title of the item."
},
"status": {
"$ref": "#/components/schemas/Status"
},
"summary": {
"type": "string",
"description": "The summary details of the item."
}
},
"description": "The linked item.",
"x-konfig-properties": {
"icon": {
"description": "Details of the icon for the item. If no icon is defined, the default link icon is used in Jira."
},
"status": {
"description": "The status of the item."
}
},
"additionalProperties": true
}
RemoveOptionFromIssuesResult
{
"type": "object",
"properties": {
"errors": {
"$ref": "#/components/schemas/SimpleErrorCollection"
},
"modifiedIssues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The IDs of the modified issues."
},
"unmodifiedIssues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The IDs of the unchanged issues, those issues where errors prevent modification."
}
},
"x-konfig-properties": {
"errors": {
"description": "A collection of errors related to unchanged issues. The collection size is limited, which means not all errors may be returned."
}
}
}
ReorderIssuePriorities
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of issue IDs to be reordered. Cannot contain duplicates nor after ID."
},
"after": {
"type": "string",
"writeOnly": true,
"description": "The ID of the priority. Required if `position` isn't provided."
},
"position": {
"type": "string",
"writeOnly": true,
"description": "The position for issue priorities to be moved to. Required if `after` isn't provided."
}
},
"description": "Change the order of issue priorities."
}
ReorderIssueResolutionsRequest
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"writeOnly": true
},
"writeOnly": true,
"description": "The list of resolution IDs to be reordered. Cannot contain duplicates nor after ID."
},
"after": {
"type": "string",
"writeOnly": true,
"description": "The ID of the resolution. Required if `position` isn't provided."
},
"position": {
"type": "string",
"writeOnly": true,
"description": "The position for issue resolutions to be moved to. Required if `after` isn't provided."
}
},
"description": "Change the order of issue resolutions."
}
RequiredMappingByIssueType
{
"type": "object",
"properties": {
"statusIds": {
"type": "array",
"items": {
"type": "string",
"description": "The status IDs requiring mapping."
},
"description": "The status IDs requiring mapping.",
"uniqueItems": true
},
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
}
},
"description": "The list of required status mappings by issue type."
}
RequiredMappingByWorkflows
{
"type": "object",
"properties": {
"statusIds": {
"type": "array",
"items": {
"type": "string",
"description": "The status IDs requiring mapping."
},
"description": "The status IDs requiring mapping.",
"uniqueItems": true
},
"sourceWorkflowId": {
"type": "string",
"description": "The ID of the source workflow."
},
"targetWorkflowId": {
"type": "string",
"description": "The ID of the target workflow."
}
},
"description": "The list of required status mappings by workflow."
}
Resolution
{
"xml": {
"name": "resolution"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue resolution."
},
"name": {
"type": "string",
"description": "The name of the issue resolution."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the issue resolution."
},
"description": {
"type": "string",
"description": "The description of the issue resolution."
}
},
"description": "Details of an issue resolution."
}
ResolutionId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue resolution."
}
},
"description": "The ID of an issue resolution.",
"additionalProperties": true
}
ResolutionJsonBean
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"self": {
"type": "string"
},
"default": {
"type": "boolean"
},
"iconUrl": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
Resource
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"format": "uri"
},
"url": {
"type": "string",
"format": "url"
},
"file": {
"type": "string",
"format": "binary"
},
"open": {
"type": "boolean"
},
"filename": {
"type": "string"
},
"readable": {
"type": "boolean"
},
"description": {
"type": "string"
},
"inputStream": {
"type": "object"
}
}
}
RestrictedPermission
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](https://dac-static.atlassian.com) to get the list of permissions."
},
"key": {
"type": "string",
"description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](https://dac-static.atlassian.com) to get the list of permissions."
}
},
"description": "Details of the permission.",
"additionalProperties": true
}
RichText
{
"type": "object",
"properties": {
"empty": {
"type": "boolean"
},
"emptyAdf": {
"type": "boolean"
},
"valueSet": {
"type": "boolean"
},
"finalised": {
"type": "boolean"
}
}
}
RoleActor
{
"xml": {
"name": "projectRoleActor"
},
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the role actor."
},
"name": {
"type": "string",
"readOnly": true,
"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."
},
"type": {
"enum": [
"atlassian-group-role-actor",
"atlassian-user-role-actor"
],
"type": "string",
"readOnly": true,
"description": "The type of role actor."
},
"actorUser": {
"$ref": "#/components/schemas/ProjectRoleUser"
},
"avatarUrl": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The avatar of the role actor."
},
"actorGroup": {
"$ref": "#/components/schemas/ProjectRoleGroup"
},
"displayName": {
"type": "string",
"readOnly": true,
"description": "The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name."
}
},
"description": "Details about a user assigned to a project role.",
"x-konfig-properties": {
"actorUser": {
"readOnly": true
},
"actorGroup": {
"readOnly": true
}
}
}
RuleConfiguration
{
"type": "object",
"required": [
"value"
],
"properties": {
"tag": {
"type": "string",
"maxLength": 255,
"description": "A tag used to filter rules in [Get workflow transition rule configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get)."
},
"value": {
"type": "string",
"description": "Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page."
},
"disabled": {
"type": "boolean",
"default": false,
"description": "Whether the rule is disabled."
}
},
"description": "A rule configuration."
}
SanitizedJqlQueries
{
"type": "object",
"properties": {
"queries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SanitizedJqlQuery"
},
"description": "The list of sanitized JQL queries."
}
},
"description": "The sanitized JQL queries for the given account IDs."
}
SanitizedJqlQuery
{
"type": "object",
"properties": {
"errors": {
"$ref": "#/components/schemas/ErrorCollection"
},
"accountId": {
"type": "string",
"nullable": true,
"maxLength": 128,
"description": "The account ID of the user for whom sanitization was performed."
},
"initialQuery": {
"type": "string",
"description": "The initial query."
},
"sanitizedQuery": {
"type": "string",
"nullable": true,
"description": "The sanitized query, if there were no errors."
}
},
"description": "Details of the sanitized JQL query.",
"x-konfig-properties": {
"errors": {
"description": "The list of errors."
}
}
}
Scope
{
"type": "object",
"properties": {
"type": {
"enum": [
"PROJECT",
"TEMPLATE"
],
"type": "string",
"readOnly": true,
"description": "The type of scope."
},
"project": {
"$ref": "#/components/schemas/ProjectDetails"
}
},
"description": "The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).",
"x-konfig-properties": {
"project": {
"readOnly": true,
"description": "The project the item has scope in."
}
},
"additionalProperties": true
}
Screen
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the screen."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the screen."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the screen."
}
},
"description": "A screen.",
"x-konfig-properties": {
"scope": {
"description": "The scope of the screen."
}
}
}
ScreenDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the screen. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the screen. The maximum length is 255 characters."
}
},
"description": "Details of a screen."
}
ScreenScheme
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the screen scheme."
},
"name": {
"type": "string",
"description": "The name of the screen scheme."
},
"screens": {
"$ref": "#/components/schemas/ScreenTypes"
},
"description": {
"type": "string",
"description": "The description of the screen scheme."
},
"issueTypeScreenSchemes": {
"$ref": "#/components/schemas/PageBeanIssueTypeScreenScheme"
}
},
"description": "A screen scheme.",
"x-konfig-properties": {
"screens": {
"description": "The IDs of the screens for the screen types of the screen scheme."
},
"issueTypeScreenSchemes": {
"description": "Details of the issue type screen schemes associated with the screen scheme."
}
}
}
ScreenSchemeDetails
{
"type": "object",
"required": [
"name",
"screens"
],
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the screen scheme. The name must be unique. The maximum length is 255 characters."
},
"screens": {
"$ref": "#/components/schemas/ScreenTypes"
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the screen scheme. The maximum length is 255 characters."
}
},
"description": "Details of a screen scheme.",
"x-konfig-properties": {
"screens": {
"description": "The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted."
}
}
}
ScreenSchemeId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the screen scheme."
}
},
"description": "The ID of a screen scheme."
}
ScreenTypes
{
"type": "object",
"required": [
"defaultScreen"
],
"writeOnly": true,
"properties": {
"edit": {
"type": "integer",
"format": "int64",
"description": "The ID of the edit screen."
},
"view": {
"type": "integer",
"format": "int64",
"description": "The ID of the view screen."
},
"create": {
"type": "integer",
"format": "int64",
"description": "The ID of the create screen."
},
"default": {
"type": "integer",
"format": "int64",
"description": "The ID of the default screen. Required when creating a screen scheme."
}
},
"description": "The IDs of the screens for the screen types of the screen scheme."
}
ScreenWithTab
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the screen."
},
"tab": {
"$ref": "#/components/schemas/ScreenableTab"
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the screen."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the screen."
}
},
"description": "A screen with tab details.",
"x-konfig-properties": {
"tab": {
"description": "The tab for the screen."
},
"scope": {
"description": "The scope of the screen."
}
}
}
ScreenableField
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the screen tab field."
},
"name": {
"type": "string",
"description": "The name of the screen tab field. Required on create and update. The maximum length is 255 characters."
}
},
"description": "A screen tab field."
}
ScreenableTab
{
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the screen tab."
},
"name": {
"type": "string",
"description": "The name of the screen tab. The maximum length is 255 characters."
}
},
"description": "A screen tab."
}
SearchAutoCompleteFilter
{
"type": "object",
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of project IDs used to filter the visible field details returned."
},
"includeCollapsedFields": {
"type": "boolean",
"default": false,
"description": "Include collapsed fields for fields that have non-unique names."
}
},
"description": "Details of how to filter and list search auto complete information."
}
SearchRequestBean
{
"type": "object",
"properties": {
"jql": {
"type": "string",
"description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression."
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Use [expand](em>#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are:\n\n * `renderedFields` Returns field values rendered in HTML format.\n * `names` Returns the display name of each field.\n * `schema` Returns the schema describing a field type.\n * `transitions` Returns all possible transitions for the issue.\n * `operations` Returns all possible operations for the issue.\n * `editmeta` Returns information about how each field can be edited.\n * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent.\n * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:\n\n * `*all` Returns all fields.\n * `*navigable` Returns navigable fields.\n * Any issue field, prefixed with a minus to exclude.\n\nThe default is `*navigable`.\n\nExamples:\n\n * `summary,comment` Returns the summary and comments fields only.\n * `-description` Returns all navigable (default) fields except description.\n * `*all,-comment` Returns all fields except comments.\n\nMultiple `fields` parameters can be included in a request.\n\nNote: All navigable fields are returned by default. This differs from [GET issue](https://dac-static.atlassian.com) where the default is all fields."
},
"startAt": {
"type": "integer",
"format": "int32",
"description": "The index of the first item to return in the page of results (page offset). The base index is `0`."
},
"maxResults": {
"type": "integer",
"format": "int32",
"default": 50,
"description": "The maximum number of items to return per page."
},
"properties": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list."
},
"fieldsByKeys": {
"type": "boolean",
"description": "Reference fields by their key (rather than ID). The default is `false`."
},
"validateQuery": {
"enum": [
"strict",
"warn",
"none",
"true",
"false"
],
"type": "string",
"description": "Determines how to validate the JQL query and treat the validation results. Supported values:\n\n * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings).\n * `warn` Returns all errors as warnings.\n * `none` No validation is performed.\n * `true` *Deprecated* A legacy synonym for `strict`.\n * `false` *Deprecated* A legacy synonym for `warn`.\n\nThe default is `strict`.\n\nNote: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value."
}
}
}
SearchResults
{
"type": "object",
"properties": {
"names": {
"type": "object",
"readOnly": true,
"description": "The ID and name of each field in the search results.",
"additionalProperties": {
"type": "string",
"readOnly": true
}
},
"total": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of results on the page."
},
"expand": {
"type": "string",
"readOnly": true,
"description": "Expand options that include additional search result details in the response."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueBean"
},
"readOnly": true,
"description": "The list of issues found by the search."
},
"schema": {
"type": "object",
"readOnly": true,
"description": "The schema describing the field types in the search results.",
"additionalProperties": {
"$ref": "#/components/schemas/JsonTypeBean"
}
},
"startAt": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
},
"maxResults": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
},
"warningMessages": {
"type": "array",
"items": {
"type": "string",
"readOnly": true
},
"readOnly": true,
"description": "Any warnings related to the JQL query."
}
},
"description": "The result of a JQL search."
}
SecurityLevel
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue level security item."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue level security item."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue level security item."
},
"isDefault": {
"type": "boolean",
"readOnly": true,
"description": "Whether the issue level security item is the default."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the issue level security item."
},
"issueSecuritySchemeId": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue level security scheme."
}
},
"description": "Details of an issue level security item."
}
SecurityLevelMember
{
"type": "object",
"required": [
"holder",
"id",
"issueSecurityLevelId",
"issueSecuritySchemeId"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue security level member."
},
"holder": {
"$ref": "#/components/schemas/PermissionHolder"
},
"managed": {
"type": "boolean",
"writeOnly": true
},
"issueSecurityLevelId": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue security level."
},
"issueSecuritySchemeId": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue security scheme."
}
},
"description": "Issue security level member.",
"x-konfig-properties": {
"holder": {
"readOnly": true,
"description": "The user or group being granted the permission. It consists of a `type` and a type-dependent `parameter`. See [Holder object](../api-group-permission-schemes/#holder-object) in *Get all permission schemes* for more information."
}
},
"additionalProperties": true
}
SecurityScheme
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue security scheme."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue security scheme."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue security scheme."
},
"levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityLevel"
}
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the issue security scheme."
},
"defaultSecurityLevelId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the default security level."
}
},
"description": "Details about a security scheme."
}
SecuritySchemeId
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue security scheme."
}
},
"description": "The ID of the issue security scheme.",
"additionalProperties": true
}
SecuritySchemeLevelBean
{
"type": "object",
"required": [
"name"
],
"writeOnly": true,
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The name of the issue security scheme level. Must be unique."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecuritySchemeLevelMemberBean"
},
"writeOnly": true,
"description": "The list of level members which should be added to the issue security scheme level."
},
"isDefault": {
"type": "boolean",
"writeOnly": true,
"description": "Specifies whether the level is the default level. False by default."
},
"description": {
"type": "string",
"maxLength": 4000,
"writeOnly": true,
"description": "The description of the issue security scheme level."
}
}
}
SecuritySchemeLevelMemberBean
{
"type": "object",
"required": [
"type"
],
"writeOnly": true,
"properties": {
"type": {
"type": "string",
"writeOnly": true,
"description": "The issue security level member type, e.g `reporter`, `group`, `user`."
},
"parameter": {
"type": "string",
"writeOnly": true,
"description": "The value corresponding to the specified member type."
}
}
}
SecuritySchemeMembersRequest
{
"type": "object",
"required": [
"securitySchemeLevelMembers"
],
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecuritySchemeLevelMemberBean"
},
"writeOnly": true,
"description": "The list of level members which should be added to the issue security scheme level."
}
},
"description": "Details of issue security scheme level new members."
}
SecuritySchemeWithProjects
{
"type": "object",
"required": [
"id",
"name",
"self"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue security scheme."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the issue security scheme."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue security scheme."
},
"projectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"readOnly": true
},
"readOnly": true,
"description": "The list of project IDs associated with the issue security scheme.",
"uniqueItems": true
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the issue security scheme."
},
"defaultLevel": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The default level ID of the issue security scheme."
}
},
"description": "Details about an issue security scheme.",
"additionalProperties": true
}
SecuritySchemes
{
"type": "object",
"properties": {
"issueSecuritySchemes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SecurityScheme"
},
"readOnly": true,
"description": "List of security schemes."
}
},
"description": "List of security schemes."
}
ServerInformation
{
"type": "object",
"properties": {
"baseUrl": {
"type": "string",
"description": "The base URL of the Jira instance."
},
"scmInfo": {
"type": "string",
"description": "The unique identifier of the Jira version."
},
"version": {
"type": "string",
"description": "The version of Jira."
},
"buildDate": {
"type": "string",
"format": "date-time",
"description": "The timestamp when the Jira version was built."
},
"displayUrl": {
"type": "string",
"description": "The display URL of the Jira instance."
},
"serverTime": {
"type": "string",
"format": "date-time",
"description": "The time in Jira when this request was responded to."
},
"buildNumber": {
"type": "integer",
"format": "int32",
"description": "The build number of the Jira version."
},
"serverTitle": {
"type": "string",
"description": "The name of the Jira instance."
},
"healthChecks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HealthCheckResult"
},
"description": "Jira instance health check results. Deprecated and no longer returned."
},
"deploymentType": {
"type": "string",
"description": "The type of server deployment. This is always returned as *Cloud*."
},
"serverTimeZone": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"rawOffset": {
"type": "integer",
"format": "int32"
},
"dstsavings": {
"type": "integer",
"format": "int32"
},
"displayName": {
"type": "string"
}
},
"description": "The default timezone of the Jira server. In a format known as Olson Time Zones, IANA Time Zones or TZ Database Time Zones."
},
"versionNumbers": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
},
"description": "The major, minor, and revision version numbers of the Jira version."
},
"displayUrlServicedeskHelpCenter": {
"type": "string",
"description": "The display URL of the Servicedesk Help Center."
}
},
"description": "Details about the Jira instance."
}
ServiceManagementNavigationInfo
{
"type": "object",
"properties": {
"queueId": {
"type": "integer",
"format": "int64"
},
"queueName": {
"type": "string"
},
"queueCategory": {
"type": "string"
}
}
}
ServiceRegistry
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "service ID"
},
"name": {
"type": "string",
"description": "service name"
},
"revision": {
"type": "string",
"description": "service revision"
},
"description": {
"type": "string",
"nullable": true,
"description": "service description"
},
"serviceTier": {
"$ref": "#/components/schemas/ServiceRegistryTier"
},
"organizationId": {
"type": "string",
"description": "organization ID"
}
}
}
ServiceRegistryTier
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "tier ID"
},
"name": {
"type": "string",
"nullable": true,
"description": "tier name"
},
"level": {
"type": "integer",
"description": "tier level"
},
"nameKey": {
"type": "string",
"example": "service-registry.tier1.name",
"description": "name key of the tier"
},
"description": {
"type": "string",
"nullable": true,
"description": "tier description"
}
}
}
SetDefaultLevelsRequest
{
"type": "object",
"required": [
"defaultValues"
],
"properties": {
"defaultValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DefaultLevelValue"
},
"maxLength": 1000,
"writeOnly": true,
"description": "List of objects with issue security scheme ID and new default level ID."
}
},
"description": "Details of new default levels.",
"additionalProperties": true
}
SetDefaultPriorityRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"writeOnly": true,
"description": "The ID of the new default issue priority. Must be an existing ID or null. Setting this to null erases the default priority setting."
}
},
"description": "The new default issue priority."
}
SetDefaultResolutionRequest
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"writeOnly": true,
"description": "The ID of the new default issue resolution. Must be an existing ID or null. Setting this to null erases the default resolution setting."
}
},
"description": "The new default issue resolution."
}
SharePermission
{
"type": "object",
"required": [
"type"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The unique identifier of the share permission."
},
"role": {
"$ref": "#/components/schemas/ProjectRole"
},
"type": {
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
],
"type": "string",
"description": "The type of share permission:\n\n * `user` Shared with a user.\n * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well.\n * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well.\n * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`.\n * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified.\n * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`.\n * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request."
},
"user": {
"$ref": "#/components/schemas/UserBean"
},
"group": {
"$ref": "#/components/schemas/GroupName"
},
"project": {
"$ref": "#/components/schemas/Project"
}
},
"description": "Details of a share permission for the filter.",
"x-konfig-properties": {
"role": {
"description": "The project role that the filter is shared with. \nFor a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
},
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](https://dac-static.atlassian.com) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. \nFor a request, specify the `id` for the project."
}
}
}
SharePermissionInputBean
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"user",
"project",
"group",
"projectRole",
"global",
"authenticated"
],
"type": "string",
"description": "The type of the share permission.Specify the type as follows:\n\n * `user` Share with a user.\n * `group` Share with a group. Specify `groupname` as well.\n * `project` Share with a project. Specify `projectId` as well.\n * `projectRole` Share with a project role in a project. Specify `projectId` and `projectRoleId` as well.\n * `global` Share globally, including anonymous users. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set.\n * `authenticated` Share with all logged-in users. This shows as `loggedin` in the response. If set, this type overrides all existing share permissions and must be deleted before any non-global share permissions is set."
},
"rights": {
"type": "integer",
"format": "int32",
"description": "The rights for the share permission."
},
"groupId": {
"type": "string",
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products.For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*. Cannot be provided with `groupname`."
},
"accountId": {
"type": "string",
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
},
"groupname": {
"type": "string",
"description": "The name of the group to share the filter with. Set `type` to `group`. Please note that the name of a group is mutable, to reliably identify a group use `groupId`."
},
"projectId": {
"type": "string",
"description": "The ID of the project to share the filter with. Set `type` to `project`."
},
"projectRoleId": {
"type": "string",
"description": "The ID of the project role to share the filter with. Set `type` to `projectRole` and the `projectId` for the project that the role is in."
}
}
}
SimpleApplicationPropertyBean
{
"xml": {
"name": "applicationProperty"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application property."
},
"value": {
"type": "string",
"description": "The new value."
}
}
}
SimpleErrorCollection
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"",
"additionalProperties": {
"type": "string"
}
},
"errorMessages": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\""
},
"httpStatusCode": {
"type": "integer",
"format": "int32"
}
}
}
SimpleLink
{
"xml": {
"name": "link"
},
"type": "object",
"properties": {
"id": {
"type": "string"
},
"href": {
"type": "string"
},
"label": {
"type": "string"
},
"title": {
"type": "string"
},
"weight": {
"type": "integer",
"format": "int32"
},
"iconClass": {
"type": "string"
},
"styleClass": {
"type": "string"
}
},
"description": "Details about the operations available in this version."
}
SimpleListWrapperApplicationRole
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"size": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplicationRole"
}
},
"callback": {
"$ref": "#/components/schemas/ListWrapperCallbackApplicationRole"
},
"max-results": {
"xml": {
"name": "max-results",
"attribute": true
},
"type": "integer",
"format": "int32"
},
"pagingCallback": {
"$ref": "#/components/schemas/ListWrapperCallbackApplicationRole"
}
}
}
SimpleListWrapperGroupName
{
"xml": {
"name": "list"
},
"type": "object",
"properties": {
"size": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int32"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupName"
}
},
"callback": {
"$ref": "#/components/schemas/ListWrapperCallbackGroupName"
},
"max-results": {
"xml": {
"name": "max-results",
"attribute": true
},
"type": "integer",
"format": "int32"
},
"pagingCallback": {
"$ref": "#/components/schemas/ListWrapperCallbackGroupName"
}
}
}
SimpleUsage
{
"type": "object",
"required": [
"issueTypeIds",
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"description": "The project ID for the usage."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"description": "The issue type IDs for the usage."
},
"description": "The issue type IDs for the usage."
}
},
"description": "Represents a usage of an entity by a project ID and related issue type IDs."
}
SimplifiedHierarchyLevel
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
},
"name": {
"type": "string",
"description": "The name of this hierarchy level."
},
"level": {
"type": "integer",
"format": "int32",
"description": "The level of this item in the hierarchy."
},
"aboveLevelId": {
"type": "integer",
"format": "int64",
"description": "The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
},
"belowLevelId": {
"type": "integer",
"format": "int64",
"description": "The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
},
"externalUuid": {
"type": "string",
"format": "uuid",
"description": "The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The issue types available in this hierarchy level."
},
"hierarchyLevelNumber": {
"type": "integer",
"format": "int32"
},
"projectConfigurationId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/)."
}
}
}
SoftwareNavigationInfo
{
"type": "object",
"properties": {
"boardId": {
"type": "integer",
"format": "int64"
},
"boardName": {
"type": "string"
},
"simpleBoard": {
"type": "boolean"
},
"totalBoardsInProject": {
"type": "integer",
"format": "int64"
}
}
}
Status
{
"type": "object",
"properties": {
"icon": {
"$ref": "#/components/schemas/Icon"
},
"resolved": {
"type": "boolean",
"description": "Whether the item is resolved. If set to \"true\", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font."
}
},
"description": "The status of the item.",
"x-konfig-properties": {
"icon": {
"description": "Details of the icon representing the status. If not provided, no status icon displays in Jira."
}
},
"additionalProperties": true
}
StatusCategory
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the status category."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the status category."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the status category."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the status category."
},
"colorName": {
"type": "string",
"readOnly": true,
"description": "The name of the color used to represent the status category."
}
},
"description": "A status category.",
"additionalProperties": true
}
StatusCreate
{
"type": "object",
"required": [
"name",
"statusCategory"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "The name of the status."
},
"description": {
"type": "string",
"description": "The description of the status."
},
"statusCategory": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
}
},
"description": "Details of the status being created."
}
StatusCreateRequest
{
"type": "object",
"required": [
"scope",
"statuses"
],
"properties": {
"scope": {
"$ref": "#/components/schemas/StatusScope"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusCreate"
},
"description": "Details of the statuses being created."
}
},
"description": "Details of the statuses being created and their scope."
}
StatusDetails
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the status."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the status."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the status."
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"iconUrl": {
"type": "string",
"readOnly": true,
"description": "The URL of the icon used to represent the status."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the status."
},
"statusCategory": {
"$ref": "#/components/schemas/StatusCategory"
}
},
"description": "A status.",
"x-konfig-properties": {
"scope": {
"readOnly": true,
"description": "The scope of the field."
},
"statusCategory": {
"readOnly": true,
"description": "The category assigned to the status."
}
},
"additionalProperties": true
}
StatusLayoutUpdate
{
"type": "object",
"required": [
"properties",
"statusReference"
],
"properties": {
"layout": {
"$ref": "#/components/schemas/WorkflowLayout"
},
"properties": {
"type": "object",
"description": "The properties for this status layout.",
"additionalProperties": {
"type": "string",
"description": "The properties for this status layout."
}
},
"statusReference": {
"type": "string",
"description": "A unique ID which the status will use to refer to this layout configuration."
}
},
"description": "The statuses associated with this workflow.",
"additionalProperties": true
}
StatusMapping
{
"type": "object",
"required": [
"issueTypeId",
"newStatusId",
"statusId"
],
"properties": {
"statusId": {
"type": "string",
"description": "The ID of the status."
},
"issueTypeId": {
"type": "string",
"description": "The ID of the issue type."
},
"newStatusId": {
"type": "string",
"description": "The ID of the new status."
}
},
"description": "Details about the mapping from a status to a new status for an issue type."
}
StatusMappingDTO
{
"type": "object",
"required": [
"issueTypeId",
"projectId",
"statusMigrations"
],
"properties": {
"projectId": {
"type": "string",
"description": "The project for the status mapping."
},
"issueTypeId": {
"type": "string",
"description": "The issue type for the status mapping."
},
"statusMigrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMigration"
},
"description": "The list of old and new status ID mappings for the specified project and issue type."
}
},
"description": "The mapping of old to new status ID for a specific project and issue type.",
"additionalProperties": true
}
StatusMetadata
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"name": {
"type": "string",
"description": "The name of the status."
},
"category": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
}
},
"description": "The details of the statuses in the associated workflows."
}
StatusMigration
{
"type": "object",
"required": [
"newStatusReference",
"oldStatusReference"
],
"properties": {
"newStatusReference": {
"type": "string",
"description": "The new status ID."
},
"oldStatusReference": {
"type": "string",
"description": "The old status ID."
}
},
"description": "The mapping of old to new status ID.",
"additionalProperties": true
}
StatusReferenceAndPort
{
"type": "object",
"nullable": true,
"required": [
"statusReference"
],
"properties": {
"port": {
"type": "integer",
"format": "int32",
"description": "The port this transition uses to connect to this status."
},
"statusReference": {
"type": "string",
"description": "The reference of this status."
}
},
"description": "The status reference and port that a transition is connected to."
}
StatusScope
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"PROJECT",
"GLOBAL"
],
"type": "string",
"description": "The scope of the status. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects."
},
"project": {
"$ref": "#/components/schemas/ProjectId"
}
},
"description": "The scope of the status."
}
StatusUpdate
{
"type": "object",
"required": [
"id",
"name",
"statusCategory"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"name": {
"type": "string",
"description": "The name of the status."
},
"description": {
"type": "string",
"description": "The description of the status."
},
"statusCategory": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
}
},
"description": "Details of the status being updated.",
"additionalProperties": true
}
StatusUpdateRequest
{
"type": "object",
"required": [
"statuses"
],
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusUpdate"
},
"description": "The list of statuses that will be updated."
}
},
"description": "The list of statuses that will be updated."
}
StatusesPerWorkflow
{
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"type": "string",
"description": "The status IDs associated with the workflow."
},
"description": "The status IDs associated with the workflow.",
"uniqueItems": true
},
"workflowId": {
"type": "string",
"description": "The ID of the workflow."
},
"initialStatusId": {
"type": "string",
"description": "The ID of the initial status for the workflow."
}
},
"description": "The statuses associated with each workflow."
}
StreamingResponseBody
{
"type": "object"
}
StringList
{
"type": "object"
}
SuggestedIssue
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue."
},
"img": {
"type": "string",
"readOnly": true,
"description": "The URL of the issue type's avatar."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the issue."
},
"keyHtml": {
"type": "string",
"readOnly": true,
"description": "The key of the issue in HTML format."
},
"summary": {
"type": "string",
"readOnly": true,
"description": "The phrase containing the query string in HTML format, with the string highlighted with HTML bold tags."
},
"summaryText": {
"type": "string",
"readOnly": true,
"description": "The phrase containing the query string, as plain text."
}
},
"description": "An issue suggested for use in the issue picker auto-completion."
}
SystemAvatars
{
"type": "object",
"properties": {
"system": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Avatar"
},
"readOnly": true,
"description": "A list of avatar details."
}
},
"description": "List of system avatars."
}
TaskProgressBeanObject
{
"type": "object",
"required": [
"elapsedRuntime",
"id",
"lastUpdate",
"progress",
"self",
"status",
"submitted",
"submittedBy"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the task."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the task."
},
"result": {
"description": "The result of the task execution."
},
"status": {
"enum": [
"ENQUEUED",
"RUNNING",
"COMPLETE",
"FAILED",
"CANCEL_REQUESTED",
"CANCELLED",
"DEAD"
],
"type": "string",
"description": "The status of the task."
},
"message": {
"type": "string",
"description": "Information about the progress of the task."
},
"started": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was started."
},
"finished": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was finished."
},
"progress": {
"type": "integer",
"format": "int64",
"description": "The progress of the task, as a percentage complete."
},
"submitted": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was submitted."
},
"lastUpdate": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task progress was last updated."
},
"description": {
"type": "string",
"description": "The description of the task."
},
"submittedBy": {
"type": "integer",
"format": "int64",
"description": "The ID of the user who submitted the task."
},
"elapsedRuntime": {
"type": "integer",
"format": "int64",
"description": "The execution time of the task, in milliseconds."
}
},
"description": "Details about a task."
}
TaskProgressBeanRemoveOptionFromIssuesResult
{
"type": "object",
"required": [
"elapsedRuntime",
"id",
"lastUpdate",
"progress",
"self",
"status",
"submitted",
"submittedBy"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the task."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the task."
},
"result": {
"$ref": "#/components/schemas/RemoveOptionFromIssuesResult"
},
"status": {
"enum": [
"ENQUEUED",
"RUNNING",
"COMPLETE",
"FAILED",
"CANCEL_REQUESTED",
"CANCELLED",
"DEAD"
],
"type": "string",
"description": "The status of the task."
},
"message": {
"type": "string",
"description": "Information about the progress of the task."
},
"started": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was started."
},
"finished": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was finished."
},
"progress": {
"type": "integer",
"format": "int64",
"description": "The progress of the task, as a percentage complete."
},
"submitted": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task was submitted."
},
"lastUpdate": {
"type": "integer",
"format": "int64",
"description": "A timestamp recording when the task progress was last updated."
},
"description": {
"type": "string",
"description": "The description of the task."
},
"submittedBy": {
"type": "integer",
"format": "int64",
"description": "The ID of the user who submitted the task."
},
"elapsedRuntime": {
"type": "integer",
"format": "int64",
"description": "The execution time of the task, in milliseconds."
}
},
"description": "Details about a task.",
"x-konfig-properties": {
"result": {
"description": "The result of the task execution."
}
}
}
TimeTrackingConfiguration
{
"type": "object",
"required": [
"defaultUnit",
"timeFormat",
"workingDaysPerWeek",
"workingHoursPerDay"
],
"properties": {
"timeFormat": {
"enum": [
"pretty",
"days",
"hours"
],
"type": "string",
"description": "The format that will appear on an issue's *Time Spent* field."
},
"defaultUnit": {
"enum": [
"minute",
"hour",
"day",
"week"
],
"type": "string",
"description": "The default unit of time applied to logged time."
},
"workingDaysPerWeek": {
"type": "number",
"format": "double",
"description": "The number of days in a working week."
},
"workingHoursPerDay": {
"type": "number",
"format": "double",
"description": "The number of hours in a working day."
}
},
"description": "Details of the time tracking configuration."
}
TimeTrackingDetails
{
"type": "object",
"properties": {
"timeSpent": {
"type": "string",
"readOnly": true,
"description": "Time worked on this issue in readable format."
},
"originalEstimate": {
"type": "string",
"readOnly": true,
"description": "The original estimate of time needed for this issue in readable format."
},
"timeSpentSeconds": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Time worked on this issue in seconds."
},
"remainingEstimate": {
"type": "string",
"readOnly": true,
"description": "The remaining estimate of time needed for this issue in readable format."
},
"originalEstimateSeconds": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The original estimate of time needed for this issue in seconds."
},
"remainingEstimateSeconds": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The remaining estimate of time needed for this issue in seconds."
}
},
"description": "Time tracking details."
}
TimeTrackingProvider
{
"type": "object",
"required": [
"key"
],
"properties": {
"key": {
"type": "string",
"description": "The key for the time tracking provider. For example, *JIRA*."
},
"url": {
"type": "string",
"readOnly": true,
"description": "The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app."
},
"name": {
"type": "string",
"description": "The name of the time tracking provider. For example, *JIRA provided time tracking*."
}
},
"description": "Details about the time tracking provider."
}
Transition
{
"type": "object",
"required": [
"description",
"from",
"id",
"name",
"to",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the transition."
},
"to": {
"type": "string",
"description": "The status the transition goes to."
},
"from": {
"type": "array",
"items": {
"type": "string",
"description": "The statuses the transition can start from."
},
"description": "The statuses the transition can start from."
},
"name": {
"type": "string",
"description": "The name of the transition."
},
"type": {
"enum": [
"global",
"initial",
"directed"
],
"type": "string",
"description": "The type of the transition."
},
"rules": {
"$ref": "#/components/schemas/WorkflowRules"
},
"screen": {
"$ref": "#/components/schemas/TransitionScreenDetails"
},
"properties": {
"type": "object",
"description": "The properties of the transition.",
"additionalProperties": {
"description": "The properties of the transition."
}
},
"description": {
"type": "string",
"description": "The description of the transition."
}
},
"description": "Details of a workflow transition."
}
TransitionScreenDetails
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the screen."
},
"name": {
"type": "string",
"description": "The name of the screen."
}
},
"description": "The details of a transition screen."
}
TransitionUpdateDTO
{
"type": "object",
"required": [
"id",
"name",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the transition."
},
"to": {
"$ref": "#/components/schemas/StatusReferenceAndPort"
},
"from": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusReferenceAndPort"
},
"description": "The statuses the transition can start from."
},
"name": {
"type": "string",
"description": "The name of the transition."
},
"type": {
"enum": [
"INITIAL",
"GLOBAL",
"DIRECTED"
],
"type": "string",
"description": "The transition type."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The post-functions of the transition."
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTrigger"
},
"description": "The triggers of the transition."
},
"conditions": {
"$ref": "#/components/schemas/ConditionGroupUpdate"
},
"properties": {
"type": "object",
"description": "The properties of the transition.",
"additionalProperties": {
"type": "string",
"description": "The properties of the transition."
}
},
"validators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The validators of the transition."
},
"description": {
"type": "string",
"description": "The description of the transition."
},
"transitionScreen": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"customIssueEventId": {
"type": "string",
"description": "The custom event ID of the transition."
}
},
"description": "The transitions of this workflow.",
"additionalProperties": true
}
Transitions
{
"type": "object",
"properties": {
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional transitions details in the response."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/IssueTransition"
},
"readOnly": true,
"description": "List of issue transitions."
}
},
"description": "List of issue transitions."
}
UiModificationContextDetails
{
"type": "object",
"writeOnly": true,
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the UI modification context."
},
"viewType": {
"enum": [
"GIC",
"IssueView"
],
"type": "string",
"description": "The view type of the context. Only `GIC`(Global Issue Create) and `IssueView` are supported. Null is treated as a wildcard, meaning the UI modification will be applied to all view types. Each UI modification context can have a maximum of one wildcard."
},
"projectId": {
"type": "string",
"description": "The project ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all projects. Each UI modification context can have a maximum of one wildcard."
},
"isAvailable": {
"type": "boolean",
"readOnly": true,
"description": "Whether a context is available. For example, when a project is deleted the context becomes unavailable."
},
"issueTypeId": {
"type": "string",
"description": "The issue type ID of the context. Null is treated as a wildcard, meaning the UI modification will be applied to all issue types. Each UI modification context can have a maximum of one wildcard."
}
},
"description": "The details of a UI modification's context, which define where to activate the UI modification."
}
UiModificationDetails
{
"type": "object",
"required": [
"id",
"name",
"self"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the UI modification."
},
"data": {
"type": "string",
"readOnly": true,
"description": "The data of the UI modification. The maximum size of the data is 50000 characters."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of the UI modification. The maximum length is 255 characters."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the UI modification."
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UiModificationContextDetails"
},
"readOnly": true,
"description": "List of contexts of the UI modification. The maximum number of contexts is 1000."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The description of the UI modification. The maximum length is 255 characters."
}
},
"description": "The details of a UI modification."
}
UiModificationIdentifiers
{
"type": "object",
"required": [
"id",
"self"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the UI modification."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the UI modification."
}
},
"description": "Identifiers for a UI modification."
}
UnrestrictedUserEmail
{
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "The email of the user"
},
"accountId": {
"type": "string",
"description": "The accountId of the user"
}
},
"additionalProperties": true
}
UpdateCustomFieldDetails
{
"type": "object",
"writeOnly": true,
"properties": {
"name": {
"type": "string",
"description": "The name of the custom field. It doesn't have to be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"description": "The description of the custom field. The maximum length is 40000 characters."
},
"searcherKey": {
"enum": [
"com.atlassian.jira.plugin.system.customfieldtypes:cascadingselectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:daterange",
"com.atlassian.jira.plugin.system.customfieldtypes:datetimerange",
"com.atlassian.jira.plugin.system.customfieldtypes:exactnumber",
"com.atlassian.jira.plugin.system.customfieldtypes:exacttextsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:grouppickersearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:labelsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:numberrange",
"com.atlassian.jira.plugin.system.customfieldtypes:projectsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:textsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
"com.atlassian.jira.plugin.system.customfieldtypes:versionsearcher"
],
"type": "string",
"description": "The searcher that defines the way the field is searched in Jira. It can be set to `null`, otherwise you must specify the valid searcher for the field type, as listed below (abbreviated values shown):\n\n * `cascadingselect`: `cascadingselectsearcher`\n * `datepicker`: `daterange`\n * `datetime`: `datetimerange`\n * `float`: `exactnumber` or `numberrange`\n * `grouppicker`: `grouppickersearcher`\n * `importid`: `exactnumber` or `numberrange`\n * `labels`: `labelsearcher`\n * `multicheckboxes`: `multiselectsearcher`\n * `multigrouppicker`: `multiselectsearcher`\n * `multiselect`: `multiselectsearcher`\n * `multiuserpicker`: `userpickergroupsearcher`\n * `multiversion`: `versionsearcher`\n * `project`: `projectsearcher`\n * `radiobuttons`: `multiselectsearcher`\n * `readonlyfield`: `textsearcher`\n * `select`: `multiselectsearcher`\n * `textarea`: `textsearcher`\n * `textfield`: `textsearcher`\n * `url`: `exacttextsearcher`\n * `userpicker`: `userpickergroupsearcher`\n * `version`: `versionsearcher`"
}
},
"description": "Details of a custom field."
}
UpdateDefaultProjectClassificationBean
{
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the project classification."
}
},
"description": "The request for updating the default project classification level."
}
UpdateDefaultScreenScheme
{
"type": "object",
"required": [
"screenSchemeId"
],
"properties": {
"screenSchemeId": {
"type": "string",
"writeOnly": true,
"description": "The ID of the screen scheme."
}
},
"description": "The ID of a screen scheme."
}
UpdateFieldConfigurationSchemeDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The name of the field configuration scheme. The name must be unique."
},
"description": {
"type": "string",
"maxLength": 1024,
"writeOnly": true,
"description": "The description of the field configuration scheme."
}
},
"description": "The details of the field configuration scheme."
}
UpdateIssueSecurityLevelDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the issue security scheme level. Must be unique."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the issue security scheme level."
}
},
"description": "Details of issue security scheme level.",
"additionalProperties": true
}
UpdateIssueSecuritySchemeRequestBean
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the security scheme scheme. Must be unique."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the security scheme scheme."
}
}
}
UpdateNotificationSchemeDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The name of the notification scheme. Must be unique."
},
"description": {
"type": "string",
"maxLength": 4000,
"writeOnly": true,
"description": "The description of the notification scheme."
}
},
"description": "Details of a notification scheme.",
"additionalProperties": true
}
UpdatePriorityDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the priority. Must be unique."
},
"iconUrl": {
"enum": [
"/images/icons/priorities/blocker.png",
"/images/icons/priorities/critical.png",
"/images/icons/priorities/high.png",
"/images/icons/priorities/highest.png",
"/images/icons/priorities/low.png",
"/images/icons/priorities/lowest.png",
"/images/icons/priorities/major.png",
"/images/icons/priorities/medium.png",
"/images/icons/priorities/minor.png",
"/images/icons/priorities/trivial.png"
],
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the priority."
},
"statusColor": {
"type": "string",
"writeOnly": true,
"description": "The status color of the priority in 3-digit or 6-digit hexadecimal format."
}
},
"description": "Details of an issue priority.",
"additionalProperties": true
}
UpdateProjectDetails
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters."
},
"url": {
"type": "string",
"description": "A link to information about this project, such as project documentation"
},
"lead": {
"type": "string",
"description": "This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The user name of the project lead. Cannot be provided with `leadAccountId`."
},
"name": {
"type": "string",
"description": "The name of the project."
},
"avatarId": {
"type": "integer",
"format": "int64",
"description": "An integer value for the project's avatar."
},
"categoryId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project's category. A complete list of category IDs is found using the [Get all project categories](https://dac-static.atlassian.com) operation. To remove the project category from the project, set the value to `-1.`"
},
"description": {
"type": "string",
"description": "A brief description of the project."
},
"assigneeType": {
"enum": [
"PROJECT_LEAD",
"UNASSIGNED"
],
"type": "string",
"description": "The default assignee when creating issues for this project."
},
"leadAccountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the project lead. Cannot be provided with `lead`."
},
"permissionScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the permission scheme for the project. Use the [Get all permission schemes](https://dac-static.atlassian.com) resource to see a list of all permission scheme IDs."
},
"notificationScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the notification scheme for the project. Use the [Get notification schemes](https://dac-static.atlassian.com) resource to get a list of notification scheme IDs."
},
"issueSecurityScheme": {
"type": "integer",
"format": "int64",
"description": "The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the [Get issue security schemes](https://dac-static.atlassian.com) resource to get all issue security scheme IDs."
}
},
"description": "Details about the project."
}
UpdateResolutionDetails
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 60,
"writeOnly": true,
"description": "The name of the resolution. Must be unique."
},
"description": {
"type": "string",
"maxLength": 255,
"writeOnly": true,
"description": "The description of the resolution."
}
},
"description": "Details of an issue resolution.",
"additionalProperties": true
}
UpdateScreenDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the screen. The name must be unique. The maximum length is 255 characters."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the screen. The maximum length is 255 characters."
}
},
"description": "Details of a screen."
}
UpdateScreenSchemeDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the screen scheme. The name must be unique. The maximum length is 255 characters."
},
"screens": {
"$ref": "#/components/schemas/UpdateScreenTypes"
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the screen scheme. The maximum length is 255 characters."
}
},
"description": "Details of a screen scheme.",
"x-konfig-properties": {
"screens": {
"description": "The IDs of the screens for the screen types of the screen scheme. Only screens used in classic projects are accepted."
}
}
}
UpdateScreenTypes
{
"type": "object",
"writeOnly": true,
"properties": {
"edit": {
"type": "string",
"writeOnly": true,
"description": "The ID of the edit screen. To remove the screen association, pass a null."
},
"view": {
"type": "string",
"writeOnly": true,
"description": "The ID of the view screen. To remove the screen association, pass a null."
},
"create": {
"type": "string",
"writeOnly": true,
"description": "The ID of the create screen. To remove the screen association, pass a null."
},
"default": {
"type": "string",
"writeOnly": true,
"description": "The ID of the default screen. When specified, must include a screen ID as a default screen is required."
}
},
"description": "The IDs of the screens for the screen types of the screen scheme."
}
UpdateUiModificationDetails
{
"type": "object",
"properties": {
"data": {
"type": "string",
"writeOnly": true,
"description": "The data of the UI modification. The maximum size of the data is 50000 characters."
},
"name": {
"type": "string",
"writeOnly": true,
"description": "The name of the UI modification. The maximum length is 255 characters."
},
"contexts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UiModificationContextDetails"
},
"writeOnly": true,
"description": "List of contexts of the UI modification. The maximum number of contexts is 1000. If provided, replaces all existing contexts."
},
"description": {
"type": "string",
"writeOnly": true,
"description": "The description of the UI modification. The maximum length is 255 characters."
}
},
"description": "The details of a UI modification."
}
UpdateUserToGroupBean
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "This property is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"accountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
}
},
"additionalProperties": true
}
UpdatedProjectCategory
{
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the project category."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The description of the project category."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the project category."
},
"description": {
"type": "string",
"readOnly": true,
"description": "The name of the project category."
}
},
"description": "A project category."
}
User
{
"xml": {
"name": "user"
},
"type": "object",
"properties": {
"key": {
"type": "string",
"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."
},
"name": {
"type": "string",
"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."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the user."
},
"active": {
"type": "boolean",
"readOnly": true,
"description": "Whether the user is active."
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"readOnly": true,
"description": "Expand options that include additional user details in the response."
},
"groups": {
"$ref": "#/components/schemas/SimpleListWrapperGroupName"
},
"locale": {
"type": "string",
"readOnly": true,
"description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"timeZone": {
"type": "string",
"readOnly": true,
"description": "The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null."
},
"accountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests."
},
"avatarUrls": {
"$ref": "#/components/schemas/AvatarUrlsBean"
},
"accountType": {
"enum": [
"atlassian",
"app",
"customer",
"unknown"
],
"type": "string",
"readOnly": true,
"description": "The user account type. Can take the following values:\n\n * `atlassian` regular Atlassian user account\n * `app` system account used for Connect applications and OAuth to represent external systems\n * `customer` Jira Service Desk account representing an external service desk"
},
"displayName": {
"type": "string",
"readOnly": true,
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value."
},
"emailAddress": {
"type": "string",
"readOnly": true,
"description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"applicationRoles": {
"$ref": "#/components/schemas/SimpleListWrapperApplicationRole"
}
},
"description": "A user with details as 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.",
"x-konfig-properties": {
"groups": {
"readOnly": true,
"description": "The groups that the user belongs to."
},
"avatarUrls": {
"readOnly": true,
"description": "The avatars of the user."
},
"applicationRoles": {
"readOnly": true,
"description": "The application roles the user is assigned to."
}
}
}
UserBean
{
"type": "object",
"properties": {
"key": {
"type": "string",
"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."
},
"name": {
"type": "string",
"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."
},
"self": {
"type": "string",
"format": "uri",
"description": "The URL of the user."
},
"active": {
"type": "boolean",
"description": "Whether the user is active."
},
"accountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"avatarUrls": {
"$ref": "#/components/schemas/UserBeanAvatarUrls"
},
"displayName": {
"type": "string",
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value."
}
},
"x-konfig-properties": {
"avatarUrls": {
"description": "The avatars of the user."
}
}
}
UserBeanAvatarUrls
{
"type": "object",
"properties": {
"16x16": {
"type": "string",
"format": "uri",
"description": "The URL of the user's 16x16 pixel avatar."
},
"24x24": {
"type": "string",
"format": "uri",
"description": "The URL of the user's 24x24 pixel avatar."
},
"32x32": {
"type": "string",
"format": "uri",
"description": "The URL of the user's 32x32 pixel avatar."
},
"48x48": {
"type": "string",
"format": "uri",
"description": "The URL of the user's 48x48 pixel avatar."
}
}
}
UserColumnRequestBody
{
"type": "object",
"properties": {
"columns": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
UserContextVariable
{
"type": "object",
"required": [
"accountId",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "Type of custom context variable."
},
"accountId": {
"type": "string",
"description": "The account ID of the user."
}
},
"description": "A [user](https://developer.atlassian.com/cloud/jira/platform/jira-expressions-type-reference#user) specified as an Atlassian account ID."
}
UserDetails
{
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true,
"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."
},
"name": {
"type": "string",
"readOnly": true,
"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."
},
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of the user."
},
"active": {
"type": "boolean",
"readOnly": true,
"description": "Whether the user is active."
},
"timeZone": {
"type": "string",
"readOnly": true,
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null."
},
"accountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"avatarUrls": {
"$ref": "#/components/schemas/AvatarUrlsBean"
},
"accountType": {
"type": "string",
"readOnly": true,
"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)"
},
"displayName": {
"type": "string",
"readOnly": true,
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value."
},
"emailAddress": {
"type": "string",
"readOnly": true,
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null."
}
},
"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.",
"x-konfig-properties": {
"avatarUrls": {
"readOnly": true,
"description": "The avatars of the user."
}
}
}
UserFilter
{
"type": "object",
"required": [
"enabled"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "string",
"description": "User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided."
},
"description": "User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 groups can be provided.",
"uniqueItems": true
},
"enabled": {
"type": "boolean",
"description": "Whether the filter is enabled."
},
"roleIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64",
"description": "Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided."
},
"description": "Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of 10 roles can be provided.",
"uniqueItems": true
}
},
"description": "Filter for a User Picker (single) custom field."
}
UserKey
{
"type": "object",
"properties": {
"key": {
"type": "string",
"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."
},
"accountId": {
"type": "string",
"maxLength": 128,
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import."
}
},
"description": "List of user account IDs."
}
UserList
{
"type": "object",
"properties": {
"size": {
"xml": {
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of items on the page."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"readOnly": true,
"description": "The list of items."
},
"end-index": {
"xml": {
"name": "end-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the last item returned on the page."
},
"max-results": {
"xml": {
"name": "max-results",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The maximum number of results that could be on the page."
},
"start-index": {
"xml": {
"name": "start-index",
"attribute": true
},
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The index of the first item returned on the page."
}
},
"description": "A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with."
}
UserMigrationBean
{
"type": "object",
"properties": {
"key": {
"type": "string"
},
"username": {
"type": "string"
},
"accountId": {
"type": "string"
}
}
}
UserPermission
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the permission. Either `id` or `key` must be specified. Use [Get all permissions](https://dac-static.atlassian.com) to get the list of permissions."
},
"key": {
"type": "string",
"description": "The key of the permission. Either `id` or `key` must be specified. Use [Get all permissions](https://dac-static.atlassian.com) to get the list of permissions."
},
"name": {
"type": "string",
"description": "The name of the permission."
},
"type": {
"enum": [
"GLOBAL",
"PROJECT"
],
"type": "string",
"description": "The type of the permission."
},
"description": {
"type": "string",
"description": "The description of the permission."
},
"deprecatedKey": {
"type": "boolean",
"description": "Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.`"
},
"havePermission": {
"type": "boolean",
"description": "Whether the permission is available to the user in the queried context."
}
},
"description": "Details of a permission and its availability to a user.",
"additionalProperties": true
}
UserPickerUser
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "This property is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"html": {
"type": "string",
"description": "The display name, email address, and key of the user with the matched query string highlighted with the HTML bold tag."
},
"name": {
"type": "string",
"description": "This property is no longer available . See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
},
"avatarUrl": {
"type": "string",
"format": "uri",
"description": "The avatar URL of the user."
},
"displayName": {
"type": "string",
"description": "The display name of the user. Depending on the user’s privacy setting, this may be returned as null."
}
},
"description": "A user found in a search."
}
ValidationOptionsForCreate
{
"type": "object",
"properties": {
"levels": {
"type": "array",
"items": {
"enum": [
"WARNING",
"ERROR"
],
"type": "string"
},
"maxItems": 2
}
},
"description": "The level of validation to return from the API. If no values are provided, the default would return `WARNING` and `ERROR` level validation results."
}
ValidationOptionsForUpdate
{
"type": "object",
"properties": {
"levels": {
"type": "array",
"items": {
"enum": [
"WARNING",
"ERROR"
],
"type": "string"
},
"maxItems": 2
}
},
"description": "The level of validation to return from the API. If no values are provided, the default would return `WARNING` and `ERROR` level validation results."
}
ValueOperand
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "The operand value."
},
"encodedValue": {
"type": "string",
"description": "Encoded value, which can be used directly in a JQL query."
}
},
"description": "An operand that is a user-provided value."
}
Version
{
"xml": {
"name": "version"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the version."
},
"name": {
"type": "string",
"description": "The unique name of the version. Required when creating a version. Optional when updating a version. The maximum length is 255 characters."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the version."
},
"driver": {
"type": "string",
"readOnly": true,
"description": "If the expand option `driver` is used, returns the Atlassian account ID of the driver."
},
"expand": {
"xml": {
"attribute": true
},
"type": "string",
"description": "Use [expand](em>#expansion) to include additional information about version in the response. This parameter accepts a comma-separated list. Expand options include:\n\n * `operations` Returns the list of operations available for this version.\n * `issuesstatus` Returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*.\n * `driver` Returns the Atlassian account ID of the version driver.\n * `approvers` Returns a list containing approvers for this version.\n\nOptional for create and update."
},
"overdue": {
"type": "boolean",
"readOnly": true,
"description": "Indicates that the version is overdue."
},
"project": {
"type": "string",
"description": "Deprecated. Use `projectId`."
},
"archived": {
"type": "boolean",
"description": "Indicates that the version is archived. Optional when creating or updating a version."
},
"released": {
"type": "boolean",
"description": "Indicates that the version is released. If the version is released a request to release again is ignored. Not applicable when creating a version. Optional when updating a version."
},
"approvers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionApprover"
},
"readOnly": true,
"description": "If the expand option `approvers` is used, returns a list containing the approvers for this version."
},
"projectId": {
"type": "integer",
"format": "int64",
"description": "The ID of the project to which this version is attached. Required when creating a version. Not applicable when updating a version."
},
"startDate": {
"type": "string",
"format": "date",
"description": "The start date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"operations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleLink"
},
"readOnly": true,
"description": "If the expand option `operations` is used, returns the list of operations available for this version."
},
"description": {
"type": "string",
"description": "The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes."
},
"releaseDate": {
"type": "string",
"format": "date",
"description": "The release date of the version. Expressed in ISO 8601 format (yyyy-mm-dd). Optional when creating or updating a version."
},
"userStartDate": {
"type": "string",
"readOnly": true,
"description": "The date on which work on this version is expected to start, expressed in the instance's *Day/Month/Year Format* date format."
},
"userReleaseDate": {
"type": "string",
"readOnly": true,
"description": "The date on which work on this version is expected to finish, expressed in the instance's *Day/Month/Year Format* date format."
},
"moveUnfixedIssuesTo": {
"type": "string",
"format": "uri",
"description": "The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not applicable when creating a version. Optional when updating a version."
},
"issuesStatusForFixVersion": {
"$ref": "#/components/schemas/VersionIssuesStatus"
}
},
"description": "Details about a project version.",
"x-konfig-properties": {
"issuesStatusForFixVersion": {
"readOnly": true,
"description": "If the expand option `issuesstatus` is used, returns the count of issues in this version for each of the status categories *to do*, *in progress*, *done*, and *unmapped*. The *unmapped* property contains a count of issues with a status other than *to do*, *in progress*, and *done*."
}
}
}
VersionApprover
{
"type": "object",
"properties": {
"status": {
"type": "string",
"readOnly": true,
"description": "The status of the approval, which can be *PENDING*, *APPROVED*, or *DECLINED*"
},
"accountId": {
"type": "string",
"readOnly": true,
"description": "The Atlassian account ID of the approver."
},
"description": {
"type": "string",
"readOnly": true,
"description": "A description of what the user is approving within the specified version."
},
"declineReason": {
"type": "string",
"readOnly": true,
"description": "A description of why the user is declining the approval."
}
},
"description": "Contains details about a version approver.",
"additionalProperties": true
}
VersionIssueCounts
{
"xml": {
"name": "version"
},
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of these count details."
},
"customFieldUsage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionUsageInCustomField"
},
"readOnly": true,
"description": "List of custom fields using the version."
},
"issuesFixedCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues where the `fixVersion` is set to the version."
},
"issuesAffectedCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues where the `affectedVersion` is set to the version."
},
"issueCountWithCustomFieldsShowingVersion": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues where a version custom field is set to the version."
}
},
"description": "Various counts of issues within a version."
}
VersionIssuesStatus
{
"type": "object",
"properties": {
"done": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues with status *done*."
},
"toDo": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues with status *to do*."
},
"unmapped": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues with a status other than *to do*, *in progress*, and *done*."
},
"inProgress": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues with status *in progress*."
}
},
"description": "Counts of the number of issues in various statuses.",
"additionalProperties": true
}
VersionMoveBean
{
"xml": {
"name": "version"
},
"type": "object",
"properties": {
"after": {
"type": "string",
"format": "uri",
"description": "The URL (self link) of the version after which to place the moved version. Cannot be used with `position`."
},
"position": {
"enum": [
"Earlier",
"Later",
"First",
"Last"
],
"type": "string",
"description": "An absolute position in which to place the moved version. Cannot be used with `after`."
}
}
}
VersionRelatedWork
{
"type": "object",
"required": [
"category"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The URL of the related work. Will be null for the native release note related work item, but is otherwise required."
},
"title": {
"type": "string",
"description": "The title of the related work"
},
"issueId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the issue associated with the related work (if there is one). Cannot be updated via the Rest API."
},
"category": {
"type": "string",
"description": "The category of the related work"
},
"relatedWorkId": {
"type": "string",
"readOnly": true,
"description": "The id of the related work. For the native release note related work item, this will be null, and Rest API does not support updating it."
}
},
"description": "Associated related work to a version"
}
VersionUnresolvedIssuesCount
{
"xml": {
"name": "version"
},
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of these count details."
},
"issuesCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of issues."
},
"issuesUnresolvedCount": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of unresolved issues."
}
},
"description": "Count of a version's unresolved issues."
}
VersionUsageInCustomField
{
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"readOnly": true,
"description": "The name of the custom field."
},
"customFieldId": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the custom field."
},
"issueCountWithVersionInCustomField": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Count of the issues where the custom field contains the version."
}
},
"description": "List of custom fields using the version."
}
Visibility
{
"type": "object",
"properties": {
"type": {
"enum": [
"group",
"role"
],
"type": "string",
"description": "Whether visibility of this item is restricted to a group or role."
},
"value": {
"type": "string",
"description": "The name of the group or role that visibility of this item is restricted to. Please note that the name of a group is mutable, to reliably identify a group use `identifier`."
},
"identifier": {
"type": "string",
"nullable": true,
"description": "The ID of the group or the name of the role that visibility of this item is restricted to."
}
},
"description": "The group or role to which this item is visible.",
"additionalProperties": true
}
Votes
{
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of these issue vote details."
},
"votes": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The number of votes on the issue."
},
"voters": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
},
"readOnly": true,
"description": "List of the users who have voted on this issue. An empty list is returned when the calling user doesn't have the *View voters and watchers* project permission."
},
"hasVoted": {
"type": "boolean",
"readOnly": true,
"description": "Whether the user making this request has voted on the issue."
}
},
"description": "The details of votes on an issue."
}
WarningCollection
{
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Watchers
{
"xml": {
"name": "watchers"
},
"type": "object",
"properties": {
"self": {
"type": "string",
"readOnly": true,
"description": "The URL of these issue watcher details."
},
"watchers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetails"
},
"readOnly": true,
"description": "Details of the users watching this issue."
},
"isWatching": {
"type": "boolean",
"readOnly": true,
"description": "Whether the calling user is watching this issue."
},
"watchCount": {
"type": "integer",
"format": "int32",
"readOnly": true,
"description": "The number of users watching this issue."
}
},
"description": "The details of watchers on an issue."
}
Webhook
{
"type": "object",
"required": [
"events",
"id",
"jqlFilter"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The ID of the webhook."
},
"events": {
"type": "array",
"items": {
"enum": [
"jira:issue_created",
"jira:issue_updated",
"jira:issue_deleted",
"comment_created",
"comment_updated",
"comment_deleted",
"issue_property_set",
"issue_property_deleted"
],
"type": "string"
},
"description": "The Jira events that trigger the webhook."
},
"jqlFilter": {
"type": "string",
"description": "The JQL filter that specifies which issues the webhook is sent for."
},
"expirationDate": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The date after which the webhook is no longer sent. Use [Extend webhook life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) to extend the date."
},
"fieldIdsFilter": {
"type": "array",
"items": {
"type": "string",
"description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook <code>jira:issue_updated</code> is sent. If this parameter is not present, the app is notified about all field updates."
},
"description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates."
},
"issuePropertyKeysFilter": {
"type": "array",
"items": {
"type": "string",
"description": "A list of issue property keys. A change of those issue properties triggers the <code>issue_property_set</code> or <code>issue_property_deleted</code> webhooks. If this parameter is not present, the app is notified about all issue property updates."
},
"description": "A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates."
}
},
"description": "A webhook."
}
WebhookDetails
{
"type": "object",
"required": [
"events",
"jqlFilter"
],
"properties": {
"events": {
"type": "array",
"items": {
"enum": [
"jira:issue_created",
"jira:issue_updated",
"jira:issue_deleted",
"comment_created",
"comment_updated",
"comment_deleted",
"issue_property_set",
"issue_property_deleted"
],
"type": "string"
},
"description": "The Jira events that trigger the webhook."
},
"jqlFilter": {
"type": "string",
"description": "The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL can be used. The supported elements are:\n\n * Fields: `issueKey`, `project`, `issuetype`, `status`, `assignee`, `reporter`, `issue.property`, and `cf[id]`. For custom fields (`cf[id]`), only the epic label custom field is supported.\".\n * Operators: `=`, `!=`, `IN`, and `NOT IN`."
},
"fieldIdsFilter": {
"type": "array",
"items": {
"type": "string",
"description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook <code>jira:issue_updated</code> is sent. If this parameter is not present, the app is notified about all field updates."
},
"description": "A list of field IDs. When the issue changelog contains any of the fields, the webhook `jira:issue_updated` is sent. If this parameter is not present, the app is notified about all field updates."
},
"issuePropertyKeysFilter": {
"type": "array",
"items": {
"type": "string",
"description": "A list of issue property keys. A change of those issue properties triggers the <code>issue_property_set</code> or <code>issue_property_deleted</code> webhooks. If this parameter is not present, the app is notified about all issue property updates."
},
"description": "A list of issue property keys. A change of those issue properties triggers the `issue_property_set` or `issue_property_deleted` webhooks. If this parameter is not present, the app is notified about all issue property updates."
}
},
"description": "A list of webhooks."
}
WebhookRegistrationDetails
{
"type": "object",
"required": [
"url",
"webhooks"
],
"properties": {
"url": {
"type": "string",
"description": "The URL that specifies where to send the webhooks. This URL must use the same base URL as the Connect app. Only a single URL per app is allowed to be registered."
},
"webhooks": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebhookDetails"
},
"description": "A list of webhooks."
}
},
"description": "Details of webhooks to register."
}
WebhooksExpirationDate
{
"type": "object",
"required": [
"expirationDate"
],
"properties": {
"expirationDate": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The expiration date of all the refreshed webhooks."
}
},
"description": "The date the refreshed webhooks expire."
}
WorkManagementNavigationInfo
{
"type": "object",
"properties": {
"boardName": {
"type": "string"
}
}
}
Workflow
{
"type": "object",
"required": [
"description",
"id"
],
"properties": {
"id": {
"$ref": "#/components/schemas/PublishedWorkflowId"
},
"created": {
"type": "string",
"format": "date-time",
"description": "The creation date of the workflow."
},
"schemes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowSchemeIdName"
},
"description": "The workflow schemes the workflow is assigned to."
},
"updated": {
"type": "string",
"format": "date-time",
"description": "The last edited date of the workflow."
},
"projects": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectDetails"
},
"description": "The projects the workflow is assigned to, through workflow schemes."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowStatus"
},
"description": "The statuses of the workflow."
},
"isDefault": {
"type": "boolean",
"description": "Whether this is the default workflow."
},
"operations": {
"$ref": "#/components/schemas/WorkflowOperations"
},
"description": {
"type": "string",
"description": "The description of the workflow."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Transition"
},
"description": "The transitions of the workflow."
},
"hasDraftWorkflow": {
"type": "boolean",
"description": "Whether the workflow has a draft version."
}
},
"description": "Details about a workflow."
}
WorkflowAssociationStatusMapping
{
"type": "object",
"required": [
"newStatusId",
"oldStatusId"
],
"properties": {
"newStatusId": {
"type": "string",
"description": "The ID of the status in the new workflow."
},
"oldStatusId": {
"type": "string",
"description": "The ID of the status in the old workflow that isn't present in the new workflow."
}
},
"description": "The list of status mappings."
}
WorkflowCapabilities
{
"type": "object",
"properties": {
"forgeRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableWorkflowForgeRule"
},
"description": "The Forge provided ecosystem rules available."
},
"editorScope": {
"enum": [
"PROJECT",
"GLOBAL"
],
"type": "string",
"description": "The scope of the workflow capabilities. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects."
},
"systemRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableWorkflowSystemRule"
},
"description": "The Atlassian provided system rules available."
},
"connectRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableWorkflowConnectRule"
},
"description": "The Connect provided ecosystem rules available."
},
"projectTypes": {
"type": "array",
"items": {
"enum": [
"software",
"service_desk",
"product_discovery",
"business",
"unknown"
],
"type": "string"
},
"description": "The types of projects that this capability set is available for."
},
"triggerRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AvailableWorkflowTriggers"
},
"description": "The trigger rules available."
}
}
}
WorkflowCompoundCondition
{
"type": "object",
"required": [
"conditions",
"nodeType",
"operator"
],
"properties": {
"nodeType": {
"type": "string"
},
"operator": {
"enum": [
"AND",
"OR"
],
"type": "string",
"description": "The compound condition operator."
},
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowCondition"
},
"description": "The list of workflow conditions."
}
},
"description": "A compound workflow transition rule condition. This object returns `nodeType` as `compound`."
}
WorkflowCondition
{
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowSimpleCondition"
},
{
"$ref": "#/components/schemas/WorkflowCompoundCondition"
}
],
"description": "The workflow transition rule conditions tree.",
"discriminator": {
"mapping": {
"simple": "#/components/schemas/WorkflowSimpleCondition",
"compound": "#/components/schemas/WorkflowCompoundCondition"
},
"propertyName": "nodeType"
}
}
WorkflowCreate
{
"type": "object",
"maximum": 20,
"required": [
"name",
"statuses",
"transitions"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow to create."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusLayoutUpdate"
},
"description": "The statuses associated with this workflow."
},
"description": {
"type": "string",
"description": "The description of the workflow to create."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransitionUpdateDTO"
},
"description": "The transitions of this workflow."
},
"startPointLayout": {
"$ref": "#/components/schemas/WorkflowLayout"
}
},
"description": "The details of the workflows to create."
}
WorkflowCreateRequest
{
"type": "object",
"required": [
"scope",
"statuses",
"workflows"
],
"properties": {
"scope": {
"$ref": "#/components/schemas/WorkflowScope"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowStatusUpdate"
},
"maximum": 1000,
"description": "The statuses to associate with the workflows."
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowCreate"
},
"maximum": 20,
"description": "The details of the workflows to create."
}
},
"description": "The create workflows payload."
}
WorkflowCreateResponse
{
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflowStatus"
},
"description": "List of created statuses.",
"uniqueItems": true
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflow"
},
"description": "List of created workflows.",
"uniqueItems": true
}
},
"description": "Details of the created workflows and statuses."
}
WorkflowCreateValidateRequest
{
"type": "object",
"required": [
"payload"
],
"properties": {
"payload": {
"$ref": "#/components/schemas/WorkflowCreateRequest"
},
"validationOptions": {
"$ref": "#/components/schemas/ValidationOptionsForCreate"
}
}
}
WorkflowElementReference
{
"type": "object",
"properties": {
"ruleId": {
"type": "string",
"description": "A rule ID."
},
"propertyKey": {
"type": "string",
"description": "A property key."
},
"transitionId": {
"type": "string",
"description": "A transition ID."
},
"statusReference": {
"type": "string",
"description": "A status reference."
},
"statusMappingReference": {
"$ref": "#/components/schemas/ProjectAndIssueTypePair"
}
},
"description": "A reference to the location of the error. This will be null if the error does not refer to a specific element."
}
WorkflowIDs
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow."
},
"entityId": {
"type": "string",
"description": "The entity ID of the workflow."
}
},
"description": "The classic workflow identifiers."
}
WorkflowId
{
"type": "object",
"required": [
"draft",
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The name of the workflow."
},
"draft": {
"type": "boolean",
"description": "Whether the workflow is in the draft state."
}
},
"description": "Properties that identify a workflow."
}
WorkflowLayout
{
"type": "object",
"nullable": true,
"properties": {
"x": {
"type": "number",
"format": "double",
"description": "The x axis location."
},
"y": {
"type": "number",
"format": "double",
"description": "The y axis location."
}
},
"description": "The starting point for the statuses in the workflow."
}
WorkflowMetadataAndIssueTypeRestModel
{
"type": "object",
"required": [
"issueTypeIds",
"workflow"
],
"properties": {
"workflow": {
"$ref": "#/components/schemas/WorkflowMetadataRestModel"
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"description": "The list of issue type IDs for the mapping."
},
"description": "The list of issue type IDs for the mapping."
}
},
"description": "The workflow metadata and issue type IDs which use this workflow."
}
WorkflowMetadataRestModel
{
"type": "object",
"required": [
"description",
"id",
"name",
"usage",
"version"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the workflow."
},
"name": {
"type": "string",
"description": "The name of the workflow."
},
"usage": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleUsage"
},
"description": "Use the optional `workflows.usages` expand to get additional information about the projects and issue types associated with the workflows in the workflow scheme."
},
"version": {
"$ref": "#/components/schemas/DocumentVersion"
},
"description": {
"type": "string",
"description": "The description of the workflow."
}
},
"description": "Workflow metadata and usage detail."
}
WorkflowOperations
{
"type": "object",
"required": [
"canDelete",
"canEdit"
],
"properties": {
"canEdit": {
"type": "boolean",
"description": "Whether the workflow can be updated."
},
"canDelete": {
"type": "boolean",
"description": "Whether the workflow can be deleted."
}
},
"description": "Operations allowed on a workflow"
}
WorkflowReadRequest
{
"type": "object",
"properties": {
"workflowIds": {
"type": "array",
"items": {
"type": "string",
"description": "The list of workflow IDs to query."
},
"description": "The list of workflow IDs to query."
},
"workflowNames": {
"type": "array",
"items": {
"type": "string",
"description": "The list of workflow names to query."
},
"description": "The list of workflow names to query."
},
"projectAndIssueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProjectAndIssueTypePair"
},
"description": "The list of projects and issue types to query."
}
}
}
WorkflowReadResponse
{
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflowStatus"
},
"description": "List of statuses.",
"uniqueItems": true
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflow"
},
"description": "List of workflows.",
"uniqueItems": true
}
},
"description": "Details of workflows and related statuses."
}
WorkflowReferenceStatus
{
"type": "object",
"properties": {
"layout": {
"$ref": "#/components/schemas/WorkflowStatusLayout"
},
"deprecated": {
"type": "boolean",
"description": "Indicates if the status is deprecated."
},
"properties": {
"type": "object",
"description": "The properties associated with the status.",
"additionalProperties": {
"type": "string",
"description": "The properties associated with the status."
}
},
"statusReference": {
"type": "string",
"description": "The reference of the status."
}
},
"description": "The statuses referenced in the workflow."
}
WorkflowRuleConfiguration
{
"type": "object",
"nullable": true,
"required": [
"ruleKey"
],
"properties": {
"id": {
"type": "string",
"nullable": true,
"description": "The ID of the rule."
},
"ruleKey": {
"type": "string",
"description": "The rule key of the rule."
},
"parameters": {
"type": "object",
"description": "The parameters related to the rule.",
"additionalProperties": {
"type": "string",
"description": "The parameters related to the rule."
}
}
},
"description": "The configuration of the rule."
}
WorkflowRules
{
"type": "object",
"properties": {
"validators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRule"
},
"description": "The workflow validators."
},
"postFunctions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRule"
},
"description": "The workflow post functions."
},
"conditionsTree": {
"$ref": "#/components/schemas/WorkflowCondition"
}
},
"description": "A collection of transition rules."
}
WorkflowRulesSearch
{
"type": "object",
"required": [
"ruleIds",
"workflowEntityId"
],
"properties": {
"expand": {
"type": "string",
"example": "transition",
"description": "Use expand to include additional information in the response. This parameter accepts `transition` which, for each rule, returns information about the transition the rule is assigned to."
},
"ruleIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "55d44f1d-c859-42e5-9c27-2c5ec3f340b1",
"description": "Workflow rule ID."
},
"maxItems": 10,
"minItems": 1,
"description": "The list of workflow rule IDs."
},
"workflowEntityId": {
"type": "string",
"format": "uuid",
"example": "a498d711-685d-428d-8c3e-bc03bb450ea7",
"description": "The workflow ID."
}
},
"description": "Details of the workflow and its transition rules."
}
WorkflowRulesSearchDetails
{
"type": "object",
"properties": {
"validRules": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRules"
},
"description": "List of valid workflow transition rules."
},
"invalidRules": {
"type": "array",
"items": {
"type": "string",
"format": "uuid",
"example": "55d44f1d-c859-42e5-9c27-2c5ec3f340b1",
"description": "Workflow rule ID."
},
"description": "List of workflow rule IDs that do not belong to the workflow or can not be found."
},
"workflowEntityId": {
"type": "string",
"format": "uuid",
"example": "a498d711-685d-428d-8c3e-bc03bb450ea7",
"description": "The workflow ID."
}
},
"description": "Details of workflow transition rules."
}
WorkflowScheme
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "The ID of the workflow scheme."
},
"name": {
"type": "string",
"description": "The name of the workflow scheme. The name must be unique. The maximum length is 255 characters. Required when creating a workflow scheme."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true
},
"draft": {
"type": "boolean",
"readOnly": true,
"description": "Whether the workflow scheme is a draft or not."
},
"issueTypes": {
"type": "object",
"readOnly": true,
"description": "The issue types available in Jira.",
"additionalProperties": {
"$ref": "#/components/schemas/IssueTypeDetails"
}
},
"description": {
"type": "string",
"description": "The description of the workflow scheme."
},
"lastModified": {
"type": "string",
"readOnly": true,
"description": "The date-time that the draft workflow scheme was last modified. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows."
},
"defaultWorkflow": {
"type": "string",
"description": "The name of the default workflow for the workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira. If `defaultWorkflow` is not specified when creating a workflow scheme, it is set to *Jira Workflow (jira)*."
},
"lastModifiedUser": {
"$ref": "#/components/schemas/User"
},
"issueTypeMappings": {
"type": "object",
"description": "The issue type to workflow mappings, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"additionalProperties": {
"type": "string"
}
},
"updateDraftIfNeeded": {
"type": "boolean",
"description": "Whether to create or update a draft workflow scheme when updating an active workflow scheme. An active workflow scheme is a workflow scheme that is used by at least one project. The following examples show how this property works:\n\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `true`: If a draft workflow scheme exists, it is updated. Otherwise, a draft workflow scheme is created.\n * Update an active workflow scheme with `updateDraftIfNeeded` set to `false`: An error is returned, as active workflow schemes cannot be updated.\n * Update an inactive workflow scheme with `updateDraftIfNeeded` set to `true`: The workflow scheme is updated, as inactive workflow schemes do not require drafts to update.\n\nDefaults to `false`."
},
"originalDefaultWorkflow": {
"type": "string",
"readOnly": true,
"description": "For draft workflow schemes, this property is the name of the default workflow for the original workflow scheme. The default workflow has *All Unassigned Issue Types* assigned to it in Jira."
},
"originalIssueTypeMappings": {
"type": "object",
"readOnly": true,
"description": "For draft workflow schemes, this property is the issue type to workflow mappings for the original workflow scheme, where each mapping is an issue type ID and workflow name pair. Note that an issue type can only be mapped to one workflow in a workflow scheme.",
"additionalProperties": {
"type": "string",
"readOnly": true
}
}
},
"description": "Details about a workflow scheme.",
"x-konfig-properties": {
"lastModifiedUser": {
"readOnly": true,
"description": "The user that last modified the draft workflow scheme. A modification is a change to the issue type-project mappings only. This property does not apply to non-draft workflows."
}
}
}
WorkflowSchemeAssociation
{
"type": "object",
"required": [
"issueTypeIds",
"workflowId"
],
"properties": {
"workflowId": {
"type": "string",
"description": "The ID of the workflow."
},
"issueTypeIds": {
"type": "array",
"items": {
"type": "string",
"description": "The issue types assigned to the workflow."
},
"description": "The issue types assigned to the workflow.",
"uniqueItems": true
}
},
"description": "The explicit association between issue types and a workflow in a workflow scheme."
}
WorkflowSchemeAssociations
{
"type": "object",
"required": [
"projectIds",
"workflowScheme"
],
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The list of projects that use the workflow scheme."
},
"workflowScheme": {
"$ref": "#/components/schemas/WorkflowScheme"
}
},
"description": "A workflow scheme along with a list of projects that use it.",
"x-konfig-properties": {
"workflowScheme": {
"description": "The workflow scheme."
}
}
}
WorkflowSchemeIdName
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the workflow scheme."
},
"name": {
"type": "string",
"description": "The name of the workflow scheme."
}
},
"description": "The ID and the name of the workflow scheme."
}
WorkflowSchemeProjectAssociation
{
"type": "object",
"required": [
"projectId"
],
"properties": {
"projectId": {
"type": "string",
"description": "The ID of the project."
},
"workflowSchemeId": {
"type": "string",
"description": "The ID of the workflow scheme. If the workflow scheme ID is `null`, the operation assigns the default workflow scheme."
}
},
"description": "An associated workflow scheme and project."
}
WorkflowSchemeReadRequest
{
"type": "object",
"properties": {
"projectIds": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"description": "The list of project IDs to query."
},
"nullable": true,
"description": "The list of project IDs to query."
},
"workflowSchemeIds": {
"type": "array",
"items": {
"type": "string",
"nullable": true,
"description": "The list of workflow scheme IDs to query."
},
"nullable": true,
"description": "The list of workflow scheme IDs to query."
}
},
"description": "The workflow scheme read request body."
}
WorkflowSchemeReadResponse
{
"type": "object",
"required": [
"id",
"name",
"projectIdsUsingScheme",
"scope",
"version",
"workflowsForIssueTypes"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the workflow scheme."
},
"name": {
"type": "string",
"description": "The name of the workflow scheme."
},
"scope": {
"$ref": "#/components/schemas/WorkflowScope"
},
"taskId": {
"type": "string",
"nullable": true,
"description": "Indicates if there's an [asynchronous task](https://dac-static.atlassian.com) for this workflow scheme."
},
"version": {
"$ref": "#/components/schemas/DocumentVersion"
},
"description": {
"type": "string",
"nullable": true,
"description": "The description of the workflow scheme."
},
"defaultWorkflow": {
"$ref": "#/components/schemas/WorkflowMetadataRestModel"
},
"projectIdsUsingScheme": {
"type": "array",
"items": {
"type": "string",
"description": "The IDs of projects using the workflow scheme."
},
"description": "The IDs of projects using the workflow scheme."
},
"workflowsForIssueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowMetadataAndIssueTypeRestModel"
},
"description": "Mappings from workflows to issue types."
}
}
}
WorkflowSchemeUpdateRequest
{
"type": "object",
"required": [
"description",
"id",
"name",
"version"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of this workflow scheme."
},
"name": {
"type": "string",
"description": "The new name for this workflow scheme."
},
"version": {
"$ref": "#/components/schemas/DocumentVersion"
},
"description": {
"type": "string",
"description": "The new description for this workflow scheme."
},
"defaultWorkflowId": {
"type": "string",
"description": "The ID of the workflow for issue types without having a mapping defined in this workflow scheme. Only used in global-scoped workflow schemes. If the `defaultWorkflowId` isn't specified, this is set to *Jira Workflow (jira)*."
},
"workflowsForIssueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowSchemeAssociation"
},
"description": "Mappings from workflows to issue types."
},
"statusMappingsByWorkflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingsByWorkflow"
},
"description": "The status mappings by workflows. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`."
},
"statusMappingsByIssueTypeOverride": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MappingsByIssueTypeOverride"
},
"description": "Overrides, for the selected issue types, any status mappings provided in `statusMappingsByWorkflows`. Status mappings are required when the new workflow for an issue type doesn't contain all statuses that the old workflow has. Status mappings can be provided by a combination of `statusMappingsByWorkflows` and `statusMappingsByIssueTypeOverride`."
}
},
"description": "The update workflow scheme payload.",
"additionalProperties": true
}
WorkflowSchemeUpdateRequiredMappingsRequest
{
"type": "object",
"required": [
"id",
"workflowsForIssueTypes"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the workflow scheme."
},
"defaultWorkflowId": {
"type": "string",
"nullable": true,
"description": "The ID of the new default workflow for this workflow scheme. Only used in global-scoped workflow schemes. If it isn't specified, is set to *Jira Workflow (jira)*."
},
"workflowsForIssueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowSchemeAssociation"
},
"description": "The new workflow to issue type mappings for this workflow scheme."
}
},
"description": "The request payload to get the required mappings for updating a workflow scheme."
}
WorkflowSchemeUpdateRequiredMappingsResponse
{
"type": "object",
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMetadata"
},
"description": "The details of the statuses in the associated workflows.",
"uniqueItems": true
},
"statusesPerWorkflow": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusesPerWorkflow"
},
"description": "The statuses associated with each workflow.",
"uniqueItems": true
},
"statusMappingsByWorkflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequiredMappingByWorkflows"
},
"description": "The list of required status mappings by workflow.",
"uniqueItems": true
},
"statusMappingsByIssueTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequiredMappingByIssueType"
},
"description": "The list of required status mappings by issue type.",
"uniqueItems": true
}
}
}
WorkflowScope
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"enum": [
"PROJECT",
"GLOBAL"
],
"type": "string",
"description": "The scope of the workflow. `GLOBAL` for company-managed projects and `PROJECT` for team-managed projects."
},
"project": {
"$ref": "#/components/schemas/ProjectId"
}
},
"description": "The scope of the workflow."
}
WorkflowSimpleCondition
{
"type": "object",
"required": [
"nodeType",
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the transition rule."
},
"nodeType": {
"type": "string"
},
"configuration": {
"type": "object",
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
},
"description": "A workflow transition rule condition. This object returns `nodeType` as `simple`."
}
WorkflowStatus
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue status."
},
"name": {
"type": "string",
"description": "The name of the status in the workflow."
},
"properties": {
"type": "object",
"description": "Additional properties that modify the behavior of issues in this status. Supports the properties `jira.issue.editable` and `issueEditable` (deprecated) that indicate whether issues are editable.",
"additionalProperties": {
"description": "Additional properties that modify the behavior of issues in this status. Supports the properties <code>jira.issue.editable</code> and <code>issueEditable</code> (deprecated) that indicate whether issues are editable."
}
}
},
"description": "Details of a workflow status."
}
WorkflowStatusAndPort
{
"type": "object",
"nullable": true,
"properties": {
"port": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "The port the transition is connected to this status."
},
"statusReference": {
"type": "string",
"description": "The reference of this status."
}
},
"description": "The status reference and port that a transition is connected to."
}
WorkflowStatusLayout
{
"type": "object",
"nullable": true,
"properties": {
"x": {
"type": "number",
"format": "double",
"nullable": true,
"description": "The x axis location."
},
"y": {
"type": "number",
"format": "double",
"nullable": true,
"description": "The y axis location."
}
},
"description": "The x and y location of the status in the workflow."
}
WorkflowStatusUpdate
{
"type": "object",
"maximum": 1000,
"required": [
"name",
"statusCategory",
"statusReference"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the status."
},
"name": {
"type": "string",
"description": "The name of the status."
},
"description": {
"type": "string",
"description": "The description of the status."
},
"statusCategory": {
"enum": [
"TODO",
"IN_PROGRESS",
"DONE"
],
"type": "string",
"description": "The category of the status."
},
"statusReference": {
"type": "string",
"description": "The reference of the status."
}
},
"description": "Details of the status being updated.",
"additionalProperties": true
}
WorkflowTransition
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "The transition ID."
},
"name": {
"type": "string",
"description": "The transition name."
}
},
"description": "A workflow transition."
}
WorkflowTransitionProperty
{
"type": "object",
"required": [
"value"
],
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the transition property."
},
"key": {
"type": "string",
"readOnly": true,
"description": "The key of the transition property. Also known as the name of the transition property."
},
"value": {
"type": "string",
"description": "The value of the transition property."
}
},
"description": "Details about the server Jira is running on.",
"additionalProperties": true
}
WorkflowTransitionRule
{
"type": "object",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the transition rule."
},
"configuration": {
"description": "EXPERIMENTAL. The configuration of the transition rule."
}
},
"description": "A workflow transition rule."
}
WorkflowTransitionRules
{
"type": "object",
"required": [
"workflowId"
],
"properties": {
"conditions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppWorkflowTransitionRule"
},
"description": "The list of conditions within the workflow."
},
"validators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppWorkflowTransitionRule"
},
"description": "The list of validators within the workflow."
},
"workflowId": {
"$ref": "#/components/schemas/WorkflowId"
},
"postFunctions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AppWorkflowTransitionRule"
},
"description": "The list of post functions within the workflow."
}
},
"description": "A workflow with transition rules."
}
WorkflowTransitionRulesDetails
{
"type": "object",
"required": [
"workflowId",
"workflowRuleIds"
],
"properties": {
"workflowId": {
"$ref": "#/components/schemas/WorkflowId"
},
"workflowRuleIds": {
"type": "array",
"items": {
"type": "string",
"description": "The list of connect workflow rule IDs."
},
"description": "The list of connect workflow rule IDs.",
"uniqueItems": true
}
},
"description": "Details about a workflow configuration update request."
}
WorkflowTransitionRulesUpdate
{
"type": "object",
"required": [
"workflows"
],
"properties": {
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRules"
},
"description": "The list of workflows with transition rules to update."
}
},
"description": "Details about a workflow configuration update request."
}
WorkflowTransitionRulesUpdateErrorDetails
{
"type": "object",
"required": [
"ruleUpdateErrors",
"updateErrors",
"workflowId"
],
"properties": {
"workflowId": {
"$ref": "#/components/schemas/WorkflowId"
},
"updateErrors": {
"type": "array",
"items": {
"type": "string",
"description": "An error specifying why the workflow update failed."
},
"description": "The list of errors that specify why the workflow update failed. The workflow was not updated if the list contains any entries.",
"uniqueItems": true
},
"ruleUpdateErrors": {
"type": "object",
"description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string",
"description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated."
},
"description": "A list of transition rule update errors, indexed by the transition rule ID. Any transition rule that appears here wasn't updated.",
"uniqueItems": true
}
}
},
"description": "Details of any errors encountered while updating workflow transition rules for a workflow."
}
WorkflowTransitionRulesUpdateErrors
{
"type": "object",
"required": [
"updateResults"
],
"properties": {
"updateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRulesUpdateErrorDetails"
},
"description": "A list of workflows."
}
},
"description": "Details of any errors encountered while updating workflow transition rules."
}
WorkflowTransitions
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the transition."
},
"to": {
"$ref": "#/components/schemas/WorkflowStatusAndPort"
},
"from": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowStatusAndPort"
},
"description": "The statuses the transition can start from."
},
"name": {
"type": "string",
"description": "The name of the transition."
},
"type": {
"enum": [
"INITIAL",
"GLOBAL",
"DIRECTED"
],
"type": "string",
"description": "The transition type."
},
"actions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The post-functions of the transition."
},
"triggers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTrigger"
},
"description": "The triggers of the transition."
},
"conditions": {
"$ref": "#/components/schemas/ConditionGroupConfiguration"
},
"properties": {
"type": "object",
"description": "The properties of the transition.",
"additionalProperties": {
"type": "string",
"description": "The properties of the transition."
}
},
"validators": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"description": "The validators of the transition."
},
"description": {
"type": "string",
"description": "The description of the transition."
},
"transitionScreen": {
"$ref": "#/components/schemas/WorkflowRuleConfiguration"
},
"customIssueEventId": {
"type": "string",
"nullable": true,
"description": "The custom event ID of the transition."
}
},
"description": "The transitions of the workflow."
}
WorkflowTrigger
{
"type": "object",
"required": [
"parameters",
"ruleKey"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of the trigger."
},
"ruleKey": {
"type": "string",
"description": "The rule key of the trigger."
},
"parameters": {
"type": "object",
"description": "The parameters of the trigger.",
"additionalProperties": {
"type": "string",
"description": "The parameters of the trigger."
}
}
},
"description": "The trigger configuration associated with a workflow."
}
WorkflowUpdate
{
"type": "object",
"maximum": 20,
"required": [
"id",
"statuses",
"transitions",
"version"
],
"properties": {
"id": {
"type": "string",
"description": "The ID of this workflow."
},
"version": {
"$ref": "#/components/schemas/DocumentVersion"
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusLayoutUpdate"
},
"description": "The statuses associated with this workflow."
},
"description": {
"type": "string",
"description": "The new description for this workflow."
},
"transitions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransitionUpdateDTO"
},
"description": "The transitions of this workflow."
},
"statusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMappingDTO"
},
"description": "The mapping of old to new status ID for a specific project and issue type."
},
"startPointLayout": {
"$ref": "#/components/schemas/WorkflowLayout"
},
"defaultStatusMappings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StatusMigration"
},
"description": "The mapping of old to new status ID."
}
},
"description": "The details of the workflows to update.",
"additionalProperties": true
}
WorkflowUpdateRequest
{
"type": "object",
"required": [
"statuses",
"workflows"
],
"properties": {
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowStatusUpdate"
},
"maximum": 1000,
"description": "The statuses to associate with the workflows."
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowUpdate"
},
"maximum": 20,
"description": "The details of the workflows to update."
}
},
"description": "The update workflows payload."
}
WorkflowUpdateResponse
{
"type": "object",
"properties": {
"taskId": {
"type": "string",
"nullable": true,
"description": "If there is a [asynchronous task](https://dac-static.atlassian.com) operation, as a result of this update."
},
"statuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflowStatus"
},
"description": "List of updated statuses.",
"uniqueItems": true
},
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JiraWorkflow"
},
"description": "List of updated workflows.",
"uniqueItems": true
}
}
}
WorkflowUpdateValidateRequestBean
{
"type": "object",
"required": [
"payload"
],
"properties": {
"payload": {
"$ref": "#/components/schemas/WorkflowUpdateRequest"
},
"validationOptions": {
"$ref": "#/components/schemas/ValidationOptionsForUpdate"
}
}
}
WorkflowUsages
{
"type": "object",
"properties": {
"workflowId": {
"type": "string",
"description": "Workflow ID."
},
"workflowName": {
"type": "string",
"description": "Workflow name."
}
},
"description": "The workflows that use this status. Only available if the `workflowUsages` expand is requested."
}
WorkflowValidationError
{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "An error code."
},
"type": {
"enum": [
"RULE",
"STATUS",
"STATUS_LAYOUT",
"STATUS_PROPERTY",
"WORKFLOW",
"TRANSITION",
"TRANSITION_PROPERTY",
"SCOPE",
"STATUS_MAPPING",
"TRIGGER"
],
"type": "string",
"description": "The type of element the error or warning references."
},
"level": {
"enum": [
"WARNING",
"ERROR"
],
"type": "string",
"description": "The validation error level."
},
"message": {
"type": "string",
"description": "An error message."
},
"elementReference": {
"$ref": "#/components/schemas/WorkflowElementReference"
}
},
"description": "The details about a workflow validation error."
}
WorkflowValidationErrorList
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowValidationError"
},
"description": "The list of validation errors."
}
}
}
WorkflowsWithTransitionRulesDetails
{
"type": "object",
"required": [
"workflows"
],
"properties": {
"workflows": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowTransitionRulesDetails"
},
"description": "The list of workflows with transition rules to delete."
}
},
"description": "Details of workflows and their transition rules to delete."
}
Worklog
{
"xml": {
"name": "worklog"
},
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the worklog record."
},
"self": {
"type": "string",
"format": "uri",
"readOnly": true,
"description": "The URL of the worklog item."
},
"author": {
"$ref": "#/components/schemas/UserDetails"
},
"comment": {
"description": "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The datetime on which the worklog was created."
},
"issueId": {
"type": "string",
"readOnly": true,
"description": "The ID of the issue this worklog is for."
},
"started": {
"type": "string",
"format": "date-time",
"description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog."
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "The datetime on which the worklog was last updated."
},
"timeSpent": {
"type": "string",
"description": "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided."
},
"properties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityProperty"
},
"description": "Details of properties for the worklog. Optional when creating or updating a worklog."
},
"visibility": {
"$ref": "#/components/schemas/Visibility"
},
"updateAuthor": {
"$ref": "#/components/schemas/UserDetails"
},
"timeSpentSeconds": {
"type": "integer",
"format": "int64",
"description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided."
}
},
"description": "Details of a worklog.",
"x-konfig-properties": {
"author": {
"readOnly": true,
"description": "Details of the user who created the worklog."
},
"visibility": {
"description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog."
},
"updateAuthor": {
"readOnly": true,
"description": "Details of the user who last updated the worklog."
}
},
"additionalProperties": true
}
WorklogIdsRequestBean
{
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "A list of worklog IDs.",
"uniqueItems": true
}
}
}
WorkspaceDataPolicy
{
"type": "object",
"properties": {
"anyContentBlocked": {
"type": "boolean",
"readOnly": true,
"description": "Whether the workspace contains any content inaccessible to the requesting application."
}
},
"description": "Details about data policy."
}