Box Signのリクエストのキャンセル
Box Signのリクエストのキャンセル
Box Signのリクエストは、まだ署名も拒否もされていない場合、Box Signのリクエストをキャンセルエンドポイントを使用してキャンセルできます。未署名の署名者は、ドキュメントに署名できなくなります。
リクエストをキャンセルできるのは、そのリクエストを作成したユーザー (リクエスト送信者) のみです。リクエストは、拒否された場合、全員が署名済みの場合、ドキュメントがまだ変換中の場合は、キャンセルできません。
cURL
curl -i -X POST "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>/cancel" \
-H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.signRequests.cancelSignRequest(createdSignRequest.id!);
Python Gen
client.sign_requests.cancel_sign_request(created_sign_request.id)
.NET Gen
await client.SignRequests.CancelSignRequestAsync(signRequestId: NullableUtils.Unwrap(createdSignRequest.Id));
Java
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();
signRequestInfo.cancel();
Python
sign_request = client.sign_request(sign_request_id='12345')
cancelled_sign_request = sign_request.cancel()
print(f'Cancelled Sign Request status is {cancelled_sign_request.status}')
.NET
BoxSignRequest cancelledSignRequest = await client.SignRequestsManager.CancelSignRequestAsync("12345");
Node
const signRequest = await client.signRequests.cancelById({
sign_request_id: 12345,
});
console.log(`Sign request id ${sr.id} cancelled`);
iOS
client.signRequests.cancelById(id: "1234") { (result: Result<SignRequest, BoxSDKError>) in
guard case let .success(signRequest) = result else {
print("Error cancelling sign request")
return
}
print("Sign request \(signRequest.id) is cancelled")
}