app

get-custom-field-configuration

Get custom field configurations

Returns a paginated list of configurations for a custom field of a type created by a Forge app.

The result can be filtered by one of these criteria:

• id.
• fieldContextId.
• issueId.
• projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

GET /rest/api/3/app/field/{fieldIdOrKey}/context/configuration

Flag	Type	Required	Description
--fieldContextId	string	No	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.
--fieldIdOrKey	string	Yes	The ID or key of the custom field, for example customfield_10000.
--id	string	No	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.
--issueId	string	No	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.
--issueTypeId	string	No	The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
--maxResults	string	No	The maximum number of items to return per page.
--projectKeyOrId	string	No	The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr app get-custom-field-configuration --fieldIdOrKey <fieldIdOrKey>

get-custom-fields-configurations

Bulk get custom field configurations

Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.

The result can be filtered by one of these criteria:

• id.
• fieldContextId.
• issueId.
• projectKeyOrId and issueTypeId.

Otherwise, all configurations for the provided list of custom fields are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

POST /rest/api/3/app/field/context/configuration/list

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--fieldContextId	string	No	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.
--id	string	No	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.
--issueId	string	No	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.
--issueTypeId	string	No	The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
--maxResults	string	No	The maximum number of items to return per page.
--projectKeyOrId	string	No	The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
--startAt	string	No	The index of the first item to return in a page of results (page offset).

Example:

jr app get-custom-fields-configurations

update-custom-field-configuration

Update custom field configurations

Update the configuration for contexts of a custom field of a type created by a Forge app.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that created the custom field type.

PUT /rest/api/3/app/field/{fieldIdOrKey}/context/configuration

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--fieldIdOrKey	string	Yes	The ID or key of the custom field, for example customfield_10000.

Example:

jr app update-custom-field-configuration --fieldIdOrKey <fieldIdOrKey>

update-custom-field-value

Update custom field value

Updates the value of a custom field on one or more issues.

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

PUT /rest/api/3/app/field/{fieldIdOrKey}/value

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--fieldIdOrKey	string	Yes	The ID or key of the custom field. For example, customfield_10010.
--generateChangelog	string	No	Whether to generate a changelog for this update.

Example:

jr app update-custom-field-value --fieldIdOrKey <fieldIdOrKey>

update-multiple-custom-field-values

Update custom fields

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.

Apps can only perform this operation on custom fields and custom field types declared in their own manifests.

Permissions required: Only the app that owns the custom field or custom field type can update its values with this operation.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

POST /rest/api/3/app/field/value

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--generateChangelog	string	No	Whether to generate a changelog for this update.

Example:

jr app update-multiple-custom-field-values