署名リクエストのリストを取得
ユーザーが作成した署名リクエストを取得します。sign_filesやparent_folderが削除された場合、署名リクエストはリストで返されません。
リクエストの例
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)
}
}レスポンスの例
{
"entries": [
{
"is_document_preparation_needed": true,
"redirect_url": "https://www.example.com",
"declined_redirect_url": "https://declined-redirect.com",
"are_text_signatures_enabled": true,
"email_subject": "Sign Request from Acme",
"email_message": "Hello! Please sign the document below",
"are_reminders_enabled": true,
"parent_folder": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"name": "name",
"prefill_tags": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26T08:12:13.982Z"
}
],
"days_valid": 2,
"external_id": "123",
"is_phone_verification_required_to_view": true,
"template_id": "123075213-af2c8822-3ef2-4952-8557-52d69c2fe9cb",
"type": "sign-request",
"source_files": [
{
"id": "12345",
"etag": "1",
"type": "file"
}
],
"signers": [
{
"email": "example@gmail.com",
"role": "signer",
"is_in_person": true,
"order": 2,
"embed_url_external_user_id": "1234",
"redirect_url": "https://example.com",
"declined_redirect_url": "https://declined-example.com",
"login_required": true,
"verification_phone_number": "6314578901",
"password": "SecretPassword123",
"has_viewed_document": true,
"signer_decision": {
"type": "signed",
"finalized_at": "2021-04-26T08:12:13.982Z"
},
"inputs": [
{
"document_tag_id": "1234",
"text_value": "text",
"checkbox_value": true,
"date_value": "2021-04-26T08:12:13.982Z",
"type": "text",
"content_type": "signature",
"page_index": 4
}
],
"embed_url": "https://example.com"
}
],
"signature_color": "blue",
"id": "12345",
"prepare_url": "https://prepareurl.com",
"signing_log": {
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
},
"status": "converting",
"sign_files": {
"files": [
{
"id": "12345",
"etag": "1",
"type": "file",
"sequence_id": "3",
"name": "Contract.pdf",
"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
"file_version": {
"id": "12345",
"type": "file_version",
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
}
}
],
"is_ready_for_download": true
},
"auto_expire_at": "2021-04-26T08:12:13.982Z"
}
],
"limit": 1000,
"next_marker": 3000,
"prev_marker": 1000
}