> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# jira-issues
> Jira Issues - search, create, update, transition issues; manage comments, attachments, links, watchers, votes, worklogs, and saved filters
**Server path:** `/jira-issues` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| [`jira_issues_add_comment`](#jira_issues_add_comment) | Add comment |
| [`jira_issues_add_vote`](#jira_issues_add_vote) | Add vote |
| [`jira_issues_add_watcher`](#jira_issues_add_watcher) | Add watcher |
| [`jira_issues_add_worklog`](#jira_issues_add_worklog) | Add worklog |
| [`jira_issues_assign_issue`](#jira_issues_assign_issue) | Assign issue |
| [`jira_issues_bulk_fetch_issues`](#jira_issues_bulk_fetch_issues) | Bulk fetch issues |
| [`jira_issues_count_issues`](#jira_issues_count_issues) | Count issues using JQL |
| [`jira_issues_create_filter`](#jira_issues_create_filter) | Create filter |
| [`jira_issues_create_issue`](#jira_issues_create_issue) | Create issue |
| [`jira_issues_delete_comment`](#jira_issues_delete_comment) | Delete comment |
| [`jira_issues_delete_filter`](#jira_issues_delete_filter) | Delete filter |
| [`jira_issues_delete_issue`](#jira_issues_delete_issue) | Delete issue |
| [`jira_issues_delete_worklog`](#jira_issues_delete_worklog) | Delete worklog |
| [`jira_issues_do_transition`](#jira_issues_do_transition) | Transition issue |
| [`jira_issues_edit_issue`](#jira_issues_edit_issue) | Edit issue |
| [`jira_issues_get_all_labels`](#jira_issues_get_all_labels) | Get all labels |
| [`jira_issues_get_attachment`](#jira_issues_get_attachment) | Get attachment metadata |
| [`jira_issues_get_attachment_meta`](#jira_issues_get_attachment_meta) | Get Jira attachment settings |
| [`jira_issues_get_auto_complete_post`](#jira_issues_get_auto_complete_post) | Get field reference data (POST) |
| [`jira_issues_get_comment`](#jira_issues_get_comment) | Get comment |
| [`jira_issues_get_comments`](#jira_issues_get_comments) | Get comments |
| [`jira_issues_get_create_issue_meta_issue_type_id`](#jira_issues_get_create_issue_meta_issue_type_id) | Get create field metadata for a project and issue type id |
| [`jira_issues_get_create_issue_meta_issue_types`](#jira_issues_get_create_issue_meta_issue_types) | Get create metadata issue types for a project |
| [`jira_issues_get_edit_issue_meta`](#jira_issues_get_edit_issue_meta) | Get edit issue metadata |
| [`jira_issues_get_favourite_filters`](#jira_issues_get_favourite_filters) | Get favorite filters |
| [`jira_issues_get_filter`](#jira_issues_get_filter) | Get filter |
| [`jira_issues_get_filters_paginated`](#jira_issues_get_filters_paginated) | Search for filters |
| [`jira_issues_get_issue`](#jira_issues_get_issue) | Get issue |
| [`jira_issues_get_issue_link`](#jira_issues_get_issue_link) | Get issue link |
| [`jira_issues_get_issue_link_types`](#jira_issues_get_issue_link_types) | Get issue link types |
| [`jira_issues_get_issue_watchers`](#jira_issues_get_issue_watchers) | Get issue watchers |
| [`jira_issues_get_my_filters`](#jira_issues_get_my_filters) | Get my filters |
| [`jira_issues_get_transitions`](#jira_issues_get_transitions) | Get transitions |
| [`jira_issues_get_votes`](#jira_issues_get_votes) | Get votes |
| [`jira_issues_get_worklog`](#jira_issues_get_worklog) | Get worklog |
| [`jira_issues_link_issues`](#jira_issues_link_issues) | Create issue link |
| [`jira_issues_remove_vote`](#jira_issues_remove_vote) | Delete vote |
| [`jira_issues_remove_watcher`](#jira_issues_remove_watcher) | Delete watcher |
| [`jira_issues_search_and_reconsile_issues_using_jql_post`](#jira_issues_search_and_reconsile_issues_using_jql_post) | Search for issues using JQL enhanced search (POST) |
| [`jira_issues_update_comment`](#jira_issues_update_comment) | Update comment |
| [`jira_issues_update_filter`](#jira_issues_update_filter) | Update filter |
***
## jira\_issues\_add\_comment
Add comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `expand` | string | No | — | Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. |
| `author` | object | No | — | The ID of the user who created the comment. |
| `body` | object | No | — | The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). |
| `created` | string | No | — | The date and time at which the comment was created. |
| `id` | string | No | — | The ID of the comment. |
| `jsdAuthorCanSeeRequest` | boolean | No | — | Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature. |
| `jsdPublic` | boolean | No | — | Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation. |
| `properties` | object\[] | No | — | A list of comment properties. Optional on create and update. |
| `renderedBody` | string | No | — | The rendered version of the comment. |
| `self` | string | No | — | The URL of the comment. |
| `updateAuthor` | object | No | — | The ID of the user who updated the comment last. |
| `updated` | string | No | — | The date and time at which the comment was updated last. |
| `visibility` | object | No | — | The group or role to which this comment is visible. Optional on create and update. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML."
},
"author": {
"description": "The ID of the user who created the comment."
},
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
},
"created": {
"type": "string",
"description": "The date and time at which the comment was created."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"jsdAuthorCanSeeRequest": {
"type": "boolean",
"description": "Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature."
},
"jsdPublic": {
"type": "boolean",
"description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "A list of comment properties. Optional on create and update."
},
"renderedBody": {
"type": "string",
"description": "The rendered version of the comment."
},
"self": {
"type": "string",
"description": "The URL of the comment."
},
"updateAuthor": {
"description": "The ID of the user who updated the comment last."
},
"updated": {
"type": "string",
"description": "The date and time at which the comment was updated last."
},
"visibility": {
"description": "The group or role to which this comment is visible. Optional on create and update."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_add\_vote
Add vote
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_add\_watcher
Add watcher
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `body` | string | Yes | — | The account ID of the user. Note that username cannot be used due to privacy changes. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"body": {
"type": "string",
"description": "The account ID of the user. Note that username cannot be used due to privacy changes."
}
},
"required": [
"PCID",
"issueIdOrKey",
"body"
]
}
```
***
## jira\_issues\_add\_worklog
Add worklog
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key the issue. |
| `notifyUsers` | boolean | No | — | Whether users watching the issue are notified by email. |
| `adjustEstimate` | string | No | — | Defines how to update the issue's time estimate, the options are: \* `new` Sets the estimate to a specific value, defined in `newEstimate`. \* `leave` Leaves the estimate unchanged. \* `manual` Reduces the estimate by amount specified in `reduceBy`. \* `auto` Reduces the estimate by the value of `timeSpent` in the worklog. |
| `newEstimate` | string | No | — | The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, *2d*. Required when `adjustEstimate` is `new`. |
| `reduceBy` | string | No | — | The amount to reduce the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m). For example, *2d*. Required when `adjustEstimate` is `manual`. |
| `expand` | string | No | — | Use expand to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties. |
| `overrideEditableFlag` | boolean | No | — | Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. |
| `author` | object | No | — | Details of the user who created the worklog. |
| `comment` | object | No | — | A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog. |
| `created` | string | No | — | The datetime on which the worklog was created. |
| `id` | string | No | — | The ID of the worklog record. |
| `issueId` | string | No | — | The ID of the issue this worklog is for. |
| `properties` | object\[] | No | — | Details of properties for the worklog. Optional when creating or updating a worklog. |
| `self` | string | No | — | The URL of the worklog item. |
| `started` | string | No | — | The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. |
| `timeSpent` | string | No | — | The time spent working on the issue as days (#d), hours (#h), or minutes (#m or #). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided. |
| `timeSpentSeconds` | integer | No | — | The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided. |
| `updateAuthor` | object | No | — | Details of the user who last updated the worklog. |
| `updated` | string | No | — | The datetime on which the worklog was last updated. |
| `visibility` | object | No | — | Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key the issue."
},
"notifyUsers": {
"type": "boolean",
"description": "Whether users watching the issue are notified by email."
},
"adjustEstimate": {
"type": "string",
"description": "Defines how to update the issue's time estimate, the options are: * `new` Sets the estimate to a specific value, defined in `newEstimate`. * `leave` Leaves the estimate unchanged. * `manual` Reduces the estimate by amount specified in `reduceBy`. * `auto` Reduces the estimate by the value of `timeSpent` in the worklog.",
"enum": [
"new",
"leave",
"manual",
"auto"
]
},
"newEstimate": {
"type": "string",
"description": "The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `new`."
},
"reduceBy": {
"type": "string",
"description": "The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when `adjustEstimate` is `manual`."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties."
},
"overrideEditableFlag": {
"type": "boolean",
"description": "Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag."
},
"author": {
"description": "Details of the user who created the worklog."
},
"comment": {
"description": "A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog."
},
"created": {
"type": "string",
"description": "The datetime on which the worklog was created."
},
"id": {
"type": "string",
"description": "The ID of the worklog record."
},
"issueId": {
"type": "string",
"description": "The ID of the issue this worklog is for."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "Details of properties for the worklog. Optional when creating or updating a worklog."
},
"self": {
"type": "string",
"description": "The URL of the worklog item."
},
"started": {
"type": "string",
"description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog."
},
"timeSpent": {
"type": "string",
"description": "The time spent working on the issue as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided."
},
"timeSpentSeconds": {
"type": "integer",
"description": "The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided."
},
"updateAuthor": {
"description": "Details of the user who last updated the worklog."
},
"updated": {
"type": "string",
"description": "The datetime on which the worklog was last updated."
},
"visibility": {
"description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_assign\_issue
Assign issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue to be assigned. |
| `accountId` | string | No | — | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests. |
| `accountType` | string | No | — | The user account type. Can take the following values: \* `atlassian` regular Atlassian user account \* `app` system account used for Connect applications and OAuth to represent external systems \* `customer` Jira Service Desk account representing an external service desk |
| `active` | boolean | No | — | Whether the user is active. |
| `applicationRoles` | object | No | — | The application roles the user is assigned to. |
| `appType` | string | No | — | The app type of the user account when accountType is 'app'. Can take the following values: \* `service` Service Account \* `agent` Rovo Agent Account \* `unknown` Unknown app type |
| `avatarUrls` | object | No | — | The avatars of the user. |
| `displayName` | string | No | — | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. |
| `emailAddress` | string | No | — | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. |
| `expand` | string | No | — | Expand options that include additional user details in the response. |
| `groups` | object | No | — | The groups that the user belongs to. |
| `guest` | boolean | No | — | Whether the user is a guest. |
| `key` | string | No | — | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
| `locale` | string | No | — | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. |
| `name` | string | No | — | This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
| `self` | string | No | — | The URL of the user. |
| `timeZone` | string | No | — | The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue to be assigned."
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required in requests."
},
"accountType": {
"type": "string",
"description": "The user account type. Can take the following values: * `atlassian` regular Atlassian user account * `app` system account used for Connect applications and OAuth to represent external systems * `customer` Jira Service Desk account representing an external service desk",
"enum": [
"atlassian",
"app",
"customer",
"unknown"
]
},
"active": {
"type": "boolean",
"description": "Whether the user is active."
},
"applicationRoles": {
"description": "The application roles the user is assigned to."
},
"appType": {
"type": "string",
"description": "The app type of the user account when accountType is 'app'. Can take the following values: * `service` Service Account * `agent` Rovo Agent Account * `unknown` Unknown app type"
},
"avatarUrls": {
"description": "The avatars of the user."
},
"displayName": {
"type": "string",
"description": "The display name of the user. Depending on the user’s privacy setting, this may return an alternative value."
},
"emailAddress": {
"type": "string",
"description": "The email address of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"expand": {
"type": "string",
"description": "Expand options that include additional user details in the response."
},
"groups": {
"description": "The groups that the user belongs to."
},
"guest": {
"type": "boolean",
"description": "Whether the user is a guest."
},
"key": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"locale": {
"type": "string",
"description": "The locale of the user. Depending on the user’s privacy setting, this may be returned as null."
},
"name": {
"type": "string",
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"self": {
"type": "string",
"description": "The URL of the user."
},
"timeZone": {
"type": "string",
"description": "The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_bulk\_fetch\_issues
Bulk fetch issues
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string\[] | No | — | Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: \* `renderedFields` Returns field values rendered in HTML format. \* `names` Returns the display name of each field. \* `schema` Returns the schema describing a field type. \* `transitions` Returns all possible transitions for the issue. \* `operations` Returns all possible operations for the issue. \* `editmeta` Returns information about how each field can be edited. \* `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. This returns a maximum of 40 changelogs. If you require more, please refer to Bulk fetch changelogs. \* `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. |
| `fields` | string\[] | No | — | A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: \* `*all` Returns all fields. \* `*navigable` Returns navigable fields. \* Any issue field, prefixed with a minus to exclude. The default is `*navigable`. Examples: \* `summary,comment` Returns the summary and comments fields only. \* `-description` Returns all navigable (default) fields except description. \* `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from GET issue where the default is all fields. |
| `fieldsByKeys` | boolean | No | — | Reference fields by their key (rather than ID). The default is `false`. |
| `issueIdsOrKeys` | string\[] | Yes | — | An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query. |
| `properties` | string\[] | No | — | A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a list of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. This returns a maximum of 40 changelogs. If you require more, please refer to [Bulk fetch changelogs](#api-rest-api-3-changelog-bulkfetch-post). * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. The default is `*navigable`. Examples: * `summary,comment` Returns the summary and comments fields only. * `-description` Returns all navigable (default) fields except description. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: All navigable fields are returned by default. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields."
},
"fieldsByKeys": {
"type": "boolean",
"description": "Reference fields by their key (rather than ID). The default is `false`."
},
"issueIdsOrKeys": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of issue IDs or issue keys to fetch. You can mix issue IDs and keys in the same query."
},
"properties": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of issue property keys of issue properties to be included in the results. A maximum of 5 issue property keys can be specified."
}
},
"required": [
"PCID",
"issueIdsOrKeys"
]
}
```
***
## jira\_issues\_count\_issues
Count issues using JQL
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `jql` | string | No | — | A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"jql": {
"type": "string",
"description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_create\_filter
Create filter
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. \* `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. |
| `overrideSharePermissions` | boolean | No | — | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `approximateLastUsed` | string | No | — | \[Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate. |
| `description` | string | No | — | A description of the filter. |
| `editPermissions` | object\[] | No | — | The groups and projects that can edit the filter. |
| `favourite` | boolean | No | — | Whether the filter is selected as a favorite. |
| `favouritedCount` | integer | No | — | The count of how many users have selected this filter as a favorite, including the filter owner. |
| `id` | string | No | — | The unique identifier for the filter. |
| `jql` | string | No | — | The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. |
| `name` | string | Yes | — | The name of the filter. Must be unique. |
| `owner` | object | No | — | The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings. |
| `searchUrl` | string | No | — | A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, *[https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug](https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug)*. |
| `self` | string | No | — | The URL of the filter. |
| `sharedUsers` | object | No | — | A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with. |
| `sharePermissions` | object\[] | No | — | The groups and projects that the filter is shared with. |
| `subscriptions` | object | No | — | A paginated list of the users that are subscribed to the filter. |
| `viewUrl` | string | No | — | A URL to view the filter results in Jira, using the ID of the filter. For example, *[https://your-domain.atlassian.net/issues/?filter=10100](https://your-domain.atlassian.net/issues/?filter=10100)*. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`."
},
"overrideSharePermissions": {
"type": "boolean",
"description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"approximateLastUsed": {
"type": "string",
"description": "\\[Experimental\\] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate."
},
"description": {
"type": "string",
"description": "A description of the filter."
},
"editPermissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project."
},
"role": {
"description": "The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
},
"type": {
"type": "string",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
],
"description": "The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request."
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
}
},
"required": [
"type"
]
},
"description": "The groups and projects that can edit the filter."
},
"favourite": {
"type": "boolean",
"description": "Whether the filter is selected as a favorite."
},
"favouritedCount": {
"type": "integer",
"description": "The count of how many users have selected this filter as a favorite, including the filter owner."
},
"id": {
"type": "string",
"description": "The unique identifier for the filter."
},
"jql": {
"type": "string",
"description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
},
"name": {
"type": "string",
"description": "The name of the filter. Must be unique."
},
"owner": {
"description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings."
},
"searchUrl": {
"type": "string",
"description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*."
},
"self": {
"type": "string",
"description": "The URL of the filter."
},
"sharedUsers": {
"description": "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with."
},
"sharePermissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project."
},
"role": {
"description": "The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
},
"type": {
"type": "string",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
],
"description": "The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request."
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
}
},
"required": [
"type"
]
},
"description": "The groups and projects that the filter is shared with."
},
"subscriptions": {
"description": "A paginated list of the users that are subscribed to the filter."
},
"viewUrl": {
"type": "string",
"description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*."
}
},
"required": [
"PCID",
"name"
]
}
```
***
## jira\_issues\_create\_issue
Create issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `updateHistory` | boolean | No | — | Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen. |
| `fields` | object | No | — | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`. |
| `historyMetadata` | object | No | — | Additional issue history details. |
| `properties` | object\[] | No | — | Details of issue properties to be add or update. |
| `transition` | object | No | — | Details of a transition. Required when performing a transition, optional when creating or editing an issue. |
| `update` | object | No | — | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"updateHistory": {
"type": "boolean",
"description": "Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a project. These values are then used to provide defaults on the issue create screen."
},
"fields": {
"type": "object",
"description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`."
},
"historyMetadata": {
"description": "Additional issue history details."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "Details of issue properties to be add or update."
},
"transition": {
"description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue."
},
"update": {
"type": "object",
"description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_delete\_comment
Delete comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `id` | string | Yes | — | The ID of the comment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"id": {
"type": "string",
"description": "The ID of the comment."
}
},
"required": [
"PCID",
"issueIdOrKey",
"id"
]
}
```
***
## jira\_issues\_delete\_filter
Delete filter
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------------- |
| `id` | integer | Yes | — | The ID of the filter to delete. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the filter to delete."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_issues\_delete\_issue
Delete issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `deleteSubtasks` | string | No | — | Whether the issue's subtasks are deleted when the issue is deleted. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"deleteSubtasks": {
"type": "string",
"description": "Whether the issue's subtasks are deleted when the issue is deleted.",
"enum": [
"true",
"false"
]
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_delete\_worklog
Delete worklog
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `id` | string | Yes | — | The ID of the worklog. |
| `notifyUsers` | boolean | No | — | Whether users watching the issue are notified by email. |
| `adjustEstimate` | string | No | — | Defines how to update the issue's time estimate, the options are: \* `new` Sets the estimate to a specific value, defined in `newEstimate`. \* `leave` Leaves the estimate unchanged. \* `manual` Increases the estimate by amount specified in `increaseBy`. \* `auto` Reduces the estimate by the value of `timeSpent` in the worklog. |
| `newEstimate` | string | No | — | The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For example, *2d*. Required when `adjustEstimate` is `new`. |
| `increaseBy` | string | No | — | The amount to increase the issue's remaining estimate by, as days (#d), hours (#h), or minutes (#m or #). For example, *2d*. Required when `adjustEstimate` is `manual`. |
| `overrideEditableFlag` | boolean | No | — | Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"id": {
"type": "string",
"description": "The ID of the worklog."
},
"notifyUsers": {
"type": "boolean",
"description": "Whether users watching the issue are notified by email."
},
"adjustEstimate": {
"type": "string",
"description": "Defines how to update the issue's time estimate, the options are: * `new` Sets the estimate to a specific value, defined in `newEstimate`. * `leave` Leaves the estimate unchanged. * `manual` Increases the estimate by amount specified in `increaseBy`. * `auto` Reduces the estimate by the value of `timeSpent` in the worklog.",
"enum": [
"new",
"leave",
"manual",
"auto"
]
},
"newEstimate": {
"type": "string",
"description": "The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `new`."
},
"increaseBy": {
"type": "string",
"description": "The amount to increase the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when `adjustEstimate` is `manual`."
},
"overrideEditableFlag": {
"type": "boolean",
"description": "Whether the work log entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with admin permission can use this flag."
}
},
"required": [
"PCID",
"issueIdOrKey",
"id"
]
}
```
***
## jira\_issues\_do\_transition
Transition issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `fields` | object | No | — | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`. |
| `historyMetadata` | object | No | — | Additional issue history details. |
| `properties` | object\[] | No | — | Details of issue properties to be add or update. |
| `transition` | object | No | — | Details of a transition. Required when performing a transition, optional when creating or editing an issue. |
| `update` | object | No | — | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"fields": {
"type": "object",
"description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`."
},
"historyMetadata": {
"description": "Additional issue history details."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "Details of issue properties to be add or update."
},
"transition": {
"description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue."
},
"update": {
"type": "object",
"description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_edit\_issue
Edit issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `notifyUsers` | boolean | No | — | Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored. |
| `overrideScreenSecurity` | boolean | No | — | Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `overrideEditableFlag` | boolean | No | — | Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `returnIssue` | boolean | No | — | Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the Get issue API. |
| `expand` | string | No | — | The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`. |
| `fields` | object | No | — | List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`. |
| `historyMetadata` | object | No | — | Additional issue history details. |
| `properties` | object\[] | No | — | Details of issue properties to be add or update. |
| `transition` | object | No | — | Details of a transition. Required when performing a transition, optional when creating or editing an issue. |
| `update` | object | No | — | A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"notifyUsers": {
"type": "boolean",
"description": "Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn't have the necessary permission the request is ignored."
},
"overrideScreenSecurity": {
"type": "boolean",
"description": "Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"overrideEditableFlag": {
"type": "boolean",
"description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"returnIssue": {
"type": "boolean",
"description": "Whether the response should contain the issue with fields edited in this request. The returned issue will have the same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get)."
},
"expand": {
"type": "string",
"description": "The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`."
},
"fields": {
"type": "object",
"description": "List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use `update`. Fields included in here cannot be included in `update`."
},
"historyMetadata": {
"description": "Additional issue history details."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "Details of issue properties to be add or update."
},
"transition": {
"description": "Details of a transition. Required when performing a transition, optional when creating or editing an issue."
},
"update": {
"type": "object",
"description": "A Map containing the field field name and a list of operations to perform on the issue screen field. Note that fields included in here cannot be included in `fields`."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_all\_labels
Get all labels
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------- |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_attachment
Get attachment metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------- |
| `id` | string | Yes | — | The ID of the attachment. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the attachment."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_issues\_get\_attachment\_meta
Get Jira attachment settings
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_auto\_complete\_post
Get field reference data (POST)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ---------- | -------- | ------- | ---------------------------------------------------------------------- |
| `includeCollapsedFields` | boolean | No | — | Include collapsed fields for fields that have non-unique names. |
| `projectIds` | integer\[] | No | — | List of project IDs used to filter the visible field details returned. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"includeCollapsedFields": {
"type": "boolean",
"description": "Include collapsed fields for fields that have non-unique names."
},
"projectIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "List of project IDs used to filter the visible field details returned."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_comment
Get comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `id` | string | Yes | — | The ID of the comment. |
| `expand` | string | No | — | Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML."
}
},
"required": [
"PCID",
"issueIdOrKey",
"id"
]
}
```
***
## jira\_issues\_get\_comments
Get comments
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
| `orderBy` | string | No | — | Order the results by a field. Accepts *created* to sort comments by their created date. |
| `expand` | string | No | — | Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
},
"orderBy": {
"type": "string",
"description": "[Order](#ordering) the results by a field. Accepts *created* to sort comments by their created date.",
"enum": [
"created",
"-created",
"+created"
]
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_create\_issue\_meta\_issue\_type\_id
Get create field metadata for a project and issue type id
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The ID or key of the project. |
| `issueTypeId` | string | Yes | — | The issuetype ID. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The ID or key of the project."
},
"issueTypeId": {
"type": "string",
"description": "The issuetype ID."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
}
},
"required": [
"PCID",
"projectIdOrKey",
"issueTypeId"
]
}
```
***
## jira\_issues\_get\_create\_issue\_meta\_issue\_types
Get create metadata issue types for a project
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------- |
| `projectIdOrKey` | string | Yes | — | The ID or key of the project. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"projectIdOrKey": {
"type": "string",
"description": "The ID or key of the project."
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
}
},
"required": [
"PCID",
"projectIdOrKey"
]
}
```
***
## jira\_issues\_get\_edit\_issue\_meta
Get edit issue metadata
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `overrideScreenSecurity` | boolean | No | — | Whether hidden fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `overrideEditableFlag` | boolean | No | — | Whether non-editable fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"overrideScreenSecurity": {
"type": "boolean",
"description": "Whether hidden fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"overrideEditableFlag": {
"type": "boolean",
"description": "Whether non-editable fields are returned. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_favourite\_filters
Get favorite filters
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. \* `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_filter
Get filter
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the filter to return. |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. \* `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. |
| `overrideSharePermissions` | boolean | No | — | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the filter to return."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`."
},
"overrideSharePermissions": {
"type": "boolean",
"description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## jira\_issues\_get\_filters\_paginated
Search for filters
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ---------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filterName` | string | No | — | String used to perform a case-insensitive partial match with `name`. |
| `accountId` | string | No | — | User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`. |
| `owner` | string | No | — | This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with `accountId`. |
| `groupname` | string | No | — | As a group's name can change, use of `groupId` is recommended to identify a group. Group name used to returns filters that are shared with a group that matches `sharePermissions.group.groupname`. This parameter cannot be used with the `groupId` parameter. |
| `groupId` | string | No | — | Group ID used to returns filters that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter. |
| `projectId` | integer | No | — | Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`. |
| `id` | integer\[] | No | — | The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Do not exceed 200 filter IDs. |
| `orderBy` | string | No | — | Order the results by a field: \* `description` Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. \* `favourite_count` Sorts by the count of how many users have this filter as a favorite. \* `is_favourite` Sorts by whether the filter is marked as a favorite. \* `id` Sorts by filter ID. \* `name` Sorts by filter name. \* `owner` Sorts by the ID of the filter owner. \* `is_shared` Sorts by whether the filter is shared. |
| `startAt` | integer | No | — | The index of the first item to return in a page of results (page offset). |
| `maxResults` | integer | No | — | The maximum number of items to return per page. |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `description` Returns the description of the filter. \* `favourite` Returns an indicator of whether the user has set the filter as a favorite. \* `favouritedCount` Returns a count of how many users have set this filter as a favorite. \* `jql` Returns the JQL query that the filter uses. \* `owner` Returns the owner of the filter. \* `searchUrl` Returns a URL to perform the filter's JQL query. \* `sharePermissions` Returns the share permissions defined for the filter. \* `editPermissions` Returns the edit permissions defined for the filter. \* `isWritable` Returns whether the current user has permission to edit the filter. \* `approximateLastUsed` \[Experimental] Returns the approximate date and time when the filter was last evaluated. \* `subscriptions` Returns the users that are subscribed to the filter. \* `viewUrl` Returns a URL to view the filter. |
| `overrideSharePermissions` | boolean | No | — | EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `isSubstringMatch` | boolean | No | — | When `true` this will perform a case-insensitive substring match for the provided `filterName`. When `false` the filter name will be searched using [full text search syntax](https://support.atlassian.com/jira-software-cloud/docs/search-for-issues-using-the-text-field/). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"filterName": {
"type": "string",
"description": "String used to perform a case-insensitive partial match with `name`."
},
"accountId": {
"type": "string",
"description": "User account ID used to return filters with the matching `owner.accountId`. This parameter cannot be used with `owner`."
},
"owner": {
"type": "string",
"description": "This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with `accountId`."
},
"groupname": {
"type": "string",
"description": "As a group's name can change, use of `groupId` is recommended to identify a group. Group name used to returns filters that are shared with a group that matches `sharePermissions.group.groupname`. This parameter cannot be used with the `groupId` parameter."
},
"groupId": {
"type": "string",
"description": "Group ID used to returns filters that are shared with a group that matches `sharePermissions.group.groupId`. This parameter cannot be used with the `groupname` parameter."
},
"projectId": {
"type": "integer",
"description": "Project ID used to returns filters that are shared with a project that matches `sharePermissions.project.id`."
},
"id": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`. Do not exceed 200 filter IDs."
},
"orderBy": {
"type": "string",
"description": "[Order](#ordering) the results by a field: * `description` Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. * `favourite_count` Sorts by the count of how many users have this filter as a favorite. * `is_favourite` Sorts by whether the filter is marked as a favorite. * `id` Sorts by filter ID. * `name` Sorts by filter name. * `owner` Sorts by the ID of the filter owner. * `is_shared` Sorts by whether the filter is shared.",
"enum": [
"description",
"-description",
"+description",
"favourite_count",
"-favourite_count",
"+favourite_count",
"id",
"-id",
"+id",
"is_favourite",
"-is_favourite",
"+is_favourite",
"name",
"-name",
"+name",
"owner",
"-owner",
"+owner",
"is_shared",
"-is_shared",
"+is_shared"
]
},
"startAt": {
"type": "integer",
"description": "The index of the first item to return in a page of results (page offset)."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `description` Returns the description of the filter. * `favourite` Returns an indicator of whether the user has set the filter as a favorite. * `favouritedCount` Returns a count of how many users have set this filter as a favorite. * `jql` Returns the JQL query that the filter uses. * `owner` Returns the owner of the filter. * `searchUrl` Returns a URL to perform the filter's JQL query. * `sharePermissions` Returns the share permissions defined for the filter. * `editPermissions` Returns the edit permissions defined for the filter. * `isWritable` Returns whether the current user has permission to edit the filter. * `approximateLastUsed` \\[Experimental\\] Returns the approximate date and time when the filter was last evaluated. * `subscriptions` Returns the users that are subscribed to the filter. * `viewUrl` Returns a URL to view the filter."
},
"overrideSharePermissions": {
"type": "boolean",
"description": "EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"isSubstringMatch": {
"type": "boolean",
"description": "When `true` this will perform a case-insensitive substring match for the provided `filterName`. When `false` the filter name will be searched using [full text search syntax](https://support.atlassian.com/jira-software-cloud/docs/search-for-issues-using-the-text-field/)."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_issue
Get issue
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `fields` | string\[] | No | — | A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: \* `*all` Returns all fields. \* `*navigable` Returns navigable fields. \* Any issue field, prefixed with a minus to exclude. Examples: \* `summary,comment` Returns only the summary and comments fields. \* `-description` Returns all (default) fields except description. \* `*navigable,-comment` Returns all navigable fields except comment. This parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`. Note: All fields are returned by default. This differs from Search for issues using JQL (GET) and Search for issues using JQL (POST) where the default is all navigable fields. |
| `fieldsByKeys` | boolean | No | — | Whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID. |
| `expand` | string | No | — | Use expand to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: \* `renderedFields` Returns field values rendered in HTML format. \* `names` Returns the display name of each field. \* `schema` Returns the schema describing a field type. \* `transitions` Returns all possible transitions for the issue. \* `editmeta` Returns information about how each field can be edited. \* `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. \* `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored. |
| `properties` | string\[] | No | — | A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: \* `*all` Returns all issue properties. \* Any issue property key, prefixed with a minus to exclude. Examples: \* `*all` Returns all properties. \* `*all,-prop1` Returns all properties except `prop1`. \* `prop1,prop2` Returns `prop1` and `prop2` properties. This parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`. |
| `updateHistory` | boolean | No | — | Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the JQL issues search `lastViewed` field. |
| `failFast` | boolean | No | — | Whether to fail the request quickly in case of an error while loading fields for an issue. For `failFast=true`, if one field fails, the entire operation fails. For `failFast=false`, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s). |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * Any issue field, prefixed with a minus to exclude. Examples: * `summary,comment` Returns only the summary and comments fields. * `-description` Returns all (default) fields except description. * `*navigable,-comment` Returns all navigable fields except comment. This parameter may be specified multiple times. For example, `fields=field1,field2& fields=field3`. Note: All fields are returned by default. This differs from [Search for issues using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL (POST)](#api-rest-api-3-search-post) where the default is all navigable fields."
},
"fieldsByKeys": {
"type": "boolean",
"description": "Whether fields in `fields` are referenced by keys rather than IDs. This parameter is useful where fields have been added by a connect app and a field's key may differ from its ID."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about the issues in the response. This parameter accepts a comma-separated list. Expand options include: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Returns a JSON array for each version of a field's value, with the highest number representing the most recent version. Note: When included in the request, the `fields` parameter is ignored."
},
"properties": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * `*all` Returns all issue properties. * Any issue property key, prefixed with a minus to exclude. Examples: * `*all` Returns all properties. * `*all,-prop1` Returns all properties except `prop1`. * `prop1,prop2` Returns `prop1` and `prop2` properties. This parameter may be specified multiple times. For example, `properties=prop1,prop2& properties=prop3`."
},
"updateHistory": {
"type": "boolean",
"description": "Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown under **Projects** in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) `lastViewed` field."
},
"failFast": {
"type": "boolean",
"description": "Whether to fail the request quickly in case of an error while loading fields for an issue. For `failFast=true`, if one field fails, the entire operation fails. For `failFast=false`, the operation will continue even if a field fails. It will return a valid response, but without values for the failed field(s)."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_issue\_link
Get issue link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------- |
| `linkId` | string | Yes | — | The ID of the issue link. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"linkId": {
"type": "string",
"description": "The ID of the issue link."
}
},
"required": [
"PCID",
"linkId"
]
}
```
***
## jira\_issues\_get\_issue\_link\_types
Get issue link types
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_issue\_watchers
Get issue watchers
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_my\_filters
Get my filters
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. \* `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. |
| `includeFavourites` | boolean | No | — | Include the user's favorite filters in the response. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`."
},
"includeFavourites": {
"type": "boolean",
"description": "Include the user's favorite filters in the response."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_get\_transitions
Get transitions
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `expand` | string | No | — | Use expand to include additional information about transitions in the response. This parameter accepts `transitions.fields`, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the `fields` and `update` fields in Transition issue. |
| `transitionId` | string | No | — | The ID of the transition. |
| `skipRemoteOnlyCondition` | boolean | No | — | Whether transitions with the condition *Hide From User Condition* are included in the response. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `includeUnavailableTransitions` | boolean | No | — | Whether details of transitions that fail a condition are included in the response |
| `sortByOpsBarAndStatus` | boolean | No | — | Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about transitions in the response. This parameter accepts `transitions.fields`, which returns information about the fields in the transition screen for each transition. Fields hidden from the screen are not returned. Use this information to populate the `fields` and `update` fields in [Transition issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post)."
},
"transitionId": {
"type": "string",
"description": "The ID of the transition."
},
"skipRemoteOnlyCondition": {
"type": "boolean",
"description": "Whether transitions with the condition *Hide From User Condition* are included in the response. Available to Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"includeUnavailableTransitions": {
"type": "boolean",
"description": "Whether details of transitions that fail a condition are included in the response"
},
"sortByOpsBarAndStatus": {
"type": "boolean",
"description": "Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_votes
Get votes
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_get\_worklog
Get worklog
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `id` | string | Yes | — | The ID of the worklog. |
| `expand` | string | No | — | Use expand to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"id": {
"type": "string",
"description": "The ID of the worklog."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts `properties`, which returns worklog properties."
}
},
"required": [
"PCID",
"issueIdOrKey",
"id"
]
}
```
***
## jira\_issues\_link\_issues
Create issue link
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `comment` | object | No | — | A comment. |
| `inwardIssue` | object | Yes | — | The ID or key of a linked issue. |
| `outwardIssue` | object | Yes | — | The ID or key of a linked issue. |
| `type` | object | Yes | — | This object is used as follows: \* In the issueLink resource it defines and reports on the type of link between the issues. Find a list of issue link types with Get issue link types. \* In the issueLinkType resource it defines and reports on issue link types. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"comment": {
"type": "object",
"description": "A comment.",
"properties": {
"author": {
"description": "The ID of the user who created the comment."
},
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
},
"created": {
"type": "string",
"description": "The date and time at which the comment was created."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"jsdAuthorCanSeeRequest": {
"type": "boolean",
"description": "Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature."
},
"jsdPublic": {
"type": "boolean",
"description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
},
"properties": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of comment properties. Optional on create and update."
},
"renderedBody": {
"type": "string",
"description": "The rendered version of the comment."
},
"self": {
"type": "string",
"description": "The URL of the comment."
},
"updateAuthor": {
"description": "The ID of the user who updated the comment last."
},
"updated": {
"type": "string",
"description": "The date and time at which the comment was updated last."
},
"visibility": {
"description": "The group or role to which this comment is visible. Optional on create and update."
}
}
},
"inwardIssue": {
"type": "object",
"description": "The ID or key of a linked issue.",
"properties": {
"fields": {
"description": "The fields associated with the issue."
},
"id": {
"type": "string",
"description": "The ID of an issue. Required if `key` isn't provided."
},
"key": {
"type": "string",
"description": "The key of an issue. Required if `id` isn't provided."
},
"self": {
"type": "string",
"description": "The URL of the issue."
}
}
},
"outwardIssue": {
"type": "object",
"description": "The ID or key of a linked issue.",
"properties": {
"fields": {
"description": "The fields associated with the issue."
},
"id": {
"type": "string",
"description": "The ID of an issue. Required if `key` isn't provided."
},
"key": {
"type": "string",
"description": "The key of an issue. Required if `id` isn't provided."
},
"self": {
"type": "string",
"description": "The URL of the issue."
}
}
},
"type": {
"type": "object",
"description": "This object is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it defines and reports on the type of link between the issues. Find a list of issue link types with [Get issue link types](#api-rest-api-3-issueLinkType-get). * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it defines and reports on issue link types.",
"properties": {
"id": {
"type": "string",
"description": "The ID of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `name` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is read only."
},
"inward": {
"type": "string",
"description": "The description of the issue link type inward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
},
"name": {
"type": "string",
"description": "The name of the issue link type and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is the type of issue link. Required on create when `id` isn't provided. Otherwise, read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
},
"outward": {
"type": "string",
"description": "The description of the issue link type outward link and is used as follows: * In the [ issueLink](#api-rest-api-3-issueLink-post) resource it is read only. * In the [ issueLinkType](#api-rest-api-3-issueLinkType-post) resource it is required on create and optional on update. Otherwise, read only."
},
"self": {
"type": "string",
"description": "The URL of the issue link type. Read only."
}
}
}
},
"required": [
"PCID",
"inwardIssue",
"outwardIssue",
"type"
]
}
```
***
## jira\_issues\_remove\_vote
Delete vote
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | --------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_remove\_watcher
Delete watcher
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `username` | string | No | — | This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
| `accountId` | string | No | — | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"username": {
"type": "string",
"description": "This parameter is no longer available. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Required."
}
},
"required": [
"PCID",
"issueIdOrKey"
]
}
```
***
## jira\_issues\_search\_and\_reconsile\_issues\_using\_jql\_post
Search for issues using JQL enhanced search (POST)
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `expand` | string | No | — | Use expand to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a comma-delimited string of values. The expand options are: \* `renderedFields` Returns field values rendered in HTML format. \* `names` Returns the display name of each field. \* `schema` Returns the schema describing a field type. \* `transitions` Returns all possible transitions for the issue. \* `operations` Returns all possible operations for the issue. \* `editmeta` Returns information about how each field can be edited. \* `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. \* `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. Examples: `"names,changelog"` Returns the display name of each field as well as a list of recent updates to an issue. |
| `fields` | string\[] | No | — | A list of fields to return for each issue. Use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: \* `*all` Returns all fields. \* `*navigable` Returns navigable fields. \* `id` Returns only issue IDs. \* Any issue field, prefixed with a dash to exclude. The default is `id`. Examples: \* `summary,comment` Returns the summary and comments fields only. \* `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: By default, this resource returns IDs only. This differs from GET issue where the default is all fields. |
| `fieldsByKeys` | boolean | No | — | Reference fields by their key (rather than ID). The default is `false`. |
| `jql` | string | No | — | A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. \* Example of an unbounded query: `order by key desc`. \* Example of a bounded query: `assignee = currentUser() order by key`. Additionally, `orderBy` clause can contain a maximum of 7 fields. |
| `maxResults` | integer | No | — | The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only. It returns max 5000 issues. |
| `nextPageToken` | string | No | — | The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of issues. |
| `properties` | string\[] | No | — | A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. |
| `reconcileIssues` | integer\[] | No | — | Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about issues in the response. Note that, unlike the majority of instances where `expand` is specified, `expand` is defined as a comma-delimited string of values. The expand options are: * `renderedFields` Returns field values rendered in HTML format. * `names` Returns the display name of each field. * `schema` Returns the schema describing a field type. * `transitions` Returns all possible transitions for the issue. * `operations` Returns all possible operations for the issue. * `editmeta` Returns information about how each field can be edited. * `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the most recent. * `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array containing each version of a field's value, with the highest numbered item representing the most recent version. Examples: `\"names,changelog\"` Returns the display name of each field as well as a list of recent updates to an issue."
},
"fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of fields to return for each issue. Use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include: * `*all` Returns all fields. * `*navigable` Returns navigable fields. * `id` Returns only issue IDs. * Any issue field, prefixed with a dash to exclude. The default is `id`. Examples: * `summary,comment` Returns the summary and comments fields only. * `*all,-comment` Returns all fields except comments. Multiple `fields` parameters can be included in a request. Note: By default, this resource returns IDs only. This differs from [GET issue](#api-rest-api-3-issue-issueIdOrKey-get) where the default is all fields."
},
"fieldsByKeys": {
"type": "boolean",
"description": "Reference fields by their key (rather than ID). The default is `false`."
},
"jql": {
"type": "string",
"description": "A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a bounded query. A bounded query is a query with a search restriction. * Example of an unbounded query: `order by key desc`. * Example of a bounded query: `assignee = currentUser() order by key`. Additionally, `orderBy` clause can contain a maximum of 7 fields."
},
"maxResults": {
"type": "integer",
"description": "The maximum number of items to return per page. To manage page size, API may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting `id` or `key` only. It returns max 5000 issues."
},
"nextPageToken": {
"type": "string",
"description": "The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the `nextPageToken` to fetch the next page of issues."
},
"properties": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list."
},
"reconcileIssues": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. This list of ids should be consistent with each paginated request across different pages."
}
},
"required": [
"PCID"
]
}
```
***
## jira\_issues\_update\_comment
Update comment
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `issueIdOrKey` | string | Yes | — | The ID or key of the issue. |
| `id` | string | Yes | — | The ID of the comment. |
| `notifyUsers` | boolean | No | — | Whether users are notified when a comment is updated. |
| `overrideEditableFlag` | boolean | No | — | Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `expand` | string | No | — | Use expand to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML. |
| `author` | object | No | — | The ID of the user who created the comment. |
| `body` | object | No | — | The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). |
| `created` | string | No | — | The date and time at which the comment was created. |
| `jsdAuthorCanSeeRequest` | boolean | No | — | Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature. |
| `jsdPublic` | boolean | No | — | Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation. |
| `properties` | object\[] | No | — | A list of comment properties. Optional on create and update. |
| `renderedBody` | string | No | — | The rendered version of the comment. |
| `self` | string | No | — | The URL of the comment. |
| `updateAuthor` | object | No | — | The ID of the user who updated the comment last. |
| `updated` | string | No | — | The date and time at which the comment was updated last. |
| `visibility` | object | No | — | The group or role to which this comment is visible. Optional on create and update. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"issueIdOrKey": {
"type": "string",
"description": "The ID or key of the issue."
},
"id": {
"type": "string",
"description": "The ID of the comment."
},
"notifyUsers": {
"type": "boolean",
"description": "Whether users are notified when a comment is updated."
},
"overrideEditableFlag": {
"type": "boolean",
"description": "Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on behalf of users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body rendered in HTML."
},
"author": {
"description": "The ID of the user who created the comment."
},
"body": {
"description": "The comment text in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)."
},
"created": {
"type": "string",
"description": "The date and time at which the comment was created."
},
"jsdAuthorCanSeeRequest": {
"type": "boolean",
"description": "Whether the comment was added from an email sent by a person who is not part of the issue. See [Allow external emails to be added as comments on issues](https://support.atlassian.com/jira-service-management-cloud/docs/allow-external-emails-to-be-added-as-comments-on-issues/)for information on setting up this feature."
},
"jsdPublic": {
"type": "boolean",
"description": "Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API [Create request comment](https://developer.atlassian.com/cloud/jira/service-desk/rest/#api-rest-servicedeskapi-request-issueIdOrKey-comment-post) operation."
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key of the property. Required on create and update."
},
"value": {
"description": "The value of the property. Required on create and update."
}
}
},
"description": "A list of comment properties. Optional on create and update."
},
"renderedBody": {
"type": "string",
"description": "The rendered version of the comment."
},
"self": {
"type": "string",
"description": "The URL of the comment."
},
"updateAuthor": {
"description": "The ID of the user who updated the comment last."
},
"updated": {
"type": "string",
"description": "The date and time at which the comment was updated last."
},
"visibility": {
"description": "The group or role to which this comment is visible. Optional on create and update."
}
},
"required": [
"PCID",
"issueIdOrKey",
"id"
]
}
```
***
## jira\_issues\_update\_filter
Update filter
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The ID of the filter to update. |
| `expand` | string | No | — | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: \* `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. \* `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. |
| `overrideSharePermissions` | boolean | No | — | EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). |
| `approximateLastUsed` | string | No | — | \[Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate. |
| `description` | string | No | — | A description of the filter. |
| `editPermissions` | object\[] | No | — | The groups and projects that can edit the filter. |
| `favourite` | boolean | No | — | Whether the filter is selected as a favorite. |
| `favouritedCount` | integer | No | — | The count of how many users have selected this filter as a favorite, including the filter owner. |
| `jql` | string | No | — | The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. |
| `name` | string | Yes | — | The name of the filter. Must be unique. |
| `owner` | object | No | — | The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings. |
| `searchUrl` | string | No | — | A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, *[https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug](https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug)*. |
| `self` | string | No | — | The URL of the filter. |
| `sharedUsers` | object | No | — | A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with. |
| `sharePermissions` | object\[] | No | — | The groups and projects that the filter is shared with. |
| `subscriptions` | object | No | — | A paginated list of the users that are subscribed to the filter. |
| `viewUrl` | string | No | — | A URL to view the filter results in Jira, using the ID of the filter. For example, *[https://your-domain.atlassian.net/issues/?filter=10100](https://your-domain.atlassian.net/issues/?filter=10100)*. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The ID of the filter to update."
},
"expand": {
"type": "string",
"description": "Use [expand](#expansion) to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use `?expand=sharedUsers[1001:2000]`. * `subscriptions` Returns the users that are subscribed to the filter. If you don't specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`."
},
"overrideSharePermissions": {
"type": "boolean",
"description": "EXPERIMENTAL: Whether share permissions are overridden to enable the addition of any share permissions to filters. Available to users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg)."
},
"approximateLastUsed": {
"type": "string",
"description": "\\[Experimental\\] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate."
},
"description": {
"type": "string",
"description": "A description of the filter."
},
"editPermissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project."
},
"role": {
"description": "The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
},
"type": {
"type": "string",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
],
"description": "The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request."
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
}
},
"required": [
"type"
]
},
"description": "The groups and projects that can edit the filter."
},
"favourite": {
"type": "boolean",
"description": "Whether the filter is selected as a favorite."
},
"favouritedCount": {
"type": "integer",
"description": "The count of how many users have selected this filter as a favorite, including the filter owner."
},
"jql": {
"type": "string",
"description": "The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*."
},
"name": {
"type": "string",
"description": "The name of the filter. Must be unique."
},
"owner": {
"description": "The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings."
},
"searchUrl": {
"type": "string",
"description": "A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) operation with the filter's JQL string to return the filter results. For example, *https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug*."
},
"self": {
"type": "string",
"description": "The URL of the filter."
},
"sharedUsers": {
"description": "A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with."
},
"sharePermissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"group": {
"description": "The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended."
},
"id": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the share permission."
},
"project": {
"description": "The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project."
},
"role": {
"description": "The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in."
},
"type": {
"type": "string",
"enum": [
"user",
"group",
"project",
"projectRole",
"global",
"loggedin",
"authenticated",
"project-unknown"
],
"description": "The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request."
},
"user": {
"description": "The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user."
}
},
"required": [
"type"
]
},
"description": "The groups and projects that the filter is shared with."
},
"subscriptions": {
"description": "A paginated list of the users that are subscribed to the filter."
},
"viewUrl": {
"type": "string",
"description": "A URL to view the filter results in Jira, using the ID of the filter. For example, *https://your-domain.atlassian.net/issues/?filter=10100*."
}
},
"required": [
"PCID",
"id",
"name"
]
}
```