Box Sign: 署名リクエストキャンセル
この工程は、Box 上の指定の署名リクエストをキャンセルします。
Basic Configs
- 工程名
- メモ
Configs for this Auto Step
- conf_OAuth2
- C1: OAuth2 設定 *
- conf_RequestId
- C2: 署名リクエスト ID *
Notes
- Box プラットフォームで Box Sign が有効にされている必要があります（デフォルト：無効）
- C1: OAuth2 設定で認証を得るユーザは、Box のBusiness プランのユーザーアカウントが必要です
- Box のプランによって、署名を依頼できるドキュメント数には制限があります
- 詳細は Box のドキュメントを参照してください
- C2: 署名リクエスト ID に設定する署名リクエストの ID は、Box: 署名リクエスト作成 で取得できます
- Box Sign の WebUI で表示される署名リクエスト ID とは別の値です
- ステータスが原因でキャンセルできなかった場合も正常終了します
- 署名済（Signed）、キャンセル済（Canceled）、拒否（Declined）、変換中（Converting）など
Capture
See Also
Script (click to open)
- 次のスクリプトが記述されている XML ファイルをダウンロードできます
- box-sign-request-cancel.xml (C) Questetra, Inc. (MIT License)
- Professional のワークフロー基盤では、ファイル内容を改変しオリジナルのアドオン自動工程として活用できます
function main() {
const oauth2 = configs.getObject("conf_OAuth2");
const requestId = decideRequestId();
cancelRequest(oauth2, requestId);
}
/**
* リクエストIDをconfigから読み出して出力する。
* @return {String} requestId リクエスト ID
*/
function decideRequestId() {
const requestIdDef = configs.getObject("conf_RequestId");
requestId = engine.findData(requestIdDef);
if (requestId === null) {
throw "Request ID is blank";
}
return requestId;
}
/**
* 署名リクエストキャンセル
* 全員署名済、拒否、キャンセル済、変換中等、ステータスが原因でキャンセルに失敗する場合は正常終了
* ステータス以外が原因でキャンセルに失敗する場合はエラーにする
* @param {AuthSettingWrapper} oauth OAuth2 設定
* @param {String} requestId 署名リクエストの ID
*/
function cancelRequest(oauth2, requestId) {
const url = `https://api.box.com/2.0/sign_requests/${requestId}/cancel`;
const response = httpClient.begin()
.authSetting(oauth2)
.post(url);
const status = response.getStatusCode();
const responseTxt = response.getResponseAsString();
if (status === 200) {
engine.log(`status: ${status} Request was cancelled, request ID: ${requestId}`);
return;
} else if (status === 400) {
engine.log(responseTxt);
engine.log('The status can be "Signed", "Canceled", "Declined", or "Converting".');
return;
} else {
const error = `Failed to cancel. status: ${status}`;
engine.log(responseTxt);
throw error;
}
}