JiraClient
Attributes
TRIGGER_OPERATIONS
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'OnNewIssue_Datacenter': {'operation_id': 'OnNewIssue_Datacenter', 'path': '/{connectionId}/datacenter/new_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnCloseIssue_Datacenter': {'operation_id': 'OnCloseIssue_Datacenter', 'path': '/{connectionId}/datacenter/close_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssueJQL_Datacenter': {'operation_id': 'OnNewIssueJQL_Datacenter', 'path': '/{connectionId}/datacenter/new_issue_jql_trigger/search', 'method': 'get', 'required_parameters': ['jql'], 'callback_payload_type': 'FullIssue'}, 'OnCloseIssue_V2': {'operation_id': 'OnCloseIssue_V2', 'path': '/{connectionId}/v2/close_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssue_V2': {'operation_id': 'OnNewIssue_V2', 'path': '/{connectionId}/v2/new_issue_trigger/search', 'method': 'get', 'required_parameters': ['projectKey'], 'callback_payload_type': 'FullIssue'}, 'OnNewIssueJQL_V2': {'operation_id': 'OnNewIssueJQL_V2', 'path': '/{connectionId}/v2/new_issue_jql_trigger/search', 'method': 'get', 'required_parameters': ['jql'], 'callback_payload_type': 'FullIssue'}}
Classes
ListIssuesResponse
dataclass
ListIssuesResponse(*, next_page_token: Optional[str] = None, is_last: Optional[bool] = None, issues: Optional[List[FullIssue | Mapping[str, Any]]] = None)
Response for Get list of issues
Attributes
next_page_token
class-attribute
instance-attribute
next_page_token: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'nextPageToken'})
The token used to retrieve the next page of issues. Pass this value into the 'Next page token' input of a subsequent call to fetch the next page. Absent on the last page.
ListIssuesResponseDatacenter
dataclass
ListIssuesResponseDatacenter(*, start_at: Optional[int] = None, max_results: Optional[int] = None, issues: Optional[List[FullIssue | Mapping[str, Any]]] = None)
ListTransitionsResponse
dataclass
Response for Get list of Transitions
UpdateTransitionResponse
dataclass
GetCurrentUserResponse
dataclass
FullIssue
dataclass
FullIssue(*, id: Optional[str] = None, key: Optional[str] = None, self: Optional[str] = None, fields: Optional[Dict[str, Any]] = None)
Response for When a new issue is created (Datacenter)
Attributes
id
class-attribute
instance-attribute
Unique id of the issue.
key
class-attribute
instance-attribute
Unique key of the issue.
MCPQueryResponse
dataclass
MCPQueryResponse(*, jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None)
Response for Jira MCP Server
CommentResponse
dataclass
CommentResponse(*, id: Optional[str] = None, body: Optional[str] = None, created: Optional[str] = None)
Response for Add comment
Attributes
id
class-attribute
instance-attribute
Unique id of the comment.
body
class-attribute
instance-attribute
Body of the comment.
CancelTaskResponse
dataclass
CreateIssueInput
dataclass
CreateIssueResponse
dataclass
Response for Create a new issue
CreateProjectInput
dataclass
CreateProjectInput(key: str, name: str, project_type_key: str, lead_account_id: str, *, description: Optional[str] = None)
Create a new project
Attributes
project_type_key
class-attribute
instance-attribute
Project type key.
lead_account_id
class-attribute
instance-attribute
Id of Project lead.
CreateProjectResponse
dataclass
Response for Create a new project
CreateProjectCategoryInput
dataclass
CreateProjectCategoryResponse
dataclass
EditIssueInput
dataclass
EditIssueInput(*, transition: Optional[Dict[str, Any]] = None, fields: Optional[Dict[str, Any]] = None, update: Optional[Dict[str, Any]] = None, history_metadata: Optional[Dict[str, Any]] = None, properties: Optional[List[Dict[str, Any]]] = None)
Edit Issue
Attributes
transition
class-attribute
instance-attribute
Transition
fields
class-attribute
instance-attribute
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.
update
class-attribute
instance-attribute
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.
EditIssueResponse
dataclass
GetTaskResponse
dataclass
GetUserResponse
dataclass
ListFiltersResponse
dataclass
ListProjectsResponse
dataclass
UpdateProjectInput
dataclass
UpdateProjectInput(*, key: Optional[str] = None, name: Optional[str] = None, project_type_key: Optional[str] = None, project_template_key: Optional[str] = None, description: Optional[str] = None, lead: Optional[str] = None, lead_account_id: Optional[str] = None, url: Optional[str] = None, assignee_type: Optional[str] = None, avatar_id: Optional[str] = None, issue_security_scheme: Optional[str] = None, permission_scheme: Optional[str] = None, notification_scheme: Optional[str] = None, category_id: Optional[str] = None)
Update Project
Attributes
key
class-attribute
instance-attribute
Key
name
class-attribute
instance-attribute
Name
project_type_key
class-attribute
instance-attribute
project_type_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectTypeKey'})
Project Type Key
project_template_key
class-attribute
instance-attribute
project_template_key: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'projectTemplateKey'})
Project Template Key
description
class-attribute
instance-attribute
Description
lead
class-attribute
instance-attribute
Lead
lead_account_id
class-attribute
instance-attribute
lead_account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'leadAccountId'})
Lead Account ID
url
class-attribute
instance-attribute
URL
assignee_type
class-attribute
instance-attribute
assignee_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'assigneeType'})
Assignee Type
avatar_id
class-attribute
instance-attribute
avatar_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'avatarId'})
Avatar ID
issue_security_scheme
class-attribute
instance-attribute
issue_security_scheme: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'issueSecurityScheme'})
Issue Security Scheme
permission_scheme
class-attribute
instance-attribute
permission_scheme: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'permissionScheme'})
Permission Scheme
UpdateProjectResponse
dataclass
Project
dataclass
Project(*, id: Optional[str] = None, key: Optional[str] = None, name: Optional[str] = None, project_type_key: Optional[str] = None)
Definition: Project
Attributes
id
class-attribute
instance-attribute
The unique Id of the project.
key
class-attribute
instance-attribute
The unique key of the project.
name
class-attribute
instance-attribute
Name of the project.
PartialIssue
dataclass
Creator
dataclass
Creator(*, account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)
Definition: Creator
Attributes
account_id
class-attribute
instance-attribute
account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountId'})
Person who created the issue.
key
class-attribute
instance-attribute
Unique key of the person who created the issue.
Assignee
dataclass
Assignee(*, account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)
Definition: Assignee
Attributes
account_id
class-attribute
instance-attribute
account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountId'})
Person whom the issue is assigned to.
key
class-attribute
instance-attribute
Unique key of the person whom the issue is assigned to.
User
dataclass
User(*, account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)
Definition: User
Attributes
account_id
class-attribute
instance-attribute
account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'accountId'})
Id of the Jira user.
key
class-attribute
instance-attribute
Unique key of the Jira user.
Reporter
dataclass
Reporter(*, account_id: Optional[str] = None, key: Optional[str] = None, email_address: Optional[str] = None, display_name: Optional[str] = None)
Definition: Reporter
Attributes
account_id
class-attribute
instance-attribute
account_id: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'AccountId'})
Person who reported the issue.
key
class-attribute
instance-attribute
Unique key of the person who reported the issue.
CreateIssueRequest
dataclass
Definition: CreateIssueRequest
UpdateIssueRequest
dataclass
Definition: UpdateIssueRequest
Comment
dataclass
Transition
dataclass
Transition(*, id: Optional[str] = None, name: Optional[str] = None, to: Optional[TransitionStatus | Mapping[str, Any]] = None, fields: Optional[Dict[str, Any]] = None)
Definition: Transition
Attributes
id
class-attribute
instance-attribute
ID of the transition
name
class-attribute
instance-attribute
Name of the transition
TransitionStatus
dataclass
TransitionInput
dataclass
TransitionInput(*, fields: Optional[Dict[str, Any]] = None, history_metadata: Optional[Dict[str, Any]] = None, transition: Optional[Dict[str, Any]] = None, update: Optional[Dict[str, Any]] = None)
Definition: TransitionInput
MCPQueryRequest
dataclass
MCPQueryRequest(*, jsonrpc: Optional[str] = None, id: Optional[str] = None, method: Optional[str] = None, params: Optional[Dict[str, Any]] = None, result: Optional[Dict[str, Any]] = None, error: Optional[Dict[str, Any]] = None, callback_endpoint: Optional[str] = None)
Definition: MCPQueryRequest
JiraClient
JiraClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for jira connector.
Initialize a JiraClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
list_resources
list_resources(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get list of Resources
This operation returns a list of resources accessible to user.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListResources.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issues
list_issues(*, jql: Optional[str] = None, fields: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get list of issues
This operation returns a list of issues using JQL.
Returns an Azure Core pager that follows opaque continuation tokens. Resume with by_page(continuation_token=...).
Swagger operation ID: ListIssues.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
jql
|
Optional[str]
|
The JQL query used to search for issues. If left blank, returns all issues created in the last 10 years. |
None
|
fields
|
Optional[str]
|
Optional comma-separated list of Jira field IDs or keys to return, for example summary,status,attachment. For custom fields, use the field ID, such as customfield_10042. Also supports *all, *navigable, and exclusions such as *all,-attachment. If omitted, all fields are returned. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issues_datacenter
list_issues_datacenter(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get list of issues (Datacenter)
This operation returns a list of issues using JQL.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListIssues_Datacenter.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_transitions
list_transitions(issue_id_or_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get list of Transitions
Returns a list of the transitions possible for this issue by the current user
Returns a single-page Azure Core async collection.
Swagger operation ID: ListTransitions.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
issue_id_or_key
|
str
|
ID or key of the issue to retrieve transitions for. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_transition
async
update_transition(input: TransitionInput | Mapping[str, Any], issue_id_or_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Performs an issue transition
Transitions an issue to a new status.
Swagger operation ID: UpdateTransition.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TransitionInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
issue_id_or_key
|
str
|
ID or key of the issue to be transitioned. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_current_user
async
get_current_user(*, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get current user
This operation returns details for the current user
Swagger operation ID: GetCurrentUser.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
expand
|
Optional[str]
|
Use expand to include additional information about users in
the response. This parameter accepts a comma-separated list.
Expand options include: * |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
mcp_jira_issue_management
async
mcp_jira_issue_management(input: MCPQueryRequest | Mapping[str, Any], *, session_id: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Jira MCP Server
Jira MCP Server
Swagger operation ID: mcp_JiraIssueManagement.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MCPQueryRequest | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
session_id
|
Optional[str]
|
sessionId. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
add_comment
async
add_comment(input: Comment | Mapping[str, Any], issue_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Add comment
This operation is used to add a comment to an existing Jira issue.
Swagger operation ID: AddComment_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
Comment | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
issue_key
|
str
|
Unique Key of the issue to add a comment to. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
cancel_task
async
cancel_task(task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Cancel Task
Cancels a task. Permissions required: either of: Administer Jira or Creator of the task.
Swagger operation ID: CancelTask_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The ID of the task. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_issue
async
create_issue(input: CreateIssueInput | Mapping[str, Any], project_key: str, issue_type_ids: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a new issue
This operation is used to create a new issue.
Swagger operation ID: CreateIssue_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateIssueInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
project_key
|
str
|
Pick a project to create the issue in. |
required |
issue_type_ids
|
str
|
Pick an issue type. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_project
async
create_project(input: CreateProjectInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create a new project
This operation is used to create a new Jira project.
Swagger operation ID: CreateProject_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateProjectInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_project_category
async
create_project_category(input: CreateProjectCategoryInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Project Category
Creates a project category. Permissions required: Administer Jira (global permissions)
Swagger operation ID: CreateProjectCategory_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateProjectCategoryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
delete_project
async
delete_project(project_id_or_key: str, *, enable_undo: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Delete Project
Deletes a project. Permissions required: Administer Jira (global permissions)
Swagger operation ID: DeleteProject_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_id_or_key
|
str
|
The project ID or project key (case sensitive). |
required |
enable_undo
|
Optional[bool]
|
Whether this project is placed in the Jira recycle bin where it will be available for restoration. |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
edit_issue
async
edit_issue(input: EditIssueInput | Mapping[str, Any], issue_id_or_key: str, *, notify_users: Optional[bool] = None, override_screen_security: Optional[bool] = None, override_editable_flag: Optional[bool] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Edit Issue
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue's fields are defined using update and fields.
Swagger operation ID: EditIssue_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
EditIssueInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
issue_id_or_key
|
str
|
Provide the Issue ID or Key for the issue you wish to edit. |
required |
notify_users
|
Optional[bool]
|
Do you want to notify users? |
None
|
override_screen_security
|
Optional[bool]
|
Do you want to override the screen security? |
None
|
override_editable_flag
|
Optional[bool]
|
Do you want to override the editable flag? |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_all_project_categories
list_all_project_categories(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get All Project Categories
Returns all project categories.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetAllProjectCategories_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_issue
async
get_issue(issue_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get issue by key
This operation is used to retrieve the issue object for a given issue Key.
Swagger operation ID: GetIssue_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
issue_key
|
str
|
Unique Key of the issue. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_task
async
get_task(task_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Task
Returns the status of a long-running asynchronous task. When a task has finished, this operation returns the JSON blob applicable to the task.
Swagger operation ID: GetTask_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
task_id
|
str
|
The ID of the task. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_user
async
get_user(account_id: str, *, expand: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get User
Returns a user. Permissions required: Browse users and groups.
Swagger operation ID: GetUser_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
account_id
|
str
|
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
required |
expand
|
Optional[str]
|
Use expand to include additional information about users in
the response. This parameter accepts a comma-separated list.
Expand options include: * |
None
|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_filters
list_filters(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get list of Filters
This operation returns a list of Filters accessible to user.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListFilters_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_projects
list_projects(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get projects
This operation is used to retrieve a list of projects for your Jira instance.
Returns an Azure Core async pager that follows the connector continuation URL.
Swagger operation ID: ListProjects_V3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_project_users
list_project_users(project_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List users by project
This operation is used to retrieve a list of all users associated with a project.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListProjectUsers_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_key
|
str
|
Unique key of the project. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
remove_project_category
async
remove_project_category(id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Remove Project Category
Deletes a project category. Permissions required: Administer Jira (global permissions)
Swagger operation ID: RemoveProjectCategory_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
int
|
ID of the project category to delete. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
update_project
async
update_project(input: UpdateProjectInput | Mapping[str, Any], project_id_or_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Update Project
Updates the project details of a project.
Swagger operation ID: UpdateProject_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateProjectInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
project_id_or_key
|
str
|
Provide the project ID or Key you want to update1. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issue_types
list_issue_types(project_key: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get issue types
This operation is used to retrieve a list of issue types for a given project.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListIssueTypes_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_key
|
str
|
Project. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
list_issue_types_fields
list_issue_types_fields(project_key: str, issuetype_ids: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
Get issue types fields
This operation is used to retrieve a list of fields for a specific issue type.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListIssueTypesFields_V2.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project_key
|
str
|
Project. |
required |
issuetype_ids
|
str
|
Issue Types. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |