Box Signのリクエストのリスト取得

ガイド Box Sign Box Signのリクエストのリスト取得

Box Signのリクエストのリスト取得

すべて

署名リクエストを取得エンドポイントを使用すると、渡されたアクセストークンに関連付けられたユーザーが作成したBox Signのすべてのリクエストのリストを表示できます。

cURL
curl -i -X GET "https://api.box.com/2.0/sign_requests" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxCollectionMarkerBased<BoxSignRequest> signRequests = await client.SignRequestsManager.GetSignRequestsAsync();
Java
Iterable<BoxSignRequest.Info> signRequests = BoxSignRequest.getAll(api);
for (BoxSignRequest.Info signRequestInfo : signRequests) {
	// Do something with each `signRequestInfo`.
}
Python
sign_requests = client.get_sign_requests()
for sign_request in sign_requests:
    print(f'(Sign Request ID: {sign_request.id})')
Node
const result = await client.signRequests.getAll();
console.log(`There are ${result.count} sign requests`);
iOS
let iterator = client.signRequests.list()
iterator.next { results in
    switch results {
    case let .success(page):
        for signRequest in page.entries {
            print("Sign request \(signRequest.id)")
        }

    case let .failure(error):
        print(error)
    }
}

IDの指定

IDを指定して署名リクエストを取得エンドポイントを使用すると、Box Signの特定のリクエストに関する情報を表示できます。このエンドポイントには、署名リクエストのIDが必要です。このIDは、Box Signのすべてのリクエストを取得エンドポイントを使用して取得するか、Box Signのリクエストを作成する際にレスポンスで取得することができます。

cURL
curl -i -X GET "https://api.box.com/2.0/sign_requests/<SIGN_REQUEST_ID>" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxSignRequest signRequest = await client.SignRequestsManager.GetSignRequestByIdAsync("12345");
Java
BoxSignRequest signRequest = new BoxSignRequest(api, id);
BoxSignRequest.Info signRequestInfo = signRequest.getInfo();

//using `fields` parameter
BoxSignRequest.Info signRequestInfoWithFields = signRequest.getInfo("status")
Python
sign_request = client.sign_request(sign_request_id='12345').get()
print(f'Sign Request ID is {sign_request.id}')
Node
const sr = await client.signRequests.getById({
	sign_request_id: 12345,
});
console.log(
	`Sign request id ${sr.id} contains ${sr.source_files.length} files`
);
iOS
client.signRequests.getById(id: "1234") { (result: Result<SignRequest, BoxSDKError>) in
    guard case let .success(signRequest) = result else {
        print("Error getting sign request")
        return
    }

    print("Sign request \(signRequest.id)")
}