brk-code

atlassian-python-api の API リファレンス

atlassian-python-api (atlassian-api/atlassian-python-api) の公開 API 400 件 —— クラス 46、関数 2、メソッド 352。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

リポジトリ: atlassian-api/atlassian-python-api

種別件数
クラス46
関数2
メソッド352

API 一覧

classatlassian.assets.AssetsCloud
Assets for Jira API wrapper.
methodatlassian.assets.AssetsCloud.delete_object_schema(schema_id)
Delete a schema
methodatlassian.assets.AssetsCloud.update_object_schema(schema_id)
Update an object schema
classatlassian.bamboo.Bamboo
Private methods
methodatlassian.bamboo.Bamboo.agent_is_online(agent_id)
Get agent online status.
methodatlassian.bamboo.Bamboo.agent_status(online=False)
Provides a list of all agents.
methodatlassian.bamboo.Bamboo.create_group(group_name)
Create a new group.
methodatlassian.bamboo.Bamboo.delete_plan(plan_key)
Marks plan for deletion.
methodatlassian.bamboo.Bamboo.delete_project(project_key)
Marks project for deletion.
methodatlassian.bamboo.Bamboo.disable_plan(plan_key)
Disable plan.
methodatlassian.bamboo.Bamboo.enable_plan(plan_key)
Enable plan.
methodatlassian.bamboo.Bamboo.get_plan(plan_key, expand=None)
Get plan information.
methodatlassian.bamboo.Bamboo.stop_reindex()
Kicks off a reindex.
classatlassian.bitbucket.MergeStrategy
Merge strategies used by the merge_pull_request method.
classatlassian.bitbucket.cloud.Cloud
Bitbucket Cloud REST API wrapper
methodatlassian.bitbucket.cloud.common.builds.Build.created_on()
Time of creation.
methodatlassian.bitbucket.cloud.common.builds.Build.description()
Build description.
methodatlassian.bitbucket.cloud.common.builds.Build.failed()
True if the build failed.
methodatlassian.bitbucket.cloud.common.builds.Build.key()
Key of the build.
methodatlassian.bitbucket.cloud.common.builds.Build.name()
Name of the build.
methodatlassian.bitbucket.cloud.common.builds.Build.refname()
Return the refname.
methodatlassian.bitbucket.cloud.common.builds.Build.update(**kwargs)
Update build status.
methodatlassian.bitbucket.cloud.common.builds.Build.updated_on()
Time of last update.
methodatlassian.bitbucket.cloud.common.comments.Comment.delete()
Delete the comment.
methodatlassian.bitbucket.cloud.common.comments.Comment.html()
The html comment.
methodatlassian.bitbucket.cloud.common.comments.Comment.markup()
The markup type.
methodatlassian.bitbucket.cloud.common.comments.Comment.raw()
The raw comment.
methodatlassian.bitbucket.cloud.repositories.Repository.branches()
The repository branches.
methodatlassian.bitbucket.cloud.repositories.Repository.commits()
The repository commits.
methodatlassian.bitbucket.cloud.repositories.Repository.delete(redirect_to=None)
Delete the repostory.
methodatlassian.bitbucket.cloud.repositories.Repository.downloads()
The repository downloads
methodatlassian.bitbucket.cloud.repositories.Repository.get_avatar()
The repository avatar
methodatlassian.bitbucket.cloud.repositories.Repository.hooks()
The repository hooks.
methodatlassian.bitbucket.cloud.repositories.Repository.issues()
The repository issues
methodatlassian.bitbucket.cloud.repositories.Repository.name()
The repository name
methodatlassian.bitbucket.cloud.repositories.Repository.pipelines()
The repository pipelines
methodatlassian.bitbucket.cloud.repositories.Repository.size()
The repository size
methodatlassian.bitbucket.cloud.repositories.Repository.slug()
The repository slug
methodatlassian.bitbucket.cloud.repositories.Repository.tags()
The repository tags.
methodatlassian.bitbucket.cloud.repositories.Repository.uuid()
The repository uuid
classatlassian.bitbucket.cloud.repositories.commits.Commit
Bitbucket Cloud commit endpoint.
methodatlassian.bitbucket.cloud.repositories.commits.Commit.approve()
Approve a commit.
methodatlassian.bitbucket.cloud.repositories.commits.Commit.date()
Commit date.
methodatlassian.bitbucket.cloud.repositories.commits.Commit.hash()
Commit id.
methodatlassian.bitbucket.cloud.repositories.commits.Commit.message()
Commit message.
methodatlassian.bitbucket.cloud.repositories.commits.Commit.unapprove()
Unapprove a commit.
classatlassian.bitbucket.cloud.repositories.commits.Commits
Bitbucket Cloud commits.
classatlassian.bitbucket.cloud.repositories.diffstat.CommitFile
Bitbucket Cloud repository diffstat file.
classatlassian.bitbucket.cloud.repositories.diffstat.DiffStat
Bitbucket Cloud repository diffstat entry.
methodatlassian.bitbucket.cloud.repositories.diffstat.DiffStat.lines_added()
Lines added.
methodatlassian.bitbucket.cloud.repositories.diffstat.DiffStat.lines_removed()
Lines removed.
methodatlassian.bitbucket.cloud.repositories.downloads.Download.get_content()
Download file content
methodatlassian.bitbucket.cloud.repositories.downloads.Download.links()
The download links
methodatlassian.bitbucket.cloud.repositories.downloads.Download.name()
The download file name
classatlassian.bitbucket.cloud.repositories.hooks.Hook
Bitbucket Cloud hook endpoint.
methodatlassian.bitbucket.cloud.repositories.hooks.Hook.active()
is webhook active?
methodatlassian.bitbucket.cloud.repositories.hooks.Hook.delete()
Delete the webhook.
methodatlassian.bitbucket.cloud.repositories.hooks.Hook.description()
webhook description.
methodatlassian.bitbucket.cloud.repositories.hooks.Hook.uuid()
hook uuid.
methodatlassian.bitbucket.cloud.repositories.hooks.Hook.webhook_url()
webhook url.
classatlassian.bitbucket.cloud.repositories.hooks.Hooks
Bitbucket Cloud webhooks.
methodatlassian.bitbucket.cloud.repositories.issues.Issue.content()
The issue content
methodatlassian.bitbucket.cloud.repositories.issues.Issue.created_on()
The issue creation time
methodatlassian.bitbucket.cloud.repositories.issues.Issue.delete()
Delete the issue.
methodatlassian.bitbucket.cloud.repositories.issues.Issue.edited_on()
The issue edit time
methodatlassian.bitbucket.cloud.repositories.issues.Issue.id()
The issue id
methodatlassian.bitbucket.cloud.repositories.issues.Issue.kind()
The issue kind
methodatlassian.bitbucket.cloud.repositories.issues.Issue.priority()
The issue priority
methodatlassian.bitbucket.cloud.repositories.issues.Issue.state()
The issue state
methodatlassian.bitbucket.cloud.repositories.issues.Issue.title()
The issue title
methodatlassian.bitbucket.cloud.repositories.issues.Issue.votes()
The issue votes
methodatlassian.bitbucket.cloud.repositories.pipelines.Pipeline.steps()
Get the pipeline steps.
methodatlassian.bitbucket.cloud.repositories.pipelines.Pipeline.uuid()
The pipeline uuid
methodatlassian.bitbucket.cloud.repositories.pipelines.Step.completed_on()
The step end time
methodatlassian.bitbucket.cloud.repositories.pipelines.Step.run_number()
The run number
methodatlassian.bitbucket.cloud.repositories.pipelines.Step.started_on()
The step start time
methodatlassian.bitbucket.cloud.repositories.pipelines.Step.state()
The step state
methodatlassian.bitbucket.cloud.repositories.pipelines.Step.uuid()
The step uuid
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.comment_count()
number of comments
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.created_on()
time of creation
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.id()
unique pull request id
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.source_branch()
source branch
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.source_commit()
Source commit.
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.task_count()
number of tasks
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.title()
pull request title
methodatlassian.bitbucket.cloud.repositories.pullRequests.PullRequest.updated_on()
time of last update
classatlassian.bitbucket.cloud.repositories.pullRequests.PullRequests
Bitbucket Cloud pull requests
methodatlassian.bitbucket.cloud.repositories.pullRequests.Task.created_on()
time of creation
methodatlassian.bitbucket.cloud.repositories.pullRequests.Task.description()
The task description.
methodatlassian.bitbucket.cloud.repositories.pullRequests.Task.id()
Task id.
methodatlassian.bitbucket.cloud.repositories.pullRequests.Task.resolved_on()
resolve timestamp
classatlassian.bitbucket.cloud.repositories.refs.Branch
Bitbucket Cloud branch endpoint.
methodatlassian.bitbucket.cloud.repositories.refs.Branch.author()
User object of the author.
classatlassian.bitbucket.cloud.repositories.refs.Branches
BitBucket Cloud branches endpoint.
classatlassian.bitbucket.cloud.repositories.refs.Ref
Base object for individual refs.
methodatlassian.bitbucket.cloud.repositories.refs.Ref.hash()
Commit hash.
methodatlassian.bitbucket.cloud.repositories.refs.Ref.name()
Ref name.
classatlassian.bitbucket.cloud.repositories.refs.Refs
Bitbucket Cloud Refs.
classatlassian.bitbucket.cloud.repositories.refs.Tag
Bitbucket Cloud tags endpoint.
methodatlassian.bitbucket.cloud.repositories.refs.Tag.author()
User object of the author.
classatlassian.bitbucket.cloud.repositories.refs.Tags
BitBucket Cloud tags endpoint.
methodatlassian.bitbucket.cloud.workspaces.Workspace.get_avatar()
The project avatar
methodatlassian.bitbucket.cloud.workspaces.Workspace.is_private()
The workspace private flag
methodatlassian.bitbucket.cloud.workspaces.Workspace.members()
The workspace members
methodatlassian.bitbucket.cloud.workspaces.Workspace.name()
The workspace name
methodatlassian.bitbucket.cloud.workspaces.Workspace.projects()
The workspace projects
methodatlassian.bitbucket.cloud.workspaces.Workspace.slug()
The workspace slug
methodatlassian.bitbucket.cloud.workspaces.Workspace.uuid()
The workspace uuid
methodatlassian.bitbucket.cloud.workspaces.projects.Project.delete()
Delete the project.
methodatlassian.bitbucket.cloud.workspaces.projects.Project.description()
The project description
methodatlassian.bitbucket.cloud.workspaces.projects.Project.get_avatar()
The project avatar
methodatlassian.bitbucket.cloud.workspaces.projects.Project.key()
The project key
methodatlassian.bitbucket.cloud.workspaces.projects.Project.name()
The project name
methodatlassian.bitbucket.server.common.permissions.Group.name()
The name of the group
methodatlassian.bitbucket.server.common.permissions.Permissions.each(filter=None)
Get all groups/users.
methodatlassian.bitbucket.server.common.permissions.User.email()
The email of the user
methodatlassian.bitbucket.server.common.permissions.User.id()
The id of the user
methodatlassian.bitbucket.server.common.permissions.User.name()
The name of the user
methodatlassian.bitbucket.server.common.permissions.User.slug()
The slug of the user
methodatlassian.bitbucket.server.projects.Project.delete()
Delete the project.
methodatlassian.bitbucket.server.projects.Project.description()
The project description
methodatlassian.bitbucket.server.projects.Project.get_avatar(s=0)
Get the avatar.
methodatlassian.bitbucket.server.projects.Project.id()
The project identifier
methodatlassian.bitbucket.server.projects.Project.key()
The project key
methodatlassian.bitbucket.server.projects.Project.name()
The project name
methodatlassian.bitbucket.server.projects.Project.public()
The project public flag
methodatlassian.bitbucket.server.projects.Project.set_avatar(avatar)
Set the avatar.
methodatlassian.bitbucket.server.projects.Project.type()
The project type
methodatlassian.bitbucket.server.projects.Projects.exists(project, by='key')
Check if project exist.
methodatlassian.bitbucket.server.projects.repos.Repository.delete()
Delete the repostory.
methodatlassian.bitbucket.server.projects.repos.Repository.forks()
Get all forks.
methodatlassian.bitbucket.server.projects.repos.Repository.id()
The repository identifier
methodatlassian.bitbucket.server.projects.repos.Repository.name()
The repository name
methodatlassian.bitbucket.server.projects.repos.Repository.readme(at=None, markup=None)
Get the readme file.
methodatlassian.bitbucket.server.projects.repos.Repository.slug()
The repository slug
classatlassian.confluence.Confluence
Legacy Confluence class for backward compatibility.
classatlassian.confluence.base.ConfluenceBase
Base class for Confluence API operations.
methodatlassian.confluence.base.ConfluenceBase.data()
Get the internal cached data.
methodatlassian.confluence.base.ConfluenceBase.get_link(link)
Get a link from the data.
classatlassian.confluence.cloud.Cloud
Confluence Cloud REST API wrapper
methodatlassian.confluence.cloud.Cloud.add_content_labels(content_id, data, **kwargs)
Add labels to content.
methodatlassian.confluence.cloud.Cloud.create_attachment(content_id, data, **kwargs)
Create new attachment.
methodatlassian.confluence.cloud.Cloud.create_comment(content_id, data, **kwargs)
Create new comment.
methodatlassian.confluence.cloud.Cloud.create_content(data, **kwargs)
Create new content.
methodatlassian.confluence.cloud.Cloud.create_space(data, **kwargs)
Create new space.
methodatlassian.confluence.cloud.Cloud.delete_attachment(attachment_id, **kwargs)
Delete attachment.
methodatlassian.confluence.cloud.Cloud.delete_comment(comment_id, **kwargs)
Delete comment.
methodatlassian.confluence.cloud.Cloud.delete_content(content_id, **kwargs)
Delete content.
methodatlassian.confluence.cloud.Cloud.delete_space(space_id, **kwargs)
Delete space.
methodatlassian.confluence.cloud.Cloud.export_content(content_id, **kwargs)
Export content.
methodatlassian.confluence.cloud.Cloud.export_space(space_id, **kwargs)
Export space.
methodatlassian.confluence.cloud.Cloud.get_attachment(attachment_id, **kwargs)
Get attachment by ID.
methodatlassian.confluence.cloud.Cloud.get_attachments(content_id, **kwargs)
Get content attachments.
methodatlassian.confluence.cloud.Cloud.get_comment(comment_id, **kwargs)
Get comment by ID.
methodatlassian.confluence.cloud.Cloud.get_comments(content_id, **kwargs)
Get content comments.
methodatlassian.confluence.cloud.Cloud.get_content(content_id, **kwargs)
Get content by ID.
methodatlassian.confluence.cloud.Cloud.get_content_analytics(content_id, **kwargs)
Get content analytics.
methodatlassian.confluence.cloud.Cloud.get_content_ancestors(content_id, **kwargs)
Get ancestor content.
methodatlassian.confluence.cloud.Cloud.get_content_children(content_id, **kwargs)
Get child content.
methodatlassian.confluence.cloud.Cloud.get_content_labels(content_id, **kwargs)
Get content labels.
methodatlassian.confluence.cloud.Cloud.get_current_user(**kwargs)
Get current user.
methodatlassian.confluence.cloud.Cloud.get_group(group_id, **kwargs)
Get group by ID.
methodatlassian.confluence.cloud.Cloud.get_group_members(group_id, **kwargs)
Get group members.
methodatlassian.confluence.cloud.Cloud.get_groups(**kwargs)
Get all groups.
methodatlassian.confluence.cloud.Cloud.get_health(**kwargs)
Get API health status.
methodatlassian.confluence.cloud.Cloud.get_labels(**kwargs)
Get all labels.
methodatlassian.confluence.cloud.Cloud.get_metadata(**kwargs)
Get API metadata.
methodatlassian.confluence.cloud.Cloud.get_space(space_id, **kwargs)
Get space by ID.
methodatlassian.confluence.cloud.Cloud.get_space_analytics(space_id, **kwargs)
Get space analytics.
methodatlassian.confluence.cloud.Cloud.get_space_content(space_id, **kwargs)
Get space content.
methodatlassian.confluence.cloud.Cloud.get_template(template_id, **kwargs)
Get template by ID.
methodatlassian.confluence.cloud.Cloud.get_templates(**kwargs)
Get all templates.
methodatlassian.confluence.cloud.Cloud.get_user(user_id, **kwargs)
Get user by ID.
methodatlassian.confluence.cloud.Cloud.get_users(**kwargs)
Get all users.
methodatlassian.confluence.cloud.Cloud.search_content(query, **kwargs)
Search content.
methodatlassian.confluence.cloud.Cloud.search_spaces(query, **kwargs)
Search spaces.
methodatlassian.confluence.cloud.Cloud.update_comment(comment_id, data, **kwargs)
Update existing comment.
methodatlassian.confluence.cloud.Cloud.update_content(content_id, data, **kwargs)
Update existing content.
methodatlassian.confluence.cloud.Cloud.update_space(space_id, data, **kwargs)
Update existing space.
classatlassian.confluence.cloud.base.ConfluenceCloudBase
Base class for Confluence Cloud API operations.
classatlassian.confluence.server.Server
Confluence Server REST API wrapper
methodatlassian.confluence.server.Server.create_attachment(content_id, data, **kwargs)
Create new attachment.
methodatlassian.confluence.server.Server.create_comment(content_id, data, **kwargs)
Create new comment.
methodatlassian.confluence.server.Server.create_content(data, **kwargs)
Create new content.
methodatlassian.confluence.server.Server.create_space(space_key, space_name=None, **kwargs)
Create space.
methodatlassian.confluence.server.Server.delete_comment(comment_id, **kwargs)
Delete comment.
methodatlassian.confluence.server.Server.delete_content(content_id, **kwargs)
Delete content.
methodatlassian.confluence.server.Server.download_attachment(attachment_id, **kwargs)
Download attachment.
methodatlassian.confluence.server.Server.export_content(content_id, **kwargs)
Export content.
methodatlassian.confluence.server.Server.export_space(space_key, **kwargs)
Export space.
methodatlassian.confluence.server.Server.get_attachment(attachment_id, **kwargs)
Get attachment by ID.
methodatlassian.confluence.server.Server.get_attachments(content_id, **kwargs)
Get content attachments.
methodatlassian.confluence.server.Server.get_comment(comment_id, **kwargs)
Get comment by ID.
methodatlassian.confluence.server.Server.get_comments(content_id, **kwargs)
Get content comments.
methodatlassian.confluence.server.Server.get_content(content_id, **kwargs)
Get content by ID.
methodatlassian.confluence.server.Server.get_content_ancestors(content_id, **kwargs)
Get ancestor content.
methodatlassian.confluence.server.Server.get_content_children(content_id, **kwargs)
Get child content.
methodatlassian.confluence.server.Server.get_content_labels(content_id, **kwargs)
Get content labels.
methodatlassian.confluence.server.Server.get_content_template(template_id)
Get a content template.
methodatlassian.confluence.server.Server.get_current_user(**kwargs)
Get current user.
methodatlassian.confluence.server.Server.get_draft_content(content_id, **kwargs)
Get draft content.
methodatlassian.confluence.server.Server.get_group(group_name, **kwargs)
Get group by name.
methodatlassian.confluence.server.Server.get_groups(**kwargs)
Get all groups.
methodatlassian.confluence.server.Server.get_health(**kwargs)
Get API health status.
methodatlassian.confluence.server.Server.get_labels(**kwargs)
Get all labels.
methodatlassian.confluence.server.Server.get_metadata(**kwargs)
Get API metadata.
methodatlassian.confluence.server.Server.get_page_space(page_id)
Get space key from page ID.
methodatlassian.confluence.server.Server.get_reindex_progress(**kwargs)
Get reindex progress.
methodatlassian.confluence.server.Server.get_space_permissions(space_key, **kwargs)
Get space permissions.
methodatlassian.confluence.server.Server.get_space_settings(space_key, **kwargs)
Get space settings.
methodatlassian.confluence.server.Server.get_spaces(**kwargs)
Get all spaces.
methodatlassian.confluence.server.Server.get_template(template_id, **kwargs)
Get template by ID.
methodatlassian.confluence.server.Server.get_template_by_id(template_id)
Get user template by id.
methodatlassian.confluence.server.Server.get_templates(**kwargs)
Get all templates.
methodatlassian.confluence.server.Server.get_trash_content(space_key, **kwargs)
Get trash content.
methodatlassian.confluence.server.Server.get_user(username, **kwargs)
Get user by username.
methodatlassian.confluence.server.Server.get_user_by_key(user_key, **kwargs)
Get user by key.
methodatlassian.confluence.server.Server.get_users(**kwargs)
Get all users.
methodatlassian.confluence.server.Server.page_exists(space_key, title, **kwargs)
Check if page exists.
methodatlassian.confluence.server.Server.remove_content_history(page_id, version_number)
Remove content history.
methodatlassian.confluence.server.Server.remove_template(template_id)
Deletes a template.
methodatlassian.confluence.server.Server.search_content(query, **kwargs)
Search content using CQL.
methodatlassian.confluence.server.Server.search_spaces(query, **kwargs)
Search spaces.
methodatlassian.confluence.server.Server.synchrony_disable()
Disable Synchrony :return:
methodatlassian.confluence.server.Server.synchrony_enable()
Enable Synchrony :return:
methodatlassian.confluence.server.Server.update_space(space_key, data, **kwargs)
Update existing space.
classatlassian.confluence.server.base.ConfluenceServerBase
Base class for Confluence Server API operations.
classatlassian.crowd.Crowd
Crowd API wrapper.
methodatlassian.crowd.Crowd.group_add_user(username, groupname)
Add user to group :return:
methodatlassian.crowd.Crowd.user_deactivate(username)
Deactivate user :return:
classatlassian.insight.Insight
Insight for Jira API wrapper.
methodatlassian.insight.Insight.delete_object_schema(schema_id)
Delete a schema
methodatlassian.insight.Insight.update_object_schema(schema_id)
Update an object schema
classatlassian.jira.Jira
Provide permission information for the current user.
methodatlassian.jira.Jira.approve_cluster_zdu_upgrade() -> T_resp_json
Approves the cluster upgrade.
methodatlassian.jira.Jira.archive_project(key:str)
Archives a project.
methodatlassian.jira.Jira.assign_issue(issue:T_id, account_id:Optional[str]=None)
Assign an issue to a user.
methodatlassian.jira.Jira.assign_priority_scheme_for_project(project_key_or_id:str, priority_scheme_id:T_id) -> T_resp_json
Assigns project with priority scheme.
methodatlassian.jira.Jira.assign_project_notification_scheme(project_key:str, new_notification_scheme:str='')
Updates a project.
methodatlassian.jira.Jira.cancel_cluster_zdu_upgrade() -> T_resp_json
Cancels the ongoing cluster upgrade.
methodatlassian.jira.Jira.create_issue_link(data:dict) -> T_resp_json
Creates an issue link between two issues.
methodatlassian.jira.Jira.create_issue_link_type(link_type_name:str, inward:str, outward:str) -> Union[T_resp_json, str]
Create a new issue link type.
methodatlassian.jira.Jira.create_issue_link_type_by_json(data:dict) -> T_resp_json
Create a new issue link type.
methodatlassian.jira.Jira.create_priority_scheme(data:dict) -> T_resp_json
Creates new priority scheme.
methodatlassian.jira.Jira.create_project_from_raw_json(json:Union[str, dict])
Creates a new project.
methodatlassian.jira.Jira.create_sprint(name:str, board_id:T_id, start_date:Optional[str]=None, end_date:Optional[str]=None, goal:Optional[str]=None) -> T_resp_json
Create a sprint within a board.
methodatlassian.jira.Jira.delete_agile_board(board_id:T_id) -> T_resp_json
Delete agile board by id :param board_id: :return:
methodatlassian.jira.Jira.delete_filter(filter_id:T_id)
Deletes a filter that has the given id.
methodatlassian.jira.Jira.delete_issue_link_type(issue_link_type_id:T_id) -> T_resp_json
Delete the specified issue link type.
methodatlassian.jira.Jira.delete_plugin(plugin_key:str) -> T_resp_json
Delete plugin :param plugin_key: :return:
methodatlassian.jira.Jira.delete_sprint(sprint_id:T_id) -> T_resp_json
Deletes a sprint.
methodatlassian.jira.Jira.disable_plugin(plugin_key:str) -> T_resp_json
Disable a plugin :param plugin_key: :return:
methodatlassian.jira.Jira.download_attachments_from_issue(issue:T_id, path:Optional[str]=None, cloud:bool=True) -> Optional[str]
Downloads all attachments from a Jira issue.
methodatlassian.jira.Jira.dvcs_get_linked_repos() -> T_resp_json
Get DVCS linked repos :return:
methodatlassian.jira.Jira.enable_plugin(plugin_key:str) -> T_resp_json
Enable a plugin :param plugin_key: :return:
methodatlassian.jira.Jira.get_agile_board(board_id:T_id) -> T_resp_json
Get agile board info by id :param board_id: :return:
methodatlassian.jira.Jira.get_agile_board_configuration(board_id:T_id) -> T_resp_json
Get the board configuration.
methodatlassian.jira.Jira.get_agile_board_refined_velocity(board_id:T_id) -> T_resp_json
Returns the estimation statistic settings of the board.
methodatlassian.jira.Jira.get_all_agile_boards(board_name:Optional[str]=None, project_key:Optional[str]=None, board_type:Optional[str]=None, start:int=0, limit:int=50) -> T_resp_json
Returns all boards.
methodatlassian.jira.Jira.get_all_global_project_roles() -> T_resp_json
Get all the ProjectRoles available in Jira.
methodatlassian.jira.Jira.get_all_priorities() -> T_resp_json
Returns a list of all priorities.
methodatlassian.jira.Jira.get_all_priority_schemes(start:int=0, limit:int=100, expand:Optional[str]=None) -> T_resp_json
Returns all priority schemes.
methodatlassian.jira.Jira.get_all_resolutions() -> T_resp_json
Returns a list of all resolutions.
methodatlassian.jira.Jira.get_all_screen_fields(screen_id:T_id) -> list
Get all fields by screen id :param screen_id: :return:
methodatlassian.jira.Jira.get_all_statuses() -> T_resp_json
Returns a list of all statuses :return:
methodatlassian.jira.Jira.get_all_system_avatars(avatar_type:str='user') -> T_resp_json
Returns all system avatars of the given type.
methodatlassian.jira.Jira.get_all_time_tracking_providers() -> T_resp_json
Returns all time tracking providers.
methodatlassian.jira.Jira.get_cluster_all_nodes() -> T_resp_json
Get all nodes in the cluster :return:
methodatlassian.jira.Jira.get_cluster_zdu_state() -> T_resp_json
Get the state of the cluster upgrade.
methodatlassian.jira.Jira.get_component_related_issues(component_id:T_id) -> T_resp_json
Returns counts of issues related to this component.
methodatlassian.jira.Jira.get_custom_fields(search:Optional[str]=None, start:int=1, limit:int=50) -> T_resp_json
Get custom fields.
methodatlassian.jira.Jira.get_filter_share_permissions(filter_id:T_id)
Gets share permissions of a filter.
methodatlassian.jira.Jira.get_issue_labels(issue_key:str) -> T_resp_json
Get issue labels.
methodatlassian.jira.Jira.get_issue_link(link_id:T_id) -> T_resp_json
Returns an issue link with the specified id.
methodatlassian.jira.Jira.get_issue_link_types_names() -> list
Provide issue link type names :return:
methodatlassian.jira.Jira.get_issue_property_keys(issue_key:str)
Get Property Keys on an Issue.
methodatlassian.jira.Jira.get_issue_types()
Return all issue types
methodatlassian.jira.Jira.get_permissionscheme(permission_id:T_id, expand:Optional[str]=None) -> T_resp_json
Returns a list of all permission schemes.
methodatlassian.jira.Jira.get_plugin_info(plugin_key:str) -> T_resp_json
Provide plugin info :return a json of installed plugins
methodatlassian.jira.Jira.get_priority_by_id(priority_id:T_id) -> T_resp_json
Get Priority info by id :param priority_id: :return:
methodatlassian.jira.Jira.get_project_validated_key(key:str) -> T_resp_json
Validates a project key.
methodatlassian.jira.Jira.get_resolution_by_id(resolution_id:T_id) -> T_resp_json
Get Resolution info by id :param resolution_id: :return:
methodatlassian.jira.Jira.get_screen_tabs(screen_id:T_id) -> Optional[list]
Get tabs for the screen id :param screen_id: :return:
methodatlassian.jira.Jira.get_server_info(do_health_check:bool=False) -> T_resp_json
Returns general information about the current Jira server.
methodatlassian.jira.Jira.get_sprint(sprint_id:T_id) -> T_resp_json
Returns the sprint for a given sprint ID.
methodatlassian.jira.Jira.get_sprint_issues(sprint_id:T_id, start:T_id, limit:T_id) -> T_resp_json
Returns all issues in a sprint, for a given sprint ID.
methodatlassian.jira.Jira.get_time_tracking_settings() -> T_resp_json
Returns the time tracking settings.
methodatlassian.jira.Jira.get_version(version:T_id)
Returns a specific version with the given id.
methodatlassian.jira.Jira.health_check() -> T_resp_json
Get health status of Jira.
methodatlassian.jira.Jira.index_checker(max_results:int=100) -> T_resp_json
Jira DC Index health checker :param max_results: :return:
methodatlassian.jira.Jira.issue_add_json_worklog(key:str, worklog:Union[dict, str])
:param key: :param worklog: :return:
methodatlassian.jira.Jira.issue_archive(issue_id_or_key:str, notify_users:Optional[bool]=None)
Archives an issue.
methodatlassian.jira.Jira.issue_createmeta(project:str, expand:str='projects.issuetypes.fields') -> T_resp_json
This function is deprecated.
methodatlassian.jira.Jira.issue_get_comments(issue_id:T_id) -> T_resp_json
Get Comments on an Issue.
methodatlassian.jira.Jira.issue_get_worklog(issue_id_or_key:str)
Returns all work logs for an issue.
methodatlassian.jira.Jira.issue_restore(issue_id_or_key:str)
Restores an archived issue.
methodatlassian.jira.Jira.match_jql(issue_ids:List[int], jqls:List[str]) -> Optional[Dict[Any, Any]]
Checks which issues match a list of JQL queries.
methodatlassian.jira.Jira.reindex_issue(issue_ids:list) -> T_resp_json
Reindex specific issues by their IDs.
methodatlassian.jira.Jira.reindex_status() -> T_resp_json
Returns information on the system reindexes.
methodatlassian.jira.Jira.remove_issue_link(link_id:T_id) -> T_resp_json
Deletes an issue link with the specified id.
methodatlassian.jira.Jira.retry_cluster_zdu_upgrade() -> T_resp_json
Retries the cluster upgrade.
methodatlassian.jira.Jira.set_agile_board_property(board_id:T_id, property_key:str) -> T_resp_json
Sets the value of the specified board's property.
methodatlassian.jira.Jira.set_agile_board_refined_velocity(board_id:T_id, data:dict) -> T_resp_json
Sets the estimation statistic settings of the board.
methodatlassian.jira.Jira.set_permissionscheme_grant(permission_id:T_id, new_permission:str) -> T_resp_json
Creates a permission grant in a permission scheme.
methodatlassian.jira.Jira.set_property(property_id:T_id, value:str) -> T_resp_json
Modify an application property via PUT.
methodatlassian.jira.Jira.start_cluster_zdu_upgrade() -> T_resp_json
Starts the cluster upgrade.
methodatlassian.jira.Jira.tempo_account_delete_account_by_id(account_id:str) -> T_resp_json
Delete an Account by id.
methodatlassian.jira.Jira.tempo_account_delete_customer_by_id(customer_id:T_id=1) -> T_resp_json
Delete an Attribute.
methodatlassian.jira.Jira.tempo_account_get_accounts_by_jira_project(project_id:T_id) -> T_resp_json
Get Accounts by JIRA Project.
methodatlassian.jira.Jira.tempo_account_get_all_account_by_customer_id(customer_id:T_id) -> T_resp_json
Get un-archived Accounts by customer.
methodatlassian.jira.Jira.tempo_account_get_rate_table_by_account_id(account_id:str) -> T_resp_json
Returns a rate table for the specified account.
methodatlassian.jira.Jira.tempo_account_update_customer_by_id(customer_id:T_id=1, data:Optional[dict]=None) -> Union[T_resp_json, str]
Updates an Attribute.
methodatlassian.jira.Jira.tempo_holiday_get_scheme_info(scheme_id:T_id) -> T_resp_json
Provide a holiday scheme :return:
methodatlassian.jira.Jira.tempo_holiday_get_scheme_members(scheme_id:T_id) -> T_resp_json
Provide a holiday scheme members :return:
methodatlassian.jira.Jira.tempo_holiday_get_schemes() -> T_resp_json
Provide a holiday schemes :return:
methodatlassian.jira.Jira.tempo_holiday_put_into_scheme_member(scheme_id:T_id, username:str) -> T_resp_json
Provide a holiday scheme :return:
methodatlassian.jira.Jira.tempo_teams_get_members(team_id:T_id) -> T_resp_json
Get members from team :param team_id: :return:
methodatlassian.jira.Jira.tempo_timesheets_get_configuration() -> T_resp_json
Provide the configs of timesheets :return:
methodatlassian.jira.Jira.tempo_timesheets_get_team_utilization(team_id:T_id, date_from:str, date_to:Optional[str]=None, group_by:Optional[str]=None) -> T_resp_json
Get team utilization.
methodatlassian.jira.Jira.tempo_timesheets_get_worklogs_by_issue(issue:str) -> T_resp_json
Get Tempo timesheet worklog by issue key or id.
methodatlassian.jira.Jira.update_issue_field(key:T_id, fields:Union[str, dict]='*all', notify_users:bool=True)
Update an issue's fields.
methodatlassian.jira.Jira.update_issue_link_type(issue_link_type_id:T_id, data:dict) -> T_resp_json
Update the specified issue link type.
methodatlassian.jira.Jira.update_partially_sprint(sprint_id:T_id, data:dict) -> T_resp_json
Performs a partial update of a sprint.
methodatlassian.jira.Jira.update_project(project_key:str, data:dict, expand:Optional[str]=None)
Updates a project.
methodatlassian.jira.Jira.update_project_category_for_project(project_key:str, new_project_category_id:T_id, expand:Optional[str]=None)
Updates a project.
methodatlassian.jira.Jira.upload_plugin(plugin_path:str) -> T_resp_json
Provide plugin path for upload into Jira e.g.
methodatlassian.jira.Jira.user(username:Optional[str]=None, key:Optional[str]=None, account_id:Optional[str]=None, expand:Optional[str]=None)
Returns a user.
methodatlassian.jira.Jira.user_deactivate(username:str)
Disable user.
methodatlassian.jira.Jira.user_disable(username:str)
Override the disable method
methodatlassian.jira.Jira.user_update_or_create_property_through_rest_point(username:str, key:str, value:str)
ATTENTION!
methodatlassian.jira.Jira.users_get_all(start:int=0, limit:int=50)
:param start: :param limit: :return:
classatlassian.marketplace.MarketPlace
Marketplace API wrapper.
classatlassian.models.jira.comment.Comment
Represents a Jira issue comment.
classatlassian.models.jira.comment.Visibility
Comment visibility restriction.
classatlassian.models.jira.transition.Transition
Represents a Jira issue status transition.
classatlassian.models.jira.transition.TransitionBuilder
Fluent builder for issue transitions.
classatlassian.models.jira.update.UpdateBuilder
Fluent builder for Jira issue update payloads.
funcatlassian.models.jira.validation.validate(issue:JiraIssue) -> list[ValidationError]
Validate an issue before serialization.
funcatlassian.models.jira.validation.validate_or_raise(issue:JiraIssue) -> None
Validate and raise ValueError if any errors found.
classatlassian.service_desk.ServiceDesk
JIRA ServiceDesk API object
methodatlassian.service_desk.ServiceDesk.create_customer(full_name, email)
Creating customer user.
classatlassian.statuspage.Branding
The main template your statuspage will use
classatlassian.statuspage.Impact
The impact of the incident
classatlassian.statuspage.MetricProviderType
The type of metric provider
classatlassian.statuspage.SortOrder
The order to sort by
classatlassian.statuspage.Status
The status of the incident
classatlassian.statuspage.StatusPage
StatusPage API wrapper.
methodatlassian.statuspage.StatusPage.page_create_incident(page_id, incident)
Create an incident.
methodatlassian.statuspage.StatusPage.page_create_template(page_id, template)
Create a template.
classatlassian.statuspage.SubscriberState
The state of the subscriber
classatlassian.statuspage.SubscriberType
The type of subscriber
classatlassian.statuspage.Transform
The transform to apply to the metric
classatlassian.tempo.cloud.Cloud
Tempo Cloud REST API wrapper
methodatlassian.tempo.cloud.Cloud.add_team_member(team_id, user_id, **kwargs)
Add member to team.
methodatlassian.tempo.cloud.Cloud.create_account(data, **kwargs)
Create a new account.
methodatlassian.tempo.cloud.Cloud.create_activity(data, **kwargs)
Create a new activity.
methodatlassian.tempo.cloud.Cloud.create_customer(data, **kwargs)
Create a new customer.
methodatlassian.tempo.cloud.Cloud.create_holiday(data, **kwargs)
Create a new holiday.
methodatlassian.tempo.cloud.Cloud.create_schedule(data, **kwargs)
Create a new schedule.
methodatlassian.tempo.cloud.Cloud.create_team(data, **kwargs)
Create a new team.
methodatlassian.tempo.cloud.Cloud.create_worklog(data, **kwargs)
Create a new worklog.
methodatlassian.tempo.cloud.Cloud.delete_account(account_id, **kwargs)
Delete an account.
methodatlassian.tempo.cloud.Cloud.delete_activity(activity_id, **kwargs)
Delete an activity.
methodatlassian.tempo.cloud.Cloud.delete_customer(customer_id, **kwargs)
Delete a customer.
methodatlassian.tempo.cloud.Cloud.delete_holiday(holiday_id, **kwargs)
Delete a holiday.
methodatlassian.tempo.cloud.Cloud.delete_schedule(schedule_id, **kwargs)
Delete a schedule.
methodatlassian.tempo.cloud.Cloud.delete_team(team_id, **kwargs)
Delete a team.
methodatlassian.tempo.cloud.Cloud.delete_worklog(worklog_id, **kwargs)
Delete a worklog.
methodatlassian.tempo.cloud.Cloud.generate_report(report_type, params=None, **kwargs)
Generate a report.
methodatlassian.tempo.cloud.Cloud.get_account(account_id, **kwargs)
Get account by ID.
methodatlassian.tempo.cloud.Cloud.get_accounts(**kwargs)
Get all accounts.
methodatlassian.tempo.cloud.Cloud.get_activities(**kwargs)
Get all activities.
methodatlassian.tempo.cloud.Cloud.get_activity(activity_id, **kwargs)
Get activity by ID.
methodatlassian.tempo.cloud.Cloud.get_customer(customer_id, **kwargs)
Get customer by ID.
methodatlassian.tempo.cloud.Cloud.get_customers(**kwargs)
Get all customers.
methodatlassian.tempo.cloud.Cloud.get_health(**kwargs)
Get API health status.
methodatlassian.tempo.cloud.Cloud.get_holiday(holiday_id, **kwargs)
Get holiday by ID.
methodatlassian.tempo.cloud.Cloud.get_holidays(**kwargs)
Get all holidays.
methodatlassian.tempo.cloud.Cloud.get_metadata(**kwargs)
Get API metadata.
methodatlassian.tempo.cloud.Cloud.get_project(project_id, **kwargs)
Get project by ID.
methodatlassian.tempo.cloud.Cloud.get_project_worklogs(project_id, **kwargs)
Get project worklogs.
methodatlassian.tempo.cloud.Cloud.get_projects(**kwargs)
Get all projects.
methodatlassian.tempo.cloud.Cloud.get_schedule(schedule_id, **kwargs)
Get schedule by ID.
methodatlassian.tempo.cloud.Cloud.get_schedules(**kwargs)
Get all schedules.
methodatlassian.tempo.cloud.Cloud.get_team(team_id, **kwargs)
Get team by ID.
methodatlassian.tempo.cloud.Cloud.get_team_members(team_id, **kwargs)
Get team members.
methodatlassian.tempo.cloud.Cloud.get_teams(**kwargs)
Get all teams.
methodatlassian.tempo.cloud.Cloud.get_user(user_id, **kwargs)
Get user by ID.
methodatlassian.tempo.cloud.Cloud.get_user_schedule(user_id, **kwargs)
Get user's schedule.
methodatlassian.tempo.cloud.Cloud.get_user_worklogs(user_id, **kwargs)
Get user's worklogs.
methodatlassian.tempo.cloud.Cloud.get_users(**kwargs)
Get all users.
methodatlassian.tempo.cloud.Cloud.get_worklog(worklog_id, **kwargs)
Get worklog by ID.
methodatlassian.tempo.cloud.Cloud.get_worklogs(**kwargs)
Get all worklogs.
methodatlassian.tempo.cloud.Cloud.remove_team_member(team_id, user_id, **kwargs)
Remove member from team.
methodatlassian.tempo.cloud.Cloud.update_team(team_id, data, **kwargs)
Update an existing team.
classatlassian.tempo.cloud.base.TempoCloudBase
Base class for Tempo Cloud API operations.
classatlassian.tempo.server.Server
Tempo Server REST API wrapper
methodatlassian.tempo.server.Server.get_health(**kwargs)
Get API health status.
methodatlassian.tempo.server.Server.get_metadata(**kwargs)
Get API metadata.
classatlassian.tempo.server.accounts.Accounts
Tempo Server Accounts API client.

この情報について

掲載しているシグネチャは atlassian-api/atlassian-python-api の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・ 型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。 詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る