スマラジ！SmartDB REST API基本編 PowerShellスクリプト

スマラジ！SmartDBのAPIを使ってみよう！ ～全6回で習得！REST APIアプリ操作基本編②～で使用するハンズオン用PowerShellコードをご案内します。

目次

1. リクエスト作成時の参照先
2. 名刺情報（連携元データ）のイメージ
3. バインダトークン
4. 「文書番号を取得する」APIの実行
5. 「文書を更新する」APIの実行

リクエスト作成時の参照先

・SmartDB環境

https://seminar.smartdb.jp/

・RestDocV3

https://doc.support-dreamarts.com/SmartDB/Document/RestDocDocumentV3/index.html

名刺情報（連携元データ）のイメージ

変更前

変更後

バインダトークン

「文書番号を取得する」APIの実行

PowerShellスクリプト

リクエスト作成時の参照先を参照して、1～6の項目を書き換えてリクエストを完成させてください。

$URI = "【1.プロトコル、ホスト名、リソースパス】" `
       + "?personalId=【2.人物ID】:EXACT"
$Method = "【3.HTTPメソッド】"
$Headers = @{
           "【4.認証のヘッダ】" = "Bearer 【5.バインダトークン】"
           "Content-type"="application/json"
           }
Invoke-WebRequest $URI -Method $Method -Headers $Headers -UseBasicParsing -OutFile .\response_DocList.json

解説

1. SmartDB REST API（指定したビューの文書一覧取得）の画面右上からURIを指定。
   同ページの「PATH PARAMETERS」からパスパラメータ（ここでは{binder}、{view}）の記述形式を確認して、SmartDBの文書一覧画面にある「文書一覧・ビュー情報」からパスパラメータの値を指定。
2. SmartDB REST API（指定したビューの文書一覧取得）の「QUERY PARAMETERS」から文書の絞り込みに必要なクエリパラメータの記述形式を確認して、他システムから連携されたデータ（ここでは「名刺情報（連携元データ）のイメージ」の「人物ID」）からクエリパラメータの値を指定。
3. SmartDB REST API（指定したビューの文書一覧取得）の画面右上からHTTPメソッドを指定。
4. SmartDB REST API（TOPぺージ）の「REST API実行時のセッションについて」から認証方式を確認して、リクエストヘッダの認証項目を指定 。
5. バインダトークンから認証に用いるバインダトークンを指定。

「文書を更新する」APIの実行

PowerShellスクリプト

※リクエスト作成時の参照先を参照して、1～6の項目を書き換えてリクエストを完成させてください。

$URI = "【1.プロトコル、ホスト名、リソースパス】"
$Method = "【2.HTTPメソッド】"
$Headers = @{
           "【3.認証のヘッダ】" = "Bearer 【4.バインダトークン】"
           "Content-type"="application/json"
           }
$Body = @{
           "【5.部署名の部品キー】" = "【6.部署名の値】"
       }
$Body = $Body | ConvertTo-Json
$Body = [System.Text.Encoding]::UTF8.GetBytes($Body)
Invoke-WebRequest $URI -Method $Method -Headers $Headers -Body $Body -UseBasicParsing -OutFile .\response_PUTDoc.json

解説

1. SmartDB REST API（文書更新）からURIを指定。
   同ページの「PATH PARAMETERS」からパスパラメータ（ここでは{binder}、{document}）の記述形式を確認して、SmartDBの文書一覧画面にある「文書一覧・ビュー情報」からパスパラメータの{binder}を指定。
   「文書番号を取得する」で取得した文書番号からパスパラメータの{document}を指定。
2. SmartDB REST API（文書更新）からHTTPメソッドを指定。
3. SmartDB REST API（TOPぺージ）の「REST API実行時のセッションについて」から認証方式を確認して、リクエストヘッダの認証項目を指定。
4. バインダトークンから認証に用いるバインダトークンを指定。
5. SmartDB REST API（文書更新）の「REQUEST BODY SCHEMA」からリクエストボディの記述形式を確認して、SmartDBの新フォーム定義にある部品の「属性パネル」からリクエストボディの項目を指定。
6. SmartDB REST API（文書更新）の「REQUEST BODY SCHEMA」からリクエストボディの記述形式を確認して、他システムから連携されたデータ（ここでは「名刺情報（連携元データ）のイメージ」の「部署名」）からリクエストボディの値を指定。