転送元 - Backlog
    • PDF

    転送元 - Backlog

    • PDF

    記事の要約

    本ページでは、Backlogからデータを取得するための設定(転送設定)について説明します。
    接続に関する設定については、接続情報 - Backlogを参照ください。

    利用上の注意・制約

    API制限について

    Backlog APIはプランやAPIの種類毎に制限の内容が異なります。
    詳細はBacklog API とは - レート制限を参照ください。

    プロジェクトIDの取得

    多くの取得対象では、プロジェクトIDの指定が必要です。
    はじめに取得対象としてプロジェクト一覧を選択した転送設定を作成・実行し、プロジェクトIDを取得することを推奨します。

    取得対象

    ユーザー一覧

    Backlogのユーザー一覧を取得します。
    詳しくは、Backlog API - Usersを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongユーザーの一意識別子
    userIdstringユーザーID
    namestringユーザー名
    roleTypelong権限タイプ
    langstring言語設定
    mailAddressstringメールアドレス
    nulabAccountjsonNulabアカウント情報
    keywordstringキーワード
    lastLoginTimetimestamp最終ログイン日時

    プロジェクト一覧

    Backlogのプロジェクト一覧を取得します。
    詳しくは、Backlog API - Projectsを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongプロジェクトの一意識別子
    projectKeystringプロジェクトキー
    namestringプロジェクト名
    chartEnabledbooleanチャート機能が有効かどうか
    useResolvedForChartbooleanチャート機能で解決済みを使用するかどうか
    subtaskingEnabledbooleanサブタスク機能が有効かどうか
    projectLeaderCanEditProjectLeaderbooleanプロジェクトリーダーの編集権限
    useWikibooleanWiki機能が有効かどうか
    useFileSharingbooleanファイル共有機能が有効かどうか
    useWikiTreeViewbooleanWikiツリービューが有効かどうか
    useSubversionbooleanSubversion機能が有効かどうか
    useGitbooleanGit機能が有効かどうか
    useOriginalImageSizeAtWikibooleanWiki内で元画像サイズを使用するかどうか
    textFormattingRulestringテキスト整形ルール
    archivedbooleanアーカイブ済みかどうか
    displayOrderlong表示順序
    useDevAttributesboolean開発属性を使用するかどうか

    プロジェクトユーザー一覧

    指定したプロジェクトに参加するユーザー一覧を取得します。
    詳しくは、Backlog API - Project Usersを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongユーザーの一意識別子
    userIdstringユーザーID
    namestringユーザー名
    roleTypelong権限タイプ
    langstring言語設定
    mailAddressstringメールアドレス
    nulabAccountjsonNulabアカウント情報
    keywordstringキーワード
    lastLoginTimetimestamp最終ログイン日時

    プロジェクト管理者一覧

    指定したプロジェクトの管理者一覧を取得します。
    詳しくは、Backlog API - Project Administratorsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongユーザーの一意識別子
    userIdstringユーザーID
    namestringユーザー名
    roleTypelong権限タイプ
    langstring言語設定
    mailAddressstringメールアドレス
    nulabAccountjsonNulabアカウント情報
    keywordstringキーワード
    lastLoginTimetimestamp最終ログイン日時

    Webhook一覧

    指定したプロジェクトのWebhook一覧を取得します。
    詳しくは、Backlog API - Webhooksを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongWebhookの一意識別子
    namestringWebhook名
    descriptionstringWebhook説明
    hookUrlstringWebhookのURL
    allEventboolean全イベントを対象とするかどうか
    activityTypeIdsjson対象のアクティビティタイプID
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時

    課題一覧

    Backlogの課題一覧を取得します。
    詳しくは、Backlog API - Issuesを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトID--特定のプロジェクトの課題のみを取得する場合に、プロジェクトIDを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。
    createdSince--作成日時の下限を入力します。
    createdUntil--作成日時の上限を入力します。
    updatedSince--更新日時の下限を入力します。
    updatedUntil--更新日時の上限を入力します。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlong課題の一意識別子
    projectIdlongプロジェクトID
    issueKeystring課題キー
    keyIdlong課題キーID
    issueTypejson課題の種別情報
    summarystring課題の件名
    descriptionstring課題の詳細
    resolutionjson課題の解決方法
    priorityjson課題の優先度
    statusjson課題のステータス
    assigneejson担当者情報
    categoryjsonカテゴリ情報
    versionsjson対象バージョン
    milestonejsonマイルストーン
    startDatestring開始日
    dueDatestring期限日
    estimatedHoursdouble予定時間
    actualHoursdouble実績時間
    parentIssueIdlong親課題ID
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時
    customFieldsjsonカスタム属性
    attachmentsjson添付ファイル
    sharedFilesjson共有ファイル
    externalFileLinksjson外部ファイルリンク
    starsjsonスター

    課題コメント

    指定した課題のコメント一覧を取得します。
    詳しくは、Backlog API - Issue Commentsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    課題のIDまたは課題キー-コメントを取得する課題のIDまたは課題キーを入力します。
    課題IDは、課題一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongコメントの一意識別子
    contentstringコメント内容
    changeLogjson変更履歴
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedtimestamp更新日時
    starsjsonスター
    notificationsjson通知情報
    projectIdlongプロジェクトID
    issueIdlong課題ID

    Wikiページ一覧

    指定したプロジェクトのWikiページ一覧を取得します。
    詳しくは、Backlog API - Wiki Pagesを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongWikiページの一意識別子
    projectIdlongプロジェクトID
    namestringWikiページ名
    contentstringWikiページ内容
    tagsjsonタグ情報
    attachmentsjson添付ファイル
    sharedFilesjson共有ファイル
    starsjsonスター
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時

    Gitリポジトリ一覧

    指定したプロジェクトのGitリポジトリ一覧を取得します。
    詳しくは、Backlog API - Git Repositoriesを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongリポジトリの一意識別子
    projectIdlongプロジェクトID
    namestringリポジトリ名
    descriptionstringリポジトリの説明
    hookUrlstringWebhookのURL
    httpUrlstringHTTP URL
    sshUrlstringSSH URL
    displayOrderlong表示順序
    pushedAttimestamp最終プッシュ日時
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時

    プルリクエスト一覧

    指定したプロジェクトのリポジトリ内のプルリクエスト一覧を取得します。
    詳しくは、Backlog API - Pull Requestsを参照ください。

    設定項目

    項目名必須デフォルト値説明
    プロジェクトのIDまたはプロジェクトキー-データを取得するプロジェクトのIDまたはプロジェクトキーを入力します。
    プロジェクトIDは、プロジェクト一覧から取得できます。
    リポジトリのIDまたはリポジトリ名-データを取得するリポジトリのIDまたはリポジトリ名を入力します。
    リポジトリIDは、Gitリポジトリ一覧から取得できます。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongプルリクエストの一意識別子
    projectIdlongプロジェクトID
    repositoryIdlongリポジトリID
    numberlongプルリクエスト番号
    summarystringプルリクエストの件名
    descriptionstringプルリクエストの詳細
    basestringベースブランチ
    branchstringブランチ
    statusjsonプルリクエストのステータス
    assigneejson担当者情報
    issuejson関連課題情報
    baseCommitstringベースコミット
    branchCommitstringブランチコミット
    closeAttimestampクローズ日時
    mergeAttimestampマージ日時
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時
    attachmentsjson添付ファイル
    starsjsonスター

    チーム一覧

    Backlogのチーム一覧を取得します。
    詳しくは、Backlog API - Teamsを参照ください。

    設定項目

    設定項目はありません。

    取得データ

    カラム名デフォルトのデータ型補足事項
    idlongチームの一意識別子
    namestringチーム名
    membersjsonチームメンバー情報
    displayOrderlong表示順序
    createdUserjson作成者情報
    createdtimestamp作成日時
    updatedUserjson更新者情報
    updatedtimestamp更新日時

    この記事は役に立ちましたか?