{"openapi":"3.0.2","info":{"version":"0.37.1","title":"クラウドサイン Web API","description":"クラウドサイン Web API の仕様書です。 \\\nスキーマ定義はページ下部の [Schemas] に記載されています。 \\\n各エンドポイントはHTTPステータスコードとスキーマを返却します。\n- HTTPステータスコードは、各エンドポイント欄 > [Responses] > [Code] をご確認ください。\n- スキーマ情報は、各エンドポイント欄 > [Responses] > [Description] > [Example Value | Schema] の `Schema` を押すと表示できます。\n"},"servers":[{"url":"https://api.cloudsign.jp","description":"プロダクション環境"},{"url":"https://api-sandbox.cloudsign.jp","description":"サンドボックス環境"},{"url":"https://lgwan-api.cloudsign.jp","description":"LGWAN プロダクション環境"},{"url":"https://lgwan-api-sandbox.cloudsign.jp","description":"LGWAN サンドボックス環境"}],"tags":[{"name":"token","description":"クラウドサインのWebAPIを実行に必要なアクセストークンを取得"},{"name":"documents","description":"書類の作成/書類の一覧を取得/書類のデータを取得/書類のデータを更新/下書きの削除/書類の却下"},{"name":"alert","description":"アラートの取得/作成/更新"},{"name":"attribute","description":"書類情報の取得/作成/更新"},{"name":"files","description":"ファイルの追加/取得/削除"},{"name":"participants","description":"宛先の追加/更新/削除/組み込み署名関連"},{"name":"widgets","description":"入力項目の追加/変更/削除"},{"name":"reportees","description":"共有先の追加/更新/削除"},{"name":"attachments","description":"添付書類の追加/更新/削除/ダウンロード"},{"name":"certificate","description":"合意締結証明書の取得"},{"name":"imported_documents","description":"書類のインポート"},{"name":"me","description":"APIを実行しているユーザー/チーム情報の取得"},{"name":"team_documents","description":"チームのメンバーがやり取りした書類一覧の取得（エンタープライズプランでは使用不可）"},{"name":"cabinets","description":"キャビネット一覧の取得（エンタープライズプラン限定）"},{"name":"cabinet_documents","description":"キャビネット内の書類一覧の取得（エンタープライズプラン限定）"},{"name":"非推奨","description":"今後廃止予定のため、新規でAPI連携される方は使用しないでください"}],"paths":{"/token":{"get":{"tags":["非推奨"],"summary":"アクセストークンを取得（非推奨）","deprecated":true,"description":"このエンドポイントは非推奨です。 \\\n代わりに POST /token を利用してください。 \\\nリクエストが成功した場合、このエンドポイントは [accessTokenModel](#accessTokenModel) を返却します。 \\\n返却されるレスポンスのスキーマ情報は「Schemas」セクションを参照してください。\n","parameters":[{"name":"client_id","in":"query","description":"クライアント ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`accessTokenModel`)","$ref":"#/paths/~1token/post/responses/200"},"400":{"$ref":"#/paths/~1token/post/responses/400"},"403":{"$ref":"#/paths/~1token/post/responses/403"},"500":{"$ref":"#/paths/~1token/post/responses/500"}}},"post":{"tags":["token"],"summary":"クラウドサイン Web API の実行に必要なアクセストークンを取得する","description":"アクセストークンの取得にはクライアント ID が必要です。\\\nクライアント ID は、クラウドサイン の [管理画面] > [アカウント] > [クライアントID] 画面 [https://www.cloudsign.jp/api/clients](https://www.cloudsign.jp/api/clients) から発行、確認できます。\\\n取得したアクセストークンの有効期限は発行されてから1時間（3,600秒）です。\\\nこの有効期限を超過した場合、再度アクセストークンの取得が必要です。\\\nアクセストークン取得後、有効期限内に再度アクセストークンの取得をリクエストしても、新しいアクセストークンは発行されません。 \\\n\\\nリクエストが成功した場合、このエンドポイントは [accessTokenModel](#accessTokenModel) を返却します。\\\n返却されるレスポンスのスキーマ情報は「Schemas」セクションを参照してください。\n","requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"client_id":{"description":"クライアント ID","type":"string"}},"required":["client_id"]}}}},"responses":{"200":{"description":"正常時 (返却モデル：`accessTokenModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/accessTokenModel"}}}},"400":{"description":"client_id が空の場合、 error の値は invalid_request (返却モデル：`errorModel`)\\\n不適切な client_id の場合、 error の値は invalid_client (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 無効なユーザーのクライアント ID を使用したリクエストの場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents":{"post":{"tags":["documents"],"summary":"書類を新規作成","description":"書類の作成を行います。\\\n作成した書類のデータを取得する場合は、作成時に返却される書類 ID を利用して GET /documents/{documentID} を実行してください。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークン、またはリクエストパラメータが不正な場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- template_id 指定時に指定された書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"title":{"description":"書類のタイトル","type":"string"},"note":{"$ref":"#/components/schemas/requestBodyNote"},"message":{"description":"書類に関するメッセージ\\\n書類送信時に受信者に指定された任意のメッセージ\n","type":"string"},"template_id":{"description":"既存のテンプレートから書類作成を行う場合の元となるテンプレートの書類 ID","type":"string"},"can_transfer":{"description":"受信者に転送を許可するフラグ\\\n指定できる値はtrue、またはfalse\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\n","type":"boolean","default":false},"private":{"description":"親展書類として送信するフラグ\\\nチーム設定で親展書類の送信が許可されている場合のみ指定可能\\\n指定できる値はtrue、またはfalse\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\n","type":"boolean","default":false}}}}}}},"get":{"tags":["documents"],"summary":"書類の一覧を取得 (ページングあり)","description":"書類の一覧を取得します。\\\n一覧のページングを行う場合は、page パラメータを指定してください。\\\nデータ量に対して大きすぎる値を渡した場合は documents の配列は空となります。\\\nリクエストが成功した場合、このエンドポイントは [documentListModel](#documentListModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"page","in":"query","allowEmptyValue":true,"description":"一覧のページングを指定する\\\nページ番号は 1 から始まる\\\n 1 ページあたり最大 100 件のデータを取得\\\n値を指定しない場合、または不適切な値を指定した場合は、デフォルト値の 1 が適用される\\\n一覧のデータ量に対して大きすぎる値を指定した場合は返却モデル：`documentListModel` の documents の配列は空となる\n","schema":{"type":"integer","default":1}},{"name":"status","in":"query","allowEmptyValue":true,"description":"状態で絞り込みを行う\n * -1 - 全ての状態\n * 0 - 下書き\n * 1 - 先方確認中\n * 2 - 締結済\n * 3 - 取消、または却下\n * 4 - テンプレート\n","schema":{"type":"integer","enum":[-1,0,1,2,3,4],"default":-1}},{"name":"with_files","in":"query","allowEmptyValue":true,"description":"ファイルの情報が不要な場合は、 y 以外の値を指定する","schema":{"type":"string","default":"y"}},{"name":"with_participants","in":"query","allowEmptyValue":true,"description":"参加者の情報が不要な場合は、 y 以外の値を指定する","schema":{"type":"string","default":"y"}},{"name":"with_reportees","in":"query","allowEmptyValue":true,"description":"共有先の情報を取得する場合は、 y を指定する","schema":{"type":"string","default":"n"}},{"name":"with_shared_templates","in":"query","allowEmptyValue":true,"description":"取得対象に書類管理者が共有したテンプレートを含む場合は、 y を指定する\\\nstatus に 4 を指定した場合のみ有効となる\n","schema":{"type":"string","default":"n"}},{"name":"with_attachment","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に添付書類の情報を付加する","schema":{"type":"string"}},{"name":"from","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の開始日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}},{"name":"to","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の終了日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentListModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentListModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- status の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合、 error の値は forbidden (返却モデル：`errorModel`)\\\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}":{"get":{"tags":["documents"],"summary":"書類のデータを取得","description":"指定した書類のデータを取得します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST / PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"put":{"tags":["documents"],"summary":"書類のデータを更新","description":"指定した書類のデータを更新します。\\\nnote の情報を更新しても、`documentAttributeModel`の counterparty フィールドの情報は更新されません。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークン、またはリクエストパラメータが不正な場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST / PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"title":{"description":"書類のタイトル","type":"string"},"note":{"$ref":"#/components/schemas/requestBodyNote"},"message":{"description":"書類に関するメッセージ\\\n書類送信時に受信者に指定された任意のメッセージ\n","type":"string"},"can_transfer":{"description":"受信者に転送を許可するフラグ\\\n指定できる値はtrue、またはfalse\\\ntrueの代わりに1, t, T, TRUE, True、falseの代わりに0, f, F, FALSE, Falseを指定可能\n","type":"boolean"},"private":{"description":"親展書類として送信するフラグ\\\nチーム設定で親展書類の送信が許可されている場合のみ指定可能\\\n指定できる値はtrue、またはfalse\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\n","type":"boolean","default":false}}}}}}},"post":{"tags":["documents"],"summary":"書類を送信またはリマインド","description":"指定した書類が下書き状態の場合には書類の送信を、書類が先方確認中状態の場合にはリマインドを行います。\\\nなお、Web API による書類送信では、承認機能による送信制御は行われません。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- 送信者に割り当てられた入力項目の値が設定されていない場合\n- 参加者（送信者と1人以上の受信者）やファイル（1つ以上）が不足している書類を操作しようとした場合\n- 組込み署名（SMS認証）が設定された受信者にリマインドを行おうとした場合\n- 送信者にマイナンバーカード署名が選択されている場合\n- PDFファイル構造に問題がある場合\n- 並列署名グループの設定が不整合な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態または先方確認中状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST / PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"delete":{"tags":["documents"],"summary":"下書きを削除","description":"指定した書類が下書き状態の場合、書類を削除します。","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"204":{"description":"正常時"},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- 書類が下書きでない場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_require (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST / PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/alert":{"get":{"tags":["alert"],"summary":"書類のアラート情報を取得","description":"指定した書類のアラート情報を取得します。\nリクエストが成功した場合、このエンドポイントは [documentAlertModel](#documentAlertModel) を返却します。\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentAlertModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentAlertModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類、アラートが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"put":{"tags":["alert"],"summary":"書類のアラート情報を作成・更新","description":"指定した書類のアラート情報が存在しない場合は作成、存在する場合は更新します。\nリクエストが成功した場合、このエンドポイントは [documentAlertModel](#documentAlertModel) を返却します。\nスキーマの詳細は「Schemas」セクションを参照してください。\n\nリクエストの `Content-Type` は `application/x-www-form-urlencoded` のみ受け付けます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentAlertModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentAlertModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類、アラートが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"415":{"description":"リクエストの `Content-Type` が `application/x-www-form-urlencoded` 以外の場合、 error の値は unsupported_media_type (返却モデル：`errorModel`)\nこのエラーが返却された場合、アラート情報は変更されません。\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"memo":{"type":"string","description":"書類に設定するアラートメモ","maxLength":1000},"alert_at":{"type":"string","description":"書類に設定するアラート日","format":"date","example":"2020-01-01"},"enabled":{"description":"書類に設定するアラートのON/OFF","type":"boolean"}}}}}}}},"/documents/{documentID}/attribute":{"get":{"tags":["attribute"],"summary":"書類の書類情報を取得","description":"指定した書類の書類情報を取得します。\\\nリクエストが成功した場合、このエンドポイントは [documentAttributeModel](#documentAttributeModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentAttributeModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentAttributeModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類情報にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類情報が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"put":{"tags":["attribute"],"summary":"書類の書類情報を作成・更新","description":"指定した書類の書類情報が存在しない場合は作成、存在する場合は書類情報を更新します。\\\n`Content-Type: application/json` のみリクエストを受け付けます。\\\nオブジェクトのキーはそれぞれ省略可能です。\\\n省略された場合は、対応する`documentAttributeModel`の値は変更されません。\\\n書類が「下書き」状態の場合に counterparty の情報を更新すると、その内容が`documentModel`の note フィールドにも反映されます。\\\nこの動作は、画面上で手動で操作した場合と同じ挙動です。\n\\\nリクエストが成功した場合、このエンドポイントは [documentAttributeModel](#documentAttributeModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentAttributeModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentAttributeModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類情報にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentAttributeUpsertRequest"}}}}}},"/documents/{documentID}/certificate":{"get":{"tags":["certificate"],"summary":"書類の合意締結証明書をダウンロード","description":"指定した書類の合意締結証明書をダウンロードします。\\\nリクエストが成功した場合、このエンドポイントは PDF ファイルを返却します。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 合意締結証明書PDFファイルが返却される","content":{"application/json":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"以下のいずれかの条件に該当する場合、 error の値は not_found (返却モデル：`errorModel`)\n- 指定された書類が存在しない場合\n- 書類のステータスが締結済み以外の場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"429":{"description":"同一のアクセストークンを用いたリクエストが1分間に800回を超えた場合 、それ以降のリクエストはブロックされます。\\\nブロックは1分間の停止期間を挟んで自動的に解除されます。\\\nerror の値は too_many_requests (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/decline":{"put":{"tags":["documents"],"summary":"書類を却下","description":"自分が送信した先方確認中の指定した書類を却下します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- 却下理由が1001文字以上の場合\n- 書類が先方確認中でない場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"comment":{"description":"却下理由を表す文字列","type":"string","maxLength":1000}}}}}}}},"/documents/{documentID}/files":{"post":{"tags":["files"],"summary":"書類にファイルを追加","description":"指定した書類にファイルを追加します。\n- 添付するファイルの容量はおおよそ 50MB を上限とする\n- 正確にはリクエストのボディ全体で 50MB を上限とする\n- 送付するファイルの合計サイズは 200MB を上限とする\n- 送付するファイルの合計件数は 100件 を上限とする\n\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","required":true,"in":"path","description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- アップロードしたファイルの内容が空の場合\n- アップロードしたファイルの合計サイズが 200MB を超えた場合\n- アップロードしたファイルの合計件数が 100件 を超えた場合\n- アップロードしたファイルの先頭にヘッダー情報 %PDF- がない場合\n- アップロードしたファイルが %%EOF で終端していない場合\n- アップロードしたファイル名にダブルクォーテーション \" が含まれる場合\n- アップロードしたファイル名の末尾がバックスラッシュ \\ の場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"413":{"description":"リクエストのボディ全体のサイズが 50MB を超えた場合、 error の値は too_large_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"415":{"description":"以下のいずれかの条件に該当する場合、 error の値は unsupported_media_type (返却モデル：`errorModel`)\n- PDF 以外のファイルをアップロードした場合\n- Content-Type に multipart/form-data を付与していなかった場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"name":{"type":"string"},"uploadfile":{"type":"string","format":"binary"}}}}}}}},"/documents/{documentID}/files/{fileID}":{"get":{"tags":["files"],"summary":"書類の特定のファイルをダウンロード","description":"指定した書類の特定のファイルをダウンロードします。\\\nリクエストが成功した場合、このエンドポイントは PDF ファイルを返却します。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"fileID","in":"path","required":true,"description":"ファイルのID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 PDFファイルが返却される","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- LGWAN環境ではダウンロードできないファイルを指定した場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類またはファイルが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"delete":{"tags":["files"],"summary":"書類の特定のファイルを削除","description":"指定した書類の特定のファイルを削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"fileID","in":"path","required":true,"description":"ファイルのID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類またはファイルが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/participants":{"post":{"tags":["participants"],"summary":"書類に宛先を追加","description":"指定した書類に宛先を追加します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\\\n追加した宛先は、書類内のすべての宛先の後ろに入ります。確認依頼は、[participantModel](#participantModel) の `order` が小さい宛先から送信されます。送信順を指定するパラメータはありません。\\\nただし、`group_type` と `group_id` を指定して既存の並列署名グループに追加した場合は、宛先がそのグループの末尾に挿入されます。詳しくは `order` の説明を参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n- すでに宛先に含まれている email を指定した場合\n- group_id を指定したが group_type が指定されていない場合\n- group_type に 1 以外の値を指定した場合\n- callback=true と group_type を同時に指定した場合\n- 機密書類に group_type を指定した場合\n- 指定した group_id が書類内に存在しない場合\n- 既存グループの group_type と一致しない group_type を指定した場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 並列署名機能を利用できるプランでない状態で group_type または group_id を指定した場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"409":{"description":"受信者数が上限(128)に達している場合、 error の値は conflict (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"name":{"description":"宛先の名前","type":"string"},"email":{"$ref":"#/components/schemas/requestBodyEmail"},"organization":{"description":"宛先の会社名など","type":"string"},"access_code":{"description":"表示をする際に要求されるアクセスコード","type":"string"},"language_code":{"description":"受信者の言語設定\\\n指定できる値はja（日本語）、en（英語）、zh-CHS（簡体字）、zh-CHT（繁体字）の４つ\\\n何も設定しない場合の値はja（日本語）\\\n以下のいずれかの条件に該当する場合、 ja（日本語）を設定してください\n- advanced_authn_requestをtrueにする場合\n- callbackがtrueの場合\n","type":"string","default":"ja"},"advanced_authn_request":{"description":"高度な認証による署名を設定\\\ntrue にした場合高度な認証による署名機能が有効となる\\\nデフォルトはfalse\\\nstring 型でも設定が可能\\\ntrue の場合は 1、t、T、TRUE、True\\\nfalse の場合は 0, f, F, FALSE, False\\\ntrueにした時、language_codeを設定する際は ja を設定してください\n","type":"boolean","default":false},"tel":{"description":"宛先の電話番号\\\n組込み署名 （SMS認証）の場合は必須\\\n組込み署名 （SMS認証）のみ使用可能\\\nデフォルトは空\n","type":"string","format":"^0[6-9]0\\d{8}$"},"recipient_id":{"description":"連携システム側のユーザー識別子\\\n組込み署名 （簡易認証）の場合、必須\\\n組込み署名 （簡易認証）のみ使用可能\\\n半角英数字と記号（ASCII文字）のみ許可\\\n最大64バイト\\\nデフォルトは空\n","type":"string","maxLength":64,"pattern":"^[ -~]*$"},"callback":{"description":"受信者の組込み署名（SMS認証）フラグ\\\n指定できる値はtrue、またはfalse\\\nチームの設定で組込み署名（SMS認証）ができ、かつ、書類にマイナンバーカード署名が設定されている宛先が含まれていない場合のみ指定可能\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\\\ntrue にした時、advanced_authn_request は false のみ指定可能\\\ntrueにした時、group_type は指定できない\n"},"group_type":{"description":"グループ種別\\\n指定できる値は 1 (AND署名) のみ\\\nグループの宛先として追加する場合に指定\\\ncallback=true とは同時指定できない\n","type":"integer","enum":[1]},"group_id":{"description":"既存グループに追加する場合の group_id\\\n新規グループを作成する場合は指定しない (サーバ側で採番)\\\ngroup_type とセットで指定する必要がある\\\n書類内に該当グループが存在しない場合はエラー\n","type":"string"}},"required":["name"]}}}}}},"/documents/{documentID}/participants/{participantID}":{"put":{"tags":["participants"],"summary":"書類の特定の宛先情報を更新","description":"指定した書類の特定の宛先情報を更新します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"participantID","in":"path","required":true,"description":"宛先のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email が不適切な場合\n- すでに宛先に含まれている email を指定した場合\n- 言語設定がja（日本語）以外、かつ、マイナンバーカード署名または高度な認証による署名を選択されている場合\n- グループに所属している宛先に callback=true を指定した場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- 宛先操作の際に書類の送信者を対象とした場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または宛先が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/requestBodyEmail"},"name":{"description":"宛先の名前","type":"string"},"organization":{"description":"宛先の会社名など","type":"string"},"access_code":{"description":"表示をする際に要求されるアクセスコード","type":"string"},"language_code":{"description":"受信者の言語設定\\\n指定できる値はja（日本語）、en（英語）、zh-CHS（簡体字）、zh-CHT（繁体字）の４つ\\\n何も設定しない場合の値はja（日本語）\\\n以下のいずれかの条件に該当する場合、 ja（日本語）を設定してください\n- advanced_authn_requestをtrueにする場合\n- callbackがtrueの場合\n","type":"string"},"advanced_authn_request":{"description":"高度な認証による署名を設定\\\ntrue にした場合高度な認証による署名機能が有効となる\\\nstring 型でも設定が可能\\\ntrue の場合は 1、t、T、TRUE、True\\\nfalse の場合は 0, f, F, FALSE, False\\\ntrueにした時、language_codeを設定する際は ja を設定してください\n","type":"boolean"},"tel":{"description":"宛先の電話番号\\\n組込み署名 （SMS認証）の場合、必須\\\n組込み署名 （SMS認証）のみ使用可能\\\nデフォルトは空\n","type":"string","format":"^0[6-9]0\\d{8}$"},"recipient_id":{"description":"連携システム側のユーザー識別子\\\n組込み署名 （簡易認証）の場合、必須\\\n組込み署名 （簡易認証）のみ使用可能\\\n半角英数字と記号（ASCII文字）のみ許可\\\n最大64バイト\\\nデフォルトは空\n","type":"string","maxLength":64,"pattern":"^[ -~]*$"},"callback":{"description":"受信者の組込み署名（SMS認証）フラグ\\\n指定できる値はtrue、またはfalse\\\nチームの設定で組込み署名（SMS認証）ができ、かつ、書類にマイナンバーカード署名が設定されている宛先が含まれていない、かつ、グループに所属していない場合のみ指定可能\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\\\ntrue にした時、advanced_authn_request は false のみ指定可能\n"}}}}}}},"delete":{"tags":["participants"],"summary":"書類の特定の宛先を削除","description":"指定した書類の特定の宛先を削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\\\n宛先を削除すると、その宛先に設定されている入力項目もすべて削除されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"participantID","in":"path","required":true,"description":"宛先のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- 宛先操作の際に書類の送信者を対象とした場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または宛先が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/participant_groups/{groupID}":{"delete":{"tags":["participants"],"summary":"書類の署名グループを削除","description":"指定した書類の署名グループ（`group_id`）に所属する全ての宛先を一括で削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\\\nグループを削除すると、そのグループに所属する各宛先に設定されている入力項目もすべて削除されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"groupID","in":"path","required":true,"description":"削除対象の署名グループのID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または署名グループが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/participants/{participantID}/signing_url":{"post":{"tags":["participants"],"summary":"組込み署名（SMS認証）用の署名URLを取得","description":"組込み署名（SMS認証）が設定された受信者に同意 URL と有効期限の情報が返却されます。\\\nリクエストが成功した場合、このエンドポイントは [callbackSigningInfoModel](#callbackSigningInfoModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"participantID","in":"path","required":true,"description":"宛先のID","schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"recipient_id":{"description":"連携システム側のユーザー識別子\\\n組込み署名 （簡易認証）の場合、必須\\\n組込み署名 （簡易認証）のみ使用可能\\\nデフォルトは空\n","type":"string"}}}}}},"responses":{"200":{"description":"正常時 (返却モデル：`callbackSigningInfoModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/callbackSigningInfoModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- チームの設定で組込み署名（SMS認証）ができない場合\n- 受信者が同意できる状態でない場合\n- 受信者の設定で組込み署名（SMS認証）ができない場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または宛先が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/files/{fileID}/widgets":{"post":{"tags":["widgets"],"summary":"書類のファイルに入力項目を追加","description":"指定したファイルに入力項目を追加します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"fileID","in":"path","required":true,"description":"ファイルのID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n- page の値が不適切な場合、送信者宛の入力項目で text が空の場合\n- 送信者以外宛の入力項目で text が空でない場合\n- x または y の値が不適切な場合\n- inner_width の値が不適切な場合\n- font_size の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類またはファイルが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"participant_id":{"description":"宛先のID","type":"string"},"type":{"description":"入力項目の種類を整数で指定\n* 0 - 押印\n* 1 - フリーテキスト\n* 2 - チェックボックス\n","type":"integer"},"page":{"description":"入力項目を設置するページ番号を整数で指定\\\nなお、最初のページを0とする\n","type":"integer"},"x":{"description":"入力項目を設置する位置のX座標を整数で指定する\\\nなお、 fileID で指定した PDF ファイルの左端を0とする\n","type":"integer"},"y":{"description":"入力項目を設置する位置のY座標を整数で指定する\\\nなお、 fileID で指定した PDF ファイルの page で指定したページの上端を0とする\n","type":"integer"},"inner_width":{"description":"設置するフリーテキスト入力項目の横幅を整数で指定する\\\ntype が 1（フリーテキスト）の場合にのみ有効。type が 1 以外の場合は無視される。\\\n90 から 360 までの整数値で指定\\\n指定した場合、レスポンスの fixed_width が true になる\n","type":"integer","minimum":90,"maximum":360},"font_size":{"description":"type が 1（フリーテキスト）の場合に、フォントサイズを指定するためのポイント数を表す文字列。\\\ntype が 1 以外の場合は無視される。\\\n使用可能な値は、\"\"、\"8\"、\"9\"、\"10\"、\"11\"、\"12\"、\"13\"および\"14\"のいずれか。\\\n空文字列の場合はフォントサイズの指定がリセットされデフォルト状態になる。\\\nデフォルト状態に比べてフォントサイズを指定した場合では、PC画面上で入力内容の周りの余白が小さくなる。\\\nデフォルト状態のフォントサイズは、12を指定した場合のフォントサイズに相当する。\n","type":"string","enum":["","8","9","10","11","12","13","14"]},"text":{"description":"入力項目を送信者に割り当てた場合、もしくは任意入力のチェックボックスを受信者に割り当てた場合、入力する内容を指定する\\\nチェックボックスの場合、1 を指定するとチェックが入り、空文字を指定するとチェックが外れる\\\nチェックボックスを送信者に割り当てた場合、指定した内容は無視されて 1 (チェック済み) として扱われる\n","type":"string"},"label":{"description":"入力項目のラベルを指定する","type":"string"},"required":{"description":"type が 2（チェックボックス）の場合に、チェックを必須とするかを設定するフラグ\\\n指定できる値はtrue(必須)、またはfalse(任意)\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\ntype が 2 以外の場合は無視される\n","type":"boolean","default":true}},"required":["participant_id","type","page","x","y"]}}}}}},"/documents/{documentID}/files/{fileID}/widgets/{widgetID}":{"put":{"tags":["widgets"],"summary":"書類のファイルの特定の入力項目を更新","description":"指定した入力項目を更新します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"fileID","in":"path","required":true,"description":"ファイルのID","schema":{"type":"string"}},{"name":"widgetID","in":"path","required":true,"description":"入力項目のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n- page の値が不適切な場合\n- x または y の値が不適切な場合\n- inner_width の値が不適切な場合\n- font_size の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類・ファイル、または入力項目が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT/DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"participant_id":{"type":"string"},"type":{"type":"integer"},"page":{"type":"integer"},"x":{"type":"integer"},"y":{"type":"integer"},"inner_width":{"description":"設置するフリーテキスト入力項目の横幅を整数で指定する\\\ntype が 1（フリーテキスト）の場合にのみ有効。type が 1 以外の場合は無視される。\\\n90 から 360 までの整数値で指定\\\n指定した場合、レスポンスの fixed_width が true になる\n","type":"integer","minimum":90,"maximum":360},"font_size":{"description":"type が 1（フリーテキスト）の場合に、フォントサイズを指定するためのポイント数を表す文字列。\\\ntype が 1 以外の場合は無視される。\\\n未指定の場合は元の値を維持する。\\\n使用可能な値は、\"\"、\"8\"、\"9\"、\"10\"、\"11\"、\"12\"、\"13\"および\"14\"のいずれか。\\\n空文字列の場合はフォントサイズの指定がリセットされデフォルト状態になる。\\\nデフォルト状態に比べてフォントサイズを指定した場合では、PC画面上で入力内容の周りの余白が小さくなる。\\\nデフォルト状態のフォントサイズは、12を指定した場合のフォントサイズに相当する。\n","type":"string","enum":["","8","9","10","11","12","13","14"]},"text":{"type":"string"},"label":{"description":"入力項目のラベルを指定する\\\n未指定の場合は元の値を維持する\n","type":"string"},"required":{"description":"type が 2（チェックボックス）の場合に、チェックを必須とするかを設定するフラグ\\\n指定できる値はtrue(必須)、またはfalse(任意)\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\ntype が 2 以外の場合は無視される\n","type":"boolean"}}}}}}},"delete":{"tags":["widgets"],"summary":"書類のファイルの特定の入力項目を削除","description":"指定した入力項目を削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"fileID","in":"path","required":true,"description":"ファイルのID","schema":{"type":"string"}},{"name":"widgetID","in":"path","required":true,"description":"入力項目のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類・ファイル、または入力項目が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT/DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/team_documents":{"get":{"tags":["team_documents"],"summary":"チーム内の全書類一覧を取得 (ページングあり)","description":"メンバー全員がやり取りした書類の一覧を取得します。\\\nこの API で返る書類一覧は、書類の状態が「先方確認中」「締結済」「取消、または却下」「インポート書類」のもののみで、下書きやテンプレートなどは含まれません。\\\nまた、この API は管理者権限を持たないアカウントや複数部署管理機能を利用しているアカウントは利用できません。\\\n一覧のページングを行う場合は、page パラメータを指定してください。\\\nリクエストが成功した場合、このエンドポイントは [documentListModel](#documentListModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"page","in":"query","allowEmptyValue":true,"description":"一覧のページングを指定する\\\nページ番号は 1 から始まる\\\n 1 ページあたり最大 100 件のデータを取得\\\n値を指定しない場合、または不適切な値を指定した場合は、デフォルト値の 1 が適用される\\\n一覧のデータ量に対して大きすぎる値を指定した場合は返却モデル：`documentListModel` の documents の配列は空となる\n","schema":{"type":"integer","default":1}},{"name":"with_files","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類にファイルの情報を付加する","schema":{"type":"string"}},{"name":"with_participants","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に参加者の情報を付加する","schema":{"type":"string"}},{"name":"with_reportees","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に共有先の情報を付加する","schema":{"type":"string"}},{"name":"with_attachment","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に添付書類の情報を付加する","schema":{"type":"string"}},{"name":"from","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の開始日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}},{"name":"to","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の終了日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentListModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentListModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- status の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 管理者権限が無いアカウントでアクセスした場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 複数部署管理機能を利用しているアカウントからのアクセスの場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET / POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/me":{"get":{"tags":["me"],"summary":"操作対象クライアントIDに紐づくユーザーの所属チーム/保持権限情報を取得","description":"APIを実行しているユーザーのユーザー情報およびチーム情報を返却します。\\\nこの API は複数部署管理機能を利用しているアカウントは利用できません。\\\nリクエストが成功した場合、このエンドポイントは [userModel](#userModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"responses":{"200":{"description":"正常時 (返却モデル：`userModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/userModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- status の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"複数部署管理機能を利用しているアカウントからのアクセスの場合、 error の値は forbidden (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/reportees":{"post":{"tags":["reportees"],"summary":"書類に共有先を追加","description":"指定した書類に共有先を追加します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/requestBodyReporteesEmail"},"name":{"description":"共有先の名前","type":"string","minLength":1,"maxLength":64},"organization":{"description":"共有先の会社名など","type":"string","minLength":0,"maxLength":64}},"required":["email","name"]}}}},"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n- すでに宛先/共有先に含まれている email を指定した場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/reportees/{reporteeID}":{"put":{"tags":["reportees"],"summary":"書類の特定の共有先の情報を更新","description":"指定した共有先の情報を更新します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n入力された全角スペースは半角スペースに変換されます。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"reporteeID","in":"path","required":true,"description":"共有先のID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"email":{"$ref":"#/components/schemas/requestBodyReporteesEmail"},"name":{"description":"共有先の名前","type":"string","minLength":1,"maxLength":64},"organization":{"description":"共有先の会社名など","type":"string","minLength":0,"maxLength":64}},"required":["name","email"]}}}},"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- email または name が空・不適切な場合\n- すでに宛先/共有先に含まれている email を指定した場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または共有先が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"delete":{"tags":["reportees"],"summary":"書類の特定の共有先を削除","description":"指定した共有先を削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"reporteeID","in":"path","required":true,"description":"共有先のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- 宛先操作の際に書類の送信者を対象とした場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または共有先が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/attachments":{"post":{"tags":["attachments"],"summary":"書類に添付書類を追加","description":"指定した書類に、受信者ファイルアップロード機能で用いる添付資料を追加します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"participant_id":{"description":"添付書類を割り当てる宛先の宛先ID","type":"string","minLength":32,"maxLength":36},"description":{"description":"添付書類についての説明","type":"string","minLength":0,"maxLength":200},"required":{"description":"true:ファイルアップロード必須/false:ファイルアップロード任意","type":"boolean","default":true}},"required":["participant_id"]}}}},"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- すでに添付書類がある場合\n- 宛先が書類の受信者でない場合\n- 書類にマイナンバーカード署名が設定されている宛先が含まれている場合\n- required の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 受信者ファイルアップロード機能を利用できるプランでない場合\n- 並列署名を利用した書類の場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/attachments/{attachmentID}":{"put":{"tags":["attachments"],"summary":"書類の特定の添付書類の情報を更新","description":"指定した添付書類の情報を更新します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"attachmentID","in":"path","required":true,"description":"添付書類のID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"participant_id":{"description":"添付書類を割り当てる宛先の宛先ID","type":"string","minLength":32,"maxLength":36},"description":{"description":"添付書類についての説明","type":"string","minLength":0,"maxLength":200},"required":{"description":"true:ファイルアップロード必須/false:ファイルアップロード任意","type":"boolean","default":true}}}}}},"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- 宛先が書類の受信者でない場合\n- required の値が不適切な場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 受信者ファイルアップロード機能を利用できるプランでない場合\n- 並列署名を利用した書類の場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または添付書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}},"delete":{"tags":["attachments"],"summary":"書類の特定の添付書類を削除","description":"指定した添付書類を削除します。\\\nリクエストが成功した場合、このエンドポイントは [documentModel](#documentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"attachmentID","in":"path","required":true,"description":"添付書類のID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 受信者ファイルアップロード機能を利用できるプランでない場合\n- 並列署名を利用した書類の場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\\\n下書き状態でない書類に対して操作をしようとした場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または添付書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"PUT / DELETE 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/documents/{documentID}/attachments/{attachmentID}/attached_files/{attachedFileID}":{"get":{"tags":["attachments"],"summary":"書類の特定の添付ファイルをダウンロード","description":"指定した添付ファイルをダウンロードします。\\\nリクエストが成功した場合、このエンドポイントは添付ファイルを返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"documentID","in":"path","required":true,"description":"書類のID","schema":{"type":"string"}},{"name":"attachmentID","in":"path","required":true,"description":"添付書類のID","schema":{"type":"string"}},{"name":"attachedFileID","in":"path","required":true,"description":"添付ファイルのID","schema":{"type":"string"}}],"responses":{"200":{"description":"正常時 受信者によりアップロードされた添付ファイルが返却される","content":{"application/json":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)\\\nLGWAN環境ではダウンロードできないファイルを指定した場合、 error の値は bad_request (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類にアクセスする権限が無い場合\n- 宛先操作の際に書類の送信者を対象とした場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n- 受信者ファイルアップロード機能を利用できるプランでない場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n\n以下のいずれかの条件に該当する場合、 error の値は not_acceptable (返却モデル：`errorModel`)\n- 合意締結が完了した状態でない書類に対して操作をしようとした場合\n- 添付ファイルのステータスが有効でない場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定された書類または添付書類が存在しない場合、 error の値は not_found (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/imported_documents":{"post":{"tags":["imported_documents"],"summary":"書類をインポート","description":"書類をインポートします。\\\n複数部署管理機能を利用しているアカウントでは、指定したキャビネットに書類が格納されます。\\\nリクエストが成功した場合、このエンドポイントは [importedDocumentModel](#importedDocumentModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","required":["uploadfile"],"properties":{"name":{"description":"name を指定した場合は書類名と書類ファイル名に適用される\\\n指定しない場合は uploadfile に指定したファイルのファイル名がそのまま適用される\\\n末尾が .pdf である必要がある\\\n.pdf を除き64文字以内で設定する\n","type":"string","maxLength":68},"uploadfile":{"description":"インポートするファイル\\\nファイルの容量は 50MB を上限とする\\\nファイルの種類は PDF のみ\n","type":"string","format":"binary"},"cabinet_id":{"description":"インポート先のキャビネットのID\\\n複数部署管理機能を利用しているアカウントからのアクセスの場合は必須\\\nそうでない場合は指定不可\n","type":"string","minLength":32,"maxLength":32}}}}}},"responses":{"200":{"description":"正常時 (返却モデル：`importedDocumentModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/importedDocumentModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- アクセストークンが適切に設定されていない場合\n- uploadfile が未指定の場合\n- uploadfile がPDFとして解釈できない場合\n- uploadfile がマイナンバーカード署名を含んでいる場合\n- uploadfile が `%%EOF` で終端していない場合\n- uploadfile のファイル名が空の場合\n- name が空で、かつ以下のいずれかの条件に該当する場合\n  - uploadfile のファイル名が68文字を超える場合\n  - uploadfile のファイル名の末尾が `.pdf` でない場合\n  - uploadfile のファイル名が拡張子のみの場合\n  - uploadfile のファイル名の拡張子の前が空白のみの場合\n- name が68文字を超える場合\n- name の末尾が `.pdf` でない場合\n- name が拡張子のみの場合\n- name の拡張子の前が空白のみの場合\n- 複数部署管理機能を利用していて、かつ cabinet_id が指定されていない場合\n- 複数部署管理機能を利用していて、かつ指定したキャビネットへのアクセス許可が無い場合\n- 複数部署管理機能を利用していなくて、かつ cabinet_id が指定されている場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 書類インポート機能フラグがOFFの場合\n- 複数部署管理機能を利用していて、かつ書類インポート権限が無い場合\n- 複数部署管理機能を利用していなくて、かつ書類管理権限が無い場合\n- IPアドレス制限機能を設定していて、かつ不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"POST 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"413":{"description":"アップロードしたファイルのサイズが 50MB を超えた場合、 error の値は payload_too_large (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"415":{"description":"Content-Type に multipart/form-data を付与していなかった場合、 error の値は unsupported_media_type (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/cabinets":{"get":{"tags":["cabinets"],"summary":"キャビネット一覧を取得","description":"キャビネットの一覧を取得します。\\\n1ページあたりのデータ数は最大100件まで取得可能です。\\\nアクセス許可があるキャビネットのみ取得できます。\\\n並び順はすべての書類のキャビネットが先頭で、その後にユーザーが作成したキャビネットがキャビネット名の昇順で並びます。\\\n一覧のページングを行う場合は、page パラメータを指定してください。\\\nリクエストが成功した場合、このエンドポイントは [cabinetListModel](#cabinetListModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"page","description":"一覧のページングを指定する\\\nページ番号は 1 から始まる\\\n 1 ページあたり最大 100 件のデータを取得\\\n値を指定しない場合、または不適切な値を指定した場合は、デフォルト値の 1 が適用される\\\n一覧のデータ量に対して大きすぎる値を指定した場合は返却モデル：`cabinetListModel` の cabinets の配列は空となる\n","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1}}],"responses":{"200":{"description":"正常時 (返却モデル：`cabinetListModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cabinetListModel"}}}},"400":{"description":"アクセストークンが適切に設定されていない場合、 error の値は bad_request (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- 複数部署管理機能を利用していないアカウントからのアクセスの場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}},"/cabinet_documents":{"get":{"tags":["cabinet_documents"],"summary":"キャビネット内の書類一覧を取得（エンタープライズプラン限定）","description":"指定したキャビネットに格納されている書類の一覧を取得します。\\\nこのエンドポイントはエンタープライズプランでのみ利用可能です。\\\n1ページあたりのデータ数は最大100件まで取得可能です。\\\nアクセス許可があるキャビネットのみ取得できます。\\\n一覧のページングを行う場合は、page パラメータを指定してください。\\\nリクエストが成功した場合、このエンドポイントは [documentListModel](#documentListModel) を返却します。\\\nスキーマの詳細は「Schemas」セクションを参照してください。\\\n\\\n注意事項：\\\n受信管理者側書類非表示が設定された書類は除外されます。\\\ntotal フィールドは検索エンジンがヒットした書類の総件数を返します。そのため、非表示書類を含む場合があります。\\\n取得できる書類の総数は最大 10,000 件（100 ページ）までです。10,000 件を超える書類がある場合は、from/to パラメータで期間を絞り込んでください。\n","security":[{"accessTokenAuth":[]}],"parameters":[{"name":"cabinet_id","in":"query","required":true,"description":"キャビネットID","schema":{"type":"string"}},{"name":"page","description":"一覧のページングを指定する\\\nページ番号は 1 から始まる\\\n1 ページあたり最大 100 件のデータを取得\\\n値を指定しない場合、または数字以外の不適切な値を指定した場合は、デフォルト値の 1 が適用される\\\n一覧のデータ量に対して大きすぎる値を指定した場合は返却モデル：`documentListModel` の documents の配列は空となる\n","in":"query","allowEmptyValue":true,"schema":{"type":"integer","minimum":1,"maximum":100,"default":1}},{"name":"with_files","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類にファイルの情報を付加する","schema":{"type":"string"}},{"name":"with_participants","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に参加者の情報を付加する","schema":{"type":"string"}},{"name":"with_reportees","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に共有先の情報を付加する","schema":{"type":"string"}},{"name":"with_attachment","in":"query","allowEmptyValue":true,"description":"値として y を渡した場合のみ、それぞれの書類に添付書類の情報を付加する","schema":{"type":"string"}},{"name":"from","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の開始日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}},{"name":"to","in":"query","allowEmptyValue":true,"description":"書類の最終処理日時で絞り込みをする際の終了日時を指定する（RFC3339準拠）","schema":{"type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"}}],"responses":{"200":{"description":"正常時 (返却モデル：`documentListModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/documentListModel"}}}},"400":{"description":"以下のいずれかの条件に該当する場合、 error の値は bad_request (返却モデル：`errorModel`)\n- cabinet_id パラメータが指定されていない場合\n- page パラメータに101以上の数値が指定された場合\n- from または to パラメータの日時形式が不正な場合\n- from が to より後の日時の場合\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"401":{"description":"アクセストークンが無効な場合、 error の値は unauthorized (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"403":{"description":"以下のいずれかの条件に該当する場合、 error の値は forbidden (返却モデル：`errorModel`)\n- エンタープライズプラン以外のユーザーからのアクセスの場合\n- 指定したキャビネットへのアクセス権限がない場合\n- IPアドレス制限機能を設定していて、不正なIPアドレスからリクエストした場合\n\nAPI オプションの契約が無いユーザーからのアクセスの場合、 error の値は webapi_option_required (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"404":{"description":"指定したキャビネットが存在しない場合、 error の値は not_found (返却モデル：`errorModel`)\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"405":{"description":"GET 以外のメソッドでアクセスした場合、 error の値は method_not_allowed (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}},"500":{"description":"API サーバーの内部的なエラーの場合、 error の値は internal_server_error (返却モデル：`errorModel`)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}}}}}}},"components":{"securitySchemes":{"accessTokenAuth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"accessTokenModel":{"example":{"access_token":"01234567-89ab-cdef-0123-456789abcdef","expires_in":3600,"token_type":"Bearer"},"properties":{"access_token":{"description":"アクセストークンの値","type":"string","minLength":32,"maxLength":36},"expires_in":{"description":"アクセストークンが有効な残り秒数","type":"integer","format":"int64"},"token_type":{"type":"string","format":"Bearer","description":"Bearer"}}},"attachmentModel":{"properties":{"id":{"description":"添付書類ID","type":"string","minLength":32,"maxLength":32},"participant_id":{"description":"添付書類を割り当てる宛先の宛先ID","type":"string","minLength":32,"maxLength":36},"description":{"description":"添付書類についての説明","type":"string","minLength":0,"maxLength":200},"required":{"description":"true:アップロード必須/false:アップロード任意","type":"boolean"},"attached_files":{"description":"アップロードされた添付ファイル","type":"array","items":{"$ref":"#/components/schemas/attachedFileModel"}}}},"attachedFileModel":{"properties":{"id":{"description":"添付ファイルID","type":"string","minLength":32,"maxLength":32},"name":{"description":"受信者によってアップロードされた添付ファイルの添付ファイル名","type":"string","minLength":5,"maxLength":69},"status":{"description":"添付ファイルの状態:\n * 1 - 有効\n * 2 - 削除済み\n","type":"integer","enum":[1,2]}}},"errorModel":{"properties":{"error":{"type":"string","description":"エラーの種類"},"message":{"type":"string","description":"エラーメッセージ"}}},"documentModel":{"properties":{"id":{"description":"書類ID","type":"string","minLength":32,"maxLength":36},"user_id":{"description":"作成者ID","type":"string","minLength":32,"maxLength":36},"title":{"description":"書類のタイトル","type":"string","minLength":0,"maxLength":500},"note":{"description":"契約相手の名称などのメモ\\\n受信者には表示されない\n","type":"string"},"message":{"description":"受信者に対するメッセージ","type":"string","minLength":0,"maxLength":16000},"status":{"description":"書類の状態:\n * 0 - 下書き\n * 1 - 先方確認中\n * 2 - 締結済\n * 3 - 取消、または却下\n * 4 - テンプレート\n * 13 - インポート書類\n","type":"integer","enum":[0,1,2,3,4],"format":"int64"},"can_transfer":{"description":"転送許可設定","type":"boolean"},"private":{"description":"親展書類設定","type":"boolean"},"sent_at":{"description":"送信日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"},"last_processed_at":{"description":"書類の最終処理日時（RFC3339準拠）\\\ndocumentModel.statusが以下のいずれかである場合は、最後の同意/却下日時\\\nparticipants中のparticipantModel.processed_atの最新と等しい\n\nstatus:\n  * 1 - 先方確認中\n  * 2 - 締結済\n  * 3 - 取消、または却下\n  * 13 - インポート書類\n\ndocumentModel.statusが上記のいずれでもない場合は、書類の最終更新日時\n","type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"},"created_at":{"description":"作成日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"updated_at":{"description":"更新日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"participants":{"description":"参加者の一覧（作成者を含む）\\\nparticipantModel の配列として返却されます\n","type":"array","items":{"$ref":"#/components/schemas/participantModel"}},"files":{"description":"ファイルの一覧","type":"array","items":{"$ref":"#/components/schemas/fileModel"}},"reportees":{"description":"共有先の一覧","type":"array","items":{"$ref":"#/components/schemas/reporteeModel"}},"attachment":{"description":"添付書類の一覧","allOf":[{"$ref":"#/components/schemas/attachmentModel"}]},"decline_comment":{"description":"書類の却下理由及び取消理由","type":"string"}}},"importedDocumentModel":{"properties":{"id":{"description":"書類ID","type":"string","minLength":32,"maxLength":36},"user_id":{"description":"作成者ID","type":"string","minLength":32,"maxLength":36},"title":{"description":"書類のタイトル","type":"string","minLength":0,"maxLength":500},"note":{"description":"契約相手の名称などのメモ\\\n受信者には表示されない\n","type":"string"},"message":{"description":"受信者に対するメッセージ","type":"string","minLength":0,"maxLength":16000},"status":{"description":"書類の状態:\n * 13 - インポート書類\n","type":"integer","enum":[13],"format":"int64"},"can_transfer":{"description":"転送許可設定","type":"boolean"},"private":{"description":"親展書類設定","type":"boolean"},"sent_at":{"description":"送信日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"},"last_processed_at":{"description":"書類の最終処理日時（RFC3339準拠）\\\nparticipants中のparticipantModel.processed_atの最新と等しい\n","type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"},"created_at":{"description":"作成日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"updated_at":{"description":"更新日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"participants":{"description":"参加者の一覧（作成者を含む）\\\nparticipantModel の配列として返却されます\n","type":"array","items":{"$ref":"#/components/schemas/participantModel"}},"files":{"description":"ファイルの一覧","type":"array","items":{"$ref":"#/components/schemas/importedFileModel"}}}},"documentAlertModel":{"properties":{"id":{"description":"アラートID","type":"integer","format":"int64"},"document_id":{"description":"書類ID","type":"string","minLength":32,"maxLength":36},"memo":{"description":"アラートのメモ","type":"string","minLength":0,"maxLength":1000},"alert_at":{"description":"アラート日時","type":"string","format":"YYYY-MM-DD"},"enabled":{"description":"アラートの有効/無効","type":"boolean"},"created_at":{"description":"作成日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"updated_at":{"description":"更新日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"}}},"documentAttributeModel":{"properties":{"document_id":{"description":"書類のID","type":"string"},"title":{"description":"管理用タイトル","type":"string","minLength":0,"maxLength":500},"counterparty":{"description":"契約相手の名称","type":"string","minLength":0,"maxLength":500},"contract_at":{"description":"契約締結日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_start_at":{"description":"契約開始日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_end_at":{"description":"契約終了日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_end_notice_at":{"description":"解約通知期限 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"auto_update":{"description":"自動更新の有無:\n  * 0 - 指定なし\n  * 1 - あり\n  * 2 - なし\n","type":"integer","enum":[0,1,2]},"local_id":{"description":"管理番号","type":"string","minLength":0,"maxLength":500},"amount":{"description":"取引金額 nullを許容する","minimum":-9223372036854775808,"maximum":9223372036854775807,"type":"integer","format":"int64","default":null},"created_at":{"description":"作成日時（RFC3339準拠）","type":"string","format":"$YYYY-MM-DDThh:mm:ssZ"},"updated_at":{"description":"更新日時（RFC3339準拠）","type":"string","format":"$YYYY-MM-DDThh:mm:ssZ"},"options":{"description":"ユーザー定義の項目","type":"array","items":{"properties":{"order":{"type":"integer","description":"ユーザー定義の項目の番号","minimum":1,"maximum":10,"example":1},"content":{"type":"string","description":"ユーザー定義の項目の値","minLength":0,"maxLength":500}}}}}},"documentAttributeUpsertRequest":{"description":"書類情報作成・更新用 オブジェクト","type":"object","properties":{"title":{"description":"管理用タイトル","type":"string","minLength":0,"maxLength":500},"counterparty":{"description":"契約相手の名称","type":"string","minLength":0,"maxLength":500},"contract_at":{"description":"契約締結日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_start_at":{"description":"契約開始日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_end_at":{"description":"契約終了日 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"validity_end_notice_at":{"description":"解約通知期限 nullを許容する","type":"string","format":"$YYYY-MM-DD","default":null},"auto_update":{"description":"自動更新の有無:\n  * 0 - 指定なし\n  * 1 - あり\n  * 2 - なし\n","type":"integer","enum":[0,1,2]},"local_id":{"description":"管理番号","type":"string","minLength":0,"maxLength":500},"amount":{"description":"取引金額 nullを許容する","minimum":-9223372036854775808,"maximum":9223372036854775807,"type":"integer","format":"int64","default":null},"options":{"type":"array","items":{"type":"object","properties":{"order":{"type":"integer","description":"ユーザー定義の項目の番号","minimum":1,"maximum":10,"example":1},"content":{"type":"string","description":"ユーザー定義の項目の値","minLength":0,"maxLength":500}}}}}},"documentListModel":{"properties":{"total":{"description":"該当する書類の総数","type":"integer","format":"int64"},"page":{"description":"指定されたページ番号\\\nページあたりの書類数は最大100件\n","type":"integer","format":"int64"},"documents":{"description":"書類のデータ","type":"array","items":{"$ref":"#/components/schemas/documentModel"}}}},"participantModel":{"properties":{"id":{"description":"宛先ID","type":"string","minLength":32,"maxLength":36},"email":{"description":"宛先のメールアドレス","type":"string","format":"email"},"name":{"description":"宛先の名前","type":"string","maxLength":64},"organization":{"description":"宛先の会社名","type":"string","maxLength":64},"order":{"description":"書類内の宛先の順序を表す整数（送信者は 0）。確認依頼はこの昇順で送信する\\\n`order` は直接指定できない。POST /documents/{documentID}/participants で追加した宛先には、書類内で最も大きい `order` の次の値が割り当てられる\\\nただし、`group_type` と `group_id` を指定して既存グループに追加した宛先は、そのグループに属する宛先のうち `order` が最大のものの直後に挿入され、それより後ろの宛先の `order` は 1 ずつ大きくなる\\\n同じグループに属する宛先には、確認依頼を同時に送信する。グループ全員の対応が完了するまで、次の `order` の宛先には送信しない\\\n例：A（個人）→ B（`group_type` を指定して新規グループ G を作成）→ C（個人）→ D（`group_type` と `group_id` に G を指定）の順に追加すると、`order` は A=1、B=2、D=3、C=4 となる。確認依頼は A → B と D（同時）→ C の順で送信する\n","type":"integer","format":"int64"},"status":{"description":"宛先の状態:\n * 0 - アクセス不可\n * 2 - 下書き\n * 3 - 配信待ち\n * 4 - 確認待ち\n * 6 - 送信済み\n * 7 - 確認済み\n * 8 - 押印または入力済み\n * 9 - 却下\n * 10 - キャンセル\n * 12 - 署名中\n","type":"integer","enum":[0,2,3,4,6,7,8,9,10,12]},"access_code":{"description":"宛先に設定されているアクセスコード\\\nAPIを使用しているユーザーが値を設定した場合のみレスポンスに含まれる\n","type":"string","maxLength":64},"language_code":{"description":"宛先の言語設定\\\nja（日本語）、en（英語）、zh-CHS（簡体字）、zh-CHT（繁体字）のいずれか\n","type":"string"},"advanced_authn_request":{"description":"宛先の高度な認証による署名設定","type":"boolean"},"tel":{"description":"宛先の電話番号\\\n組込み署名 （SMS認証）の場合、必須\\\n組込み署名 （SMS認証）のみ使用可能\\\nデフォルトは空\n","type":"string","format":"^0[6-9]0\\d{8}$"},"recipient_id":{"description":"連携システム側のユーザー識別子\\\n組込み署名 （簡易認証）の場合、必須\\\n組込み署名 （簡易認証）のみ使用可能\\\n半角英数字と記号のみ許可\\\nデフォルトは空\n","type":"string","maxLength":64},"callback":{"description":"受信者の組込み署名（SMS認証）フラグ\\\n指定できる値はtrue、またはfalse\\\nチームの設定で組込み署名（SMS認証）ができ、かつ、書類にマイナンバーカード署名が設定されている宛先が含まれていない場合のみ指定可能\\\ntrueの代わりに1、t、T、TRUE、True、falseの代わりに0, f, F, FALSE, Falseを指定可能\\\nデフォルトはfalse\\\ntrue にした時、advanced_authn_request は false のみ指定可能\n","type":"boolean","default":false},"processed_at":{"description":"各受信者による書類の同意/却下日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ss.SSSSSSZ"},"access_expires_at":{"description":"URL有効期限（RFC3339準拠）\\\nstatusが4の場合のみレスポンスに含まれる\n","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"group":{"description":"グループ参加者のグループ情報\\\nグループに属している宛先の場合のみレスポンスに含まれる\n","allOf":[{"$ref":"#/components/schemas/participantGroupModel"}]}}},"participantGroupModel":{"properties":{"group_id":{"description":"グループID","type":"string"},"group_type":{"description":"グループの種別:\n * 1 - AND（全員が署名）\n","type":"integer","enum":[1]}}},"fileModel":{"properties":{"id":{"description":"ファイルの ID","type":"string","minLength":32,"maxLength":36},"name":{"description":"ファイルのタイトル","type":"string"},"order":{"description":"書類内のファイルの順序（ファイルをアップロードした順）","type":"integer","format":"int64"},"total_pages":{"description":"ファイルのページ数","type":"integer","format":"int64"},"widgets":{"description":"入力項目の一覧","type":"array","items":{"$ref":"#/components/schemas/widgetModel"}}}},"importedFileModel":{"properties":{"id":{"description":"ファイルの ID","type":"string","minLength":32,"maxLength":36},"name":{"description":"ファイルのタイトル","type":"string"},"order":{"description":"書類内のファイルの順序（ファイルをアップロードした順）","type":"integer","format":"int64"},"total_pages":{"description":"ファイルのページ数","type":"integer","format":"int64"}}},"widgetModel":{"properties":{"id":{"description":"入力項目の ID","type":"string","minLength":32,"maxLength":36},"widget_type":{"description":"入力項目の種類:\n * 0 - 押印\n * 1 - フリーテキスト\n * 2 - チェックボックス\n","type":"integer","enum":[0,1,2]},"participant_id":{"description":"入力が割り当てられている宛先の ID","type":"string","minLength":32,"maxLength":36},"file_id":{"description":"入力対象のファイルの ID","type":"string","minLength":32,"maxLength":36},"page":{"description":"入力項目が設定されている対象ファイルのページ番号","type":"integer","format":"int64"},"x":{"description":"入力項目左上の対象ファイル・対象ページにおける設置位置の X 座標（単位:ポイント）","type":"integer","format":"int64"},"y":{"description":"入力項目左上の対象ファイル・対象ページにおける設置位置の Y 座標（単位:ポイント）","type":"integer","format":"int64"},"w":{"description":"入力項目の幅。inner_width を使用してください。","type":"integer","format":"int64","deprecated":true},"h":{"description":"入力項目の高さ。inner_height を使用してください。","type":"integer","format":"int64","deprecated":true},"inner_width":{"description":"入力項目の内部幅","type":"integer","format":"int64"},"inner_height":{"description":"入力項目の内部高さ","type":"integer","format":"int64"},"fixed_width":{"description":"widget_type が 1 (フリーテキスト) かつ inner_width が指定されている場合に true\\\nそれ以外の場合は省略される\n","type":"boolean"},"font_size":{"description":"widget_type が 1 (フリーテキスト) の場合のみ有効な、フォントサイズの指定（単位:ポイント）\\\n未設定の場合は省略される\n","type":"string","enum":["8","9","10","11","12","13","14"]},"text":{"description":"入力項目に入力されたテキスト","type":"string"},"status":{"description":"入力項目の状態:\n  * 0 - 未入力\n  * 1 - 入力済み\n","type":"integer","enum":[0,1]},"label":{"description":"入力項目に入力されたラベル","type":"string"},"required":{"description":"widget_type が 2 (チェックボックス) の場合のみ含まれる、必須/任意の設定:\n  * true - 必須\n  * false - 任意\n","type":"boolean"}}},"userModel":{"properties":{"id":{"description":"ユーザーの ID","type":"string","minLength":32,"maxLength":36},"email":{"description":"ユーザーのメールアドレス","type":"string"},"name":{"description":"ユーザーの名前","type":"string"},"organization":{"description":"ユーザーの組織の名称","type":"string"},"team":{"description":"ユーザーが所属するチーム","allOf":[{"$ref":"#/components/schemas/teamModel"}]},"authorities":{"description":"ユーザーが保持する権限","allOf":[{"$ref":"#/components/schemas/userAuthoritiesModel"}]}}},"userAuthoritiesModel":{"properties":{"team_administrator":{"description":"チーム管理権限\\\nチームの設定変更とメンバー管理が行える\n","type":"boolean"},"team_document_administrator":{"description":"書類管理権限\\\nチーム内で送受信された書類を閲覧できる\n","type":"boolean"},"document_approver":{"description":"承認者\\\nチームの承認機能が有効な場合、書類の宛先に承認者として追加できる\n","type":"boolean"},"private_document_administrator":{"description":"親展書類管理権限\\\nチーム内で送受信された親展書類を閲覧できる\n","type":"boolean"}}},"teamModel":{"properties":{"id":{"description":"チームの ID","type":"string","minLength":32,"maxLength":36},"name":{"description":"チームの名前","type":"string"}}},"reporteeModel":{"properties":{"id":{"description":"共有先の ID","type":"string","minLength":32,"maxLength":36},"email":{"description":"共有先のメールアドレス","type":"string","format":"email"},"name":{"description":"共有先の名前","type":"string","minLength":1,"maxLength":64},"organization":{"description":"共有先の会社名など","type":"string","minLength":0,"maxLength":64}}},"callbackSigningInfoModel":{"properties":{"url":{"description":"同意 URL","type":"string"},"expires_at":{"description":"URL有効期限（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"}}},"cabinetModel":{"properties":{"id":{"description":"キャビネットの ID","type":"string","minLength":32,"maxLength":32},"name":{"description":"キャビネットの名前","type":"string","minLength":1,"maxLength":100},"note":{"description":"キャビネットのメモ","type":"string","minLength":0,"maxLength":200},"type":{"description":"キャビネットの種別:\n * 0 - ユーザーが作成したキャビネット\n * 1 - すべての書類\n","type":"integer","enum":[0,1],"format":"int64"},"created_at":{"description":"作成日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"},"updated_at":{"description":"更新日時（RFC3339準拠）","type":"string","format":"YYYY-MM-DDThh:mm:ssZ"}}},"cabinetListModel":{"properties":{"total":{"description":"キャビネットの総数","type":"integer","format":"int64"},"page":{"description":"指定されたページ番号","type":"integer","format":"int64"},"cabinets":{"description":"キャビネットデータのリスト","type":"array","items":{"$ref":"#/components/schemas/cabinetModel"}}}},"requestBodyNote":{"description":"契約相手の名称などのメモ\\\n受信者には表示されない\\\n文字数上限はないものの、リクエスト全体のサイズ上限の200MBを超えない範囲内で指定可能\n","type":"string"},"requestBodyEmail":{"description":"宛先のメールアドレス\\\nRFCに対応しているメールアドレスかどうかを検証している\\\nドメインの存在確認を行っている\\\ncallbackがfalseの場合、必須\n","type":"string","format":"email","maxLength":254},"requestBodyReporteesEmail":{"description":"共有先のメールアドレス\\\nRFCに対応しているメールアドレスかどうかを検証している\\\nドメインの存在確認を行っている\n","type":"string","format":"email","maxLength":254}}}}