pybacklogpy package

Submodules

pybacklogpy.Attachment module

class pybacklogpy.Attachment.Attachment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

post_attachment_file(filepath: str, filename: str) → requests.models.Response

添付ファイルの送信 https://developer.nulab.com/ja/docs/backlog/api/2/post-attachment-file/

Parameters

  • filepath – 添付ファイルのパス

  • filename – 任意のファイル名

Returns

レスポンス

pybacklogpy.BacklogConfigure module

class pybacklogpy.BacklogConfigure.BacklogComConfigure(space_key: str, api_key: str)

Bases: pybacklogpy.BacklogConfigure.BacklogConfigure

class pybacklogpy.BacklogConfigure.BacklogConfigure(space_key: str, api_key: str, domain: str)

Bases: object

class pybacklogpy.BacklogConfigure.BacklogJpConfigure(space_key: str, api_key: str)

Bases: pybacklogpy.BacklogConfigure.BacklogConfigure

class pybacklogpy.BacklogConfigure.BacklogToolConfigure(space_key: str, api_key: str)

Bases: pybacklogpy.BacklogConfigure.BacklogConfigure

pybacklogpy.Category module

class pybacklogpy.Category.Category(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_category(project_id_or_key: str, name: str) → requests.models.Response

カテゴリーの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-category/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • name – カテゴリーの名前

Returns

レスポンス

delete_category(project_id_or_key: str, category_id: int) → requests.models.Response

カテゴリーの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-category/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • category_id – カテゴリーのID

Returns

レスポンス

get_category_list(project_id_or_key: str) → requests.models.Response

カテゴリー一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-category-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

update_category(project_id_or_key: str, category_id: int, name: str) → requests.models.Response

カテゴリー情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-category/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • category_id – カテゴリーのID

  • name – カテゴリーの名前

Returns

レスポンス

pybacklogpy.CustomField module

class pybacklogpy.CustomField.CustomField(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_custom_field(project_id_or_key: str, type_id: int, name: str, applicable_issue_types: Optional[List[int]] = None, description: Optional[str] = None, required: Optional[bool] = None, min_num: Optional[int] = None, max_num: Optional[int] = None, min_date: Optional[str] = None, max_date: Optional[str] = None, initial_value: Optional[int] = None, unit: Optional[str] = None, initial_value_type: Optional[int] = None, initial_date: Optional[str] = None, initial_shift: Optional[int] = None, items: List[str] = None, allow_input: Optional[bool] = None, allow_add_item: Optional[bool] = None) → requests.models.Response

カスタム属性の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • type_id – カスタム属性の形式 (1)文字列 (2)文章 (3)数値 (4)日付 (5)単一リスト (6)複数リスト (7)チェックボックス (8)ラジオ

  • name – カスタム属性の名前

  • applicable_issue_types – カスタム属性を有効にする種別ID空の場合、すべての課題種別で有効

  • description – カスタム属性の説明

  • required – 必須な属性とする場合はtrue

  • min_num – 最小値

  • max_num – 最大値

  • min_date – 最小値 (yyyy-MM-dd)

  • max_date – 最大値 (yyyy-MM-dd)

  • initial_value – 初期値

  • unit – 単位

  • initial_value_type – 1:当日 2: 当日 + initialShift 3:指定日

  • initial_date – 初期値 (yyyy-MM-dd)

  • initial_shift – 差分日数

  • items – リスト項目

  • allow_input – その他直接入力を許可

  • allow_add_item – 項目の追加を許可

Returns

レスポンス

delete_custom_field(project_id_or_key: Optional[str] = None, custom_field_id: Optional[int] = None) → requests.models.Response

カスタム属性の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • custom_field_id – カスタム属性のID

Returns

レスポンス

get_custom_field_list(project_id_or_key: Optional[str] = None) → requests.models.Response

カスタム属性一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-custom-field-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

update_custom_field(project_id_or_key: str, custom_field_id: int, name: Optional[str] = None, applicable_issue_types: Optional[List[int]] = None, description: Optional[str] = None, required: Optional[bool] = None, min_num: Optional[int] = None, max_num: Optional[int] = None, min_date: Optional[str] = None, max_date: Optional[str] = None, initial_value: Optional[int] = None, unit: Optional[str] = None, initial_value_type: Optional[int] = None, initial_date: Optional[str] = None, initial_shift: Optional[int] = None, items: Optional[List[str]] = None, allow_input: Optional[bool] = None, allow_add_item: Optional[bool] = None) → requests.models.Response

カスタム属性の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • custom_field_id – カスタム属性のID

  • name – カスタム属性の名前

  • applicable_issue_types – カスタム属性を有効にする種別ID空の場合、すべての課題種別で有効

  • description – カスタム属性の説明

  • required – 必須な属性とする場合はtrue

  • min_num – 最小値

  • max_num – 最大値

  • min_date – 最小値 (yyyy-MM-dd)

  • max_date – 最大値 (yyyy-MM-dd)

  • initial_value – 初期値

  • unit – 単位

  • initial_value_type –

    1. 当日 (2) 当日 + initialShift (3)指定日

  • initial_date – 初期値 (yyyy-MM-dd)

  • initial_shift – 差分日数

  • items – リスト項目

  • allow_input – その他直接入力を許可

  • allow_add_item – 項目の追加を許可

Returns

レスポンス

class pybacklogpy.CustomField.ListTypeCustomField(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_list_item_for_list_type_custom_field(project_id_or_key: Optional[str] = None, custom_field_id: Optional[int] = None, name: Optional[str] = None) → requests.models.Response

選択リストカスタム属性のリスト項目の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-list-item-for-list-type-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • custom_field_id – カスタム属性のID

  • name – リスト項目の名前

Returns

レスポンス

delete_list_item_for_list_type_custom_field(project_id_or_key: str, custom_field_id: int, item_id: int) → requests.models.Response

選択リストカスタム属性のリスト項目の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-list-item-for-list-type-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • custom_field_id – カスタム属性のID

  • item_id – リスト項目のID

Returns

レスポンス

update_list_item_for_list_type_custom_field(project_id_or_key: Optional[str] = None, custom_field_id: Optional[int] = None, item_id: Optional[int] = None, name: Optional[str] = None) → requests.models.Response

選択リストカスタム属性のリスト項目の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-list-item-for-list-type-custom-field/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • custom_field_id – カスタム属性のID

  • item_id – リスト項目のID

  • name – リスト項目の名前

Returns

レスポンス

pybacklogpy.GitRepository module

class pybacklogpy.GitRepository.GitRepository(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_git_repository(project_id_or_key: str, repo_id_or_name: str) → requests.models.Response

Gitリポジトリの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-git-repository/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

Returns

レスポンス

get_list_of_git_repositories(project_id_or_key: str) → requests.models.Response

Gitリポジトリ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-git-repositories/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

pybacklogpy.Issue module

class pybacklogpy.Issue.Issue(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_issue(project_id: int, summary: str, issue_type_id: int, priority_id: int, parent_issue_id: Optional[int] = None, description: Optional[str] = None, start_date: Optional[str] = None, due_date: Optional[str] = None, estimated_hours: Optional[int] = None, actual_hours: Optional[int] = None, category_id: Optional[List[int]] = None, version_id: Optional[List[int]] = None, milestone_id: Optional[List[int]] = None, assignee_id: Optional[int] = None, notified_user_id: List[int] = None, attachment_id: Optional[List[int]] = None, **kwargs) → requests.models.Response

課題の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-issue/

Parameters

  • project_id – 課題を登録するプロジェクトのID

  • summary – 課題の件名

  • issue_type_id – 課題の種別のID

  • priority_id – 課題の優先度のID

  • parent_issue_id – 課題の親課題のID

  • description – 課題の詳細

  • start_date – 課題の開始日 (yyyy-MM-dd)

  • due_date – 課題の期限日 (yyyy-MM-dd)

  • estimated_hours – 課題の予定時間

  • actual_hours – 課題の実績時間

  • category_id – 課題のカテゴリーのID

  • version_id – 課題の発生バージョンのID

  • milestone_id – 課題のマイルストーンのID

  • assignee_id – 課題の担当者のID

  • notified_user_id – 課題の登録の通知を受け取るユーザーのID

  • attachment_id – 添付ファイルの送信APIが返すID

  • kwargs – カスタム属性を渡す customField_{id}=[value] または customField_{id}_otherValue=[value] の形式

Returns

レスポンス

count_issue(project_id: Optional[List[int]] = None, issue_type_id: Optional[List[int]] = None, category_id: Optional[List[int]] = None, version_id: Optional[List[int]] = None, milestone_id: Optional[List[int]] = None, status_id: Optional[List[int]] = None, priority_id: Optional[List[int]] = None, assignee_id: Optional[List[int]] = None, created_user_id: Optional[List[int]] = None, resolution_id: Optional[List[int]] = None, parent_child: Optional[int] = None, attachment: Optional[bool] = None, shared_file: Optional[bool] = None, sort: Optional[str] = None, order: Optional[str] = 'desc', offset: Optional[int] = None, count: Optional[int] = 20, created_since: Optional[str] = None, created_until: Optional[str] = None, updated_since: Optional[str] = None, updated_until: Optional[str] = None, start_date_since: Optional[str] = None, start_date_until: Optional[str] = None, due_date_since: Optional[str] = None, due_date_until: Optional[str] = None, id_: Optional[List[int]] = None, parent_issue_id: Optional[List[int]] = None, keyword: Optional[str] = None, custom_field_text: Dict[int, str] = None, custom_field_num: Dict[int, Dict[str, int]] = None, custom_field_date: Dict[int, Dict[str, int]] = None, custom_field_list: Dict[int, List[int]] = None) → requests.models.Response

課題数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-issue/

Parameters

  • project_id – プロジェクトのID

  • issue_type_id – 種別のID

  • category_id – カテゴリーのID

  • version_id – 発生バージョンのID

  • milestone_id – マイルストーンのID

  • status_id – 状態のID

  • priority_id – 優先度のID

  • assignee_id – 担当者のID

  • created_user_id – 登録者のID

  • resolution_id – 完了理由のID

  • parent_child – 親子課題の 0:すべて, 1:子課題以外, 2:子課題, 3:親課題でも子課題でもない課題, 4:親課題

  • attachment – 添付ファイルを含む場合はtrue

  • shared_file – 共有ファイルを含む場合はtrue

  • sort – 課題一覧のソートに使用する属性名

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset – オフセット

  • count – 取得上限(1-100) 指定が無い場合は20

  • created_since – 登録日 (yyyy-MM-dd)

  • created_until – 登録日 (yyyy-MM-dd)

  • updated_since – 更新日 (yyyy-MM-dd)

  • updated_until – 更新日 (yyyy-MM-dd)

  • start_date_since – 開始日 (yyyy-MM-dd)

  • start_date_until – 開始日 (yyyy-MM-dd)

  • due_date_since – 期限日 (yyyy-MM-dd)

  • due_date_until – 期限日 (yyyy-MM-dd)

  • id – 課題のID

  • parent_issue_id – 親課題のID

  • keyword – 検索キーワード

  • custom_field_text – カスタム属性(テキスト)の検索キーワード e.g.) {1: ‘debug’, 2: ‘top’}

  • custom_field_num – カスタム属性(数値)の最小・最大値 e.g.) {1: {‘min’: 10, ‘max’: 20}, 2: {‘min’: None, ‘max’: 100}}

  • custom_field_date – カスタム属性(日付)の最小・最大値 e.g.) {1: {‘min’: ‘2000-01-01’, max: ‘2000-12-31’}}

  • custom_field_list – カスタム属性(リスト)の指定ID e.g.) {1: [100, 101, 102], 2: [200]}

Returns

レスポンス

delete_issue(issue_id_or_key: str) → requests.models.Response

課題の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-issue/

Parameters

issue_id_or_key – 課題のID または 課題キー

Returns

レスポンス

get_issue(issue_id_or_key: str) → requests.models.Response

課題情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-issue/

Parameters

issue_id_or_key – 課題のID または 課題キー

Returns

レスポンス

get_issue_list(project_id: Optional[List[int]] = None, issue_type_id: Optional[List[int]] = None, category_id: Optional[List[int]] = None, version_id: Optional[List[int]] = None, milestone_id: Optional[List[int]] = None, status_id: Optional[List[int]] = None, priority_id: Optional[List[int]] = None, assignee_id: Optional[List[int]] = None, created_user_id: Optional[List[int]] = None, resolution_id: Optional[List[int]] = None, parent_child: Optional[int] = None, attachment: Optional[bool] = None, shared_file: Optional[bool] = None, sort: Optional[str] = None, order: Optional[str] = 'desc', offset: Optional[int] = None, count: Optional[int] = 20, created_since: Optional[str] = None, created_until: Optional[str] = None, updated_since: Optional[str] = None, updated_until: Optional[str] = None, start_date_since: Optional[str] = None, start_date_until: Optional[str] = None, due_date_since: Optional[str] = None, due_date_until: Optional[str] = None, id_: Optional[List[int]] = None, parent_issue_id: Optional[List[int]] = None, keyword: Optional[str] = None, custom_field_text: Dict[int, str] = None, custom_field_num: Dict[int, Dict[str, int]] = None, custom_field_date: Dict[int, Dict[str, int]] = None, custom_field_list: Dict[int, List[int]] = None) → requests.models.Response

課題一覧の取得 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-issue-list/

Parameters

  • project_id – プロジェクトのID

  • issue_type_id – 種別のID

  • category_id – カテゴリーのID

  • version_id – 発生バージョンのID

  • milestone_id – マイルストーンのID

  • status_id – 状態のID

  • priority_id – 優先度のID

  • assignee_id – 担当者のID

  • created_user_id – 登録者のID

  • resolution_id – 完了理由のID

  • parent_child – 親子課題の 0:すべて, 1:子課題以外, 2:子課題, 3:親課題でも子課題でもない課題, 4:親課題

  • attachment – 添付ファイルを含む場合はtrue

  • shared_file – 共有ファイルを含む場合はtrue

  • sort – 課題一覧のソートに使用する属性名

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset – オフセット

  • count – 取得上限(1-100) 指定が無い場合は20

  • created_since – 登録日 (yyyy-MM-dd)

  • created_until – 登録日 (yyyy-MM-dd)

  • updated_since – 更新日 (yyyy-MM-dd)

  • updated_until – 更新日 (yyyy-MM-dd)

  • start_date_since – 開始日 (yyyy-MM-dd)

  • start_date_until – 開始日 (yyyy-MM-dd)

  • due_date_since – 期限日 (yyyy-MM-dd)

  • due_date_until – 期限日 (yyyy-MM-dd)

  • id – 課題のID

  • parent_issue_id – 親課題のID

  • keyword – 検索キーワード

  • custom_field_text – カスタム属性(テキスト)の検索キーワード e.g.) {1: ‘debug’, 2: ‘top’}

  • custom_field_num – カスタム属性(数値)の最小・最大値 e.g.) {1: {‘min’: 10, ‘max’: 20}, 2: {‘min’: None, ‘max’: 100}}

  • custom_field_date – カスタム属性(日付)の最小・最大値 e.g.) {1: {‘min’: ‘2000-01-01’, max: ‘2000-12-31’}}

  • custom_field_list – カスタム属性(リスト)の指定ID e.g.) {1: [100, 101, 102], 2: [200]}

Returns

レスポンス

update_issue(issue_id_or_key: str, summary: Optional[str] = None, parent_issue_id: Optional[int] = None, description: Optional[str] = None, status_id: Optional[int] = None, resolution_id: Optional[int] = None, start_date: Optional[str] = None, due_date: Optional[str] = None, estimated_hours: Optional[int] = None, actual_hours: Optional[int] = None, issue_type_id: Optional[int] = None, category_id: Optional[List[int]] = None, version_id: Optional[List[int]] = None, milestone_id: Optional[List[int]] = None, priority_id: Optional[int] = None, assignee_id: Optional[int] = None, notified_user_id: Optional[List[int]] = None, attachment_id: Optional[List[int]] = None, comment: Optional[str] = None, **kwargs) → requests.models.Response

課題情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-issue/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • summary – 課題の件名

  • parent_issue_id – 課題の親課題のID

  • description – 課題の詳細

  • status_id – 状態のID

  • resolution_id – 完了理由のID

  • start_date – 課題の開始日 (yyyy-MM-dd)

  • due_date – 課題の期限日 (yyyy-MM-dd)

  • estimated_hours – 課題の予定時間

  • actual_hours – 課題の実績時間

  • issue_type_id – 課題の種別のID

  • category_id – 課題のカテゴリーのID

  • version_id – 課題の発生バージョンのID

  • milestone_id – 課題のマイルストーンのID

  • priority_id – 課題の優先度のID

  • assignee_id – 課題の担当者のID

  • notified_user_id – 課題の登録の通知を受け取るユーザーのID

  • attachment_id – 添付ファイルの送信APIが返すID

  • comment – コメント

  • kwargs – カスタム属性を渡す customField_{id}=[value] または customField_{id}_otherValue=[value] の形式

Returns

レスポンス

class pybacklogpy.Issue.IssueAttachment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

delete_issue_attachment(issue_id_or_key: str, attachment_id: int) → requests.models.Response

課題添付ファイルの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-issue-attachment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • attachment_id – 添付ファイルのID

Returns

レスポンス

get_issue_attachment(issue_id_or_key: str, attachment_id: int) → Tuple[str, requests.models.Response]

課題添付ファイルのダウンロード https://developer.nulab.com/ja/docs/backlog/api/2/get-issue-attachment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • attachment_id – 添付ファイルのID

Returns

保存されたファイルのPATH

get_list_of_issue_attachments(issue_id_or_key: str) → requests.models.Response

課題添付ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-issue-attachments/

Parameters

issue_id_or_key – 課題のID または 課題キー

Returns

レスポンス

class pybacklogpy.Issue.IssueComment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_comment(issue_id_or_key: str, content: str, notified_user_id: Optional[List[int]] = None, attachment_id: Optional[List[int]] = None) → requests.models.Response

課題コメントの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-comment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • content – コメントの本文

  • notified_user_id – コメント登録の通知を受け取るユーザーID

  • attachment_id – 添付ファイルの送信APIが返すID

Returns

レスポンス

add_comment_notification(issue_id_or_key: str, comment_id: int, notified_user_id: Optional[List[int]] = None) → requests.models.Response

課題コメントにお知らせを追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-comment-notification/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • comment_id – コメントのID

  • notified_user_id – 課題の登録の通知を受け取るユーザーのID

Returns

レスポンス

count_comment(issue_id_or_key: str) → requests.models.Response

課題コメント数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-comment/

Parameters

issue_id_or_key – 課題のID または 課題キー

Returns

レスポンス

delete_comment(issue_id_or_key: str, comment_id: int) → requests.models.Response

課題コメントの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-comment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • comment_id – コメントのID

Returns

レスポンス

get_comment(issue_id_or_key: str, comment_id: int) → requests.models.Response

課題コメント情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-comment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • comment_id – コメントのID

Returns

レスポンス

get_comment_list(issue_id_or_key: Optional[str] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: int = 20, order: str = 'desc') → requests.models.Response

課題コメントの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-comment-list/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

get_list_of_comment_notifications(issue_id_or_key: str, comment_id: int) → requests.models.Response

課題コメントのお知らせ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-comment-notifications/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • comment_id – コメントのID

Returns

レスポンス

update_comment(issue_id_or_key: str, comment_id: int, content: Optional[str] = None) → requests.models.Response

課題コメント情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-comment/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • comment_id – コメントのID

  • content – コメントの本文

Returns

レスポンス

class pybacklogpy.Issue.IssueSharedFile(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_list_of_linked_shared_files(issue_id_or_key: str) → requests.models.Response

課題共有ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-linked-shared-files/

Parameters

issue_id_or_key – 課題のID または 課題キー

Returns

レスポンス

課題に共有ファイルをリンク https://developer.nulab.com/ja/docs/backlog/api/2/link-shared-files-to-issue/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • file_id – 共有ファイルのID

Returns

レスポンス

課題の共有ファイルのリンクを解除 https://developer.nulab.com/ja/docs/backlog/api/2/remove-link-to-shared-file-from-issue/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • shared_file_id – 共有ファイルのID

Returns

レスポンス

class pybacklogpy.Issue.IssueType(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_issue_type(project_id_or_key: Optional[str] = None, name: Optional[str] = None, color: Optional[str] = None) → requests.models.Response

種別の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-issue-type/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • name – 種別の名前

  • color – 種別の背景色：以下から指定”#e30000””#990000””#934981””#814fbc””#2779ca””#007e9a””#7ea800””#ff9200””#ff3265””#666665”

Returns

レスポンス

delete_issue_type(project_id_or_key: Optional[str] = None, issue_id: Optional[int] = None, substitute_issue_type_id: Optional[int] = None) → requests.models.Response

種別の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-issue-type/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • issue_id – 種別のID

  • substitute_issue_type_id – 紐づく課題を付け替える先の種別のID

Returns

レスポンス

get_issue_type_list(project_id_or_key: str) → requests.models.Response

種別一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-issue-type-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

update_issue_type(project_id_or_key: str, issue_id: int, name: Optional[str] = None, color: Optional[str] = None) → requests.models.Response

種別情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-issue-type/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • issue_id – 種別のID

  • name – 種別の名前

  • color – 種別の背景色

Returns

レスポンス

pybacklogpy.Licence module

class pybacklogpy.Licence.Licence(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_licence() → requests.models.Response

ライセンス情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-licence/

Returns

レスポンス

pybacklogpy.Notification module

class pybacklogpy.Notification.Notification(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

count_notification(already_read: Optional[bool] = None, resource_already_read: Optional[bool] = None) → requests.models.Response

お知らせ数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-notification/

Parameters

  • already_read –

  • resource_already_read –

Returns

レスポンス

get_notification(min_id: Optional[int] = None, max_id: Optional[int] = None, count: Optional[int] = 20, order: Optional[str] = 'desc', sender_id: Optional[int] = None) → requests.models.Response

お知らせ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-notification/

Parameters

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • sender_id – 送信者ID

Returns

レスポンス

read_notification(notification_id: int) → requests.models.Response

お知らせの既読化 https://developer.nulab.com/ja/docs/backlog/api/2/read-notification/

Parameters

notification_id – お知らせのID

Returns

レスポンス

reset_unread_notification_count()

お知らせ数のリセット https://developer.nulab.com/ja/docs/backlog/api/2/reset-unread-notification-count/

Returns

レスポンス

pybacklogpy.Priority module

class pybacklogpy.Priority.Priority(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_priority_list() → requests.models.Response

優先度一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-priority-list/

Returns

レスポンス

pybacklogpy.Project module

class pybacklogpy.Project.Project(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_project(name: str, key: str, chart_enabled: bool, subtasking_enabled: bool, text_formatting_rule: str, project_leader_can_edit_project_leader: Optional[bool] = None) → requests.models.Response

プロジェクトの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-project/

Parameters

  • name – プロジェクト名

  • key – プロジェクトキー

  • chart_enabled – チャートを使用するかどうか(フリープランでは利用不可)

  • project_leader_can_edit_project_leader – プロジェクト管理者も他のプロジェクト管理者を指定可能にする

  • subtasking_enabled – 親子課題を使用するかどうか(フリープランでは利用不可)

  • text_formatting_rule – テキスト整形のルール backlog または markdown

Returns

レスポンス

add_project_administrator(project_id_or_key: str, user_id: int) → requests.models.Response

プロジェクト管理者の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-project-administrator/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • user_id – 追加するユーザーのID

Returns

レスポンス

add_project_user(project_id_or_key: str, user_id: int) → requests.models.Response

プロジェクトユーザーの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-project-user/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • user_id – 追加するユーザーのID

Returns

レスポンス

delete_project(project_id_or_key: str) → requests.models.Response

プロジェクトの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-project/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

delete_project_administrator(project_id_or_key: str, user_id: int) → requests.models.Response

プロジェクト管理者の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-project-administrator/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • user_id – 削除するユーザーのID

Returns

レスポンス

delete_project_user(project_id_or_key: str, user_id: int) → requests.models.Response

プロジェクトユーザーの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-project-user/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • user_id – 削除するユーザーのID

Returns

レスポンス

get_list_of_project_administrators(project_id_or_key: str) → requests.models.Response

プロジェクト管理者一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-project-administrators/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

get_project(project_id_or_key: str) → requests.models.Response

プロジェクト情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

get_project_icon(project_id_or_key: Optional[str] = None) → Tuple[str, requests.models.Response]

プロジェクトアイコンの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-icon/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

get_project_list(archived: Optional[bool] = None, all_projects: Optional[bool] = None) → requests.models.Response

プロジェクト一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-list/

Parameters

  • archived – 省略された場合は全てのプロジェクト、falseの場合はアーカイブされていないプロジェクト、trueの場合はアーカイブされたプロジェクトを返します。

  • all_projects – ユーザが管理者権限の場合のみ有効なパラメータです。trueの場合はすべてのプロジェクト、falseの場合は参加しているプロジェクトのみを返します。初期値はfalse。

Returns

レスポンス

get_project_recent_updates(project_id_or_key: str, activity_type_id: Optional[List[int]] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: Optional[int] = 20, order: Optional[str] = 'desc', update_type: Optional[int] = None) → requests.models.Response

プロジェクトの最近の活動の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-recent-updates/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • activity_type_id – type(1-26)

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • update_type – 最近の更新の種別：(1)課題の追加 (2)課題の更新 (3)課題にコメント (4)課題の削除 (5)Wikiを追加 (6)Wikiを更新 (7)Wikiを削除 (8)共有ファイルを追加 (9)共有ファイルを更新(10)共有ファイルを削除 (11)Subversionコミット (12)GITプッシュ (13)GITリポジトリ作成 (14)課題をまとめて更新 (15)ユーザーがプロジェクトに参加 (16)ユーザーがプロジェクトから脱退 (17)コメントにお知らせを追加 (18)プルリクエストの追加 (19)プルリクエストの更新 (20)プルリクエストにコメント (21)プルリクエストの削除 (22)マイルストーンの追加 (23)マイルストーンの更新 (24)マイルストーンの削除 (25)グループがプロジェクトに参加 (26)グループがプロジェクトから脱退

Returns

レスポンス

get_project_user_list(project_id_or_key: str, exclude_group_members: Optional[bool] = None) → requests.models.Response

プロジェクトユーザー一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-user-list/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • exclude_group_members – グループを介してプロジェクトに参加しているメンバーを除く

Returns

レスポンス

update_project(project_id_or_key: str, name: Optional[str] = None, key: Optional[str] = None, chart_enabled: Optional[bool] = None, subtasking_enabled: Optional[bool] = None, project_leader_can_edit_project_leader: Optional[bool] = None, text_formatting_rule: Optional[str] = None, archived: Optional[bool] = None) → requests.models.Response

プロジェクト情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-project/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • name – プロジェクト名

  • key – プロジェクトキー

  • chart_enabled – チャートを使用するかどうか(フリープランでは利用不可)

  • subtasking_enabled – 親子課題を使用するかどうか(フリープランでは利用不可)

  • project_leader_can_edit_project_leader – プロジェクト管理者も他のプロジェクト管理者を指定可能にする

  • text_formatting_rule – テキスト整形のルール backlog または markdown

  • archived – プロジェクトの一覧に表示するかどうか

Returns

レスポンス

class pybacklogpy.Project.ProjectTeam(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_project_team(project_id_or_key: str, team_id: Optional[int] = None) → requests.models.Response

プロジェクトチームの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-project-team/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • team_id – 追加するチームのID

Returns

レスポンス

delete_project_team(project_id_or_key: str, team_id: Optional[int] = None) → requests.models.Response

プロジェクトチームの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-project-team

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • team_id – 削除するチームのID

Returns

レスポンス

get_project_disk_usage(project_id_or_key: str) → requests.models.Response

プロジェクトの容量使用状況の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-disk-usage/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

get_project_team_list(project_id_or_key: str) → requests.models.Response

プロジェクトチーム一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-project-team-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

pybacklogpy.PullRequest module

class pybacklogpy.PullRequest.PullRequest(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_pull_request(project_id_or_key: str, repo_id_or_name: str, summary: str, description: str, base: str, branch: str, issue_id: Optional[int] = None, assignee_id: Optional[int] = None, notified_user_id: Optional[List[int]] = None, attachment_id: List[int] = None) → requests.models.Response

プルリクエストの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-pull-request/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • summary – プルリクエストの件名

  • description – プルリクエストの詳細

  • base – マージ先のブランチ名

  • branch – マージされるブランチ名

  • issue_id – 関連課題のID

  • assignee_id – プルリクエストの担当者のID

  • notified_user_id – プルリクエストの登録の通知を受け取るユーザーのID

  • attachment_id – 添付ファイルの送信APIが返すID

Returns

レスポンス

get_number_of_pull_requests(project_id_or_key: str, repo_id_or_name: str, status_id: Optional[List[int]] = None, assignee_id: Optional[List[int]] = None, issue_id: Optional[List[int]] = None, created_user_id: Optional[List[int]] = None, offset: Optional[int] = None, count: Optional[int] = 20) → requests.models.Response

プルリクエスト数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-number-of-pull-requests/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • status_id – 状態のID

  • assignee_id – 担当者のID

  • issue_id – 関連課題のID

  • created_user_id – 登録者のID

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

get_pull_request(project_id_or_key: str, repo_id_or_name: str, number: int) → requests.models.Response

プルリクエストの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-pull-request/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

Returns

レスポンス

get_pull_request_list(project_id_or_key: str, repo_id_or_name: str, status_id: Optional[List[int]] = None, assignee_id: Optional[List[int]] = None, issue_id: Optional[List[int]] = None, created_user_id: Optional[List[int]] = None, offset: Optional[int] = None, count: int = 20) → requests.models.Response

プルリクエスト一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-pull-request-list/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • status_id – 状態のID

  • assignee_id – 担当者のID

  • issue_id – 関連課題のID

  • created_user_id – 登録者のID

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

update_pull_request(project_id_or_key: str, repo_id_or_name: str, number: int, summary: Optional[str] = None, description: Optional[str] = None, issue_id: Optional[int] = None, assignee_id: Optional[int] = None, notified_user_id: Optional[List[int]] = None, comment: Optional[str] = None) → requests.models.Response

プルリクエストの更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-pull-request/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • summary – プルリクエストの件名

  • description – プルリクエストの詳細

  • issue_id – 関連課題のID

  • assignee_id – プルリクエストの担当者のID

  • notified_user_id – プルリクエストの登録の通知を受け取るユーザーのID

  • comment – コメント

Returns

レスポンス

class pybacklogpy.PullRequest.PullRequestAttachment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

delete_pull_request_attachments(project_id_or_key: str, repo_id_or_name: str, number: int, attachment_id: int) → requests.models.Response

プルリクエスト添付ファイルの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-pull-request-attachments/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • attachment_id – 添付ファイルのID

Returns

レスポンス

download_pull_request_attachment(project_id_or_key: str, repo_id_or_name: str, number: int, attachment_id: int) → Tuple[str, requests.models.Response]

プルリクエスト添付ファイルのダウンロード https://developer.nulab.com/ja/docs/backlog/api/2/download-pull-request-attachment/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • attachment_id – 添付ファイルのID

Returns

ダウンロードされたファイルのPATH

get_list_of_pull_request_attachment(project_id_or_key: str, repo_id_or_name: str, number: int) → requests.models.Response

プルリクエスト添付ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-pull-request-attachment/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

Returns

レスポンス

class pybacklogpy.PullRequest.PullRequestComment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_pull_request_comment(project_id_or_key: str, repo_id_or_name: str, number: int, content: str, notified_user_id: Optional[List[int]] = None) → requests.models.Response

プルリクエストコメントの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-pull-request-comment/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • content – コメントの本文

  • notified_user_id – コメント登録の通知を受け取るユーザーID

Returns

レスポンス

get_number_of_pull_request_comments(project_id_or_key: str, repo_id_or_name: str, number: int) → requests.models.Response

プルリクエストコメント数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-number-of-pull-request-comments/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

Returns

レスポンス

get_pull_request_comment(project_id_or_key: str, repo_id_or_name: str, number: Optional[int] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: int = 20, order: str = 'desc') → requests.models.Response

プルリクエストコメントの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-pull-request-comment/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

update_pull_request_comment_information(project_id_or_key: str, repo_id_or_name: str, number: int, comment_id: int, content: Optional[str] = None) → requests.models.Response

プルリクエストコメント情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-pull-request-comment-information/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • repo_id_or_name – リポジトリのID または リポジトリ名

  • number – プルリクエストの番号

  • comment_id – コメントのID

  • content – コメントの本文

Returns

レスポンス

pybacklogpy.Resolution module

class pybacklogpy.Resolution.Resolution(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_resolution_list() → requests.models.Response

完了理由一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-resolution-list/

Returns

レスポンス

pybacklogpy.SharedFile module

class pybacklogpy.SharedFile.SharedFile(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_file(project_id_or_key: Optional[str] = None, shared_file_id: Optional[int] = None) → requests.models.Response

共有ファイルのダウンロード https://developer.nulab.com/ja/docs/backlog/api/2/get-file/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • shared_file_id – 共有ファイルのID

Returns

レスポンス

get_list_of_shared_files(project_id_or_key: str, file_path: str, order: str = 'desc', offset: Optional[int] = None, count: int = 1000) → requests.models.Response

共有ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-shared-files/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • file_path – ディレクトリのパス

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset –

  • count – 取得上限(1-1000) 指定が無い場合は1000

Returns

レスポンス

pybacklogpy.Space module

class pybacklogpy.Space.Space(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_recent_updates(activity_type_id: Optional[List[int]] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: Optional[int] = 20, order: Optional[str] = 'desc') → requests.models.Response

最近の更新の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-recent-updates/

Parameters

  • activity_type_id – type(1-26)

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

get_space() → requests.models.Response

スペース情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-space/

Returns

レスポンス

get_space_disk_usage() → requests.models.Response

スペースの容量使用状況の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-space-disk-usage/

Returns

レスポンス

スペースアイコン画像の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-space-logo/

Returns

レスポンス

get_space_notification() → requests.models.Response

スペースのお知らせの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-space-notification/

Returns

レスポンス

pybacklogpy.Star module

class pybacklogpy.Star.Project(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_star(issue_id: Optional[int] = None, comment_id: Optional[int] = None, wiki_id: Optional[int] = None, pull_request_id: Optional[int] = None, pull_request_comment_id: Optional[int] = None) → requests.models.Response

スターの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-star/

Parameters

  • issue_id – 課題のID

  • comment_id – コメントのID

  • wiki_id – WikiページのID

  • pull_request_id – プルリクエストのID

  • pull_request_comment_id – プルリクエストコメントのID

Returns

レスポンス

pybacklogpy.Status module

class pybacklogpy.Status.Status(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_status_list() → requests.models.Response

状態一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-status-list/

Returns

レスポンス

pybacklogpy.Team module

class pybacklogpy.Team.Team(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_team(name: Optional[str] = None, members: Optional[List[int]] = None) → requests.models.Response

チームの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-team/

Parameters

  • name – グループ名

  • members – グループに含めるユーザーID

Returns

レスポンス

delete_team(team_id: Optional[int] = None) → requests.models.Response

チームの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-team/

Parameters

team_id – チームのID

Returns

レスポンス

get_list_of_teams(order: str = 'desc', offset: Optional[int] = None, count: int = 20) → requests.models.Response

チーム一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-teams/

Parameters

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

get_team(team_id: Optional[int] = None) → requests.models.Response

チーム情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-team/

Parameters

team_id – チームのID

Returns

レスポンス

get_team_icon(team_id: Optional[int] = None) → requests.models.Response

チームアイコンの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-team-icon/

Parameters

team_id – チームのID

Returns

レスポンス

update_team(team_id: int, name: Optional[str] = None, members: Optional[List[int]] = None) → requests.models.Response

チーム情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-team/

Parameters

  • team_id – チームのID

  • name – チーム名

  • members – チームに含めるユーザーID

Returns

レスポンス

pybacklogpy.User module

class pybacklogpy.User.User(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

count_user_received_stars(user_id: int, since: Optional[str] = None, until: Optional[str] = None) → requests.models.Response

ユーザーの受け取ったスターの数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-user-received-stars/

Parameters

  • user_id – ユーザーのID

  • since – 指定した日付以降のスターをカウント (yyyy-MM-dd)

  • until – 指定した日付以前のスターをカウント (yyyy-MM-dd)

Returns

レスポンス

get_list_of_recently_viewed_issues(order: Optional[str] = 'desc', offset: Optional[int] = None, count: Optional[int] = 20) → requests.models.Response

自分が最近見た課題一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-issues/

Parameters

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

get_list_of_recently_viewed_projects(order: Optional[str] = 'desc', offset: Optional[int] = None, count: Optional[int] = 20) → requests.models.Response

自分が最近見たプロジェクト一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-projects/

Parameters

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

get_list_of_recently_viewed_wikis(order: Optional[str] = 'desc', offset: Optional[int] = None, count: Optional[int] = 20) → requests.models.Response

自分が最近見たWiki一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-recently-viewed-wikis/

Parameters

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • offset –

  • count – 取得上限(1-100) 指定が無い場合は20

Returns

レスポンス

get_own_user() → requests.models.Response

認証ユーザー情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-own-user/

Returns

レスポンス

get_received_star_list(user_id: int, min_id: Optional[int] = None, max_id: Optional[int] = None, count: Optional[int] = 20, order: Optional[str] = 'desc') → requests.models.Response

ユーザーの受け取ったスター一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-received-star-list/

Parameters

  • user_id – ユーザーのID

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

get_user(user_id: int) → requests.models.Response

ユーザー情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-user/

Parameters

user_id – ユーザーのID

Returns

レスポンス

get_user_icon(user_id: int) → Tuple[str, requests.models.Response]

ユーザーアイコンの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-user-icon/

Parameters

user_id – ユーザーのID

Returns

(保存された画像のPATH, backlog上の画像url)

get_user_list() → requests.models.Response

ユーザー一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-user-list/

Returns

レスポンス

get_user_recent_updates(user_id: int, activity_type_id: Optional[List[int]] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: Optional[int] = 20, order: Optional[str] = 'desc') → requests.models.Response

ユーザーの最近の活動の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-user-recent-updates/

Parameters

  • user_id – ユーザーのID

  • activity_type_id – type (1)課題の追加 (2)課題の更新 (3)課題にコメント (4)課題の削除 (5)Wikiを追加 (6)Wikiを更新 (7)Wikiを削除 (8)共有ファイルを追加 (9)共有ファイルを更新(10)共有ファイルを削除 (11)Subversionコミット (12)GITプッシュ (13)GITリポジトリ作成 (14)課題をまとめて更新 (15)ユーザーがプロジェクトに参加 (16)ユーザーがプロジェクトから脱退 (17)コメントにお知らせを追加

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

pybacklogpy.Version module

class pybacklogpy.Version.Version(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_version_milestone(project_id_or_key: str, name: str, description: Optional[str] = None, start_date: Optional[str] = None, release_due_date: Optional[str] = None) → requests.models.Response

バージョン(マイルストーン)の追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-version-milestone/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • name – バージョンの名前

  • description – バージョンの説明

  • start_date – バージョンの開始日 (yyyy-MM-dd)

  • release_due_date – バージョンのリリース予定日 (yyyy-MM-dd)

Returns

レスポンス

delete_version(project_id_or_key: Optional[str] = None, version_id: Optional[int] = None) → requests.models.Response

バージョン(マイルストーン)の削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-version/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • version_id – バージョンのID

Returns

レスポンス

get_version_milestone_list(project_id_or_key: Optional[str] = None) → requests.models.Response

バージョン(マイルストーン)一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-version-milestone-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

update_version_milestone(project_id_or_key: str, version_id: int, name: str, description: Optional[str] = None, start_date: Optional[str] = None, release_due_date: Optional[str] = None, archived: Optional[bool] = None) → requests.models.Response

バージョン(マイルストーン)情報の更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-version-milestone/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • version_id – バージョンのID

  • name – バージョンの名前

  • description – バージョンの説明

  • start_date – バージョンの開始日 (yyyy-MM-dd)

  • release_due_date – バージョンのリリース予定日 (yyyy-MM-dd)

  • archived – プロジェクトホームに表示しない場合はtrue

Returns

レスポンス

pybacklogpy.Watch module

class pybacklogpy.Watch.Watch(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_watching(issue_id_or_key: Optional[str] = None, note: Optional[str] = None) → requests.models.Response

ウォッチの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-watching/

Parameters

  • issue_id_or_key – 課題のID または 課題キー

  • note – メモ

Returns

レスポンス

count_watching(user_id: int, resource_already_read: Optional[bool] = None, already_read: Optional[bool] = None) → requests.models.Response

ウォッチ数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-watching/

Parameters

  • user_id – ユーザーのID

  • resource_already_read – 既読かどうか。trueの場合は既読のウォッチ、falseの場合は未読のウォッチ、指定しない場合は両方のウォッチを返します。指定が無い場合は両方

  • already_read – ウォッチメニューの一覧表示後に更新されたウォッチの件数を返します。trueの場合はウォッチメニューを表示した後に更新されていない(既読状態の)件数を返します。falseの場合はウォッチメニューを表示した後に更新された(未読状態の)ウォッチの件数を返します。指定が無い場合は両方を合わせた件数を返します。resourceAlreadyReadが指定してある場合、alreadyReadは使用されません。

Returns

レスポンス

delete_watching(watching_id: int) → requests.models.Response

ウォッチの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-watching/

Parameters

watching_id – ウォッチのID

Returns

レスポンス

get_watching(watching_id: int) → requests.models.Response

ウォッチ情報の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-watching/

Parameters

watching_id – ウォッチのID

Returns

レスポンス

get_watching_list(user_id: int, order: str = 'desc', sort: str = 'issueUpdated', count: int = 20, offset: Optional[int] = None, resource_already_read: Optional[bool] = None, issue_id: Optional[List[int]] = None) → requests.models.Response

ウォッチ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-watching-list/

Parameters

  • user_id – ユーザーのID

  • order – “asc”または”desc” 指定が無い場合は”desc”

  • sort – ウォッチ一覧のソートに使用する属性名“created”“updated”“issueUpdated”指定が無い場合は”issueUpdated”

  • count – 取得上限(1-100) 指定が無い場合は20

  • offset –

  • resource_already_read – ウォッチしている課題の詳細を既読かどうか。trueの場合は既読のウォッチ、falseの場合は未読のウォッチ、指定しない場合は両方のウォッチを返します。指定が無い場合は両方

  • issue_id – 課題のID

Returns

レスポンス

mark_watching_as_read(watching_id: int) → requests.models.Response

ウォッチの既読化 https://developer.nulab.com/ja/docs/backlog/api/2/mark-watching-as-read/

Parameters

watching_id – ウォッチのID

Returns

レスポンス

update_watching(watching_id: int, note: Optional[str] = None) → requests.models.Response

ウォッチの更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-watching/

Parameters

  • watching_id – ウォッチのID

  • note – メモ

Returns

レスポンス

pybacklogpy.Webhook module

class pybacklogpy.Webhook.Webhook(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_webhook(project_id_or_key: str, name: Optional[str] = None, description: Optional[str] = None, hook_url: Optional[str] = None, all_event: Optional[bool] = None, activity_type_ids: Optional[List[int]] = None) → requests.models.Response

Webhookの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-webhook/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • name – 名前

  • description – 詳細

  • hook_url – hook URL

  • all_event – 全てのイベントを通知

  • activity_type_ids – 通知するイベントのID

Returns

レスポンス

delete_webhook(project_id_or_key: str, webhook_id: str) → requests.models.Response

Webhookの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-webhook/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • webhook_id – WebhookのID

Returns

レスポンス

get_list_of_webhooks(project_id_or_key: str) → requests.models.Response

Webhook一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-webhooks/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

get_webhook(project_id_or_key: str, webhook_id: str) → requests.models.Response

Webhookの取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-webhook/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • webhook_id – WebhookのID

Returns

レスポンス

update_webhook(project_id_or_key: str, webhook_id: str, name: Optional[str] = None, description: Optional[str] = None, hook_url: Optional[str] = None, all_event: Optional[bool] = None, activity_type_ids: Optional[List[int]] = None) → requests.models.Response

Webhookの更新 https://developer.nulab.com/ja/docs/backlog/api/2/update-webhook/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • webhook_id – WebhookのID

  • name – 名前

  • description – 詳細

  • hook_url – hook URL

  • all_event – 全てのイベントを通知

  • activity_type_ids – 通知するイベントのID

Returns

レスポンス

pybacklogpy.Wiki module

class pybacklogpy.Wiki.Wiki(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

add_wiki_page(project_id: int, name: str, content: str, mail_notify: Optional[bool] = None) → requests.models.Response

Wikiページの追加 https://developer.nulab.com/ja/docs/backlog/api/2/add-wiki-page/

Parameters

  • project_id – プロジェクトのID

  • name – ページ名

  • content – ページの内容

  • mail_notify – ページの追加をメールで通知する場合はtrue

Returns

レスポンス

count_wiki_page(project_id_or_key: str) → requests.models.Response

Wikiページ数の取得 https://developer.nulab.com/ja/docs/backlog/api/2/count-wiki-page/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

delete_wiki_page(wiki_id: int, mail_notify: Optional[bool] = None) → requests.models.Response

Wikiページの削除 https://developer.nulab.com/ja/docs/backlog/api/2/delete-wiki-page/

Parameters

  • wiki_id – WikiページのID

  • mail_notify – ページの削除をメールで通知する場合はtrue

Returns

レスポンス

get_wiki_page(wiki_id: int) → requests.models.Response

Wikiページ情報の取得 https://developer.nulab-inc.com/ja/docs/backlog/api/2/get-wiki-page/

Parameters

wiki_id – WikiページのID

Returns

レスポンス

get_wiki_page_history(wiki_id: Optional[int] = None, min_id: Optional[int] = None, max_id: Optional[int] = None, count: int = 20, order: str = 'desc') → requests.models.Response

Wikiページ更新履歴一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-wiki-page-history/

Parameters

  • wiki_id – WikiページのID

  • min_id – 最小ID

  • max_id – 最大ID

  • count – 取得上限(1-100) 指定が無い場合は20

  • order – “asc”または”desc” 指定が無い場合は”desc”

Returns

レスポンス

get_wiki_page_list(project_id_or_key: Optional[str] = None, keyword: Optional[str] = None) → requests.models.Response

Wikiページ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-wiki-page-list/

Parameters

  • project_id_or_key – プロジェクトのID または プロジェクトキー

  • keyword – 検索キーワード

Returns

レスポンス

get_wiki_page_star(wiki_id: Optional[int] = None) → requests.models.Response

Wikiページのスター一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-wiki-page-star/

Parameters

wiki_id – WikiページのID

Returns

レスポンス

get_wiki_page_tag_list(project_id_or_key: Optional[int] = None) → requests.models.Response

Wikiページタグ一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-wiki-page-tag-list/

Parameters

project_id_or_key – プロジェクトのID または プロジェクトキー

Returns

レスポンス

update_wiki_page(wiki_id: int, name: Optional[str] = None, content: Optional[str] = None, mail_notify: bool = False) → requests.models.Response

Wikiページ情報の更新 https://developer.nulab-inc.com/ja/docs/backlog/api/2/update-wiki-page/

Parameters

  • wiki_id – WikiページのID

  • name – ページ名

  • content – ページの内容

  • mail_notify – ページの更新をメールで通知する場合はtrue

Returns

レスポンス

class pybacklogpy.Wiki.WikiAttachment(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

attach_file_to_wiki(wiki_id: int, attachment_id: Optional[List[int]] = None) → requests.models.Response

Wiki添付ファイルの追加 https://developer.nulab.com/ja/docs/backlog/api/2/attach-file-to-wiki/

Parameters

  • wiki_id – WikiページのID

  • attachment_id – 添付ファイルの送信APIが返すID

Returns

レスポンス

get_list_of_wiki_attachments(wiki_id: int) → requests.models.Response

Wiki添付ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-wiki-attachments/

Parameters

wiki_id – WikiページのID

Returns

レスポンス

get_wiki_page_attachment(wiki_id: int, attachment_id: Optional[int] = None) → Tuple[str, requests.models.Response]

Wiki添付ファイルのダウンロード https://developer.nulab.com/ja/docs/backlog/api/2/get-wiki-page-attachment/

Parameters

  • wiki_id – WikiページのID

  • attachment_id – 添付ファイルのID

Returns

保存されたファイルのPATH

remove_wiki_attachment(wiki_id: int, attachment_id: Optional[int] = None) → requests.models.Response

Wiki添付ファイルの削除 https://developer.nulab.com/ja/docs/backlog/api/2/remove-wiki-attachment/

Parameters

  • wiki_id – WikiページのID

  • attachment_id – 添付ファイルのID

Returns

レスポンス

class pybacklogpy.Wiki.WikiSharedFile(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_list_of_shared_files_on_wiki(wiki_id: int) → requests.models.Response

Wiki共有ファイル一覧の取得 https://developer.nulab.com/ja/docs/backlog/api/2/get-list-of-shared-files-on-wiki/

Parameters

wiki_id – WikiページのID

Returns

レスポンス

Wikiに共有ファイルをリンク https://developer.nulab.com/ja/docs/backlog/api/2/link-shared-files-to-wiki/

Parameters

  • wiki_id – WikiページのID

  • file_id – 共有ファイルのID

Returns

レスポンス

Wikiの共有ファイルのリンクを解除 https://developer.nulab.com/ja/docs/backlog/api/2/remove-link-to-shared-file-from-wiki/

Parameters

  • wiki_id – WikiページのID

  • file_id – 共有ファイルのID

Returns

レスポンス

pybacklogpy.const module

pybacklogpy.modules module

class pybacklogpy.modules.RequestSender(config: Optional[pybacklogpy.BacklogConfigure.BacklogConfigure] = None)

Bases: object

get_file(path: str, url_param) → Tuple[str, requests.models.Response]
post_file(path: str, files: dict) → requests.models.Response
send_delete_request(path: str, request_param: Optional[dict] = None) → requests.models.Response
send_get_request(path: str, url_param: Optional[dict] = None) → requests.models.Response
send_patch_request(path: str, request_param: dict) → requests.models.Response
send_post_request(path: str, request_param: dict) → requests.models.Response
send_put_request(path: str, request_param: dict) → requests.models.Response
pybacklogpy.modules.convert_bool_to_str(request_param: dict) → dict

リクエストデータに bool の値があった場合、小文字のstr型に変える :param request_param: :return:

Module contents