コラボフロー REST APIを実行する

JavaScript APIを使って、コラボフロー REST APIを実行する方法について説明します。

JavaScript APIでは、コラボフロー REST APIを呼び出すための関数が用意されています。

関数はそれぞれHTTPメソッド毎に用意されており、どの関数も非同期で処理され、Promiseを返します。
サーバーからデータを受信したらthen()で登録したハンドラーが呼び出されます。

コラボフロー REST API呼び出し
関数

コラボフロー REST APIを呼び出す際のメソッド毎に関数が用意されています。
引数、戻り値はどの関数を利用した場合でも同一です。
関数
Copied!

// getメソッドでの呼び出し
collaboflow.api.get(path, parameters);

// postメソッドでの呼び出し
collaboflow.api.post(path, parameters);

// putメソッドでの呼び出し
collaboflow.api.put(path, parameters);

// deleteメソッドでの呼び出し
collaboflow.api.delete(path, parameters);

引数

引数

タイプ

説明

path

string

REST APIリファレンス

に記載のパスを指定します

parameters

object

REST APIに応じたパラメータをオブジェクト型で指定します。


記述例
記述例
Copied!

(function() {
// リストが変更されたら関連文書の情報を取得する
collaboflow.events.on('request.input.fidList.change', function(event) {
var refId = event.parts.fidOtherDocumentID.value;
console.log('関連の文書ID:' + refId);

// コラボフローAPIで申請書情報を取得
collaboflow.api.get('/v1/documents/' + refId, {
"app_cd": 1,
})
.then(function(response) {
// HTTPステータスと応答ボディ
console.log(response.status, response.body);

// API応答がエラーとなった場合の処理
if(response.body.error) {
console.log('失敗', response.body.messages);
return;
}

// REST APIに応じた処理
event.parts.fidCaption.value = response.body.title;
})
.catch(function(err) {
console.log(err);
});
});
})();

戻り値

then()で登録したイベントハンドラーで受け取るresponseオブジェクトの内容を示します。

プロパティ名

タイプ

補足

status

numeric

REST APIが返した応答HTTPステータスコードです。

詳細は

REST APIリファレンス

を参照ください。

status_text

string

headers

object

コラボフローサーバーから受信したヘッダー情報です。

body

object

REST APIからの応答内容（JSON）が、オブジェクト型に変換した状態で格納されています。


制限事項
JavaScript APIでは、 REST APIリファレンス に記載されている以下APIは利用できません。

帳票出力API
添付ファイルのアップロードAPI
添付ファイルのダウンロードAPI