pp-jira

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Jira Cloud Platform — Printing Press CLI

Prerequisites: Install the CLI

前提条件：安装CLI

This skill drives the

jira-pp-cli

binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:

Install via the Printing Press installer:

bash

npx -y @mvanhorn/printing-press install jira --cli-only

Verify:
```
jira-pp-cli --version
```
Ensure
```
$GOPATH/bin
```
(or
```
$HOME/go/bin
```
) is on
```
$PATH
```
.

If the

npx

install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.26.3 or newer):

bash

go install github.com/mvanhorn/printing-press-library/library/project-management/jira/cmd/jira-pp-cli@latest

--version

reports "command not found" after install, the install step did not put the binary on

$PATH

. Do not proceed with skill commands until verification succeeds.

Jira Cloud Platform REST API documentation

本技能基于

jira-pp-cli

二进制文件运行。在调用本技能的任何命令之前，您必须确认CLI已安装。如果未安装，请先执行以下步骤：

通过Printing Press安装程序安装：

bash

npx -y @mvanhorn/printing-press install jira --cli-only

验证：
```
jira-pp-cli --version
```
确保
```
$GOPATH/bin
```
（或
```
$HOME/go/bin
```
）已添加到
```
$PATH
```
环境变量中。

如果

npx

安装失败（无Node环境、离线等），可以改用Go直接安装（需要Go 1.26.3或更高版本）：

bash

go install github.com/mvanhorn/printing-press-library/library/project-management/jira/cmd/jira-pp-cli@latest

如果安装后执行

--version

提示“command not found”，说明安装步骤未将二进制文件添加到

$PATH

中。请在验证成功前不要继续执行技能命令。

Jira Cloud Platform REST API文档

Command Reference

命令参考

announcement-banner — This resource represents an announcement banner. Use it to retrieve and update banner configuration.

```
jira-pp-cli announcement-banner get-banner
```
— Returns the current announcement banner configuration. Permissions required: Administer Jira...
```
jira-pp-cli announcement-banner set-banner
```
— Updates the announcement banner configuration. Permissions required: Administer Jira [global...

app — Manage app

```
jira-pp-cli app get-custom-field-configuration
```
— Returns a paginated list of configurations for a custom field of a...
```
jira-pp-cli app get-custom-fields-configurations
```
— Returns a paginated list of configurations for list of custom fields of a...
```
jira-pp-cli app update-custom-field-configuration
```
— Update the configuration for contexts of a custom field of a [type](https://developer.atlassian.com/platform/forge/ma...
```
jira-pp-cli app update-custom-field-value
```
— Updates the value of a custom field on one or more issues. Apps can only perform this operation on [custom...
```
jira-pp-cli app update-multiple-custom-field-values
```
— Updates the value of one or more custom fields on one or more issues. Combinations of custom field and issue should...

application-properties — Manage application properties

```
jira-pp-cli application-properties get-advanced-settings
```
— Returns the application properties that are accessible on the Advanced Settings page. To navigate to the *Advanced...
```
jira-pp-cli application-properties get-application-property
```
— Returns all application properties or an application property. If you specify a value for the
```
key
```
parameter, then...
```
jira-pp-cli application-properties set-application-property
```
— Changes the value of an application property. For example, you can change the value of the
```
jira.clone.prefix
```
from...

applicationrole — Manage applicationrole

```
jira-pp-cli applicationrole get-all-application-roles
```
— Returns all application roles. In Jira, application roles are managed using the [Application access...
```
jira-pp-cli applicationrole get-application-role
```
— Returns an application role. Permissions required: Administer Jira [global...

atlassian-connect — Manage atlassian connect

jira-pp-cli atlassian-connect addon-properties-resource-delete-addon-property-delete

— Deletes an app's property. Permissions required: Only a Connect app whose key matches

addonKey

...

jira-pp-cli atlassian-connect addon-properties-resource-get-addon-properties-get

— Gets all the properties of an app. The reserved key

connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8

is not...

jira-pp-cli atlassian-connect addon-properties-resource-get-addon-property-get

— Returns the key and value of an app's property. The property key...

```
jira-pp-cli atlassian-connect addon-properties-resource-put-addon-property-put
```
— Sets the value of an app's property. Use this resource to store custom data for your app. The value of the request...
```
jira-pp-cli atlassian-connect app-issue-field-value-update-resource-update-issue-fields-put
```
— Updates the value of a custom field added by Connect apps on one or more issues. The values of up to 200 custom...
```
jira-pp-cli atlassian-connect connect-to-forge-migration-fetch-task-resource-fetch-migration-task-get
```
— Returns the details of a Connect issue field's migration to Forge. When migrating a Connect app to Forge, [Issue...
```
jira-pp-cli atlassian-connect connect-to-forge-migration-task-submission-resource-submit-task-post
```
— Submits a request to trigger migration of connect issue field to its Forge custom field counterpart. When migrating...
```
jira-pp-cli atlassian-connect dynamic-modules-resource-get-modules-get
```
— Returns all modules registered dynamically by the calling app. Permissions required: Only...
```
jira-pp-cli atlassian-connect dynamic-modules-resource-register-modules-post
```
— Registers a list of modules. Permissions required: Only Connect apps can make this request.
```
jira-pp-cli atlassian-connect dynamic-modules-resource-remove-modules-delete
```
— Remove all or a list of modules registered by the calling app. Permissions required: Only...
```
jira-pp-cli atlassian-connect migration-resource-update-entity-properties-value-put
```
— Updates the values of multiple entity properties for an object, up to 50 updates per request. This operation is for...
```
jira-pp-cli atlassian-connect migration-resource-workflow-rule-search-post
```
— Returns configurations for workflow transition rules migrated from server to cloud and owned by the calling Connect app.
```
jira-pp-cli atlassian-connect service-registry-resource-services-get
```
— Retrieve the attributes of given service registries. Permissions required: Only Connect apps can...

attachment — Manage attachment

```
jira-pp-cli attachment get
```
— Returns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be...
```
jira-pp-cli attachment get-content
```
— Returns the contents of an attachment. A
```
Range
```
header can be set to define a range of bytes within the attachment...
```
jira-pp-cli attachment get-meta
```
— Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed....
```
jira-pp-cli attachment get-thumbnail
```
— Returns the thumbnail of an attachment. To return the attachment contents, use [Get attachment...
```
jira-pp-cli attachment remove
```
— Deletes an attachment from an issue. This operation can be accessed anonymously. **Permissions...

auditing — Manage auditing

```
jira-pp-cli auditing
```
— Returns a list of audit records. The list can be filtered to include items: * where each item in
```
filter
```
has at...

avatar — 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, issue type or priority and obtain avatar images.

bulk — Manage bulk

```
jira-pp-cli bulk get-available-transitions
```
— Use this API to retrieve a list of transitions available for the specified issues that can be used or bulk...
```
jira-pp-cli bulk get-editable-fields
```
— Use this API to get a list of fields visible to the user to perform bulk edit operations. You can pass single or...
```
jira-pp-cli bulk get-operation-progress
```
— Use this to get the progress state for the specified bulk operation
```
taskId
```
. **Permissions...
```
jira-pp-cli bulk submit-delete
```
— Use this API to submit a bulk delete request. You can delete up to 1,000 issues in a single operation....
```
jira-pp-cli bulk submit-edit
```
— Use this API to submit a bulk edit request and simultaneously edit multiple issues. There are limits applied to the...
```
jira-pp-cli bulk submit-move
```
— Use this API to submit a bulk issue move request. You can move multiple issues from multiple projects in a single...
```
jira-pp-cli bulk submit-transition
```
— Use this API to submit a bulk issue status transition request. You can transition multiple issues, alongside with...
```
jira-pp-cli bulk submit-unwatch
```
— Use this API to submit a bulk unwatch request. You can unwatch up to 1,000 issues in a single operation....
```
jira-pp-cli bulk submit-watch
```
— Use this API to submit a bulk watch request. You can watch up to 1,000 issues in a single operation....

changelog — Manage changelog

```
jira-pp-cli changelog
```
— Bulk fetch changelogs for multiple issues and filter by fields Returns a paginated list of all changelogs for given...

classification-levels — This resource represents classification levels.

```
jira-pp-cli classification-levels
```
— Returns all classification levels. Permissions required: None.

comment — Manage comment

```
jira-pp-cli comment
```
— Returns a paginated list of comments specified by a list of comment IDs. This operation can be...

component — Manage component

```
jira-pp-cli component create
```
— Creates a component. Use components to provide containers for issues within a project. Use components to provide...
```
jira-pp-cli component delete
```
— Deletes a component. This operation can be accessed anonymously. Permissions required:...
```
jira-pp-cli component find-for-projects
```
— Returns a paginated list of all components in a project, including global (Compass) components when...
```
jira-pp-cli component get
```
— Returns a component. This operation can be accessed anonymously. Permissions required: *Browse...
```
jira-pp-cli component update
```
— Updates a component. Any fields included in the request are overwritten. If
```
leadAccountId
```
is an empty string ('')...

config — Manage config

```
jira-pp-cli config associate-projects-to-field-association-schemes
```
— Associate projects to field association schemes. Permissions required: Administer Jira [global...
```
jira-pp-cli config clone-field-association-scheme
```
— Endpoint for cloning an existing field association scheme into a new one. Permissions required:...
```
jira-pp-cli config create-field-association-scheme
```
— Endpoint for creating a new field association scheme. Permissions required: Administer Jira...
```
jira-pp-cli config delete-field-association-scheme
```
— Delete a specified field association scheme Permissions required: Administer Jira [global...
```
jira-pp-cli config get-field-association-scheme-by-id
```
— Endpoint for fetching a field association scheme by its ID Permissions required: *Administer...
```
jira-pp-cli config get-field-association-scheme-item-parameters
```
— Retrieve field association parameters on a field association scheme Permissions required:...
```
jira-pp-cli config get-field-association-schemes
```
— REST endpoint for retrieving a paginated list of field association schemes with optional filtering. This endpoint...
```
jira-pp-cli config get-projects-with-field-schemes
```
— Get projects with field association schemes. This will be a temporary API but useful when transitioning from the...
```
jira-pp-cli config remove-field-association-scheme-item-parameters
```
— Remove field association parameters overrides for work types. Permissions required: *Administer...
```
jira-pp-cli config remove-fields-associated-with-schemes
```
— Remove fields associated with field association schemes. Permissions required: Administer Jira...
```
jira-pp-cli config search-field-association-scheme-fields
```
— Search for fields belonging to a given field association scheme. Permissions required:...
```
jira-pp-cli config search-field-association-scheme-projects
```
— REST Endpoint for searching for projects belonging to a given field association scheme **Permissions...
```
jira-pp-cli config update-field-association-scheme
```
— Endpoint for updating an existing field association scheme. Permissions required: *Administer...
```
jira-pp-cli config update-field-association-scheme-item-parameters
```
— Update field association item parameters in field association schemes. Permissions required:...
```
jira-pp-cli config update-fields-associated-with-schemes
```
— Update fields associated with field association schemes. Permissions required: Administer Jira...

configuration — Manage configuration

```
jira-pp-cli configuration get
```
— Returns the global settings in Jira. These settings determine whether...
```
jira-pp-cli configuration get-available-time-tracking-implementations
```
— Returns all time tracking providers. By default, Jira only has one time tracking provider: *JIRA provided time...
```
jira-pp-cli configuration get-selected-time-tracking-implementation
```
— Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a...
```
jira-pp-cli configuration get-shared-time-tracking
```
— Returns the time tracking settings. This includes settings such as the time format, default time unit, and others....
```
jira-pp-cli configuration select-time-tracking-implementation
```
— Selects a time tracking provider. Permissions required: Administer Jira [global...
```
jira-pp-cli configuration set-shared-time-tracking
```
— Sets the time tracking settings. Permissions required: Administer Jira [global...

custom-field-option — Manage custom field option

```
jira-pp-cli custom-field-option <id>
```
— Returns a custom field option. For example, an option in a select list. Note that this operation **only works for...

dashboard — 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.

```
jira-pp-cli dashboard bulk-edit
```
— Bulk edit dashboards. Maximum number of dashboards to be edited at the same time is 100....
```
jira-pp-cli dashboard create
```
— Creates a dashboard. Permissions required: None.
```
jira-pp-cli dashboard delete
```
— Deletes a dashboard. Permissions required: None The dashboard to be deleted must be owned by the...
```
jira-pp-cli dashboard get
```
— Returns a dashboard. This operation can be accessed anonymously. Permissions required: None....
```
jira-pp-cli dashboard get-all
```
— Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or...
```
jira-pp-cli dashboard get-all-available-gadgets
```
— Gets a list of all available gadgets that can be added to all dashboards. Permissions required:...
```
jira-pp-cli dashboard get-paginated
```
— Returns a paginated list of dashboards. This operation is similar to [Get...
```
jira-pp-cli dashboard update
```
— Updates a dashboard, replacing all the dashboard details with those provided. **Permissions...

data-policy — Manage data policy

```
jira-pp-cli data-policy get-policies
```
— Returns data policies for the projects specified in the request.
```
jira-pp-cli data-policy get-policy
```
— Returns data policy for the workspace.

events — Manage events

```
jira-pp-cli events
```
— Returns all issue events. Permissions required: Administer Jira [global...

expression — Manage expression

```
jira-pp-cli expression analyse
```
— Analyses and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check...
```
jira-pp-cli expression evaluate-jira
```
— Endpoint is currently being removed. More details...
```
jira-pp-cli expression evaluate-jsisjira
```
— Evaluates a Jira expression and returns its value. The difference between this and
```
eval
```
is that this endpoint uses...

field — Manage field

```
jira-pp-cli field create-associations
```
— Associates fields with projects. Fields will be associated with each issue type on the requested projects. Fields...
```
jira-pp-cli field create-custom
```
— Creates a custom field. Permissions required: Administer Jira [global...
```
jira-pp-cli field delete-custom
```
— Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom...
```
jira-pp-cli field get
```
— Returns system and custom issue fields according to the following rules: * Fields that cannot be added to the issue...
```
jira-pp-cli field get-paginated
```
— Returns a paginated list of fields for Classic Jira projects. The list can include: * all fields *...
```
jira-pp-cli field get-trashed-paginated
```
— Returns a paginated list of fields in the trash. The list may be restricted to fields whose field...
```
jira-pp-cli field remove-associations
```
— Unassociates a set of fields with a project and issue type context. Fields will be unassociated with all...
```
jira-pp-cli field update-custom
```
— Updates a custom field. Permissions required: Administer Jira [global...

fieldconfiguration — Manage fieldconfiguration

```
jira-pp-cli fieldconfiguration create-field-configuration
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration delete-field-configuration
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration get-all-field-configurations
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration update-field-configuration
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...

fieldconfigurationscheme — Manage fieldconfigurationscheme

```
jira-pp-cli fieldconfigurationscheme assign-field-configuration-scheme-to-project
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme create-field-configuration-scheme
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme delete-field-configuration-scheme
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-all-field-configuration-schemes
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-mappings
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-project-mapping
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme update-field-configuration-scheme
```
— Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...

filter — This resource represents filters. Use it to get, create, update, or delete filters. Also use it to configure the columns for a filter and set favorite filters.

```
jira-pp-cli filter create
```
— Creates a filter. The filter is shared according to the default share scope. The...
```
jira-pp-cli filter delete
```
— Delete a filter. Permissions required: Permission to access Jira, however filters can only be...
```
jira-pp-cli filter get
```
— Returns a filter. This operation can be accessed anonymously. Permissions required: None,...
```
jira-pp-cli filter get-default-share-scope
```
— Returns the default sharing settings for new filters and dashboards for a user. **Permissions...
```
jira-pp-cli filter get-favourite
```
— Returns the visible favorite filters of the user. This operation can be accessed anonymously....
```
jira-pp-cli filter get-my
```
— Returns the filters owned by the user. If
```
includeFavourites
```
is
```
true
```
, the user's visible favorite filters are...
```
jira-pp-cli filter get-paginated
```
— Returns a paginated list of filters. Use this operation to get: * specific filters, by defining
```
id
```
...
```
jira-pp-cli filter set-default-share-scope
```
— Sets the default sharing for new filters and dashboards for a user. Permissions required:...
```
jira-pp-cli filter update
```
— Updates a filter. Use this operation to update a filter's name, description, JQL, or sharing....

forge — Manage forge

```
jira-pp-cli forge bulk-pin-unpin-projects-async
```
— Bulk pin or unpin an issue panel (added by a Forge app) to or from multiple projects. The operation runs...
```
jira-pp-cli forge delete-app-property
```
— Deletes a Forge app's property. Permissions required: Only Forge apps can make this request....
```
jira-pp-cli forge get-app-property
```
— Returns the value of a Forge app's property. Permissions required: Only Forge apps can make this...
```
jira-pp-cli forge get-app-property-keys
```
— Returns all property keys for the Forge app. Permissions required: Only Forge apps can make this...
```
jira-pp-cli forge put-app-property
```
— Sets the value of a Forge app's property. These values can be retrieved in [Jira...

group — 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.)

```
jira-pp-cli group add-user-to
```
— Adds a user to a group. Permissions required: Site administration (that is, member of the...
```
jira-pp-cli group bulk-get
```
— Returns a paginated list of groups. Permissions required: *Browse users and...
```
jira-pp-cli group create
```
— Creates a group. Permissions required: Site administration (that is, member of the site-admin...
```
jira-pp-cli group get
```
— This operation is deprecated, use
```
group/member
```
. Returns all users in a group....
```
jira-pp-cli group get-users-from
```
— Returns a paginated list of all users in a group. Note that users are ordered by username, however...
```
jira-pp-cli group remove
```
— Deletes a group. Permissions required: Site administration (that is, member of the site-admin...
```
jira-pp-cli group remove-user-from
```
— Removes a user from a group. Permissions required: Site administration (that is, member of the...

groups — 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.)

```
jira-pp-cli groups
```
— Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups...

groupuserpicker — Manage groupuserpicker

```
jira-pp-cli groupuserpicker
```
— Returns a list of users and groups matching a string. The string is used: * for users, to find a case-insensitive...

instance — Manage instance

```
jira-pp-cli instance
```
— Returns licensing information about the Jira instance. Permissions required: None.

internal — Manage internal

```
jira-pp-cli internal
```
— Returns worklog details for a list of issue ID and worklog ID pairs. This is an internal API for bulk fetching...

issue — This resource represents Jira issues. Use it to:

create or edit issues, individually or in bulk.
retrieve metadata about the options for creating or editing issues.
delete an issue.
assign a user to an issue.
get issue changelogs.
send notifications about an issue.
get details of the transitions available for an issue.
transition an issue.
Archive issues.
Unarchive issues.
Export archived issues.

```
jira-pp-cli issue archive
```
— Enables admins to archive up to 1000 issues in a single request using issue ID/key, returning details of the...
```
jira-pp-cli issue archive-async
```
— Enables admins to archive up to 100,000 issues in a single request using JQL, returning the URL to check the status...
```
jira-pp-cli issue bulk-delete-property
```
— Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The...
```
jira-pp-cli issue bulk-fetch
```
— Returns the details for a set of requested issues. You can request up to 100 issues. Each issue is identified by its...
```
jira-pp-cli issue bulk-set-properties-by
```
— Sets or updates entity property values on issues. Up to 10 entity properties can be specified for each issue and up...
```
jira-pp-cli issue bulk-set-properties-list
```
— Sets or updates a list of entity property values on issues. A list of up to 10 entity properties can be specified...
```
jira-pp-cli issue bulk-set-property
```
— Sets a property value on multiple issues. The value set can be a constant or determined by a [Jira...
```
jira-pp-cli issue create
```
— Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied,...
```
jira-pp-cli issue create-bulk
```
— Creates upto 50 issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be...
```
jira-pp-cli issue delete
```
— Deletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set...
```
jira-pp-cli issue edit
```
— Edits an issue. Issue properties may be updated as part of the edit. Please note that issue transition is not...
```
jira-pp-cli issue get
```
— Returns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn't match...
```
jira-pp-cli issue get-create-meta
```
— Returns details of projects, issue types within projects, and, when requested, the create screen fields for each...
```
jira-pp-cli issue get-create-meta-type-id
```
— Returns a page of field metadata for a specified project and issuetype id. Use the information to populate the...
```
jira-pp-cli issue get-create-meta-types
```
— Returns a page of issue type metadata for a specified project. Use the information to populate the requests in [...
```
jira-pp-cli issue get-is-watching-bulk
```
— Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned...
```
jira-pp-cli issue get-limit-report
```
— Returns all issues breaching and approaching per-issue limits. Permissions required: * *Browse...
```
jira-pp-cli issue get-picker-resource
```
— Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the...
```
jira-pp-cli issue unarchive
```
— Enables admins to unarchive up to 1000 issues in a single request using issue ID/key, returning details of the...

issue-link — This resource represents links between issues. Use it to get, create, and delete links between issues.

To use it, the site must have issue linking enabled.

```
jira-pp-cli issue-link delete
```
— Deletes an issue link. This operation can be accessed anonymously. Permissions required: *...
```
jira-pp-cli issue-link get
```
— Returns an issue link. This operation can be accessed anonymously. Permissions required: *...
```
jira-pp-cli issue-link link-issues
```
— Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally...

issue-link-type — This resource represents issue link types. Use it to get, create, update, and delete link issue types as well as get lists of all link issue types.

To use it, the site must have issue linking enabled.

```
jira-pp-cli issue-link-type create
```
— Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The...
```
jira-pp-cli issue-link-type delete
```
— Deletes an issue link type. To use this operation, the site must have [issue...
```
jira-pp-cli issue-link-type get
```
— Returns a list of all issue link types. To use this operation, the site must have [issue...
```
jira-pp-cli issue-link-type get-issuelinktype
```
— Returns an issue link type. To use this operation, the site must have [issue...
```
jira-pp-cli issue-link-type update
```
— Updates an issue link type. To use this operation, the site must have [issue...

issues — This resource represents Jira issues. Use it to:

create or edit issues, individually or in bulk.
retrieve metadata about the options for creating or editing issues.
delete an issue.
assign a user to an issue.
get issue changelogs.
send notifications about an issue.
get details of the transitions available for an issue.
transition an issue.
Archive issues.
Unarchive issues.
Export archived issues.

```
jira-pp-cli issues
```
— Enables admins to retrieve details of all archived issues. Upon a successful request, the admin who submitted it...

issuesecurityschemes — Manage issuesecurityschemes

```
jira-pp-cli issuesecurityschemes associate-schemes-to-projects
```
— Associates an issue security scheme with a project and remaps security levels of issues to the new levels, if...
```
jira-pp-cli issuesecurityschemes create-issue-security-scheme
```
— Creates a security scheme with security scheme levels and levels' members. You can create up to 100 security scheme...
```
jira-pp-cli issuesecurityschemes delete-security-scheme
```
— Deletes an issue security scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli issuesecurityschemes get-issue-security-scheme
```
— Returns an issue security scheme along with its security levels. Permissions required: *...

jira-pp-cli issuesecurityschemes get-issue-security-schemes

— Returns all issue security schemes. **Permissions...

```
jira-pp-cli issuesecurityschemes get-security-level-members
```
— Returns a paginated list of issue security level members. Only issue security level members in the...
```
jira-pp-cli issuesecurityschemes get-security-levels
```
— Returns a paginated list of issue security levels. Only issue security levels in the context of...
```
jira-pp-cli issuesecurityschemes search-projects-using-security-schemes
```
— Returns a paginated mapping of projects that are using security schemes. You can provide either one...
```
jira-pp-cli issuesecurityschemes search-security-schemes
```
— Returns a paginated list of issue security schemes. If you specify the project ID parameter, the...
```
jira-pp-cli issuesecurityschemes set-default-levels
```
— Sets default issue security levels for schemes. Permissions required: Administer Jira [global...
```
jira-pp-cli issuesecurityschemes update-issue-security-scheme
```
— Updates the issue security scheme. Permissions required: Administer Jira [global...

issuetype — Manage issuetype

```
jira-pp-cli issuetype create-issue-type
```
— Creates an issue type. Permissions required: Administer Jira [global...
```
jira-pp-cli issuetype delete-issue-type
```
— Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type...
```
jira-pp-cli issuetype get-issue-all-types
```
— Returns all issue types. This operation can be accessed anonymously. Permissions required: Issue...
```
jira-pp-cli issuetype get-issue-type
```
— Returns an issue type. This operation can be accessed anonymously. Permissions required: *Browse...
```
jira-pp-cli issuetype get-issue-types-for-project
```
— Returns issue types for a project. This operation can be accessed anonymously. **Permissions...
```
jira-pp-cli issuetype update-issue-type
```
— Updates the issue type. Permissions required: Administer Jira [global...

issuetypescheme — Manage issuetypescheme

```
jira-pp-cli issuetypescheme assign-issue-type-scheme-to-project
```
— Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the...
```
jira-pp-cli issuetypescheme create-issue-type-scheme
```
— Creates an issue type scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli issuetypescheme delete-issue-type-scheme
```
— Deletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Only issue type...
```
jira-pp-cli issuetypescheme get-all-issue-type-schemes
```
— Returns a paginated list of issue type schemes. Only issue type schemes used in classic projects are...
```
jira-pp-cli issuetypescheme get-issue-type-scheme-for-projects
```
— Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the...
```
jira-pp-cli issuetypescheme get-issue-type-schemes-mapping
```
— Returns a paginated list of issue type scheme items. Only issue type scheme items used in classic...
```
jira-pp-cli issuetypescheme update-issue-type-scheme
```
— Updates an issue type scheme. Permissions required: Administer Jira [global...

issuetypescreenscheme — Manage issuetypescreenscheme

```
jira-pp-cli issuetypescreenscheme assign-issue-type-screen-scheme-to-project
```
— Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic...
```
jira-pp-cli issuetypescreenscheme create-issue-type-screen-scheme
```
— Creates an issue type screen scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli issuetypescreenscheme delete-issue-type-screen-scheme
```
— Deletes an issue type screen scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-mappings
```
— Returns a paginated list of issue type screen scheme items. Only issue type screen schemes used in...
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-project-associations
```
— Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list...
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-schemes
```
— Returns a paginated list of issue type screen schemes. Only issue type screen schemes used in classic...
```
jira-pp-cli issuetypescreenscheme update-issue-type-screen-scheme
```
— Updates an issue type screen scheme. Permissions required: Administer Jira [global...

jira-search — Manage jira cloud platform search

```
jira-pp-cli jira-search and-reconsile-issues-using-jql
```
— Searches for issues using JQL. Recent updates might not be immediately...
```
jira-pp-cli jira-search and-reconsile-issues-using-jql-post
```
— Searches for issues using JQL. Recent updates might not be immediately...
```
jira-pp-cli jira-search count-issues
```
— Provide an estimated count of the issues that match the JQL. Recent...
```
jira-pp-cli jira-search for-issues-using-jql
```
— Endpoint is currently being removed. More details Searches...
```
jira-pp-cli jira-search for-issues-using-jql-post
```
— Endpoint is currently being removed. More details Searches...

jira-version — Manage jira cloud platform version

```
jira-pp-cli jira-version create
```
— Creates a project version. This operation can be accessed anonymously. Permissions required:...
```
jira-pp-cli jira-version delete
```
— Deletes a project version. Deprecated, use [ Delete and replace...
```
jira-pp-cli jira-version get
```
— Returns a project version. This operation can be accessed anonymously. Permissions required:...
```
jira-pp-cli jira-version update
```
— Updates a project version. This operation can be accessed anonymously. Permissions required:...

jira-workflow — Manage jira cloud platform workflow

jira-pp-cli jira-workflow create-transition-property

— This will be removed on June 1, 2026;...

```
jira-pp-cli jira-workflow delete-inactive
```
— Deletes a workflow. The workflow cannot be deleted if it is: * an active workflow. * a system workflow. * associated...

jira-pp-cli jira-workflow delete-transition-property

— This will be removed on June 1, 2026;...

```
jira-pp-cli jira-workflow delete-transition-rule-configurations
```
— Deletes workflow transition rules from one or more workflows. These rule types are supported: * [post...
```
jira-pp-cli jira-workflow get-paginated
```
— This will be removed on June 1, 2026;...

jira-pp-cli jira-workflow get-transition-properties

— This will be removed on June 1, 2026;...

```
jira-pp-cli jira-workflow get-transition-rule-configurations
```
— Returns a paginated list of workflows with transition rules. The workflows can be filtered to return...
```
jira-pp-cli jira-workflow list-history
```
— Returns a list of workflow history entries for a specified workflow id. Note: Stored workflow data expires after...
```
jira-pp-cli jira-workflow read-from-history
```
— Returns a workflow and related statuses for a specified workflow id and version number. Note: Stored workflow...

jira-pp-cli jira-workflow update-transition-property

— This will be removed on June 1, 2026;...

```
jira-pp-cli jira-workflow update-transition-rule-configurations
```
— Updates configuration of workflow transition rules. The following rule types are supported: * [post...

jql — 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:

convert one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs.
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.

```
jira-pp-cli jql get-auto-complete
```
— Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced...
```
jira-pp-cli jql get-auto-complete-post
```
— Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced...
```
jira-pp-cli jql get-field-auto-complete-for-query-string
```
— Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing: *...
```
jira-pp-cli jql get-precomputations
```
— Returns the list of a function's precomputations along with information about when they were created, updated, and...
```
jira-pp-cli jql get-precomputations-by-id
```
— Returns function precomputations by IDs, along with information about when they were created, updated, and last...
```
jira-pp-cli jql match-issues
```
— Checks whether one or more issues would be returned by one or more JQL queries. **Permissions...
```
jira-pp-cli jql migrate-queries
```
— Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account...
```
jira-pp-cli jql parse-queries
```
— Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be...
```
jira-pp-cli jql sanitise-queries
```
— Sanitizes one or more JQL queries by converting readable details into IDs where a user doesn't have permission to...
```
jira-pp-cli jql update-precomputations
```
— Update the precomputation value of a function created by a Forge/Connect app. **Permissions...

label — This resource represents available labels. Use it to get available labels for the global label field.

```
jira-pp-cli label
```
— Returns a paginated list of labels.

license — Manage license

```
jira-pp-cli license get-approximate-application-count
```
— Returns the total approximate number of user accounts for a single Jira license. Note that this information is...
```
jira-pp-cli license get-approximate-count
```
— Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with...

mypermissions — Manage mypermissions

```
jira-pp-cli mypermissions
```
— Returns a list of permissions indicating which permissions the user has. Details of the user's permissions can be...

mypreferences — Manage mypreferences

```
jira-pp-cli mypreferences get-locale
```
— Returns the locale for the user. If the user has no language preference set (which is the default setting) or this...
```
jira-pp-cli mypreferences get-preference
```
— Returns the value of a preference of the current user. Note that these keys are deprecated: * jira.user.locale The...
```
jira-pp-cli mypreferences remove-preference
```
— Deletes a preference of the user, which restores the default value of system defined settings. Note that these keys...
```
jira-pp-cli mypreferences set-locale
```
— Deprecated, use [ Update a user profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-...
```
jira-pp-cli mypreferences set-preference
```
— Creates a preference for the user or updates a preference's value by sending a plain text string. For example,...

myself — 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.

```
jira-pp-cli myself
```
— Returns details for the current user. Permissions required: Permission to access Jira.

notificationscheme — Manage notificationscheme

```
jira-pp-cli notificationscheme create-notification-scheme
```
— Creates a notification scheme with notifications. You can create up to 1000 notifications per request....
```
jira-pp-cli notificationscheme delete-notification-scheme
```
— Deletes a notification scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli notificationscheme get-notification-scheme
```
— Returns a notification scheme, including the list of events and the...
```
jira-pp-cli notificationscheme get-notification-scheme-to-project-mappings
```
— Returns a paginated mapping of project that have notification scheme assigned. You can provide either...
```
jira-pp-cli notificationscheme get-notification-schemes
```
— Returns a paginated list of notification schemes ordered...
```
jira-pp-cli notificationscheme update-notification-scheme
```
— Updates a notification scheme. Permissions required: Administer Jira [global...

permissions — This resource represents permissions. Use it to obtain details of all permissions and determine whether the user has certain permissions.

```
jira-pp-cli permissions get-all
```
— Returns all permissions, including: * global permissions. * project permissions. * global permissions added by...
```
jira-pp-cli permissions get-bulk
```
— Returns: * for a list of global permissions, the global permissions granted to a user. * for a list of project...
```
jira-pp-cli permissions get-permitted-projects
```
— Returns all the projects where the user is granted a list of project permissions. This operation can be accessed...

permissionscheme — Manage permissionscheme

```
jira-pp-cli permissionscheme create-permission-scheme
```
— Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission...
```
jira-pp-cli permissionscheme delete-permission-scheme
```
— Deletes a permission scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli permissionscheme get-all-permission-schemes
```
— Returns all permission schemes. ### About permission schemes and grants ### A permission scheme is a collection of...
```
jira-pp-cli permissionscheme get-permission-scheme
```
— Returns a permission scheme. Permissions required: Permission to access Jira.
```
jira-pp-cli permissionscheme update-permission-scheme
```
— Updates a permission scheme. Below are some important things to note when using this resource: * If a permissions...

plans — This resource represents plans. Use it to get, create, duplicate, update, trash and archive plans.

```
jira-pp-cli plans add-atlassian-team
```
— Adds an existing Atlassian team to a plan and configures their plannning settings. **Permissions...
```
jira-pp-cli plans archive
```
— Archives a plan. Permissions required: Administer Jira [global...
```
jira-pp-cli plans create
```
— Creates a plan. Permissions required: Administer Jira [global...
```
jira-pp-cli plans create-only-team
```
— Creates a plan-only team and configures their planning settings. Permissions required:...
```
jira-pp-cli plans delete-only-team
```
— Deletes a plan-only team and their planning settings. Permissions required: Administer Jira...
```
jira-pp-cli plans duplicate
```
— Duplicates a plan. Permissions required: Administer Jira [global...
```
jira-pp-cli plans get
```
— Returns a paginated list of plans. Permissions required: Administer Jira...
```
jira-pp-cli plans get-atlassian-team
```
— Returns planning settings for an Atlassian team in a plan. Permissions required: *Administer...
```
jira-pp-cli plans get-only-team
```
— Returns planning settings for a plan-only team. Permissions required: Administer Jira [global...
```
jira-pp-cli plans get-plan
```
— Returns a plan. Permissions required: Administer Jira [global...
```
jira-pp-cli plans get-teams
```
— Returns a paginated list of plan-only and Atlassian teams in a plan. **Permissions...
```
jira-pp-cli plans remove-atlassian-team
```
— Removes an Atlassian team from a plan and deletes their planning settings. Permissions required:...
```
jira-pp-cli plans trash
```
— Moves a plan to trash. Permissions required: Administer Jira [global...
```
jira-pp-cli plans update
```
— Updates any of the following details of a plan using JSON Patch. *...
```
jira-pp-cli plans update-atlassian-team
```
— Updates any of the following planning settings of an Atlassian team in a plan using [JSON...
```
jira-pp-cli plans update-only-team
```
— Updates any of the following planning settings of a plan-only team using [JSON...

priority — Manage priority

```
jira-pp-cli priority create
```
— Creates an issue priority. Deprecation applies to iconUrl param in request body which will be sunset on 16th Mar...
```
jira-pp-cli priority delete
```
— Deletes an issue priority. This operation is asynchronous. Follow the
```
location
```
link in the response to...
```
jira-pp-cli priority get
```
— Returns an issue priority. Permissions required: Permission to access Jira.
```
jira-pp-cli priority get-priorities
```
— Returns the list of all issue priorities. Permissions required: Permission to access Jira.
```
jira-pp-cli priority move-priorities
```
— Changes the order of issue priorities. Permissions required: Administer Jira [global...
```
jira-pp-cli priority search-priorities
```
— Returns a paginated list of priorities. The list can contain all priorities or a subset determined by...
```
jira-pp-cli priority set-default
```
— Sets default issue priority. Permissions required: Administer Jira [global...
```
jira-pp-cli priority update
```
— Updates an issue priority. At least one request body parameter must be defined. Deprecation applies to iconUrl param...

priorityscheme — Manage priorityscheme

```
jira-pp-cli priorityscheme create-priority-scheme
```
— Creates a new priority scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli priorityscheme delete-priority-scheme
```
— Deletes a priority scheme. This operation is only available for priority schemes without any associated projects....
```
jira-pp-cli priorityscheme get-available-priorities-by-priority-scheme
```
— Returns a paginated list of priorities available for adding to a priority scheme....
```
jira-pp-cli priorityscheme get-priority-schemes
```
— Returns a paginated list of priority schemes. Permissions required: Permission to...
```
jira-pp-cli priorityscheme suggested-priorities-for-mappings
```
— Returns a paginated list of priorities that would require mapping, given a change in priorities or...
```
jira-pp-cli priorityscheme update-priority-scheme
```
— Updates a priority scheme. This includes its details, the lists of priorities and projects in it...

project — 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.

```
jira-pp-cli project create
```
— Creates a project based on a project type template, as shown in the following table: | Project Type Key | Project...
```
jira-pp-cli project delete
```
— Deletes a project. You can't delete a project if it's archived. To delete an archived project, restore the project...
```
jira-pp-cli project get
```
— Returns the project details for a project. This operation can be...
```
jira-pp-cli project get-accessible-type-by-key
```
— Returns a project type if it is accessible to the user....
```
jira-pp-cli project get-all
```
— Returns all projects visible to the user. Deprecated, use [ Get projects...
```
jira-pp-cli project get-all-accessible-types
```
— Returns all project types with a valid license.
```
jira-pp-cli project get-all-types
```
— Returns all project types, whether or not the instance has a valid...
```
jira-pp-cli project get-recent
```
— Returns a list of up to 20 projects recently viewed by the user that are still visible to the user. This operation...
```
jira-pp-cli project get-type-by-key
```
— Returns a project type. This operation can be accessed anonymously....
```
jira-pp-cli project search
```
— Returns a paginated list of projects visible to the user. This operation can be accessed anonymously....
```
jira-pp-cli project update
```
— Updates the project details of a project. All parameters are optional...

project-category — Manage project category

```
jira-pp-cli project-category create
```
— Creates a project category. Permissions required: Administer Jira [global...
```
jira-pp-cli project-category get-all-project-categories
```
— Returns all project categories. Permissions required: Permission to access Jira.
```
jira-pp-cli project-category get-by-id
```
— Returns a project category. Permissions required: Permission to access Jira.
```
jira-pp-cli project-category remove
```
— Deletes a project category. Permissions required: Administer Jira [global...
```
jira-pp-cli project-category update
```
— Updates a project category. Permissions required: Administer Jira [global...

project-template — This resource represents project templates. Use it to create a new project from a custom template.

```
jira-pp-cli project-template create-project-with-custom-template
```
— Creates a project based on a custom template provided in the request. The request body should contain the project...
```
jira-pp-cli project-template edit-template
```
— Edit custom template This API endpoint allows you to edit an existing customised template. ***Note: Custom Templates...
```
jira-pp-cli project-template live-template
```
— Get custom template This API endpoint allows you to get a live custom project template details by either templateKey...
```
jira-pp-cli project-template remove-template
```
— Remove custom template This API endpoint allows you to remove a specified customised template ***Note: Custom...
```
jira-pp-cli project-template save-template
```
— Save custom template This API endpoint allows you to save a customised template ***Note: Custom Templates are only...

projects — 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.

```
jira-pp-cli projects
```
— Returns a paginated list of fields for the requested projects and work types. Only fields that are...

projectvalidate — Manage projectvalidate

```
jira-pp-cli projectvalidate get-valid-project-key
```
— Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key....
```
jira-pp-cli projectvalidate get-valid-project-name
```
— Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in...
```
jira-pp-cli projectvalidate validate-project-key
```
— Validates a project key by confirming the key is a valid string and not in use. **Permissions...

redact — Manage redact

```
jira-pp-cli redact get-redaction-status
```
— Retrieves the current status of a redaction job ID. The jobStatus will be one of the following: * IN_PROGRESS - The...
```
jira-pp-cli redact redact
```
— Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields...

resolution — Manage resolution

```
jira-pp-cli resolution create
```
— Creates an issue resolution. Permissions required: Administer Jira [global...
```
jira-pp-cli resolution delete
```
— Deletes an issue resolution. This operation is asynchronous. Follow the
```
location
```
link in the response to...
```
jira-pp-cli resolution get
```
— Returns a list of all issue resolution values. Permissions required: Permission to access Jira.
```
jira-pp-cli resolution get-id
```
— Returns an issue resolution value. Permissions required: Permission to access Jira.
```
jira-pp-cli resolution move
```
— Changes the order of issue resolutions. Permissions required: Administer Jira [global...
```
jira-pp-cli resolution search
```
— Returns a paginated list of resolutions. The list can contain all resolutions or a subset determined...
```
jira-pp-cli resolution set-default
```
— Sets default issue resolution. Permissions required: Administer Jira [global...
```
jira-pp-cli resolution update
```
— Updates an issue resolution. Permissions required: Administer Jira [global...

role — Manage role

```
jira-pp-cli role create-project
```
— Creates a new project role with no default actors. You can use the [Add default...
```
jira-pp-cli role delete-project
```
— Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in...
```
jira-pp-cli role fully-update-project
```
— Updates the project role's name and description. You must include both a name and a description in the request....
```
jira-pp-cli role get-all-project
```
— Gets a list of all project roles, complete with project role details and default actors. ### About project roles ###...
```
jira-pp-cli role get-project-by-id
```
— Gets the project role details and the default actors associated with the role. The list of default actors is sorted...
```
jira-pp-cli role partial-update-project
```
— Updates either the project role's name or its description. You cannot update both the name and description at the...

screens — This resource represents the screens used to record issue details. Use it to:

get details of all screens.
get details of all the fields available for use on screens.
create screens.
delete screens.
update screens.
add a field to the default screen.

```
jira-pp-cli screens add-field-to-default
```
— Adds a field to the default tab of the default screen. Permissions required: Administer Jira...
```
jira-pp-cli screens create
```
— Creates a screen with a default field tab. Permissions required: Administer Jira [global...
```
jira-pp-cli screens delete
```
— Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only...
```
jira-pp-cli screens get
```
— Returns a paginated list of all screens or those specified by one or more screen IDs....
```
jira-pp-cli screens get-bulk-tabs
```
— Returns the list of tabs for a bulk of screens. Permissions required: * Administer Jira...
```
jira-pp-cli screens update
```
— Updates a screen. Only screens used in classic projects can be updated. Permissions required:...

screenscheme — Manage screenscheme

```
jira-pp-cli screenscheme create-screen-scheme
```
— Creates a screen scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli screenscheme delete-screen-scheme
```
— Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only...
```
jira-pp-cli screenscheme get-screen-schemes
```
— Returns a paginated list of screen schemes. Only screen schemes used in classic projects are...
```
jira-pp-cli screenscheme update-screen-scheme
```
— Updates a screen scheme. Only screen schemes used in classic projects can be updated. **Permissions...

securitylevel — Manage securitylevel

```
jira-pp-cli securitylevel <id>
```
— Returns details of an issue security level. Use [Get issue security...

server-info — This resource provides information about the Jira instance.

```
jira-pp-cli server-info
```
— Returns information about the Jira instance. This operation can be accessed anonymously....

settings — Manage settings

```
jira-pp-cli settings get-issue-navigator-default-columns
```
— Returns the default issue navigator columns. Permissions required: Administer Jira [global...
```
jira-pp-cli settings set-issue-navigator-default-columns
```
— Sets the default issue navigator columns. The
```
columns
```
parameter accepts a navigable field value and is expressed...

status — This resource represents statuses. Use it to search, get, create, delete, and change statuses.

```
jira-pp-cli status get
```
— Returns a status. The status must be associated with an active workflow to be returned. If a name is used on more...
```
jira-pp-cli status get-statuses
```
— Returns a list of all statuses associated with active workflows. This operation can be accessed anonymously....

statuscategory — Manage statuscategory

```
jira-pp-cli statuscategory get-status-categories
```
— Returns a list of all status categories. Permissions required: Permission to access Jira.
```
jira-pp-cli statuscategory get-status-category
```
— Returns a status category. Status categories provided a mechanism for categorizing...

statuses — Manage statuses

```
jira-pp-cli statuses create
```
— Creates statuses for a global or project scope. Permissions required: * Administer projects...
```
jira-pp-cli statuses delete-by-id
```
— Deletes statuses by ID. Permissions required: * Administer projects [project...
```
jira-pp-cli statuses get-by-id
```
— Returns a list of the statuses specified by one or more status IDs. Permissions required: *...
```
jira-pp-cli statuses get-by-name
```
— Returns a list of the statuses specified by one or more status names. Permissions required: *...
```
jira-pp-cli statuses search
```
— Returns a paginated list of...
```
jira-pp-cli statuses update
```
— Updates statuses by ID. Permissions required: * Administer projects [project...

task — This resource represents a long-running asynchronous tasks. Use it to obtain details about the progress of a long-running task or cancel a long-running task.

```
jira-pp-cli task <taskId>
```
— Returns the status of a long-running asynchronous task. When a task has finished, this operation returns...

ui-modifications — Manage ui modifications

```
jira-pp-cli ui-modifications create
```
— Creates a UI modification. UI modification can only be created by Forge apps. Each app can define up to 3000 UI...
```
jira-pp-cli ui-modifications delete
```
— Deletes a UI modification. All the contexts that belong to the UI modification are deleted too. UI modification can...
```
jira-pp-cli ui-modifications get
```
— Gets UI modifications. UI modifications can only be retrieved by Forge apps. **Permissions...
```
jira-pp-cli ui-modifications update
```
— Updates a UI modification. UI modification can only be updated by Forge apps. Each UI modification can define up to...

universal-avatar — Manage universal avatar

```
jira-pp-cli universal-avatar delete-avatar
```
— Deletes an avatar from a project, issue type or priority. Permissions required: *Administer...
```
jira-pp-cli universal-avatar get-avatar-image-by-id
```
— Returns a project, issue type or priority avatar image by ID. This operation can be accessed anonymously....
```
jira-pp-cli universal-avatar get-avatar-image-by-owner
```
— Returns the avatar image for a project, issue type or priority. This operation can be accessed anonymously....
```
jira-pp-cli universal-avatar get-avatar-image-by-type
```
— Returns the default project, issue type or priority avatar image. This operation can be accessed anonymously....
```
jira-pp-cli universal-avatar get-avatars
```
— Returns the system and custom avatars for a project, issue type or priority. This operation can be accessed...
```
jira-pp-cli universal-avatar store-avatar
```
— Loads a custom avatar for a project, issue type or priority. Specify the avatar's local file location in the body of...

user — This resource represent users. Use it to:

get, get a list of, create, and delete users.
get, set, and reset a user's default issue table columns.
get a list of the groups the user belongs to.
get a list of user account IDs for a list of usernames or user keys.

```
jira-pp-cli user bulk-get
```
— Returns a paginated list of the users specified by one or more account IDs....
```
jira-pp-cli user bulk-get-migration
```
— Returns the account IDs for the users specified in the
```
key
```
or
```
username
```
parameters. Note that multiple
```
key
```
or...
```
jira-pp-cli user create
```
— Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is...
```
jira-pp-cli user delete-property
```
— Deletes a property from a user. Note: This operation does not access the [user...
```
jira-pp-cli user find
```
— Returns a list of active users that match the search string and property. This operation first applies a filter to...
```
jira-pp-cli user find-assignable
```
— Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be...
```
jira-pp-cli user find-bulk-assignable
```
— Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users...
```
jira-pp-cli user find-by-query
```
— Finds users with a structured query and returns a paginated list of user details. This operation...
```
jira-pp-cli user find-for-picker
```
— Returns a list of users whose attributes match the query term. The returned object includes the
```
html
```
field where...
```
jira-pp-cli user find-keys-by-query
```
— Finds users with a structured query and returns a paginated list of user keys. This operation takes...
```
jira-pp-cli user find-with-all-permissions
```
— Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have a set...
```
jira-pp-cli user find-with-browse-permission
```
— Returns a list of users who fulfill these criteria: * their user attributes match a search string. * they have...
```
jira-pp-cli user get
```
— Returns a user. Privacy controls are applied to the response based on the user's preferences. This could mean, for...
```
jira-pp-cli user get-default-columns
```
— Returns the default issue table columns for the user. If
```
accountId
```
is...
```
jira-pp-cli user get-email
```
— Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is...
```
jira-pp-cli user get-email-bulk
```
— Returns a user's email address regardless of the user's profile visibility settings. For Connect apps, this API is...
```
jira-pp-cli user get-groups
```
— Returns the groups to which a user belongs. Permissions required: Browse users and groups...
```
jira-pp-cli user get-property
```
— Returns the value of a user's property. If no property key is provided [Get user property...
```
jira-pp-cli user get-property-keys
```
— Returns the keys of all properties for a user. Note: This operation does not access the [user...
```
jira-pp-cli user remove
```
— Deletes a user. If the operation completes successfully then the user is removed from Jira's user base. This...
```
jira-pp-cli user reset-columns
```
— Resets the default issue table columns for the user to the system...
```
jira-pp-cli user set-columns
```
— Sets the default issue table columns for the user. If an account ID is...
```
jira-pp-cli user set-property
```
— Sets the value of a user's property. Use this resource to store custom data against a user. Note: This operation...

users — This resource represent users. Use it to:

get, get a list of, create, and delete users.
get, set, and reset a user's default issue table columns.
get a list of the groups the user belongs to.
get a list of user account IDs for a list of usernames or user keys.

```
jira-pp-cli users get-all
```
— Returns a list of all users, including active users, inactive users and previously deleted users that have an...
```
jira-pp-cli users get-all-default
```
— Returns a list of all users, including active users, inactive users and previously deleted users that have an...

webhook — 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.

```
jira-pp-cli webhook delete-by-id
```
— Removes webhooks by ID. Only webhooks registered by the calling app are removed. If webhooks created by other apps...
```
jira-pp-cli webhook get-dynamic-for-app
```
— Returns a paginated list of the webhooks registered by the calling app. **Permissions...
```
jira-pp-cli webhook get-failed
```
— Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of...
```
jira-pp-cli webhook refresh
```
— Extends the life of webhook. Webhooks registered through the REST API expire after 30 days. Call this operation to...
```
jira-pp-cli webhook register-dynamic
```
— Registers webhooks. NOTE: for non-public OAuth apps, webhooks are delivered only if there is a match between the...

workflows — This resource represents workflows. Use it to:

Get workflows
Create workflows
Update workflows
Delete inactive workflows
Get workflow capabilities

```
jira-pp-cli workflows capabilities
```
— Get the list of workflow capabilities for a specific workflow using either the workflow ID, or the project and issue...
```
jira-pp-cli workflows create
```
— Create workflows and related statuses. Permissions required: * Administer Jira project...
```
jira-pp-cli workflows get-default-editor
```
— Get the user's default workflow editor. This can be either the new editor or the legacy editor.
```
jira-pp-cli workflows read
```
— Returns a list of workflows and related statuses by providing workflow names, workflow IDs, or project and issue...
```
jira-pp-cli workflows read-previews
```
— Returns a requested workflow within a given project. The response provides a read-only preview of the workflow,...
```
jira-pp-cli workflows search
```
— Returns a paginated list of global and project workflows. If workflow names are specified in the...
```
jira-pp-cli workflows update
```
— Update workflows and related statuses. Permissions required: * Administer Jira project...
```
jira-pp-cli workflows validate-create
```
— Validate the payload for bulk create workflows. Permissions required: * Administer Jira...
```
jira-pp-cli workflows validate-update
```
— Validate the payload for bulk update workflows. Permissions required: * Administer Jira...

workflowscheme — Manage workflowscheme

```
jira-pp-cli workflowscheme assign-scheme-to-project
```
— Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project....
```
jira-pp-cli workflowscheme create-workflow-scheme
```
— Creates a workflow scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli workflowscheme delete-workflow-scheme
```
— Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at...
```
jira-pp-cli workflowscheme get-all-workflow-schemes
```
— Returns a paginated list of all workflow schemes, not including draft workflow schemes....
```
jira-pp-cli workflowscheme get-required-workflow-scheme-mappings
```
— Gets the required status mappings for the desired changes to a workflow scheme. The results are provided per issue...
```
jira-pp-cli workflowscheme get-workflow-scheme
```
— Returns a workflow scheme. Permissions required: Administer Jira [global...
```
jira-pp-cli workflowscheme get-workflow-scheme-project-associations
```
— Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a...
```
jira-pp-cli workflowscheme read-workflow-schemes
```
— Returns a list of workflow schemes by providing workflow scheme IDs or project IDs. **Permissions...
```
jira-pp-cli workflowscheme switch-workflow-scheme-for-project
```
— Switches a workflow scheme for a project. Workflow schemes can only be assigned to classic projects. **Calculating...
```
jira-pp-cli workflowscheme update-schemes
```
— Updates company-managed and team-managed project workflow schemes. This API doesn't have a concept of draft, so any...
```
jira-pp-cli workflowscheme update-workflow-scheme
```
— Updates a company-manged project workflow scheme, including the name, default workflow, issue type to project...

worklog — Manage worklog

```
jira-pp-cli worklog get-for-ids
```
— Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items....
```
jira-pp-cli worklog get-ids-of-deleted-since
```
— Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated,...
```
jira-pp-cli worklog get-ids-of-modified-since
```
— Returns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated,...

announcement-banner — 该资源代表公告横幅。用于检索和更新横幅配置。

```
jira-pp-cli announcement-banner get-banner
```
— 返回当前公告横幅配置。权限要求： 管理Jira...
```
jira-pp-cli announcement-banner set-banner
```
— 更新公告横幅配置。权限要求： 管理Jira [全局...

app — 管理应用

```
jira-pp-cli app get-custom-field-configuration
```
— 返回某个自定义字段的配置分页列表，该字段属于...
```
jira-pp-cli app get-custom-fields-configurations
```
— 返回一组自定义字段的配置分页列表，这些字段属于...
```
jira-pp-cli app update-custom-field-configuration
```
— 更新自定义字段在不同上下文下的配置，该字段属于[类型](https://developer.atlassian.com/platform/forge/ma...
```
jira-pp-cli app update-custom-field-value
```
— 更新一个或多个问题上自定义字段的值。应用仅能对[自定义...
```
jira-pp-cli app update-multiple-custom-field-values
```
— 更新一个或多个问题上多个自定义字段的值。自定义字段与问题的组合应...

application-properties — 管理应用属性

```
jira-pp-cli application-properties get-advanced-settings
```
— 返回“高级设置”页面中可访问的应用属性。要导航到“高级...
```
jira-pp-cli application-properties get-application-property
```
— 返回所有应用属性或单个应用属性。如果您为
```
key
```
参数指定了值，则...

jira-pp-cli application-properties set-application-property

— 修改应用属性的值。例如，您可以将

jira.clone.prefix

的值从...

applicationrole — 管理应用角色

```
jira-pp-cli applicationrole get-all-application-roles
```
— 返回所有应用角色。在Jira中，应用角色通过[应用访问...
```
jira-pp-cli applicationrole get-application-role
```
— 返回单个应用角色。权限要求： 管理Jira [全局...

atlassian-connect — 管理Atlassian Connect

jira-pp-cli atlassian-connect addon-properties-resource-delete-addon-property-delete

— 删除应用的属性。权限要求： 仅密钥与

addonKey

匹配的Connect应用...

jira-pp-cli atlassian-connect addon-properties-resource-get-addon-properties-get

— 获取应用的所有属性。保留密钥

connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8

不会...

jira-pp-cli atlassian-connect addon-properties-resource-get-addon-property-get

— 返回应用属性的密钥和值。属性密钥...

```
jira-pp-cli atlassian-connect addon-properties-resource-put-addon-property-put
```
— 设置应用属性的值。使用此资源存储应用的自定义数据。请求的值...
```
jira-pp-cli atlassian-connect app-issue-field-value-update-resource-update-issue-fields-put
```
— 更新一个或多个问题上由Connect应用添加的自定义字段的值。最多可更新200个自定义...
```
jira-pp-cli atlassian-connect connect-to-forge-migration-fetch-task-resource-fetch-migration-task-get
```
— 返回Connect问题字段迁移到Forge的详细信息。将Connect应用迁移到Forge时，[问题...

jira-pp-cli atlassian-connect connect-to-forge-migration-task-submission-resource-submit-task-post

— 提交请求以触发Connect问题字段迁移到对应的Forge自定义字段。迁移时...

```
jira-pp-cli atlassian-connect dynamic-modules-resource-get-modules-get
```
— 返回调用应用动态注册的所有模块。权限要求： 仅...
```
jira-pp-cli atlassian-connect dynamic-modules-resource-register-modules-post
```
— 注册一组模块。权限要求： 仅Connect应用可发起此请求。

jira-pp-cli atlassian-connect dynamic-modules-resource-remove-modules-delete

— 删除调用应用注册的所有或一组模块。权限要求： 仅...

```
jira-pp-cli atlassian-connect migration-resource-update-entity-properties-value-put
```
— 更新一个对象的多个实体属性值，每个请求最多可更新50个属性。此操作用于...
```
jira-pp-cli atlassian-connect migration-resource-workflow-rule-search-post
```
— 返回从服务器迁移到云端且归调用Connect应用所有的工作流转换规则配置。
```
jira-pp-cli atlassian-connect service-registry-resource-services-get
```
— 获取指定服务注册中心的属性。权限要求： 仅Connect应用可...

attachment — 管理附件

```
jira-pp-cli attachment get
```
— 返回附件的元数据。注意，不会返回附件本身。此操作可以...
```
jira-pp-cli attachment get-content
```
— 返回附件的内容。可以设置
```
Range
```
头来定义附件中的字节范围...
```
jira-pp-cli attachment get-meta
```
— 返回附件设置，即是否启用附件以及允许的最大附件大小....
```
jira-pp-cli attachment get-thumbnail
```
— 返回附件的缩略图。要返回附件内容，请使用[获取附件...
```
jira-pp-cli attachment remove
```
— 从问题中删除附件。此操作可匿名访问。**权限...

auditing — 管理审计

```
jira-pp-cli auditing
```
— 返回审计记录列表。可过滤列表以包含以下项：*
```
filter
```
中的每个项都有...

avatar — 该资源代表系统和自定义头像。用于获取系统或自定义头像的详细信息，为项目、问题类型或优先级添加和删除头像，以及获取头像图片。

bulk — 管理批量操作

```
jira-pp-cli bulk get-available-transitions
```
— 使用此API检索指定问题可用的转换列表，可用于批量...
```
jira-pp-cli bulk get-editable-fields
```
— 使用此API获取用户可见的可用于批量编辑操作的字段列表。您可以传递单个或...
```
jira-pp-cli bulk get-operation-progress
```
— 使用此API获取指定批量操作
```
taskId
```
的进度状态。**权限...
```
jira-pp-cli bulk submit-delete
```
— 使用此API提交批量删除请求。单次操作最多可删除1000个问题....
```
jira-pp-cli bulk submit-edit
```
— 使用此API提交批量编辑请求，同时编辑多个问题。操作有以下限制...
```
jira-pp-cli bulk submit-move
```
— 使用此API提交批量问题移动请求。单次操作可将多个问题从多个项目移动到...
```
jira-pp-cli bulk submit-transition
```
— 使用此API提交批量问题状态转换请求。您可以转换多个问题，同时...
```
jira-pp-cli bulk submit-unwatch
```
— 使用此API提交批量取消关注请求。单次操作最多可取消关注1000个问题....
```
jira-pp-cli bulk submit-watch
```
— 使用此API提交批量关注请求。单次操作最多可关注1000个问题....

changelog — 管理变更日志

```
jira-pp-cli changelog
```
— 批量获取多个问题的变更日志并按字段过滤，返回给定问题的所有变更日志分页列表...

classification-levels — 该资源代表分类级别。

```
jira-pp-cli classification-levels
```
— 返回所有分类级别。权限要求： 无。

comment — 管理评论

```
jira-pp-cli comment
```
— 返回由评论ID列表指定的评论分页列表。此操作可以...

component — 管理组件

```
jira-pp-cli component create
```
— 创建组件。使用组件为项目中的问题提供容器。使用组件来...
```
jira-pp-cli component delete
```
— 删除组件。此操作可匿名访问。权限要求：...
```
jira-pp-cli component find-for-projects
```
— 返回项目中的所有组件分页列表，包括全局（Compass）组件（当...
```
jira-pp-cli component get
```
— 返回单个组件。此操作可匿名访问。权限要求： *浏览...
```
jira-pp-cli component update
```
— 更新组件。请求中包含的任何字段都会被覆盖。如果
```
leadAccountId
```
是空字符串('')...

config — 管理配置

```
jira-pp-cli config associate-projects-to-field-association-schemes
```
— 将项目关联到字段关联方案。权限要求： 管理Jira [全局...
```
jira-pp-cli config clone-field-association-scheme
```
— 将现有字段关联方案克隆为新方案的端点。权限要求：...
```
jira-pp-cli config create-field-association-scheme
```
— 创建新字段关联方案的端点。权限要求： 管理Jira...
```
jira-pp-cli config delete-field-association-scheme
```
— 删除指定的字段关联方案 权限要求： 管理Jira [全局...
```
jira-pp-cli config get-field-association-scheme-by-id
```
— 通过ID获取字段关联方案的端点 权限要求： *管理...
```
jira-pp-cli config get-field-association-scheme-item-parameters
```
— 检索字段关联方案上的字段关联参数 权限要求：...
```
jira-pp-cli config get-field-association-schemes
```
— 检索字段关联方案分页列表（支持可选过滤）的REST端点。此端点...
```
jira-pp-cli config get-projects-with-field-schemes
```
— 获取关联了字段关联方案的项目。这是一个临时API，但在从...过渡时很有用
```
jira-pp-cli config remove-field-association-scheme-item-parameters
```
— 移除工作类型的字段关联参数覆盖。权限要求： *管理...
```
jira-pp-cli config remove-fields-associated-with-schemes
```
— 移除与字段关联方案关联的字段。权限要求： 管理Jira...
```
jira-pp-cli config search-field-association-scheme-fields
```
— 搜索属于指定字段关联方案的字段。权限要求：...
```
jira-pp-cli config search-field-association-scheme-projects
```
— 搜索属于指定字段关联方案的项目的REST端点 **权限...
```
jira-pp-cli config update-field-association-scheme
```
— 更新现有字段关联方案的端点。权限要求： *管理...
```
jira-pp-cli config update-field-association-scheme-item-parameters
```
— 更新字段关联方案中的字段关联项参数。权限要求：...
```
jira-pp-cli config update-fields-associated-with-schemes
```
— 更新与字段关联方案关联的字段。权限要求： 管理Jira...

configuration — 管理配置

```
jira-pp-cli configuration get
```
— 返回Jira中的全局设置。这些设置决定了是否...
```
jira-pp-cli configuration get-available-time-tracking-implementations
```
— 返回所有时间跟踪提供商。默认情况下，Jira只有一个时间跟踪提供商：*Jira提供的时间...
```
jira-pp-cli configuration get-selected-time-tracking-implementation
```
— 返回当前选中的时间跟踪提供商。注意，如果时间跟踪已禁用，则...
```
jira-pp-cli configuration get-shared-time-tracking
```
— 返回时间跟踪设置。包括时间格式、默认时间单位等设置....
```
jira-pp-cli configuration select-time-tracking-implementation
```
— 选择时间跟踪提供商。权限要求： 管理Jira [全局...
```
jira-pp-cli configuration set-shared-time-tracking
```
— 设置时间跟踪设置。权限要求： 管理Jira [全局...

custom-field-option — 管理自定义字段选项

```
jira-pp-cli custom-field-option <id>
```
— 返回自定义字段选项。例如，选择列表中的选项。注意，此操作**仅适用于...

dashboard — 该资源代表仪表板。用于获取仪表板的详细信息，以及获取、创建、更新或删除仪表板的项属性和小工具。

```
jira-pp-cli dashboard bulk-edit
```
— 批量编辑仪表板。单次最多可编辑100个仪表板....
```
jira-pp-cli dashboard create
```
— 创建仪表板。权限要求： 无。
```
jira-pp-cli dashboard delete
```
— 删除仪表板。权限要求： 无。要删除的仪表板必须归当前用户所有...
```
jira-pp-cli dashboard get
```
— 返回单个仪表板。此操作可匿名访问。权限要求： 无....
```
jira-pp-cli dashboard get-all
```
— 返回用户拥有或共享的仪表板列表。可过滤列表以仅包含收藏的或...
```
jira-pp-cli dashboard get-all-available-gadgets
```
— 获取可添加到所有仪表板的所有可用小工具列表。权限要求：...
```
jira-pp-cli dashboard get-paginated
```
— 返回仪表板的分页列表。此操作类似于[获取...
```
jira-pp-cli dashboard update
```
— 更新仪表板，用提供的内容替换所有仪表板详细信息。**权限...

data-policy — 管理数据策略

```
jira-pp-cli data-policy get-policies
```
— 返回请求中指定项目的数据策略。
```
jira-pp-cli data-policy get-policy
```
— 返回工作区的数据策略。

events — 管理事件

```
jira-pp-cli events
```
— 返回所有问题事件。权限要求： 管理Jira [全局...

expression — 管理表达式

```
jira-pp-cli expression analyse
```
— 分析并验证Jira表达式。作为实验性功能，此操作还可以尝试进行类型检查...
```
jira-pp-cli expression evaluate-jira
```
— 该端点目前正在移除中。更多详情...
```
jira-pp-cli expression evaluate-jsisjira
```
— 计算Jira表达式并返回其值。此端点与
```
eval
```
的区别在于使用...

field — 管理字段

```
jira-pp-cli field create-associations
```
— 将字段与项目关联。字段将与请求项目中的每个问题类型关联。字段...
```
jira-pp-cli field create-custom
```
— 创建自定义字段。权限要求： 管理Jira [全局...
```
jira-pp-cli field delete-custom
```
— 删除自定义字段。无论自定义字段是否在回收站中，都会被删除。请参阅[编辑或删除自定义...
```
jira-pp-cli field get
```
— 根据以下规则返回系统和自定义问题字段：* 无法添加到问题的字段...
```
jira-pp-cli field get-paginated
```
— 返回经典Jira项目的字段分页列表。列表可包含：* 所有字段 *...
```
jira-pp-cli field get-trashed-paginated
```
— 返回回收站中的字段分页列表。列表可能仅限于字段...
```
jira-pp-cli field remove-associations
```
— 将一组字段与项目和问题类型上下文解除关联。字段将与所有...
```
jira-pp-cli field update-custom
```
— 更新自定义字段。权限要求： 管理Jira [全局...

fieldconfiguration — 管理字段配置

```
jira-pp-cli fieldconfiguration create-field-configuration
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration delete-field-configuration
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration get-all-field-configurations
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfiguration update-field-configuration
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...

fieldconfigurationscheme — 管理字段配置方案

```
jira-pp-cli fieldconfigurationscheme assign-field-configuration-scheme-to-project
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme create-field-configuration-scheme
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme delete-field-configuration-scheme
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-all-field-configuration-schemes
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-mappings
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme get-field-configuration-scheme-project-mapping
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...
```
jira-pp-cli fieldconfigurationscheme update-field-configuration-scheme
```
— 已弃用，请使用[字段方案](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/...

filter — 该资源代表过滤器。用于获取、创建、更新或删除过滤器，还可配置过滤器的列并设置收藏过滤器。

```
jira-pp-cli filter create
```
— 创建过滤器。过滤器将根据默认共享范围进行共享。...
```
jira-pp-cli filter delete
```
— 删除过滤器。权限要求： 访问Jira的权限，但过滤器只能由...
```
jira-pp-cli filter get
```
— 返回单个过滤器。此操作可匿名访问。权限要求： 无，...
```
jira-pp-cli filter get-default-share-scope
```
— 返回用户新建过滤器和仪表板的默认共享设置。**权限...
```
jira-pp-cli filter get-favourite
```
— 返回用户可见的收藏过滤器。此操作可匿名访问....
```
jira-pp-cli filter get-my
```
— 返回用户拥有的过滤器。如果
```
includeFavourites
```
为
```
true
```
，则还会包含用户可见的收藏过滤器...
```
jira-pp-cli filter get-paginated
```
— 返回过滤器的分页列表。使用此操作可获取：* 指定的过滤器，通过定义
```
id
```
...
```
jira-pp-cli filter set-default-share-scope
```
— 设置用户新建过滤器和仪表板的默认共享设置。权限要求：...
```
jira-pp-cli filter update
```
— 更新过滤器。使用此操作更新过滤器的名称、描述、JQL或共享设置....

forge — 管理Forge

```
jira-pp-cli forge bulk-pin-unpin-projects-async
```
— 批量将Forge应用添加的问题面板固定到多个项目或从多个项目取消固定。操作将...
```
jira-pp-cli forge delete-app-property
```
— 删除Forge应用的属性。权限要求： 仅Forge应用可发起此请求....
```
jira-pp-cli forge get-app-property
```
— 返回Forge应用属性的值。权限要求： 仅Forge应用可发起此...
```
jira-pp-cli forge get-app-property-keys
```
— 返回Forge应用的所有属性密钥。权限要求： 仅Forge应用可发起此...
```
jira-pp-cli forge put-app-property
```
— 设置Forge应用属性的值。这些值可在[Jira...

group — 该资源代表用户组。用于获取、创建、查找和删除组，以及向组中添加或移除用户。（[警告] 标准Atlassian组名仅为默认名称，可编辑或删除。例如，管理员或Atlassian支持人员可随时删除默认组jira-software-users或将其重命名为jsw-users。详情请参阅https://support.atlassian.com/user-management/docs/create-and-update-groups/。）

```
jira-pp-cli group add-user-to
```
— 将用户添加到组中。权限要求： 站点管理权限（即属于...
```
jira-pp-cli group bulk-get
```
— 返回组的分页列表。权限要求： *浏览用户和...
```
jira-pp-cli group create
```
— 创建组。权限要求： 站点管理权限（即属于site-admin...
```
jira-pp-cli group get
```
— 此操作已弃用，请使用
```
group/member
```
。返回组中的所有用户....
```
jira-pp-cli group get-users-from
```
— 返回组中所有用户的分页列表。注意，用户按用户名排序，但...
```
jira-pp-cli group remove
```
— 删除组。权限要求： 站点管理权限（即属于site-admin...
```
jira-pp-cli group remove-user-from
```
— 将用户从组中移除。权限要求： 站点管理权限（即属于...

groups — 该资源代表用户组。用于获取、创建、查找和删除组，以及向组中添加或移除用户。（[警告] 标准Atlassian组名仅为默认名称，可编辑或删除。例如，管理员或Atlassian支持人员可随时删除默认组jira-software-users或将其重命名为jsw-users。详情请参阅https://support.atlassian.com/user-management/docs/create-and-update-groups/。）

```
jira-pp-cli groups
```
— 返回名称包含查询字符串的组列表。可提供组名称列表以排除某些组...

groupuserpicker — 管理用户组选择器

```
jira-pp-cli groupuserpicker
```
— 返回与字符串匹配的用户和组列表。该字符串用于：* 对于用户，查找不区分大小写的...

instance — 管理实例

```
jira-pp-cli instance
```
— 返回Jira实例的许可信息。权限要求： 无。

internal — 管理内部操作

```
jira-pp-cli internal
```
— 返回一组问题ID和工作日志ID对应的工作日志详细信息。这是一个用于批量获取...的内部API

issue — 该资源代表Jira问题。用于：

单独或批量创建或编辑问题。
获取创建或编辑问题的选项元数据。
删除问题。
将用户分配给问题。
获取问题变更日志。
发送关于问题的通知。
获取问题可用的转换详细信息。
转换问题状态。
归档问题。
取消归档问题。
导出归档问题。

```
jira-pp-cli issue archive
```
— 允许管理员使用问题ID/密钥在单次请求中归档最多1000个问题，返回...的详细信息
```
jira-pp-cli issue archive-async
```
— 允许管理员使用JQL在单次请求中归档最多100000个问题，返回用于检查状态的URL...
```
jira-pp-cli issue bulk-delete-property
```
— 从多个问题中删除属性值。可通过过滤条件指定要更新的问题。...
```
jira-pp-cli issue bulk-fetch
```
— 返回一组请求问题的详细信息。您最多可请求100个问题。每个问题通过其...
```
jira-pp-cli issue bulk-set-properties-by
```
— 在问题上设置或更新实体属性值。每个问题最多可指定10个实体属性，最多...
```
jira-pp-cli issue bulk-set-properties-list
```
— 在问题上设置或更新一组实体属性值。每个问题最多可指定10个实体属性...
```
jira-pp-cli issue bulk-set-property
```
— 在多个问题上设置属性值。设置的值可以是常量或由[Jira...
```
jira-pp-cli issue create
```
— 创建问题，或者在Jira中启用创建子任务选项时创建子任务。可应用转换，...
```
jira-pp-cli issue create-bulk
```
— 创建最多50个问题，或者在Jira中启用创建子任务选项时创建子任务。可应用转换...
```
jira-pp-cli issue delete
```
— 删除问题。如果问题有一个或多个子任务，则无法删除。要删除带有子任务的问题，请设置...
```
jira-pp-cli issue edit
```
— 编辑问题。问题属性可作为编辑的一部分进行更新。请注意，问题转换不是...
```
jira-pp-cli issue get
```
— 返回问题的详细信息。问题通过其ID或密钥标识，但如果标识符不匹配...
```
jira-pp-cli issue get-create-meta
```
— 返回项目、项目中的问题类型的详细信息，以及（如果请求）每个...的创建屏幕字段
```
jira-pp-cli issue get-create-meta-type-id
```
— 返回指定项目和问题类型ID的字段元数据页面。使用此信息填充...
```
jira-pp-cli issue get-create-meta-types
```
— 返回指定项目的问题类型元数据页面。使用此信息填充[...中的请求
```
jira-pp-cli issue get-is-watching-bulk
```
— 返回用户对列表中问题的关注状态详细信息。如果问题ID无效，返回的...
```
jira-pp-cli issue get-limit-report
```
— 返回所有违反或接近每个问题限制的问题。权限要求： * *浏览...
```
jira-pp-cli issue get-picker-resource
```
— 返回与查询字符串匹配的问题列表。使用此资源在...时提供自动完成建议
```
jira-pp-cli issue unarchive
```
— 允许管理员使用问题ID/密钥在单次请求中取消归档最多1000个问题，返回...的详细信息

issue-link — 该资源代表问题之间的链接。用于获取、创建和删除问题之间的链接。

要使用此资源，站点必须启用问题链接。

```
jira-pp-cli issue-link delete
```
— 删除问题链接。此操作可匿名访问。权限要求： *...
```
jira-pp-cli issue-link get
```
— 返回问题链接。此操作可匿名访问。权限要求： *...
```
jira-pp-cli issue-link link-issues
```
— 在两个问题之间创建链接。使用此操作指示两个问题之间的关系，并可选地...

issue-link-type — 该资源代表问题链接类型。用于获取、创建、更新和删除问题链接类型，以及获取所有问题链接类型的列表。

要使用此资源，站点必须启用问题链接。

```
jira-pp-cli issue-link-type create
```
— 创建问题链接类型。使用此操作创建问题链接原因的描述。...
```
jira-pp-cli issue-link-type delete
```
— 删除问题链接类型。要使用此操作，站点必须启用[问题...
```
jira-pp-cli issue-link-type get
```
— 返回所有问题链接类型的列表。要使用此操作，站点必须启用[问题...
```
jira-pp-cli issue-link-type get-issuelinktype
```
— 返回单个问题链接类型。要使用此操作，站点必须启用[问题...
```
jira-pp-cli issue-link-type update
```
— 更新问题链接类型。要使用此操作，站点必须启用[问题...

issues — 该资源代表Jira问题。用于：

单独或批量创建或编辑问题。
获取创建或编辑问题的选项元数据。
删除问题。
将用户分配给问题。
获取问题变更日志。
发送关于问题的通知。
获取问题可用的转换详细信息。
转换问题状态。
归档问题。
取消归档问题。
导出归档问题。

```
jira-pp-cli issues
```
— 允许管理员检索所有归档问题的详细信息。请求成功后，提交请求的管理员...

issuesecurityschemes — 管理问题安全方案

```
jira-pp-cli issuesecurityschemes associate-schemes-to-projects
```
— 将问题安全方案与项目关联，并在需要时将问题的安全级别重新映射到新级别...
```
jira-pp-cli issuesecurityschemes create-issue-security-scheme
```
— 创建带有安全方案级别和级别成员的安全方案。您最多可创建100个安全方案...
```
jira-pp-cli issuesecurityschemes delete-security-scheme
```
— 删除问题安全方案。权限要求： 管理Jira [global...
```
jira-pp-cli issuesecurityschemes get-issue-security-scheme
```
— 返回问题安全方案及其安全级别。权限要求： *...

jira-pp-cli issuesecurityschemes get-issue-security-schemes

— 返回所有问题安全方案。**权限...

```
jira-pp-cli issuesecurityschemes get-security-level-members
```
— 返回问题安全级别成员的分页列表。仅包含...中的问题安全级别成员
```
jira-pp-cli issuesecurityschemes get-security-levels
```
— 返回问题安全级别的分页列表。仅包含...上下文中的问题安全级别
```
jira-pp-cli issuesecurityschemes search-projects-using-security-schemes
```
— 返回使用安全方案的项目映射分页列表。您可以提供一个...
```
jira-pp-cli issuesecurityschemes search-security-schemes
```
— 返回问题安全方案的分页列表。如果您指定项目ID参数，则...
```
jira-pp-cli issuesecurityschemes set-default-levels
```
— 为方案设置默认问题安全级别。权限要求： 管理Jira [global...
```
jira-pp-cli issuesecurityschemes update-issue-security-scheme
```
— 更新问题安全方案。权限要求： 管理Jira [global...

issuetype — 管理问题类型

```
jira-pp-cli issuetype create-issue-type
```
— 创建问题类型。权限要求： 管理Jira [global...
```
jira-pp-cli issuetype delete-issue-type
```
— 删除问题类型。如果问题类型正在使用中，所有使用该类型的地方都会替换为备选问题类型...
```
jira-pp-cli issuetype get-issue-all-types
```
— 返回所有问题类型。此操作可匿名访问。权限要求： Issue...
```
jira-pp-cli issuetype get-issue-type
```
— 返回单个问题类型。此操作可匿名访问。权限要求： *浏览...
```
jira-pp-cli issuetype get-issue-types-for-project
```
— 返回项目的问题类型。此操作可匿名访问。**权限...
```
jira-pp-cli issuetype update-issue-type
```
— 更新问题类型。权限要求： 管理Jira [global...

issuetypescheme — 管理问题类型方案

```
jira-pp-cli issuetypescheme assign-issue-type-scheme-to-project
```
— 将问题类型方案分配给项目。如果项目中的任何问题分配了方案中不存在的问题类型...
```
jira-pp-cli issuetypescheme create-issue-type-scheme
```
— 创建问题类型方案。权限要求： 管理Jira [global...
```
jira-pp-cli issuetypescheme delete-issue-type-scheme
```
— 删除问题类型方案。仅经典项目中使用的问题类型方案可删除。仅问题类型...
```
jira-pp-cli issuetypescheme get-all-issue-type-schemes
```
— 返回问题类型方案的分页列表。仅包含经典项目中使用的问题类型方案...
```
jira-pp-cli issuetypescheme get-issue-type-scheme-for-projects
```
— 返回问题类型方案的分页列表，以及每个问题类型方案对应的...列表
```
jira-pp-cli issuetypescheme get-issue-type-schemes-mapping
```
— 返回问题类型方案项的分页列表。仅包含经典...中使用的问题类型方案项
```
jira-pp-cli issuetypescheme update-issue-type-scheme
```
— 更新问题类型方案。权限要求： 管理Jira [global...

issuetypescreenscheme — 管理问题类型屏幕方案

```
jira-pp-cli issuetypescreenscheme assign-issue-type-screen-scheme-to-project
```
— 将问题类型屏幕方案分配给项目。问题类型屏幕方案仅可分配给经典...
```
jira-pp-cli issuetypescreenscheme create-issue-type-screen-scheme
```
— 创建问题类型屏幕方案。权限要求： 管理Jira [global...
```
jira-pp-cli issuetypescreenscheme delete-issue-type-screen-scheme
```
— 删除问题类型屏幕方案。权限要求： 管理Jira [global...
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-mappings
```
— 返回问题类型屏幕方案项的分页列表。仅包含...中使用的问题类型屏幕方案
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-scheme-project-associations
```
— 返回问题类型屏幕方案的分页列表，以及每个问题类型屏幕方案对应的...列表
```
jira-pp-cli issuetypescreenscheme get-issue-type-screen-schemes
```
— 返回问题类型屏幕方案的分页列表。仅包含经典项目中使用的问题类型屏幕方案...
```
jira-pp-cli issuetypescreenscheme update-issue-type-screen-scheme
```
— 更新问题类型屏幕方案。权限要求： 管理Jira [global...

jira-search — 管理Jira Cloud Platform搜索

```
jira-pp-cli jira-search and-reconsile-issues-using-jql
```
— 使用JQL搜索问题。最近的更新可能不会立即...
```
jira-pp-cli jira-search and-reconsile-issues-using-jql-post
```
— 使用JQL搜索问题。最近的更新可能不会立即...
```
jira-pp-cli jira-search count-issues
```
— 提供与JQL匹配的问题估计数量。最近...
```
jira-pp-cli jira-search for-issues-using-jql
```
— 该端点目前正在移除中。更多详情搜索...
```
jira-pp-cli jira-search for-issues-using-jql-post
```
— 该端点目前正在移除中。更多详情搜索...

jira-version — 管理Jira Cloud Platform版本

```
jira-pp-cli jira-version create
```
— 创建项目版本。此操作可匿名访问。权限要求：...
```
jira-pp-cli jira-version delete
```
— 删除项目版本。已弃用，请使用[删除并替换...
```
jira-pp-cli jira-version get
```
— 返回项目版本。此操作可匿名访问。权限要求：...
```
jira-pp-cli jira-version update
```
— 更新项目版本。此操作可匿名访问。权限要求：...

jira-workflow — 管理Jira Cloud Platform工作流

jira-pp-cli jira-workflow create-transition-property

— 此功能将于2026年6月1日移除；...

```
jira-pp-cli jira-workflow delete-inactive
```
— 删除工作流。如果工作流属于以下情况，则无法删除：* 活动工作流。* 系统工作流。* 关联...

jira-pp-cli jira-workflow delete-transition-property

— 此功能将于2026年6月1日移除；...

```
jira-pp-cli jira-workflow delete-transition-rule-configurations
```
— 从一个或多个工作流中删除工作流转换规则。支持以下规则类型：* [post...
```
jira-pp-cli jira-workflow get-paginated
```
— 此功能将于2026年6月1日移除；...

jira-pp-cli jira-workflow get-transition-properties

— 此功能将于2026年6月1日移除；...

```
jira-pp-cli jira-workflow get-transition-rule-configurations
```
— 返回带有转换规则的工作流分页列表。可过滤工作流以返回...
```
jira-pp-cli jira-workflow list-history
```
— 返回指定工作流ID的工作流历史条目列表。注意： 存储的工作流数据在...后过期
```
jira-pp-cli jira-workflow read-from-history
```
— 返回指定工作流ID和版本号的工作流及相关状态。注意： 存储的工作流...

jira-pp-cli jira-workflow update-transition-property

— 此功能将于2026年6月1日移除；...

```
jira-pp-cli jira-workflow update-transition-rule-configurations
```
— 更新工作流转换规则的配置。支持以下规则类型：* [post...

jql — 该资源代表JQL搜索自动完成详细信息。用于获取JQL搜索自动完成数据和建议，以用于程序化构建查询或自定义查询生成器。还提供以下操作：

将一个或多个包含用户标识符（用户名或用户密钥）的JQL查询转换为包含账户ID的等效JQL查询。
将一个或多个JQL查询中的可读详细信息转换为ID（当用户无权查看可读详细信息对应的实体时）。

```
jira-pp-cli jql get-auto-complete
```
— 返回JQL搜索的参考数据。这是[高级...中提供的文档的可下载版本
```
jira-pp-cli jql get-auto-complete-post
```
— 返回JQL搜索的参考数据。这是[高级...中提供的文档的可下载版本
```
jira-pp-cli jql get-field-auto-complete-for-query-string
```
— 返回字段的JQL搜索自动完成建议。可通过提供以下内容获取建议：*...
```
jira-pp-cli jql get-precomputations
```
— 返回函数的预计算列表，以及它们的创建时间、更新时间和...信息
```
jira-pp-cli jql get-precomputations-by-id
```
— 通过ID返回函数预计算，以及它们的创建时间、更新时间和最后...信息
```
jira-pp-cli jql match-issues
```
— 检查一个或多个问题是否会被一个或多个JQL查询返回。**权限...
```
jira-pp-cli jql migrate-queries
```
— 将一个或多个包含用户标识符（用户名或用户密钥）的JQL查询转换为包含账户...的等效JQL查询
```
jira-pp-cli jql parse-queries
```
— 解析并验证JQL查询。验证在当前用户的上下文中执行。此操作可以...
```
jira-pp-cli jql sanitise-queries
```
— 通过将可读详细信息转换为ID（当用户无权查看...时）来清理一个或多个JQL查询
```
jira-pp-cli jql update-precomputations
```
— 更新Forge/Connect应用创建的函数的预计算值。**权限...

label — 该资源代表可用标签。用于获取全局标签字段的可用标签。

```
jira-pp-cli label
```
— 返回标签的分页列表。

license — 管理许可

```
jira-pp-cli license get-approximate-application-count
```
— 返回单个Jira许可的用户账户近似总数。注意，此信息是...
```
jira-pp-cli license get-approximate-count
```
— 返回所有Jira许可的用户账户近似数量。注意，此信息会被缓存...

mypermissions — 管理我的权限

```
jira-pp-cli mypermissions
```
— 返回权限列表，指示用户拥有哪些权限。用户权限的详细信息可以...

mypreferences — 管理我的偏好设置

```
jira-pp-cli mypreferences get-locale
```
— 返回用户的区域设置。如果用户未设置语言偏好（默认设置）或此...
```
jira-pp-cli mypreferences get-preference
```
— 返回当前用户的偏好值。注意，以下密钥已弃用：* jira.user.locale...
```
jira-pp-cli mypreferences remove-preference
```
— 删除用户的偏好，恢复系统定义设置的默认值。注意，以下密钥...
```
jira-pp-cli mypreferences set-locale
```
— 已弃用，请使用[更新用户资料](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-...
```
jira-pp-cli mypreferences set-preference
```
— 为用户创建偏好或通过发送纯文本字符串更新偏好值。例如，...

myself — 该资源代表当前用户的信息，如基本详情、组成员身份、应用角色、偏好设置和区域设置。用于获取、创建、更新和删除（恢复默认）用户的偏好设置和区域设置值。

```
jira-pp-cli myself
```
— 返回当前用户的详细信息。权限要求： 访问Jira的权限。

notificationscheme — 管理通知方案

```
jira-pp-cli notificationscheme create-notification-scheme
```
— 创建带有通知的通知方案。单次请求最多可创建1000个通知....
```
jira-pp-cli notificationscheme delete-notification-scheme
```
— 删除通知方案。权限要求： 管理Jira [global...

jira-pp-cli notificationscheme get-notification-scheme

— 返回通知方案，包括事件列表和...

```
jira-pp-cli notificationscheme get-notification-scheme-to-project-mappings
```
— 返回分配了通知方案的项目映射分页列表。您可以提供一个...

jira-pp-cli notificationscheme get-notification-schemes

— 返回通知方案的分页列表，按...排序

```
jira-pp-cli notificationscheme update-notification-scheme
```
— 更新通知方案。权限要求： 管理Jira [global...

permissions — 该资源代表权限。用于获取所有权限的详细信息并确定用户是否拥有某些权限。

```
jira-pp-cli permissions get-all
```
— 返回所有权限，包括：* 全局权限。* 项目权限。* 由...添加的全局权限
```
jira-pp-cli permissions get-bulk
```
— 返回：* 对于一组全局权限，授予用户的全局权限。* 对于一组项目...
```
jira-pp-cli permissions get-permitted-projects
```
— 返回用户被授予一组项目权限的所有项目。此操作可以...

permissionscheme — 管理权限方案

```
jira-pp-cli permissionscheme create-permission-scheme
```
— 创建新的权限方案。您可以创建带有或不带有一组权限...的权限方案
```
jira-pp-cli permissionscheme delete-permission-scheme
```
— 删除权限方案。权限要求： 管理Jira [global...
```
jira-pp-cli permissionscheme get-all-permission-schemes
```
— 返回所有权限方案。### 关于权限方案和授权 ### 权限方案是一组...
```
jira-pp-cli permissionscheme get-permission-scheme
```
— 返回权限方案。权限要求： 访问Jira的权限。
```
jira-pp-cli permissionscheme update-permission-scheme
```
— 更新权限方案。使用此资源时请注意以下重要事项：* 如果权限...

plans — 该资源代表计划。用于获取、创建、复制、更新、删除和归档计划。

```
jira-pp-cli plans add-atlassian-team
```
— 将现有Atlassian团队添加到计划中并配置其规划设置。**权限...
```
jira-pp-cli plans archive
```
— 归档计划。权限要求： 管理Jira [global...
```
jira-pp-cli plans create
```
— 创建计划。权限要求： 管理Jira [global...
```
jira-pp-cli plans create-only-team
```
— 创建仅计划团队并配置其规划设置。权限要求：...
```
jira-pp-cli plans delete-only-team
```
— 删除仅计划团队及其规划设置。权限要求： 管理Jira...
```
jira-pp-cli plans duplicate
```
— 复制计划。权限要求： 管理Jira [global...
```
jira-pp-cli plans get
```
— 返回计划的分页列表。权限要求： 管理Jira...
```
jira-pp-cli plans get-atlassian-team
```
— 返回计划中Atlassian团队的规划设置。权限要求： *管理...
```
jira-pp-cli plans get-only-team
```
— 返回仅计划团队的规划设置。权限要求： 管理Jira [global...
```
jira-pp-cli plans get-plan
```
— 返回单个计划。权限要求： 管理Jira [global...
```
jira-pp-cli plans get-teams
```
— 返回计划中仅计划团队和Atlassian团队的分页列表。**权限...
```
jira-pp-cli plans remove-atlassian-team
```
— 从计划中移除Atlassian团队并删除其规划设置。权限要求：...
```
jira-pp-cli plans trash
```
— 将计划移至回收站。权限要求： 管理Jira [global...
```
jira-pp-cli plans update
```
— 使用JSON Patch更新计划的以下任何详细信息：*...
```
jira-pp-cli plans update-atlassian-team
```
— 使用[JSON...更新计划中Atlassian团队的以下任何规划设置
```
jira-pp-cli plans update-only-team
```
— 使用[JSON...更新仅计划团队的以下任何规划设置

priority — 管理优先级

```
jira-pp-cli priority create
```
— 创建问题优先级。请求体中的iconUrl参数已弃用，将于3月16日停止使用...
```
jira-pp-cli priority delete
```
— 删除问题优先级。此操作是异步的。请按照响应中的
```
location
```
链接...
```
jira-pp-cli priority get
```
— 返回单个问题优先级。权限要求： 访问Jira的权限。
```
jira-pp-cli priority get-priorities
```
— 返回所有问题优先级的列表。权限要求： 访问Jira的权限。
```
jira-pp-cli priority move-priorities
```
— 更改问题优先级的顺序。权限要求： 管理Jira [global...
```
jira-pp-cli priority search-priorities
```
— 返回优先级的分页列表。列表可包含所有优先级或由...确定的子集
```
jira-pp-cli priority set-default
```
— 设置默认问题优先级。权限要求： 管理Jira [global...
```
jira-pp-cli priority update
```
— 更新问题优先级。请求体中至少必须定义一个参数。iconUrl参数已弃用...

priorityscheme — 管理优先级方案

```
jira-pp-cli priorityscheme create-priority-scheme
```
— 创建新的优先级方案。权限要求： 管理Jira [global...
```
jira-pp-cli priorityscheme delete-priority-scheme
```
— 删除优先级方案。此操作仅适用于未关联任何项目的优先级方案....

jira-pp-cli priorityscheme get-available-priorities-by-priority-scheme

— 返回可添加到优先级方案的优先级分页列表....

```
jira-pp-cli priorityscheme get-priority-schemes
```
— 返回优先级方案的分页列表。权限要求： 访问...的权限
```
jira-pp-cli priorityscheme suggested-priorities-for-mappings
```
— 返回在优先级或...变更时需要映射的优先级分页列表
```
jira-pp-cli priorityscheme update-priority-scheme
```
— 更新优先级方案。包括其详细信息、方案中的优先级和项目列表...

project — 该资源代表项目。用于获取、创建、更新和删除项目，还可获取项目可用的状态、项目的通知方案以及更新项目类型。

```
jira-pp-cli project create
```
— 基于项目类型模板创建项目，如下表所示：| 项目类型密钥 | 项目...
```
jira-pp-cli project delete
```
— 删除项目。无法删除已归档的项目。要删除已归档的项目，请先恢复项目...
```
jira-pp-cli project get
```
— 返回项目的详细信息。此操作可以...
```
jira-pp-cli project get-accessible-type-by-key
```
— 如果用户可访问，则返回项目类型....
```
jira-pp-cli project get-all
```
— 返回用户可见的所有项目。已弃用，请使用[获取项目...
```
jira-pp-cli project get-all-accessible-types
```
— 返回所有具有有效许可的项目类型。
```
jira-pp-cli project get-all-types
```
— 返回所有项目类型，无论实例是否具有有效...
```
jira-pp-cli project get-recent
```
— 返回用户最近查看的最多20个仍可见的项目列表。此操作...
```
jira-pp-cli project get-type-by-key
```
— 返回项目类型。此操作可匿名访问....
```
jira-pp-cli project search
```
— 返回用户可见的项目分页列表。此操作可匿名访问....
```
jira-pp-cli project update
```
— 更新项目的详细信息。所有参数都是可选的...

project-category — 管理项目分类

```
jira-pp-cli project-category create
```
— 创建项目分类。权限要求： 管理Jira [global...
```
jira-pp-cli project-category get-all-project-categories
```
— 返回所有项目分类。权限要求： 访问Jira的权限。
```
jira-pp-cli project-category get-by-id
```
— 返回单个项目分类。权限要求： 访问Jira的权限。
```
jira-pp-cli project-category remove
```
— 删除项目分类。权限要求： 管理Jira [global...
```
jira-pp-cli project-category update
```
— 更新项目分类。权限要求： 管理Jira [global...

project-template — 该资源代表项目模板。用于从自定义模板创建新项目。

```
jira-pp-cli project-template create-project-with-custom-template
```
— 基于请求中提供的自定义模板创建项目。请求体应包含项目...
```
jira-pp-cli project-template edit-template
```
— 编辑自定义模板此API端点允许您编辑现有的自定义模板。***注意：自定义模板...
```
jira-pp-cli project-template live-template
```
— 获取自定义模板此API端点允许您通过templateKey获取实时自定义项目模板的详细信息...
```
jira-pp-cli project-template remove-template
```
— 删除自定义模板此API端点允许您删除指定的自定义模板 ***注意：自定义...
```
jira-pp-cli project-template save-template
```
— 保存自定义模板此API端点允许您保存自定义模板 ***注意：自定义模板仅...

projects — 该资源代表项目。用于获取、创建、更新和删除项目，还可获取项目可用的状态、项目的通知方案以及更新项目类型。

```
jira-pp-cli projects
```
— 返回请求项目和工作类型的字段分页列表。仅包含...的字段

projectvalidate — 管理项目验证

```
jira-pp-cli projectvalidate get-valid-project-key
```
— 验证项目密钥，如果密钥无效或已被使用，则生成一个有效的随机字符串作为项目密钥....
```
jira-pp-cli projectvalidate get-valid-project-name
```
— 检查项目名称是否已被使用。如果名称未被使用，则返回传入的字符串。如果名称已被...
```
jira-pp-cli projectvalidate validate-project-key
```
— 通过确认密钥是有效字符串且未被使用来验证项目密钥。**权限...

redact — 管理脱敏

```
jira-pp-cli redact get-redaction-status
```
— 检索脱敏作业ID的当前状态。作业状态将是以下之一：* IN_PROGRESS - 正在...
```
jira-pp-cli redact redact
```
— 提交作业以脱敏问题字段数据。这将触发指定字段中数据的脱敏...

resolution — 管理解决状态

```
jira-pp-cli resolution create
```
— 创建问题解决状态。权限要求： 管理Jira [global...
```
jira-pp-cli resolution delete
```
— 删除问题解决状态。此操作是异步的。请按照响应中的
```
location
```
链接...
```
jira-pp-cli resolution get
```
— 返回所有问题解决状态值的列表。权限要求： 访问Jira的权限。
```
jira-pp-cli resolution get-id
```
— 返回单个问题解决状态值。权限要求： 访问Jira的权限。
```
jira-pp-cli resolution move
```
— 更改问题解决状态的顺序。权限要求： 管理Jira [global...
```
jira-pp-cli resolution search
```
— 返回解决状态的分页列表。列表可包含所有解决状态或由...确定的子集
```
jira-pp-cli resolution set-default
```
— 设置默认问题解决状态。权限要求： 管理Jira [global...
```
jira-pp-cli resolution update
```
— 更新问题解决状态。权限要求： 管理Jira [global...

role — 管理角色

```
jira-pp-cli role create-project
```
— 创建新的项目角色，无默认参与者。您可以使用[添加默认...
```
jira-pp-cli role delete-project
```
— 删除项目角色。如果要删除正在使用的项目角色，必须指定替换项目角色...
```
jira-pp-cli role fully-update-project
```
— 更新项目角色的名称和描述。请求中必须同时包含名称和描述....
```
jira-pp-cli role get-all-project
```
— 获取所有项目角色的列表，包含项目角色详细信息和默认参与者。### 关于项目角色 ###...
```
jira-pp-cli role get-project-by-id
```
— 获取项目角色详细信息和与该角色关联的默认参与者。默认参与者列表按...排序
```
jira-pp-cli role partial-update-project
```
— 更新项目角色的名称或描述。您不能同时更新名称和描述...

screens — 该资源代表用于记录问题详细信息的屏幕。用于：

获取所有屏幕的详细信息。
获取可在屏幕上使用的所有字段的详细信息。
创建屏幕。
删除屏幕。
更新屏幕。
将字段添加到默认屏幕。

```
jira-pp-cli screens add-field-to-default
```
— 将字段添加到默认屏幕的默认选项卡。权限要求： 管理Jira...
```
jira-pp-cli screens create
```
— 创建带有默认字段选项卡的屏幕。权限要求： 管理Jira [global...
```
jira-pp-cli screens delete
```
— 删除屏幕。如果屏幕用于屏幕方案、工作流或工作流草稿，则无法删除。仅...
```
jira-pp-cli screens get
```
— 返回所有屏幕或由一个或多个屏幕ID指定的屏幕的分页列表....
```
jira-pp-cli screens get-bulk-tabs
```
— 返回多个屏幕的选项卡列表。权限要求： * 管理Jira...
```
jira-pp-cli screens update
```
— 更新屏幕。仅经典项目中使用的屏幕可更新。权限要求：...

screenscheme — 管理屏幕方案

```
jira-pp-cli screenscheme create-screen-scheme
```
— 创建屏幕方案。权限要求： 管理Jira [global...
```
jira-pp-cli screenscheme delete-screen-scheme
```
— 删除屏幕方案。如果屏幕方案用于问题类型屏幕方案，则无法删除。仅...
```
jira-pp-cli screenscheme get-screen-schemes
```
— 返回屏幕方案的分页列表。仅包含经典项目中使用的屏幕方案...
```
jira-pp-cli screenscheme update-screen-scheme
```
— 更新屏幕方案。仅经典项目中使用的屏幕方案可更新。**权限...

securitylevel — 管理安全级别

```
jira-pp-cli securitylevel <id>
```
— 返回问题安全级别的详细信息。使用[获取问题安全...

server-info — 该资源提供Jira实例的信息。

```
jira-pp-cli server-info
```
— 返回Jira实例的信息。此操作可匿名访问....

settings — 管理设置

```
jira-pp-cli settings get-issue-navigator-default-columns
```
— 返回问题导航器的默认列。权限要求： 管理Jira [global...
```
jira-pp-cli settings set-issue-navigator-default-columns
```
— 设置问题导航器的默认列。
```
columns
```
参数接受可导航字段值，格式为...

status — 该资源代表状态。用于搜索、获取、创建、删除和更改状态。

```
jira-pp-cli status get
```
— 返回单个状态。状态必须与活动工作流关联才能被返回。如果多个...使用相同名称
```
jira-pp-cli status get-statuses
```
— 返回与活动工作流关联的所有状态的列表。此操作可匿名访问....

statuscategory — 管理状态分类

```
jira-pp-cli statuscategory get-status-categories
```
— 返回所有状态分类的列表。权限要求： 访问Jira的权限。
```
jira-pp-cli statuscategory get-status-category
```
— 返回单个状态分类。状态分类提供了一种对...进行分类的机制

statuses — 管理状态

```
jira-pp-cli statuses create
```
— 为全局或项目范围创建状态。权限要求： * 管理项目...
```
jira-pp-cli statuses delete-by-id
```
— 通过ID删除状态。权限要求： * 管理项目 [project...
```
jira-pp-cli statuses get-by-id
```
— 返回由一个或多个状态ID指定的状态列表。权限要求： *...
```
jira-pp-cli statuses get-by-name
```
— 返回由一个或多个状态名称指定的状态列表。权限要求： *...
```
jira-pp-cli statuses search
```
— 返回状态的分页列表...
```
jira-pp-cli statuses update
```
— 通过ID更新状态。权限要求： * 管理项目 [project...

task — 该资源代表长时间运行的异步任务。用于获取长时间运行任务的进度详细信息或取消长时间运行任务。

```
jira-pp-cli task <taskId>
```
— 返回长时间运行的异步任务的状态。任务完成后，此操作返回...

ui-modifications — 管理UI修改

```
jira-pp-cli ui-modifications create
```
— 创建UI修改。UI修改仅可由Forge应用创建。每个应用最多可定义3000个UI...
```
jira-pp-cli ui-modifications delete
```
— 删除UI修改。属于该UI修改的所有上下文也会被删除。UI修改可...
```
jira-pp-cli ui-modifications get
```
— 获取UI修改。UI修改仅可由Forge应用检索。**权限...
```
jira-pp-cli ui-modifications update
```
— 更新UI修改。UI修改仅可由Forge应用更新。每个UI修改最多可定义...

universal-avatar — 管理通用头像

```
jira-pp-cli universal-avatar delete-avatar
```
— 从项目、问题类型或优先级中删除头像。权限要求： *管理...
```
jira-pp-cli universal-avatar get-avatar-image-by-id
```
— 通过ID返回项目、问题类型或优先级的头像图片。此操作可匿名访问....
```
jira-pp-cli universal-avatar get-avatar-image-by-owner
```
— 返回项目、问题类型或优先级的头像图片。此操作可匿名访问....
```
jira-pp-cli universal-avatar get-avatar-image-by-type
```
— 返回项目、问题类型或优先级的默认头像图片。此操作可匿名访问....
```
jira-pp-cli universal-avatar get-avatars
```
— 返回项目、问题类型或优先级的系统和自定义头像。此操作可以...
```
jira-pp-cli universal-avatar store-avatar
```
— 为项目、问题类型或优先级加载自定义头像。在请求体中指定头像的本地文件位置...

user — 该资源代表用户。用于：

获取、获取列表、创建和删除用户。
获取、设置和重置用户的默认问题表格列。
获取用户所属的组列表。
获取用户名或用户密钥列表对应的用户账户ID列表。

```
jira-pp-cli user bulk-get
```
— 返回由一个或多个账户ID指定的用户分页列表....
```
jira-pp-cli user bulk-get-migration
```
— 返回
```
key
```
或
```
username
```
参数中指定用户的账户ID。注意，多个
```
key
```
或...
```
jira-pp-cli user create
```
— 创建用户。此资源仅为向后兼容保留。一旦有更合适的替代方案...
```
jira-pp-cli user delete-property
```
— 删除用户的属性。注意：此操作不访问[用户...
```
jira-pp-cli user find
```
— 返回与搜索字符串和属性匹配的活跃用户列表。此操作首先应用过滤器...
```
jira-pp-cli user find-assignable
```
— 返回可分配给问题的用户列表。使用此操作查找可...的用户列表
```
jira-pp-cli user find-bulk-assignable
```
— 返回可在一个或多个项目中分配问题的用户列表。列表可能仅限于...用户
```
jira-pp-cli user find-by-query
```
— 使用结构化查询查找用户并返回用户详细信息的分页列表。此操作...
```
jira-pp-cli user find-for-picker
```
— 返回属性与查询词匹配的用户列表。返回的对象包含
```
html
```
字段，其中...
```
jira-pp-cli user find-keys-by-query
```
— 使用结构化查询查找用户并返回用户密钥的分页列表。此操作需要...
```
jira-pp-cli user find-with-all-permissions
```
— 返回满足以下条件的用户列表：* 用户属性与搜索字符串匹配。* 他们拥有一组...
```
jira-pp-cli user find-with-browse-permission
```
— 返回满足以下条件的用户列表：* 用户属性与搜索字符串匹配。* 他们拥有...
```
jira-pp-cli user get
```
— 返回单个用户。根据用户的偏好设置对响应应用隐私控制。这可能意味着，对于...
```
jira-pp-cli user get-default-columns
```
— 返回用户的默认问题表格列。如果
```
accountId
```
是...
```
jira-pp-cli user get-email
```
— 返回用户的电子邮件地址，无论用户的资料可见性设置如何。对于Connect应用，此API是...
```
jira-pp-cli user get-email-bulk
```
— 返回用户的电子邮件地址，无论用户的资料可见性设置如何。对于Connect应用，此API是...
```
jira-pp-cli user get-groups
```
— 返回用户所属的组。权限要求： 浏览用户和组...
```
jira-pp-cli user get-property
```
— 返回用户属性的值。如果未提供属性密钥，请[获取用户属性...
```
jira-pp-cli user get-property-keys
```
— 返回用户的所有属性密钥。注意：此操作不访问[用户...
```
jira-pp-cli user remove
```
— 删除用户。如果操作成功完成，则用户将从Jira的用户库中移除。此...
```
jira-pp-cli user reset-columns
```
— 将用户的默认问题表格列重置为系统...
```
jira-pp-cli user set-columns
```
— 设置用户的默认问题表格列。如果指定了账户ID...
```
jira-pp-cli user set-property
```
— 设置用户属性的值。使用此资源存储用户的自定义数据。注意：此操作...

users — 该资源代表用户。用于：

获取、获取列表、创建和删除用户。
获取、设置和重置用户的默认问题表格列。
获取用户所属的组列表。
获取用户名或用户密钥列表对应的用户账户ID列表。

```
jira-pp-cli users get-all
```
— 返回所有用户的列表，包括活跃用户、非活跃用户和已删除但仍有...的用户
```
jira-pp-cli users get-all-default
```
— 返回所有用户的列表，包括活跃用户、非活跃用户和已删除但仍有...的用户

webhook — 该资源代表Webhook。Webhook是当Jira中发生与JQL查询指定的问题相关的事件时发送到URL的调用。仅Connect和OAuth 2.0应用可注册和管理Webhook。更多信息，请参阅Webhook。

```
jira-pp-cli webhook delete-by-id
```
— 通过ID删除Webhook。仅删除调用应用注册的Webhook。如果其他应用创建的Webhook...
```
jira-pp-cli webhook get-dynamic-for-app
```
— 返回调用应用注册的Webhook分页列表。**权限...
```
jira-pp-cli webhook get-failed
```
— 返回最近在达到最大重试次数后仍无法传递给请求应用的Webhook...
```
jira-pp-cli webhook refresh
```
— 延长Webhook的有效期。通过REST API注册的Webhook有效期为30天。调用此操作以...
```
jira-pp-cli webhook register-dynamic
```
— 注册Webhook。注意： 对于非公开OAuth应用，仅当...匹配时才会传递Webhook

workflows — 该资源代表工作流。用于：

获取工作流
创建工作流
更新工作流
删除非活动工作流
获取工作流功能

```
jira-pp-cli workflows capabilities
```
— 使用工作流ID或项目和问题...获取特定工作流的工作流功能列表
```
jira-pp-cli workflows create
```
— 创建工作流及相关状态。权限要求： * 管理Jira project...
```
jira-pp-cli workflows get-default-editor
```
— 获取用户的默认工作流编辑器。可以是新编辑器或旧编辑器。
```
jira-pp-cli workflows read
```
— 通过提供工作流名称、工作流ID或项目和问题...返回工作流及相关状态的列表
```
jira-pp-cli workflows read-previews
```
— 返回指定项目中的请求工作流。响应提供工作流的只读预览，...
```
jira-pp-cli workflows search
```
— 返回全局和项目工作流的分页列表。如果在...中指定了工作流名称
```
jira-pp-cli workflows update
```
— 更新工作流及相关状态。权限要求： * 管理Jira project...
```
jira-pp-cli workflows validate-create
```
— 验证批量创建工作流的请求体。权限要求： * 管理Jira...
```
jira-pp-cli workflows validate-update
```
— 验证批量更新工作流的请求体。权限要求： * 管理Jira...

workflowscheme — 管理工作流方案

```
jira-pp-cli workflowscheme assign-scheme-to-project
```
— 将工作流方案分配给项目。仅当项目中没有问题时才执行此操作....
```
jira-pp-cli workflowscheme create-workflow-scheme
```
— 创建工作流方案。权限要求： 管理Jira [global...
```
jira-pp-cli workflowscheme delete-workflow-scheme
```
— 删除工作流方案。注意，如果工作流方案处于活动状态（即至少有一个...在使用），则无法删除
```
jira-pp-cli workflowscheme get-all-workflow-schemes
```
— 返回所有工作流方案的分页列表，不包括草稿工作流方案....
```
jira-pp-cli workflowscheme get-required-workflow-scheme-mappings
```
— 获取工作流方案所需变更的状态映射。结果按问题...提供
```
jira-pp-cli workflowscheme get-workflow-scheme
```
— 返回工作流方案。权限要求： 管理Jira [global...
```
jira-pp-cli workflowscheme get-workflow-scheme-project-associations
```
— 返回与一组项目关联的工作流方案列表。每个返回的工作流方案包含一个...
```
jira-pp-cli workflowscheme read-workflow-schemes
```
— 通过提供工作流方案ID或项目ID返回工作流方案列表。**权限...
```
jira-pp-cli workflowscheme switch-workflow-scheme-for-project
```
— 为项目切换工作流方案。工作流方案仅可分配给经典项目。**计算...
```
jira-pp-cli workflowscheme update-schemes
```
— 更新公司管理和团队管理项目的工作流方案。此API没有草稿概念，因此任何...
```
jira-pp-cli workflowscheme update-workflow-scheme
```
— 更新公司管理项目的工作流方案，包括名称、默认工作流、问题类型到项目...

worklog — 管理工作日志

```
jira-pp-cli worklog get-for-ids
```
— 返回工作日志ID列表对应的工作日志详细信息。返回的工作日志列表最多包含1000个条目....
```
jira-pp-cli worklog get-ids-of-deleted-since
```
— 返回指定日期和时间后删除的工作日志ID和删除时间戳列表。此资源是分页的，...
```
jira-pp-cli worklog get-ids-of-modified-since
```
— 返回指定日期和时间后更新的工作日志ID和更新时间戳列表。此资源是分页的，...

Finding the right command

查找正确的命令

When you know what you want to do but not which command does it, ask the CLI directly:

bash

jira-pp-cli which "<capability in your own words>"

which

resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code

means at least one match; exit code

means no confident match — fall back to

--help

or use a narrower query.

当您知道要执行的操作但不知道对应的命令时，可以直接询问CLI：

bash

jira-pp-cli which "<用您自己的语言描述功能>"

which

命令会将自然语言功能查询解析为该CLI精选功能索引中最匹配的命令。退出代码

表示至少有一个匹配项；退出代码

表示没有确定的匹配项 — 请改用

--help

或使用更精确的查询。

Auth Setup

身份验证设置

Run

jira-pp-cli auth setup

for the URL and steps to obtain a token (add

--launch

to open the URL). Then store it:

bash

jira-pp-cli auth set-token YOUR_TOKEN_HERE

Or set

JIRA_OAUTH2

as an environment variable.

Run

jira-pp-cli doctor

to verify setup.

运行

jira-pp-cli auth setup

获取获取令牌的URL和步骤（添加

--launch

以打开URL）。然后存储令牌：

bash

jira-pp-cli auth set-token YOUR_TOKEN_HERE

或者将

JIRA_OAUTH2

设置为环境变量。

运行

jira-pp-cli doctor

验证设置。

Agent Mode

代理模式

Add

--agent

to any command. Expands to:

--json --compact --no-input --no-color --yes

Pipeable — JSON on stdout, errors on stderr
Filterable —
```
--select
```
keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
bash
```
jira-pp-cli attachment get mock-value --agent --select id,name,status
```
Previewable —
```
--dry-run
```
shows the request without sending
Offline-friendly — sync/search commands can use the local SQLite store when available
Non-interactive — never prompts, every input is a flag
Explicit retries — use
```
--idempotent
```
only when an already-existing create should count as success, and
```
--ignore-missing
```
only when a missing delete target should count as success

在任何命令后添加

--agent

。等效于：

--json --compact --no-input --no-color --yes

。

可管道化 — 标准输出为JSON，错误输出到标准错误
可过滤 —
```
--select
```
保留字段子集。点路径可深入嵌套结构；数组可遍历元素。对于冗长的API，这对于保持上下文简洁至关重要：
bash
```
jira-pp-cli attachment get mock-value --agent --select id,name,status
```
可预览 —
```
--dry-run
```
显示请求但不发送
离线友好 — 同步/搜索命令在可用时可使用本地SQLite存储
非交互式 — 从不提示，所有输入均为标志
显式重试 — 仅当已存在的创建操作应视为成功时使用
```
--idempotent
```
，仅当缺失的删除目标应视为成功时使用
```
--ignore-missing
```

Response envelope

响应信封

Commands that read from the local store or the API wrap output in a provenance envelope:

json

{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}

Parse

.results

for data and

.meta.source

to know whether it's live or local. A human-readable

N results (live)

summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.

从本地存储或API读取数据的命令会将输出包装在来源信封中：

json

{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}

解析

.results

获取数据，

.meta.source

可了解数据是实时的还是本地的。仅当标准输出为终端时，才会将人类可读的

N results (live)

摘要打印到标准错误 — 管道/代理使用者仅会在标准输出获取纯JSON。

Agent Feedback

代理反馈

When you (or the agent) notice something off about this CLI, record it:

jira-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
jira-pp-cli feedback --stdin < notes.txt
jira-pp-cli feedback list --json --limit 10

Entries are stored locally at

~/.jira-pp-cli/feedback.jsonl

. They are never POSTed unless

JIRA_FEEDBACK_ENDPOINT

is set AND either

--send

is passed or

JIRA_FEEDBACK_AUTO_SEND=true

. Default behavior is local-only.

Write what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.

当您（或代理）发现此CLI存在问题时，请记录：

jira-pp-cli feedback "--since标志是包含性的，但文档说是排他性的"
jira-pp-cli feedback --stdin < notes.txt
jira-pp-cli feedback list --json --limit 10

反馈条目存储在本地

~/.jira-pp-cli/feedback.jsonl

中。仅当设置了

JIRA_FEEDBACK_ENDPOINT

且传递了

--send

或

JIRA_FEEDBACK_AUTO_SEND=true

时，才会发送反馈。默认行为仅存储在本地。

请写下让您感到意外的内容，而不是错误报告。简短、具体、一行内容：这才是有价值的部分。

Output Delivery

输出交付

Every command accepts

--deliver <sink>

. The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:

Sink	Effect
`stdout`	Default; write to stdout only
`file:<path>`	Atomically write output to `<path>` (tmp + rename)
`webhook:<url>`	POST the output body to the URL ( `application/json` or `application/x-ndjson` when `--compact` )

Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.

每个命令都接受

--deliver <sink>

。输出会发送到指定的接收器，同时（或代替）发送到标准输出，因此代理无需手动管道即可路由命令结果。支持三种接收器：

接收器	效果
`stdout`	默认；仅写入标准输出
`file:<path>`	原子性地将输出写入 `<path>` （临时文件 + 重命名）
`webhook:<url>`	将输出体POST到URL（ `application/json` 或使用 `--compact` 时为 `application/x-ndjson` ）

未知的协议会被拒绝，并返回结构化错误，列出支持的协议集。Webhook失败时返回非零退出代码，并在标准错误中记录URL和HTTP状态。

Named Profiles

命名配置文件

A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.

jira-pp-cli profile save briefing --json
jira-pp-cli --profile briefing attachment get mock-value
jira-pp-cli profile list --json
jira-pp-cli profile show briefing
jira-pp-cli profile delete briefing --yes

Explicit flags always win over profile values; profile values win over defaults.

agent-context

lists all available profiles under

available_profiles

so introspecting agents discover them at runtime.

配置文件是一组保存的标志值，可在多次调用中重复使用。当调度代理每次运行都使用相同配置调用相同命令时，可使用此功能 — 即HeyGen的“Beacon”模式。

jira-pp-cli profile save briefing --json
jira-pp-cli --profile briefing attachment get mock-value
jira-pp-cli profile list --json
jira-pp-cli profile show briefing
jira-pp-cli profile delete briefing --yes

显式标志始终优先于配置文件值；配置文件值优先于默认值。

agent-context

会在

available_profiles

下列出所有可用配置文件，以便内省代理在运行时发现它们。

Async Jobs

异步作业

For endpoints that submit long-running work, the generator detects the submit-then-poll pattern (a

job_id

task_id

operation_id

field in the response plus a sibling status endpoint) and wires up three extra flags on the submitting command:

Flag	Purpose
`--wait`	Block until the job reaches a terminal status instead of returning the job ID immediately
`--wait-timeout`	Maximum wait duration (default 10m, 0 means no timeout)
`--wait-interval`	Initial poll interval (default 2s; grows with exponential backoff up to 30s)

Use async submission without

--wait

when you want to fire-and-forget; use

--wait

when you want one command to return the finished artifact.

对于提交长时间运行任务的端点，生成器会检测提交-轮询模式（响应中的

job_id

task_id

operation_id

字段以及同级状态端点），并在提交命令上添加三个额外标志：

标志	用途
`--wait`	阻塞直到作业达到终端状态，而不是立即返回作业ID
`--wait-timeout`	最大等待时长（默认10分钟，0表示无超时）
`--wait-interval`	初始轮询间隔（默认2秒；指数退避最多增长到30秒）

当您想触发即忘时，使用不带

--wait

的异步提交；当您想让一个命令返回完成的结果时，使用

--wait

。

Exit Codes

退出代码

Code	Meaning
0	Success
2	Usage error (wrong arguments)
3	Resource not found
4	Authentication required
5	API error (upstream issue)
7	Rate limited (wait and retry)
10	Config error

代码	含义
0	成功
2	使用错误（参数错误）
3	资源未找到
4	需要身份验证
5	API错误（上游问题）
7	速率限制（等待并重试）
10	配置错误

Argument Parsing

参数解析

Parse

$ARGUMENTS

Empty,
help
, or
--help
→ show
```
jira-pp-cli --help
```
output
Starts with
install
→ ends with
```
mcp
```
→ MCP installation; otherwise → see Prerequisites above
Anything else → Direct Use (execute as CLI command with
```
--agent
```
)

解析

$ARGUMENTS

：

为空、
help
或
--help
→ 显示
```
jira-pp-cli --help
```
输出
以
install
开头 → 以
```
mcp
```
结尾 → MCP安装；否则 → 参见上方前提条件
其他情况 → 直接使用（使用
```
--agent
```
执行CLI命令）

MCP Server Installation

MCP服务器安装

Install the MCP binary from this CLI's published public-library entry or pre-built release, then register it:

bash

claude mcp add jira-pp-mcp -- jira-pp-mcp

Verify:

claude mcp list

从该CLI发布的公共库条目或预构建版本安装MCP二进制文件，然后注册：

bash

claude mcp add jira-pp-mcp -- jira-pp-mcp

验证：

claude mcp list

Direct Use

直接使用

Check if installed:
```
which jira-pp-cli
```
If not found, offer to install (see Prerequisites at the top of this skill).
Match the user query to the best command from the Unique Capabilities and Command Reference above.

Execute with the

--agent

flag:

bash

jira-pp-cli <command> [subcommand] [args] --agent

If ambiguous, drill into subcommand help:
```
jira-pp-cli <command> --help
```
.

检查是否已安装：
```
which jira-pp-cli
```
如果未找到，提供安装选项（请参阅本技能顶部的前提条件）。
将用户查询与上方“独特功能”和“命令参考”中最匹配的命令进行匹配。

使用

--agent

标志执行：

bash

jira-pp-cli <command> [subcommand] [args] --agent

如果存在歧义，查看子命令帮助：
```
jira-pp-cli <command> --help
```
。