@itentialopensource/adapter-jira

{ "openapi": "3.0.1", "info": { "title": "The Jira Cloud platform REST API", "description": "Jira Cloud platform REST API documentation", "termsOfService": "http://atlassian.com/terms/", "contact": { "email": "ecosystem@atlassian.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1001.0.0-SNAPSHOT" }, "externalDocs": { "description": "Find out more about Atlassian products and services.", "url": "http://www.atlassian.com" }, "servers": [ { "url": "https://your-domain.atlassian.net" } ], "tags": [ { "name": "Announcement banner", "description": "This resource represents an announcement banner. Use it to retrieve and update banner configuration." }, { "name": "Application roles", "description": "This resource represents application roles. Use it to get details of an application role or all application roles." }, { "name": "Audit records", "description": "This resource represents audits that record activities undertaken in Jira. Use it to get a list of audit records." }, { "name": "Avatars", "description": "This resource represents system and custom avatars. Use it to obtain the details of system or custom avatars, add and remove avatars from a project or issue type, and obtain avatar images." }, { "name": "Dashboards", "description": "This resource represents dashboards. Use it to obtain the details of dashboards as well as get, create, update, or remove item properties and gadgets from dashboards." }, { "name": "Filters", "description": "This resource represents [filters](https://confluence.atlassian.com/x/eQiiLQ). Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters." }, { "name": "Filter sharing", "description": "This resource represents options for sharing [filters](#api-group-Filters). Use it to get share scopes as well as add and remove share scopes from filters." }, { "name": "Group and user picker", "description": "This resource represents a list of users and a list of groups. Use it to obtain the details to populate user and group picker suggestions list." }, { "name": "Groups", "description": "This resource represents groups of users. Use it to get, create, find, and delete groups as well as add and remove users from groups. (\\[WARNING\\] The standard Atlassian group names are default names only and can be edited or deleted. For example, an admin or Atlassian support could delete the default group jira-software-users or rename it to jsw-users at any point. See https://support.atlassian.com/user-management/docs/create-and-update-groups/ for details.)" }, { "name": "Instance information", "description": "This resource represents information about the Jira instance. Use it to get license details." }, { "name": "Issues", "description": "This resource represents Jira issues. Use it to:\n\n * create or edit issues, individually or in bulk.\n * retrieve metadata about the options for creating or editing issues.\n * delete an issue.\n * assign a user to an issue.\n * get issue changelogs.\n * send notifications about an issue.\n * get details of the transitions available for an issue.\n * transition an issue." }, { "name": "UI modifications (apps)", "description": "UI modifications is an experimental feature available for **Forge apps only**. It enables Forge apps to control how selected Jira fields behave on global create issue dialog. For example: hide specific fields, set them as required, etc." }, { "name": "Issue attachments", "description": "This resource represents issue attachments and the attachment settings for Jira. Use it to get the metadata for an attachment, delete an attachment, and view the metadata for the contents of an attachment. Also, use it to get the attachment settings for Jira." }, { "name": "Issue comments", "description": "This resource represents issue comments. Use it to:\n\n * get, create, update, and delete a comment from an issue.\n * get all comments from issue.\n * get a list of comments by comment ID." }, { "name": "Issue comment properties", "description": "This resource represents [issue comment](#api-group-Issue-comments) properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "Issue fields", "description": "This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields." }, { "name": "Issue field configurations", "description": "This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes." }, { "name": "Issue custom field contexts", "description": "This resource represents issue custom field contexts. Use it to:\n\n * get, create, update, and delete custom field contexts.\n * get context to issue types and projects mappings.\n * get custom field contexts for projects and issue types.\n * assign custom field contexts to projects.\n * remove custom field contexts from projects.\n * add issue types to custom field contexts." }, { "name": "Issue custom field options", "description": "This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types:\n\n * Checkboxes.\n * Radio Buttons.\n * Select List (single choice).\n * Select List (multiple choices).\n * Select List (cascading).\n\nSee [Issue custom field options (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom issue field select list options created by a Connect app.\n\nUse it to retrieve, create, update, order, and delete custom field options." }, { "name": "Issue custom field options (apps)", "description": "This resource represents custom issue field select list options created by a Connect app. See [Issue custom field options](#api-group-Issue-custom-field-options) to manipulate options created in Jira or using the REST API.\n\nA select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select an option from a list. Use it to add, remove, and update the options of a select list issue field." }, { "name": "Issue custom field values (apps)", "description": "This resource represents the values of custom fields added by [Forge apps](https://developer.atlassian.com/platform/forge/). Use it to update the value of a custom field on issues." }, { "name": "Issue custom field configuration (apps)", "description": "This resource represents configurations stored against a custom field context by a [Forge app](https://developer.atlassian.com/platform/forge/). Configurations are information used by the Forge app at runtime to determine how to handle or process the data in a custom field in a given context. Use this resource to set and read configurations." }, { "name": "Issue links", "description": "This resource represents links between issues. Use it to get, create, and delete links between issues.\n\nTo use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled." }, { "name": "Issue link types", "description": "This resource represents [issue link](#api-group-Issue-links) types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.\n\nTo use it, the site must have [issue linking](https://confluence.atlassian.com/x/yoXKM) enabled." }, { "name": "Issue navigator settings", "description": "This resource represents issue navigator settings. Use it to get and set issue navigator default columns." }, { "name": "Issue notification schemes", "description": "This resource represents notification schemes, lists of events and the recipients who will receive notifications for those events. Use it to get details of a notification scheme and a list of notification schemes.\n\n### About notification schemes ###\n\nA notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the `notificationSchemeEvents` object and contains pairs of `events` and `notifications`:\n\n * `event` Identifies the type of event. The events can be [Jira system events](https://support.atlassian.com/jira-cloud-administration/docs/configure-notification-schemes/) (see the *Events* section) or [custom events](https://support.atlassian.com/jira-cloud-administration/docs/add-a-custom-event/).\n * `notifications` Identifies the [recipients](https://confluence.atlassian.com/x/8YdKLg#Creatinganotificationscheme-recipientsRecipients) of notifications for each event. Recipients can be any of the following types:\n \n * `CurrentAssignee`\n * `Reporter`\n * `CurrentUser`\n * `ProjectLead`\n * `ComponentLead`\n * `User` (the `parameter` is the user key)\n * `Group` (the `parameter` is the group name)\n * `ProjectRole` (the `parameter` is the project role ID)\n * `EmailAddress`\n * `AllWatchers`\n * `UserCustomField` (the `parameter` is the ID of the custom field)\n * `GroupCustomField`(the `parameter` is the ID of the custom field)" }, { "name": "Issue priorities", "description": "This resource represents issue priorities. Use it to get, create and update issue priorities and details for individual issue priorities." }, { "name": "Issue properties", "description": "This resource represents [issue](#api-group-Issues) properties, which provides for storing custom data against an issue. Use it to get, set, and delete issue properties as well as obtain details of all properties on an issue. Operations to bulk update and delete issue properties are also provided. Issue properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "Issue remote links", "description": "This resource represents remote issue links, a way of linking Jira to information in other systems. Use it to get, create, update, and delete remote issue links either by ID or global ID. The global ID provides a way of accessing remote issue links using information about the item's remote system host and remote system identifier." }, { "name": "Issue resolutions", "description": "This resource represents issue resolution values. Use it to obtain a list of all issue resolution values and the details of individual resolution values." }, { "name": "Issue search", "description": "This resource represents various ways to search for issues. Use it to search for issues with a JQL query and find issues to populate an issue picker." }, { "name": "Issue security level", "description": "This resource represents issue security levels. Use it to obtain the details of any issue security level. For more information about issue security levels, see [Configuring issue-level security](https://confluence.atlassian.com/x/J4lKLg)." }, { "name": "Issue security schemes", "description": "This resource represents issue security schemes. Use it to get an issue security scheme or a list of issue security schemes.\n\nIssue security schemes control which users or groups of users can view an issue. When an issue security scheme is associated with a project, its security levels can be applied to issues in that project. Sub-tasks also inherit the security level of their parent issue." }, { "name": "Issue security scheme", "description": "This resource represents issue security schemes, issue security levels, and issue security level members. Use it to get, create, update, and delete issue security schemes or issue security scheme details. Note that only company-managed (classic) projects are supported.\n\n### About issue security schemes ###\n\nIssue security schemes control which users or groups of users can view an issue. An issue security scheme is made up of multiple security levels. Each level can have users or groups of users assigned to it. The following are valid security level members:\n\n * Individual users\n * Groups of users\n * Project roles\n * Issue roles\n * \"Anyone\", for example to allow anonymous access\n * A (multi-)user or (multi-)group picker custom field" }, { "name": "Issue types", "description": "This resource represents issues types. Use it to:\n\n * get, create, update, and delete issue types.\n * get all issue types for a user.\n * get alternative issue types.\n * set an avatar for an issue type." }, { "name": "Issue type schemes", "description": "This resource represents issue type schemes in classic projects. Use it to:\n\n * get issue type schemes and a list of the projects that use them.\n * associate issue type schemes with projects.\n * add issue types to issue type schemes.\n * delete issue types from issue type schemes.\n * create, update, and delete issue type schemes.\n * change the order of issue types in issue type schemes." }, { "name": "Issue type screen schemes", "description": "This resource represents issue type screen schemes. Use it to:\n\n * get issue type screen schemes and a list of the projects that use them.\n * create issue type screen schemes.\n * update issue type screen schemes.\n * delete issue type screen schemes.\n * associate issue type screen schemes with projects.\n * append issue type to screen scheme mappings to issue type screen schemes.\n * remove issue type to screen scheme mappings from issue type screen schemes.\n * update default screen scheme of issue type screen scheme." }, { "name": "Issue type properties", "description": "This resource represents [issue type](#api-group-Issue-types) properties, which provides for storing custom data against an issue type. Use it to get, create, and delete issue type properties as well as obtain the keys of all properties on a issues type. Issue type properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "Issue votes", "description": "This resource represents votes cast by users on an issue. Use it to get details of votes on an issue as well as cast and withdrawal votes." }, { "name": "Issue watchers", "description": "This resource represents users watching an issue. Use it to get details of users watching an issue as well as start and stop a user watching an issue." }, { "name": "Issue worklogs", "description": "This resource represents issue worklogs. Use it to:\n\n * get, create, update, and delete worklogs.\n * obtain lists of updated or deleted worklogs." }, { "name": "Issue worklog properties", "description": "This resource represents [issue worklog](#api-group-Issue-worklogs) properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "Jira expressions", "description": "This resource is a collection of operations for [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/)." }, { "name": "Jira settings", "description": "This resource represents various settings in Jira. Use it to get and update Jira settings and properties." }, { "name": "JQL", "description": "This resource represents JQL search auto-complete details. Use it to obtain JQL search auto-complete data and suggestions for use in programmatic construction of queries or custom query builders. It also provides operations to:\n\n * convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.\n * convert readable details in one or more JQL queries to IDs where a user doesn't have permission to view the entity whose details are readable." }, { "name": "JQL functions (apps)", "description": "This resource represents JQL function's precomputations. Precomputation is a mapping between custom function call and JQL fragment returned by this function. Use it to get and update precomputations." }, { "name": "Labels", "description": "This resource represents available labels. Use it to get available labels for the global label field." }, { "name": "License metrics", "description": "This resource represents license metrics. Use it to get available metrics for Jira licences." }, { "name": "Myself", "description": "This resource represents information about the current user, such as basic details, group membership, application roles, preferences, and locale. Use it to get, create, update, and delete (restore default) values of the user's preferences and locale." }, { "name": "Permissions", "description": "This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions." }, { "name": "Permission schemes", "description": "This resource represents permission schemes. Use it to get, create, update, and delete permission schemes as well as get, create, update, and delete details of the permissions granted in those schemes." }, { "name": "Projects", "description": "This resource represents projects. Use it to get, create, update, and delete projects. Also get statuses available to a project, a project's notification schemes, and update a project's type." }, { "name": "Project avatars", "description": "This resource represents avatars associated with a project. Use it to get, load, set, and remove project avatars." }, { "name": "Project categories", "description": "This resource represents project categories. Use it to create, update, and delete project categories as well as obtain a list of all project categories and details of individual categories. For more information on managing project categories, see [Adding, assigning, and deleting project categories](https://confluence.atlassian.com/x/-A5WMg)." }, { "name": "Project components", "description": "This resource represents project components. Use it to get, create, update, and delete project components. Also get components for project and get a count of issues by component." }, { "name": "Project email", "description": "This resource represents the email address used to send a project's notifications. Use it to get and set the [project's sender email address](https://confluence.atlassian.com/x/dolKLg)." }, { "name": "Project features", "description": "This resource represents project features. Use it to get the list of features for a project and modify the state of a feature. The project feature endpoint is available only for Jira Software, both for team- and company-managed projects." }, { "name": "Project key and name validation", "description": "This resource provides validation for project keys and names." }, { "name": "Project permission schemes", "description": "This resource represents permission schemes for a project. Use this resource to:\n\n * get details of a project's issue security levels available to the calling user.\n * get the permission scheme associated with the project or assign different permission scheme to the project.\n * get details of a project's issue security scheme.\n\nSee [Managing project permissions](https://confluence.atlassian.com/x/yodKLg) for more information about permission schemes." }, { "name": "Project properties", "description": "This resource represents [project](#api-group-Projects) properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "Project roles", "description": "This resource represents the roles that users can play in projects. Use this resource to get, create, update, and delete project roles." }, { "name": "Project role actors", "description": "This resource represents the users assigned to [project roles](#api-group-Issue-comments). Use it to get, add, and remove default users from project roles. Also use it to add and remove users from a project role associated with a project." }, { "name": "Project types", "description": "This resource represents project types. Use it to obtain a list of all project types, a list of project types accessible to the calling user, and details of a project type." }, { "name": "Project versions", "description": "This resource represents project versions. Use it to get, get lists of, create, update, move, merge, and delete project versions. This resource also provides counts of issues by version." }, { "name": "Screens", "description": "This resource represents the screens used to record issue details. Use it to:\n\n * get details of all screens.\n * get details of all the fields available for use on screens.\n * create screens.\n * delete screens.\n * update screens.\n * add a field to the default screen." }, { "name": "Screen tabs", "description": "This resource represents the screen tabs used to record issue details. Use it to get, create, update, move, and delete screen tabs." }, { "name": "Screen tab fields", "description": "This resource represents the screen tab fields used to record issue details. Use it to get, add, move, and remove fields from screen tabs." }, { "name": "Screen schemes", "description": "This resource represents screen schemes in classic projects. Use it to get, create, update, and delete screen schemes." }, { "name": "Server info", "description": "This resource provides information about the Jira instance." }, { "name": "Status", "description": "This resource represents statuses. Use it to search, get, create, delete, and change statuses." }, { "name": "Tasks", "description": "This resource represents a [long-running asynchronous tasks](#async-operations). Use it to obtain details about the progress of a long-running task or cancel a long-running task." }, { "name": "Time tracking", "description": "This resource represents time tracking and time tracking providers. Use it to get and set the time tracking provider, get and set the time tracking options, and disable time tracking." }, { "name": "Users", "description": "This resource represent users. Use it to:\n\n * get, get a list of, create, and delete users.\n * get, set, and reset a user's default issue table columns.\n * get a list of the groups the user belongs to.\n * get a list of user account IDs for a list of usernames or user keys." }, { "name": "User properties", "description": "This resource represents [user](#api-group-Users) properties and provides for storing custom data against a user. Use it to get, create, and delete user properties as well as get a list of property keys for a user. This resourse is designed for integrations and apps to store per-user data and settings. This enables data used to customized the user experience to be kept in the Jira Cloud instance's database. User properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nThis resource does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira." }, { "name": "User search", "description": "This resource represents various ways to search for and find users. Use it to obtain list of users including users assignable to projects and issues, users with permissions, user lists for pickup fields, and user lists generated using structured queries. Note that the operations in this resource only return users found within the first 1000 users." }, { "name": "Webhooks", "description": "This resource represents webhooks. Webhooks are calls sent to a URL when an event occurs in Jira for issues specified by a JQL query. Only Connect and OAuth 2.0 apps can register and manage webhooks. For more information, see [Webhooks](https://developer.atlassian.com/cloud/jira/platform/webhooks/#registering-a-webhook-via-the-jira-rest-api-for-connect-apps)." }, { "name": "Workflows", "description": "This resource represents workflows. Use it to:\n\n * get workflows.\n * create workflows.\n * delete inactive workflows." }, { "name": "Workflow transition rules", "description": "This resource represents workflow transition rules. Workflow transition rules define a Connect or a Forge app routine, such as a [workflow post functions](https://developer.atlassian.com/cloud/jira/platform/modules/workflow-post-function/) that is executed in association with the workflow. Use it to read and modify configuration of workflow transition rules." }, { "name": "Workflow schemes", "description": "This resource represents workflow schemes. Use it to manage workflow schemes and the workflow scheme's workflows and issue types.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. When an active workflow scheme is edited, a draft copy of the scheme is created. The draft workflow scheme is then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information." }, { "name": "Workflow scheme project associations", "description": "This resource represents the associations between workflow schemes and projects.\n\nFor more information, see [Managing your workflows](https://confluence.atlassian.com/x/q4hKLg)." }, { "name": "Workflow scheme drafts", "description": "This resource represents draft workflow schemes. Use it to manage drafts of workflow schemes.\n\nA workflow scheme maps issue types to workflows. A workflow scheme can be associated with one or more projects, which enables the projects to use the workflow-issue type mappings.\n\nActive workflow schemes (workflow schemes that are used by projects) cannot be edited. Editing an active workflow scheme creates a draft copy of the scheme. The draft workflow scheme can then be edited and published (replacing the active scheme).\n\nSee [Configuring workflow schemes](https://confluence.atlassian.com/x/tohKLg) for more information." }, { "name": "Workflow statuses", "description": "This resource represents issue workflow statuses. Use it to obtain a list of all statuses associated with workflows and the details of a status." }, { "name": "Workflow status categories", "description": "This resource represents status categories. Use it to obtain a list of all status categories and the details of a category. Status categories provided a mechanism for categorizing [statuses](#api-group-Workflow-statuses)." }, { "name": "Workflow transition properties", "description": "This resource represents workflow transition properties, which provides for storing custom data against a workflow transition. Use it to get, create, and delete workflow transition properties as well as get a list of property keys for a workflow transition. Workflow transition properties are a type of [entity property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)." }, { "name": "App properties", "description": "This resource represents app properties. Use it to store arbitrary data for your\n[Connect app](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)." }, { "name": "Dynamic modules", "description": "This resource represents [modules registered dynamically](https://developer.atlassian.com/cloud/jira/platform/dynamic-modules/)\nby [Connect apps](https://developer.atlassian.com/cloud/jira/platform/index/#connect-apps)." }, { "name": "App migration", "description": "This resource supports [app migrations](https://developer.atlassian.com/platform/app-migration/). Use it to:\n- [to request migrated workflow rules details](https://developer.atlassian.com/platform/app-migration/tutorials/migration-app-workflow-rules/).\n- [perform bulk updates of entity properties](https://developer.atlassian.com/platform/app-migration/tutorials/entity-properties-bulk-api/).\n- [perform bulk updates of issue custom field values](https://developer.atlassian.com/platform/app-migration/tutorials/migrating-app-custom-fields/)." } ], "paths": { "/rest/api/3/announcementBanner": { "get": { "tags": [ "Announcement banner" ], "summary": "Get announcement banner configuration", "description": "Returns the current announcement banner configuration.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId": "getBanner", "parameters": [], "responses": { "200": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementBannerConfiguration" }, "example": "{\"message\":\"This is a public, enabled, non-dismissible banner, set using the API\",\"isDismissible\":false,\"isEnabled\":true,\"hashId\":\"9HN2FJK9DM8BHRWERVW3RRTGDJ4G4D5C\",\"visibility\":\"public\"}" } } }, "401": { "description": "Returned if the authentication credentials are incorrect or missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } } }, "403": { "description": "Returned if the user does not have the necessary permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "example": "\"Only admins can read banner configuration.\"" } } } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [ "manage:jira-configuration" ] } ], "x-experimental": true, "x-atlassian-connect-scope": "ADMIN" }, "put": { "tags": [ "Announcement banner" ], "summary": "Update announcement banner configuration", "description": "Updates the announcement banner configuration.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).", "operationId": "setBanner", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnouncementBannerConfigurationUpdate" }, "example": { "isDismissible": false, "isEnabled": true, "message": "This is a public, enabled, non-dismissible banner, set using the API", "visibility": "public" } } }, "required": true }, "responses": { "204": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Returned if an invalid parameter is passed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "example": "\"Banner message cannot be null.\"" } } }, "401": { "description": "Returned if the authentication credentials are incorrect or missing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" } } } }, "403": { "description": "Returned if the user does not have the necessary permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorCollection" }, "example": "\"Only admins can update banner configuration.\"" } } } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [ "manage:jira-configuration" ] } ], "x-experimental": true, "x-atlassian-connect-scope": "ADMIN" } }, "/rest/api/3/app/field/value": { "post": { "tags": [ "Issue custom field values (apps)" ], "summary": "Update custom fields", "description": "Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should be unique within the request. Custom fields can only be updated by the Forge app that created them.\n\n**[Permissions](#permissions) required:** Only the app that created the custom field can update its values with this operation.", "operationId": "updateMultipleCustomFieldValues", "parameters": [ { "name": "generateChangelog", "in": "query", "description": "Whether to generate a changelog for this update.", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultipleCustomFieldValuesUpdateDetails" }, "example": { "updates": [ { "customField": "customfield_10010", "issueIds": [ 10010, 10011 ], "value": "new value" }, { "customField": "customfield_10011", "issueIds": [ 10010 ], "value": 1000 } ] } } }, "required": true }, "responses": { "204": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Returned if the request is invalid." }, "403": { "description": "Returned if the request is not authenticated as the app that provided all the fields." }, "404": { "description": "Returned if any field is not found." } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [] } ], "x-atlassian-oauth2-scopes": [ { "state": "Current", "scheme": "OAuth2", "scopes": [] }, { "state": "Beta", "scheme": "OAuth2", "scopes": [] } ], "x-experimental": true, "x-atlassian-connect-scope": "INACCESSIBLE" } }, "/rest/api/3/app/field/{fieldIdOrKey}/context/configuration": { "get": { "tags": [ "Issue custom field configuration (apps)" ], "summary": "Get custom field configurations", "description": "Returns a [paginated](#pagination) list of configurations for a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).\n\nThe result can be filtered by one of these criteria:\n\n * `id`.\n * `fieldContextId`.\n * `issueId`.\n * `projectKeyOrId` and `issueTypeId`.\n\nOtherwise, all configurations are returned.\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field.", "operationId": "getCustomFieldConfiguration", "parameters": [ { "name": "fieldIdOrKey", "in": "path", "description": "The ID or key of the custom field, for example `customfield_10000`.", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "fieldContextId", "in": "query", "description": "The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or `issueTypeId`.", "schema": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } }, { "name": "issueId", "in": "query", "description": "The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with `projectKeyOrId`, or `issueTypeId`.", "schema": { "type": "integer", "format": "int64" } }, { "name": "projectKeyOrId", "in": "query", "description": "The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with `issueId`.", "schema": { "type": "string" } }, { "name": "issueTypeId", "in": "query", "description": "The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with `issueId`.", "schema": { "type": "string" } }, { "name": "startAt", "in": "query", "description": "The index of the first item to return in a page of results (page offset).", "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "maxResults", "in": "query", "description": "The maximum number of items to return per page.", "schema": { "type": "integer", "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageBeanContextualConfiguration" }, "example": "{\"maxResults\":1000,\"startAt\":0,\"total\":2,\"isLast\":true,\"values\":[{\"id\":\"10000\",\"fieldContextId\":\"10010\"},{\"id\":\"10001\",\"fieldContextId\":\"10011\",\"configuration\":{\"minValue\":0,\"maxValue\":10000},\"schema\":{\"properties\":{\"amount\":{\"type\":\"number\"},\"currency\":{\"type\":\"string\"}},\"required\":[\"amount\",\"currency\"]}}]}" } } }, "400": { "description": "Returned if the request is invalid." }, "401": { "description": "Returned if the authentication credentials are incorrect or missing." }, "403": { "description": "Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field." }, "404": { "description": "Returned if the custom field is not found." } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [ "manage:jira-configuration" ] } ], "x-atlassian-oauth2-scopes": [ { "state": "Current", "scheme": "OAuth2", "scopes": [ "manage:jira-configuration" ] }, { "state": "Beta", "scheme": "OAuth2", "scopes": [ "read:custom-field-contextual-configuration:jira" ] } ], "x-experimental": true, "x-atlassian-connect-scope": "ADMIN" }, "put": { "tags": [ "Issue custom field configuration (apps)" ], "summary": "Update custom field configurations", "description": "Update the configuration for contexts of a custom field created by a [Forge app](https://developer.atlassian.com/platform/forge/).\n\n**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that created the custom field.", "operationId": "updateCustomFieldConfiguration", "parameters": [ { "name": "fieldIdOrKey", "in": "path", "description": "The ID or key of the custom field, for example `customfield_10000`.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldConfigurations" }, "example": { "configurations": [ { "id": "10000" }, { "configuration": { "maxValue": 10000, "minValue": 0 }, "id": "10001", "schema": { "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } } ] } } }, "required": true }, "responses": { "200": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Returned if the request is invalid." }, "401": { "description": "Returned if the authentication credentials are incorrect or missing." }, "403": { "description": "Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field." }, "404": { "description": "Returned if the custom field is not found." } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [ "manage:jira-configuration" ] } ], "x-atlassian-oauth2-scopes": [ { "state": "Current", "scheme": "OAuth2", "scopes": [ "manage:jira-configuration" ] }, { "state": "Beta", "scheme": "OAuth2", "scopes": [ "write:custom-field-contextual-configuration:jira" ] } ], "x-experimental": true, "x-atlassian-connect-scope": "ADMIN" } }, "/rest/api/3/app/field/{fieldIdOrKey}/value": { "put": { "tags": [ "Issue custom field values (apps)" ], "summary": "Update custom field value", "description": "Updates the value of a custom field on one or more issues. Custom fields can only be updated by the Forge app that created them.\n\n**[Permissions](#permissions) required:** Only the app that created the custom field can update its values with this operation.", "operationId": "updateCustomFieldValue", "parameters": [ { "name": "fieldIdOrKey", "in": "path", "description": "The ID or key of the custom field. For example, `customfield_10010`.", "required": true, "schema": { "type": "string" } }, { "name": "generateChangelog", "in": "query", "description": "Whether to generate a changelog for this update.", "schema": { "type": "boolean", "default": true } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValueUpdateDetails" }, "example": { "updates": [ { "issueIds": [ 10010 ], "value": "new value" } ] } } }, "required": true }, "responses": { "204": { "description": "Returned if the request is successful.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Returned if the request is invalid." }, "403": { "description": "Returned if the request is not authenticated as the app that provided the field." }, "404": { "description": "Returned if the field is not found." } }, "deprecated": false, "security": [ { "basicAuth": [] }, { "OAuth2": [] } ], "x-atlassian-oauth2-scopes": [ { "state": "Current", "scheme": "OAuth2", "scopes": [] }, { "state": "Beta", "scheme": "OAuth2", "scopes": [] } ], "x-experimental": true,