製品をチェック

無償トライアル:

無償トライアルへ

製品の情報と無償トライアルへ:

Backlog Data Cmdlets

PowerShell Cmdlets は、Backlog へのリアルタイム連携機能を提供します。Cmdlets を使って、データに直接連携し、読み書き更新をDB と同感覚で行うことができます。

データ連携でお困りですか？

お問い合わせ

記事の内容

関連記事

PowerShell Cmdlets でBacklog データをCSV にエクスポート


標準PowerShell cmdlets を使ってBacklog テーブルにアクセスして、CSV にエクスポート。

古川えりか
コンテンツスペシャリスト

backlog ロゴ画像

Cmdlets

powershell ロゴ画像
PowerShell ロゴ画像

CData Cmdlets Module for Backlog は、直感的なBacklog データ連携を提供する標準cmdlet です。 本記事では、Backlog Cmdlets を使ったサンプルを提供します。

Backlog への接続を設定

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

  1. Backlog の個人設定ページを開きます。
  2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
  3. ApiKey にAPI キーを指定します。
  4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。 

$conn = Connect-Backlog  -ApiKey "$ApiKey" -Url "$Url"

Backlog データを取得してCSV にパイプライン

次の手順で、Issues テーブルデータを取得して、結果をCSV ファイルにエクスポートします: 

Select-Backlog -Connection $conn -Table Issues | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myIssuesData.csv -NoTypeInformation

このように、Select-Backlog から取得した結果を、Select-Object cmdlet に流し、Export-Csv cmdlet に渡す前にいくつかのプロパティを除外しています。これは、CData Cmdlets が接続情報、テーブル、およびカラム情報が結果セットのそれぞれの"行"に挿入されるためです。それらの情報を表示したくない場合に、Export-Csv cmdlet に渡す前に除外を先に行い、それからCSV ファイルにエクスポートします。。

CData Cmdlets から、次のCmdlets にデータをパイプラインするところでは、接続、テーブル、カラムの情報が必要です。

データの削除

以下のように、指定に合致するレコードを削除することができます: 

Select-Backlog -Connection $conn -Table Issues -Where "Id = 1" | Remove-Backlog

データの挿入と更新

CData Cmdlets は、データの加工やクレンジングを行うことができます。以下の手順では、CSV ファイルのデータを、挿入対象のオブジェクトに同じレコードが存在するかを確認した上で、存在する場合にはデータの更新、存在しない場合にはデータの挿入を行います。 

Import-Csv -Path C:\MyIssuesUpdates.csv | %{
  $record = Select-Backlog -Connection $Backlog -Table Issues -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Backlog -Connection $backlog -Table Issues -Columns ("Id","ProjectID") -Values ($_.Id, $_.ProjectID) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Backlog -Connection $backlog -Table Issues -Columns ("Id","ProjectID") -Values ($_.Id, $_.ProjectID)
  }
}

このように、CData Cmdlets でデータ連携をシンプルに構成できます。Cmdlets では、モジュールのインストール、接続プロパティの設定だけで、データ連携の構築を始めることができます。是非、CData PowerShell Cmdlets の無償試用版をダウンロードして、シンプルかつパワフルなデータ連携を体感してください。