ネクストセット・組織ワークフロー for Office 365 公開APIとは!?

組織ワークフロー公開APIは、ネクストセット・組織ワークフローの機能を外部システムから連携、利用するための、HTTPSベースのAPIです。
申請、承認、否決などのアクションだけでなく、ひな形や申請データ、申請・承認履歴の取得、添付ファイルのアップロード、ダウンロードなど、ワークフローの機能がAPI経由で利用できます。

公開APIの活用例

・ 基幹システムに決裁済みの稟議データを連携
・ 別のカレンダーシステムの登録データを元に、交通費申請、日報などのワークフロー申請書を自動作成
          ・
          ・




APIのプロトコル、インタフェース、URL

・プロトコルはHTTPSです。
・結果はJSON形式(application/json)で返ります
・HTTPメソッドはPOST(KeyValue型)です。各パラメータごとにKeyとValueをPOSTしてください。
・文字コードは「UTF-8」です。

また、
APIのルートURLは以下のとおりです。

https://workflow.nextset.jp/<テナント名>/api/public


~APIURLの例~

 認証API ⇒ https://workflow.nextset.jp/nextset/api/public/auth
 申請API ⇒ https://workflow.nextset.jp/nextset/api/public/actions/submit




APIKEYの取得

ワークフロー管理ガジェットの「連携設定」タブからAPIキーを発行します。このキーは「認証API」でアクセストークンを取得するために使用します。
※このキーはAPIで御社ドメインのワークフローデータにアクセスする非常に大切なキーですので取り扱いには十分注意してください。



各API共通のパラメータ

各APIで共通のRequest、Responseのパラメータです。申請API、承認APIなどの各APIごとのパラメータに加え、ここに記載されているパラメータもセット、処理するようにしてください。

Request

各APIで共通のRequestパラメータです。申請API、承認APIなどの各APIごとのパラメータに加え、ここに記載されているパラメータもセットするようにしてください。
※「認証API」は除きます。「認証API」で必要なRequestパラメータは「認証API」の欄をご参照ください。
※各APIのリクエスト(POST)は、Key-Value型でPOSTしてください(
BodyへのJsonではありません)。

 キー   説明  型/桁数  必須  主な値、例        備考                                
access_token アクセストークン 英数字 必須 認証APIで取得したアクセストークンをセット
impersonate_email  管理者アカウント メールアドレス 必須 例:admin@yourdomain.com APIを実行する管理者アカウント
application_id  仮想アプリケーションID 英数字 任意 アクセスする仮想アプリケーションIDを指定
※指定無しの場合はデフォルト(default)扱い
viewer_email データ処理アカウント メールアドレス 任意
(更新系では必須)
どのユーザーの権限でデータの取得や申請などのアクションを行うか(GUI上のログインユーザーと同等)
※空にすると管理者権限で全データを対象として取得できます(更新系のAPIでは必須です)。


Response

各APIで共通のResponseのパラメータです。code、error_codeの値をチェックしてAPIの処理が正常に終了したかなどを判断して下さい。
ResponseはJSON形式です。

 キー   説明  型/桁数  主な値、例   備考                                
code                処理結果コード     数字 0:正常 
100:入力チェックエラー系(必須項目が未設定、など)    
403:認証エラー 
999:システムエラー 

error_code エラーコード    英数字 ・invalid_api_key:無効なAPIKEY
・invalid_impersonate_email:無効な実行アカウント
・invalid_access_token:無効なアクセストークン
・access_token_expire:アクセストークンの期限切れ
・invalid_application_id:無効な仮想アプリケーションID                         
・invalid_viewer_email:無効なアカウント
・invalid_template_id:無効なひな形ID
・not_found:データが見つかりません
・invalid_from_date:無効なfrom_date
・invalid_to_date:無効なto_date
・forbidden_access_doc:文書にアクセスする権限がありません
・not_found_doc:文書が見つかりません
・access_denied_template:指定ひな形の利用権限がないユーザー
・invalid_template:無効なひな形
・prohibit_ghost_write:代理申請禁止ひな形
・validation_doc_cover_date:カバー期間が重複している申請書がある場合
・not_in_process:承認、回覧待ちのプロセスではない
・invalid_approver:指定ユーザーが承認、回覧候補者ではない
・prohibit_agency:代理承認処理禁止プロセス
・prohibit_reject:否決禁止プロセス
・prohibit_return:差戻し禁止プロセス
・not_author:申請者ではない
・prohibit_withdraw:取下げ禁止
・file_size_too_large:ファイルサイズが上限を超えています
・not_found_attach_file:添付ファイルが見つかりませんでした。                                                          
                    ・                                        
                    ・
                    ・                 
※ここに挙げた以外のコードが出力される場合もあります
error_msg エラー情報 文字列 エラーの詳細情報

Responseの例(成功時)

 "code":"0"
 ,"access_token":"YzJGMFpXeGhhWFJ2TG1wdzIwMTUwNTE3MTMyNzEyUFVSd2NCVUp3UGl3bWQ3Sg=="
 ,"expires_in": 43200

Responseの例(失敗時)

 "code":"403"
 ,"error_code":"invalid_api_key"
 ,"error_msg": ""


Response:HTTPステータス

 ステータス   説明  備考                                
200 OK(正常)
405 Method Not Allowed POSTではなくGETでAPIをリクエストした、など
404 NotFound URLが間違っている、など
※その他 予期しないエラー
※ここに上げたステータス以外のステータスが返る場合もあります




認証API

各API共通のアクセス用アクセストークンを取得するAPIです。ここで取得したアクセストークンを使って各APIにアクセスします。

APIのURL

  /auth

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
api_key APIキー 英数字 必須 アドオン管理画面で発行するAPIキー
impersonate_email  管理者アカウント メールアドレス 必須 APIを実行する管理者アカウント (例:admin@yourdomain.com)

※「認証API」では「各API共通のパラメータ」で指定されているRequestは不要です。ここで指定されているパラメータのみご指定ください。


Response

 キー   説明  型/桁数  主な値、例                     備考                                
access_token アクセストークン 英数字  APIにアクセスするためのアクセストークン。
各APIのRequestとしてセット
expires_in アクセストークン期限 数字 例:43200 (12時間) アクセストークンが失効するまでの時間(秒)
失効後は、改めて認証APIでアクセストークンを取得する必要があります。
APIのコール元のプログラムではこの期限を保持しておき、適切なタイミングで認証APIにて新しいリクエストトークンを取得するようにしてください。
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



ひな形一覧取得API

ひな形の一覧を取得するAPIです。ひな形のタイトルや基本設定などが取得できます。
内容HTMLなど、詳細情報の取得は、「ひな形詳細取得API」をご利用ください。

APIのURL

  /templates/list

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
max_results 取得最大件数    数字 任意 例:50 最大取得件数を指定(0~)
※APIの上限を超える指定値の場合は、API側の設定が優先されます。
start_cursor 次結果取得用トークン 英数字 任意 データ数が多い場合、一度の取得で全件取得できない場合があります。その場合、Responseの 「next_cursor」 にて返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
next_cursor 次結果取得用トークン 英数字  取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。Requestの「start_cursor」にセット
datas ひな形一覧 JSON配列
取得されるひな形一覧配列
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

datasの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
template_id 内部ひな形ID 英数字  例:template-20150521041941is2i9bxftLWiCsLv ひな形の内部ID。ひな形詳細取得APIなどではこのIDでひな形を特定する
template_name ひな形タイトル 文字列 例:交通費精算
template_categorys カテゴリー 配列 例:["営業部門/稟議書", "営業部門/交通費関連"] ひな形のカテゴリー情報を配列で返します
template_disabled 管理者にのみ表示 英数字 ・DISABLED:一般ユーザーには非表示(管理者は表示) ※デフォルト=一般ユーザーにも表示
allow_ghost_write 代理者による申請を許可 英数字 ・ALLOW:代理者による申請を許可する ※デフォルト=許可しない
workflow_groups ワークフローグループによる制限 配列 ["営業部門", "システム部門", "総務部"] グループ文字列の配列 
template_viewers  申請書閲覧者メールアドレス 配列 例:["viewer001@yourdomain.com", "viewer002@yourdomain.com"]
prohibit_attach_files  添付ファイルを禁止する  英数字  ・PROHIBIT:禁止  ※デフォルト=許容する
mandatory_attach_files  添付ファイルを必須にする    英数字 ・MANDATORY:必須にする ※デフォルト=任意 
prohibit_reapply  「コピーして再作成」を禁止  英数字 ・PROHIBIT:禁止  ※デフォルト=許容する
prohibit_csv_export  CSVエクスポート禁止  英数字 ・PROHIBIT:禁止  このひな形の申請書のCSVエクスポートを無効にする ※デフォルト=許容する
allow_remand  差し戻し機能を有効にする  英数字 ・ALLOW:差戻し機能を有効にする ※デフォルト=無効
withdraw_doc_type  「取り下げ」処理の動作       英数字 ・REMAND:差し戻された申請書のみ取下げ可能
・APPLY:承認/回覧前の申請書のみ取下げ可能
・Empty:申請書の取下げはできない(デフォルト)
申請書の取り下げ処理の動作設定
delete_doc_type 「削除」処理の動作 英数字 ・WITHDRAW:取下げした申請書のみ削除可能
・APPLY:承認/回覧前の申請書を削除可能
・APPROVE:決裁前(承認/回覧中、否決済)の申請書まで削除可能
・FINAL_APPROVE:決裁済の申請書まで削除可能
・Empty:申請書の削除はできない(デフォルト)
申請書の削除処理の動作設定
created_date  ひな形作成日 日付 例:2014-12-01 22:23:12 ※協定世界時(UTC)
updated_date  最終更新日 日付 例:2014-12-01 22:23:12   ※協定世界時(UTC)



ひな形詳細取得API

ひな形の詳細取得するAPIです。ひな形のタイトルや基本設定に加えて内容HTML,承認ルートHTMLも取得できます。

APIのURL

  /templates/get

Request

 キー  説明 型/桁数 必須 主な値、例       備考                                
template_id内部ひな形ID英数字必須例:template-20150521041941is2i9bxftLWiCsLv

※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response


 キー   説明  型/桁数  主な値、例                                                   備考                                
data ひな形詳細       JSON 






※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

dataの要素


 キー   説明  型/桁数  主な値、例                                                   備考                                
template_id 内部ひな形ID 英数字  例:template-20150521041941is2i9bxftLWiCsLv ひな形の内部ID。ひな形詳細取得APIなどではこのIDでひな形を特定する
template_name ひな形タイトル 文字列 例:交通費精算
template_categorys カテゴリー 配列 例:["営業部門/稟議書", "営業部門/交通費関連"] ひな形のカテゴリー情報を配列で返します
template_disabled 管理者にのみ表示 英数字 ・DISABLED:一般ユーザーには非表示(管理者は表示) ※デフォルト=一般ユーザーにも表示
allow_ghost_write 代理者による申請を許可 英数字 ・ALLOW:代理者による申請を許可する ※デフォルト=許可しない
workflow_groups ワークフローグループによる制限 配列 例:["営業部門", "システム部門", "総務部"] グループ文字列の配列 
template_viewers  申請書閲覧者メールアドレス 配列 例:["viewer001@yourdomain.com", "viewer002@yourdomain.com"]
prohibit_attach_files  添付ファイルを禁止する  英数字  ・PROHIBIT:禁止  ※デフォルト=許容する
mandatory_attach_files  添付ファイルを必須にする    英数字 ・MANDATORY:必須にする ※デフォルト=任意 
prohibit_reapply  「コピーして再作成」を禁止  英数字 ・PROHIBIT:禁止  ※デフォルト=許容する
prohibit_csv_export  CSVエクスポート禁止  英数字 ・PROHIBIT:禁止  このひな形の申請書のCSVエクスポートを無効にする ※デフォルト=許容する
allow_remand  差し戻し機能を有効にする  英数字 ・ALLOW:差戻し機能を有効にする ※デフォルト=無効
withdraw_doc_type  「取り下げ」処理の動作       英数字 ・REMAND:差し戻された申請書のみ取下げ可能
・APPLY:承認/回覧前の申請書のみ取下げ可能
・Empty:申請書の取下げはできない(デフォルト)
申請書の取り下げ処理の動作設定
delete_doc_type 「削除」処理の動作 英数字 ・WITHDRAW:取下げした申請書のみ削除可能
・APPLY:承認/回覧前の申請書を削除可能
・APPROVE:決裁前(承認/回覧中、否決済)の申請書まで削除可能
・FINAL_APPROVE:決裁済の申請書まで削除可能
・Empty:申請書の削除はできない(デフォルト)
申請書の削除処理の動作設定
template_body ひな形内容HTML 文字列
template_route_xx_enabled 承認ルート有効フラグ 真理値 ・true:有効
・false:無効
※ xx 部分は承認ルート番号が入ります(例:template_route_2_enabled)
template_route_xx_name 承認ルート名称 文字列 例:部長決裁 ※ xx 部分は承認ルート番号が入ります(例:template_route_2_name)
template_route_xx_body 承認ルートHTML 文字列 ※ xx 部分は承認ルート番号が入ります(例:template_route_2_body)
created_date  ひな形作成日 日付 例:2014-12-01 22:23:12 ※協定世界時(UTC)
updated_date  最終更新日 日付 例:2014-12-01 22:23:12   ※協定世界時(UTC)



文書一覧取得API

申請文書の一覧を取得するAPIです。詳細情報の取得は、「文書詳細取得API」をご利用ください。

APIのURL

  /docs/list

Request

キー  説明 型/桁数 必須 主な値、例       備考                                
template_id検索条件:ひな形内部ID英数字任意例:template-20150521041941is2i9bxftLWiCsLv特定のひな形に絞って検索したい場合に指定
from_date検索条件:申請日FROM  日付任意例:2015-07-01申請日で絞り込む場合に指定
to_date検索条件:申請日TO日付任意例:2015-07-31申請日で絞り込む場合に指定
status検索条件:文書ステータス日付任意・draft:下書き保存状態 ※APIでは取得対象外
・in_process:処理中(申請後、承認途中の状態)
・final_approved:決裁済み
・rejected:否決済み
・remanded:申請者に差戻しされた状態
・withdrawn:取下げ済み
文書ステータスで絞り込む場合に指定
max_results取得最大件数   数字任意最大取得件数を指定(0~)
※APIの上限を超える指定値の場合は、API側の設定が優先されます。
start_cursor次結果取得用トークン英数字任意データ数が多い場合、一度の取得で全件取得できない場合があります。その場合、Responseの 「next_cursor」 にて返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。

※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
next_cursor 次結果取得用トークン 英数字  取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。Requestの「start_cursor」にセット
datas 文書一覧 JSON配列
取得される文書一覧配列
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

datasの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
doc_id    内部文書ID 英数字 例:doc-20151015084918BS8zmTNzdE8atMbF 文書の内部ID。文書詳細取得APIなどではこのIDを指定
status ステータス 英数字 ・draft:下書き保存状態 ※APIでは取得対象外
・in_process:処理中(申請後、承認途中の状態)
・final_approved:決裁済み
・rejected:否決済み
・remanded:申請者に差戻しされた状態
・withdrawn:取下げ済み
文書の承認状況を表すステータス
submit_date 申請日時 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)
author_email 申請者 メールアドレス

final_approver_or_rejector_email 決裁/否決者 メールアドレス    

final_approved_or_rejected_date 決裁/否決日時 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)
final_approve_no 決裁番号 英数字 
※ひな形HTMLで「class="final_approve_no"」項目が指定されている場合に発行されます
template_id 内部ひな形ID 英数字  例:template-20150521041941is2i9bxftLWiCsLv
doc_no 文書番号 英数字 例:2015080001 ※ひな形HTMLで「name="doc_no"」項目が指定されている場合に発行されます
doc_title 題名 文字列
※ひな形HTMLで「name="doc_title"」項目が指定されている場合に発行されます
updated_date 更新日時 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)




文書詳細取得API

申請文書1件の詳細情報を取得するAPIです。


APIのURL

  /docs/get

Request

 キー  説明 型/桁数 必須 主な値、例       備考                                
doc_idひな形文書ID英数字必須例:doc-20151015084918BS8zmTNzdE8atMbF文書の内部ID(文書一覧APIで取得できます)

※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response


 キー   説明  型/桁数  主な値、例                                                   備考                                
data 文書詳細       JSON 






※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

dataの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
doc_id    内部文書ID 英数字 例:doc-20151015084918BS8zmTNzdE8atMbF 文書の内部ID。文書詳細取得APIなどではこのIDを指定
status ステータス 英数字 ・draft:下書き保存状態 ※APIでは取得対象外
・in_process:処理中(申請後、承認途中の状態)
・final_approved:決裁済み
・rejected:否決済み
・remanded:申請者に差戻しされた状態
・withdrawn:取下げ済み
文書の承認状況を表すステータス
submit_date 申請日 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)
author_email 申請者 メールアドレス

final_approver_or_rejector_email 決裁/否決者 メールアドレス    

final_approved_or_rejected_date 決裁/否決日時 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)
final_approve_no 決裁番号 英数字 
※ひな形HTMLで「class="final_approve_no"」項目が指定されている場合に発行されます
template_id 内部ひな形ID 英数字  例:template-20150521041941is2i9bxftLWiCsLv
doc_no 文書番号 英数字 例:2015080001 ※ひな形HTMLで「name="doc_no"」項目が指定されている場合に発行されます
doc_title 題名 文字列
※ひな形HTMLで「name="doc_title"」項目が指定されている場合に発行されます
updated_date 更新日時 日付 例:2015-08-13 22:10:45 ※協定世界時(UTC)
doc_values 申請データ JSON 例:[
   {'doc_no':'201508130001', 'doc_title':'海外出張次の交通費申請', 'price':'58700'}
              ・    
              ・  
      ]
申請された各input項目のデータがJSON形式でセットされます
attached_file_list 添付ファイルID一覧 JSON 例:[
   {'file_id':'file-20150805235318veow7yIQEu2EKffx', 'file_name':'領収書.png'}
              ・    
              ・  
      ]
本申請文書に添付されたファイルの情報(内部ID、ファイル名)が配列でセットされます。
ファイル内部IDは「添付ファイル取得API」でファイルをダウンロードする際に使用できます。





文書削除API

申請文書1件を削除するAPIです。


APIのURL

  /docs/delete

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 文書の内部ID(文書一覧APIで取得できます)
update_master_datas マスター更新設定 JSON 任意 例:[
{"master_code":"yosan_master", "data_key":"yosan001", "target_approve_type":"submit", "update_data":{attribute_2:"更新値1", attribute_3:"更新値2",
 update_option:{attribute_2:["sum", "input_name"]}, is_overwite:true }
                    ・
                    ・
]
マスターデータを更新する定義を設定
※更新しない場合は指定なしでOKです。設定の詳細はワークフローヘルプの「SateraitoWF.appendUpdateMasterData」を参照
・mater_code:対象マスターのID
・data_key:更新するマスターレコードのキー
・target_approve_type:マスターを更新するタイミングの指定
・update_data:更新データ 
・update_option:更新の動作に関するオプション

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response


※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



承認プロセス取得API

1つの申請文書の承認プロセス一覧情報を取得するAPIです。各承認プロセスの設定やステータス、承認候補者アドレス一覧などが取得できます。

APIのURL

  /approvers/list

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 文書の内部ID(文書一覧APIで取得できます)

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
datas ひな形一覧 JSON配列            
取得されるひな形一覧配列
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

datasの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
approve_number 承認プロセス番号     数字 例:1 承認ルートHTMLのinput/@number に対応(1~)
status 承認ステータス 英数字 ・in_process:承認、回覧待ち
・passed:承認、回覧済(処理済み)
・rejected:否決済み
・approving_canceled:より前のプロセスの否決処理によって未処理状態が解除されたプロセス
・空:未処理(処理順番が来ていない状態)
承認プロセスの承認状況を表すステータス
approve_type 承認プロセスタイプ 英数字 ・approve:承認プロセス
・look:回覧プロセス

final_approve 決裁プロセスフラグ 真理値 ・true:決裁プロセス
・false:承認プロセス(デフォルト)

skip_ok スキップ可能プロセスフラグ 真理値 ・true:スキップ可能プロセス
・false:通常プロセス(デフォルト)
※承認ルートHTMLに「skip_ok」指定があるかどうか
no_agency 代理承認禁止フラグ 真理値 ・true:代理承認禁止プロセス
・false:代理承認可能プロセス(デフォルト)
※承認ルートHTMLに「no_agency」指定があるかどうか
need_all_approve_to_go_next 同時承認フラグ 真理値 ・true:全候補者が承認(回覧)処理をしないと次のプロセスに進まない
・false:いずれか1名の候補者が処理をすると次のプロセスに進む(デフォルト)
※承認ルートHTMLに「need_all_approve_to_go_next」指定があるかどうか
ok_to_update 編集可能項目 配列 例:['field1', 'field2', 'field3'] ok_to_updateオプションで指定された、同プロセスの承認者が編集できるinput項目のname一覧
approver_candidates 承認候補者 配列 例:['approver1@yourdomain.com', 'approver2@yourdomain.com'] 承認候補者としてセットされているユーザーのメールアドレス一覧
approvers 承認(回覧)済ユーザー 配列 例:['approver1@yourdomain.com'] 実際に承認処理を行ったユーザーのメールアドレス一覧
updated_date 最終更新日 日付 例:2014-12-01 22:23:12     ※協定世界時(UTC)



アクション履歴一覧API

1つの申請文書の申請や承認のアクション履歴一覧を取得するAPIです。各アクションを実施したユーザーやその日時、コメントなどが確認できます。

APIのURL

  /actions/list

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id ひな形文書ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 文書の内部ID(文書一覧APIで取得できます)

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
datas ひな形一覧 JSON配列            
取得されるひな形一覧配列
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

datasの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
approve_number 承認プロセス番号     数字 例:1 承認ルートHTMLのinput/@number に対応(1~)
※申請アクションの場合は、「0」が返ります
status アクションタイプ 英数字 ・submitted:申請
・passed:承認 or 回覧
・final_approved:決裁 
・rejected:否決
・updated:更新
・remanded:差戻し
・resubmitted:差戻し再申請
・withdrawn:取下げ
※passedの場合、 承認か回覧かはapprove_typeで判別可能です。
approve_type 承認プロセスタイプ 英数字 ・approve:承認プロセス
・look:回覧プロセス

user_email アクションユーザー メールアドレス
アクションしたユーザーのメールアドレス
comment 承認、否決、差戻し、取下げコメント コメント

is_auto_approve 自動承認フラグ 真理値 ・true:自動承認処理により処理されたプロセス
・false:通常プロセス

is_remanded 差戻し済みフラグ 真理値 ・true:差し戻しされたアクション
・false:差し戻しされていないアクション(デフォルト)
このアクションが差戻し処理によってキャンセルされたかどうか
ghost_writer 代理申請者 メールアドレス
代理申請の場合、代理で申請したユーザーのメールアドレスがセットされます(申請アクションの場合のみ)
deputy_approver 代理承認者 メールアドレス
代理承認の場合、代理で承認したユーザーのメールアドレスがセットされます
updated_date 最終更新日 日付 例:2014-12-01 22:23:12     ※協定世界時(UTC)




申請API

申請処理を行うAPIです。このAPIでは、ひな形を指定して新しい申請書を一件発行します。
登録したい値「doc_values」パラメータでJSON形式でセットすることで各input項目に対しての入力値をセットすることができます。
ひな形で指定されている以下の特殊クラスに関しては「doc_values」で値を指定しない場合、自動で値がセットされます。

~ 自動で値がセットされる項目 ~

・doc_no
・クラス:apply_no
・クラス:final_apply_no
・クラス:serial_no
・クラス:final_approve_date
・クラス:viewer_name
・クラス:viewer_name2
・クラス:job_title
・クラス:department_1
・クラス:department_2
・クラス:department_3
・クラス:department_4
・クラス:department_5
・クラス:employee_id
・クラス:ghost_writer_name
・クラス:set_val_if_ghost_writer
・クラス:
today_date
・クラス:
user_attribute_1
・クラス:user_attribute_2
・クラス:user_attribute_3
・クラス:user_attribute_4
・クラス:user_attribute_5
・クラス:
master_reference
・クラス:master_list
・クラス:sum
・クラス:diff
・クラス:multi
・クラス:divide

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません
・添付ファイルの必須チェックは実施されません


APIのURL

  /actions/submit

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
template_id ひな形内部ID 英数字 必須 例:template-20150521041941is2i9bxftLWiCsLv 申請するひな形
ghost_writer_of 被代理申請者 メールアドレス 任意
viewer_email が代理申請者の場合、本来の申請者のアドレスをセット
※本項目をセットすると代理申請扱いとなります。
route_selection_no 使用承認ルート 数字 任意 例:1 申請時に使用する承認ルートの番号を指定(1~)
※未指定の場合は、承認ルート1が使用されます。
doc_values 申請データ  JSON 任意 申請データをJSON辞書形式でセット
・KEY:ひな形HTMLのinput/@name にあたる値
・VALUE:入力値
relative_doc_id 関連する元文書ID 英数字 任意 例:doc-20151015084918BS8zmTNzdE8atMbF 本申請を関連する別の申請書を元に作成する場合に指定     
例:仮払申請 ⇒ 本申請 (この場合、仮払申請書の文書IDをセット)            
add_approver_candidates 追加する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver3@sateraito.co.jp" }
,{"approve_number":1, "email":"approver4@sateraito.co.jp" }
,{"approve_number":2, "email":"approver2@sateraito.co.jp" }
]
申請時に追加する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。
・approve_number…追加するプロセス番号
・email…承認候補者メールアドレス
remove_approver_candidates 削除する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
申請時に削除する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。
・approve_number…削除するプロセス番号
・email…承認候補者メールアドレス
open_notification_list 開封通知設定 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
開封通知をONにする承認候補者情報をセット(申請者用)
※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。
・approve_number…開封通知をリクエストするプロセス番号
・email…開封通知をリクエストする承認候補者メールアドレス
update_master_datas マスター更新設定 JSON 任意 例:[
{"master_code":"yosan_master", "data_key":"yosan001", "target_approve_type":"submit", "update_data":{attribute_2:"更新値1", attribute_3:"更新値2",
 update_option:{attribute_2:["sum", "input_name"]}, is_overwite:true }
                    ・
                    ・
]
マスターデータを更新する定義を設定
※更新しない場合は指定なしでOKです。設定の詳細はワークフローヘルプの「SateraitoWF.appendUpdateMasterData」を参照
・mater_code:対象マスターのID
・data_key:更新するマスターレコードのキー
・target_approve_type:マスターを更新するタイミングの指定
・update_data:更新データ 
・update_option:更新の動作に関するオプション

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。






承認・回覧API

文書に対して承認、回覧処理を行うAPIです。
アクションが、実際に、承認、回覧(決裁)のどれにあたるかは承認プロセスの定義に準じます。

承認時に更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。
また、ひな形で指定されている以下の特殊クラスに関しては自動で値がセットされます。

~ 自動で値がセットされる項目 ~

・クラス:final_apply_no
・クラス:serial_no
・クラス:final_approve_date

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません
・添付ファイルの必須チェックは実施されません


APIのURL

  /actions/approve

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
approve_number 承認プロセス番号     数字 必須 例:1 どのプロセスの処理としてアクションするかを指定
承認ルートHTMLのinput/@number に対応(1~)
approve_comment 承認、否決、差戻し理由 文字列 任意
画面上の一番下のコメント欄に当たる
doc_values 更新データ  JSON 任意 更新するデータをJSON辞書形式でセット
・KEY:ひな形HTMLのinput/@name にあたる値
・VALUE:入力値
※更新可能対象の項目のみ処理される
add_approver_candidates 追加する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver3@sateraito.co.jp" }
,{"approve_number":1, "email":"approver4@sateraito.co.jp" }
,{"approve_number":2, "email":"approver2@sateraito.co.jp" }
]
承認時に追加する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。
・approve_number…追加するプロセス番号
・email…承認候補者メールアドレス
remove_approver_candidates 削除する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
承認時に削除する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。
・approve_number…削除するプロセス番号
・email…承認候補者メールアドレス
open_notification_list 開封通知設定 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
開封通知をONにする承認候補者情報をセット(承認者用)
※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。
・approve_number…開封通知をリクエストするプロセス番号
・email…開封通知をリクエストする承認候補者メールアドレス
update_master_datas マスター更新設定 JSON 任意 例:[
{"master_code":"yosan_master", "data_key":"yosan001", "target_approve_type":"submit", "update_data":{attribute_2:"更新値1", attribute_3:"更新値2",
 update_option:{attribute_2:["sum", "input_name"]}, is_overwite:true }
                    ・
                    ・
]
マスターデータを更新する定義を設定
※更新しない場合は指定なしでOKです。設定の詳細はワークフローヘルプの「SateraitoWF.appendUpdateMasterData」を参照
・mater_code:対象マスターのID
・data_key:更新するマスターレコードのキー
・target_approve_type:マスターを更新するタイミングの指定
・update_data:更新データ 
・update_option:更新の動作に関するオプション

※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



否決API

文書に対して否決処理を行うAPIです。
否決時に更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません


APIのURL

  /actions/reject

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
approve_number 承認プロセス番号     数字 必須 例:1 どのプロセスの処理としてアクションするかを指定
承認ルートHTMLのinput/@number に対応(1~)
approve_comment 承認、否決、差戻し理由 文字列 必須
画面上の一番下のコメント欄に当たる
doc_values 更新データ  JSON 任意 更新するデータをJSON辞書形式でセット
・KEY:ひな形HTMLのinput/@name にあたる値
・VALUE:入力値
※更新可能対象の項目のみ処理される
add_approver_candidates 追加する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver3@sateraito.co.jp" }
,{"approve_number":1, "email":"approver4@sateraito.co.jp" }
,{"approve_number":2, "email":"approver2@sateraito.co.jp" }
]
否決時に追加する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。
・approve_number…追加するプロセス番号
・email…承認候補者メールアドレス
remove_approver_candidates 削除する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
否決時に削除する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。
・approve_number…削除するプロセス番号
・email…承認候補者メールアドレス
open_notification_list 開封通知設定 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
開封通知をONにする承認候補者情報をセット(承認者用)
※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。
・approve_number…開封通知をリクエストするプロセス番号
・email…開封通知をリクエストする承認候補者メールアドレス
update_master_datas マスター更新設定 JSON 任意 例:[
{"master_code":"yosan_master", "data_key":"yosan001", "target_approve_type":"submit", "update_data":{attribute_2:"更新値1", attribute_3:"更新値2",
 update_option:{attribute_2:["sum", "input_name"]}, is_overwite:true }
                    ・
                    ・
]
マスターデータを更新する定義を設定
※更新しない場合は指定なしでOKです。設定の詳細はワークフローヘルプの「SateraitoWF.appendUpdateMasterData」を参照
・mater_code:対象マスターのID
・data_key:更新するマスターレコードのキー
・target_approve_type:マスターを更新するタイミングの指定
・update_data:更新データ 
・update_option:更新の動作に関するオプション

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



差戻しAPI

文書に対して差戻し処理を行うAPIです。

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません


APIのURL

  /actions/remand

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
approve_number 処理対象の承認プロセス 数字 必須 例:1 差戻し処理を行うプロセス番号(1~)
承認ルートHTMLのinput/@number に対応(1~)
※処理待ち状態のプロセスではない場合などはエラーとなる
return_target_approve_number 差戻し先の承認プロセス 数字 任意 例:1 差戻し先のプロセス番号(1~)
※申請者まで差し戻す場合は未指定(あるいは0)
approve_comment 承認、否決、差戻し理由 文字列 必須
画面上の一番下のコメント欄に当たる
※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。




差し戻し再申請API

申請者まで差戻された文書を再申請するAPIです。

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません
・添付ファイルの必須チェックは実施されません


APIのURL

  /actions/resubmit

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
ghost_writer_of 被代理申請者 メールアドレス 任意
viewer_email が代理申請者の場合、本来の申請者のアドレスをセット
※本項目をセットすると代理申請扱いとなります。
doc_values 申請データ  JSON 任意 申請データをJSON辞書形式でセット
・KEY:ひな形HTMLのinput/@name にあたる値
・VALUE:入力値
※更新データだけでなく全項目のデータをセットしてください
add_approver_candidates 追加する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver3@sateraito.co.jp" }
,{"approve_number":1, "email":"approver4@sateraito.co.jp" }
,{"approve_number":2, "email":"approver2@sateraito.co.jp" }
]
申請時に追加する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。
・approve_number…追加するプロセス番号
・email…承認候補者メールアドレス
remove_approver_candidates 削除する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
申請時に削除する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。
・approve_number…削除するプロセス番号
・email…承認候補者メールアドレス
open_notification_list 開封通知設定 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
開封通知をONにする承認候補者情報をセット(申請者用)
※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。
・approve_number…開封通知をリクエストするプロセス番号
・email…開封通知をリクエストする承認候補者メールアドレス
update_master_datas マスター更新設定 JSON 任意 例:[
{"master_code":"yosan_master", "data_key":"yosan001", "target_approve_type":"submit", "update_data":{attribute_2:"更新値1", attribute_3:"更新値2",
 update_option:{attribute_2:["sum", "input_name"]}, is_overwite:true }
                    ・
                    ・
]
マスターデータを更新する定義を設定
※更新しない場合は指定なしでOKです。設定の詳細はワークフローヘルプの「SateraitoWF.appendUpdateMasterData」を参照
・mater_code:対象マスターのID
・data_key:更新するマスターレコードのキー
・target_approve_type:マスターを更新するタイミングの指定
・update_data:更新データ 
・update_option:更新の動作に関するオプション

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。




申請取下げAPI

申請された文書を申請者自身が取下げを行うAPIです。

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません


APIのURL

  /actions/withdraw

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
approve_comment 承認、否決、差戻し、取下げ理由 文字列 必須
画面上の一番下のコメント欄に当たる
※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



更新API

文書に対して更新処理を行うAPIです。
更新処理とは、承認プロセスは進めず、登録内容や承認候補者の変更のみ行う処理です。

更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。

~ 制限事項 ~

・各ハンドラで定義されているJavaScriptの処理は実施されません


APIのURL

  /actions/update

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
approve_number 承認プロセス番号     数字 必須 例:1 どのプロセスの処理としてアクションするかを指定
承認ルートHTMLのinput/@number に対応(1~)
approve_comment 承認、否決、差戻し理由 文字列 任意
画面上の一番下のコメント欄に当たる
doc_values 更新データ  JSON 任意 更新するデータをJSON辞書形式でセット
・KEY:ひな形HTMLのinput/@name にあたる値
・VALUE:入力値
※更新可能対象の項目のみ処理される
add_approver_candidates 追加する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver3@sateraito.co.jp" }
,{"approve_number":1, "email":"approver4@sateraito.co.jp" }
,{"approve_number":2, "email":"approver2@sateraito.co.jp" }
]
同時に追加する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。
・approve_number…追加するプロセス番号
・email…承認候補者メールアドレス
remove_approver_candidates 削除する承認候補者 JSON 任意 例:[
{"approve_number":1, "email":"approver1@sateraito.co.jp" }
,{"approve_number":1, "email":"approver2@sateraito.co.jp" }
,{"approve_number":2, "email":"approver1@sateraito.co.jp" }
]
同時に削除する承認候補者のメールアドレス一覧
※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。
・approve_number…削除するプロセス番号
・email…承認候補者メールアドレス
※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
doc_values データ JSON 文書に登録されている各データ
※文書番号など、API側で自動セット、発行される値の確認などに利用できます                                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。




添付ファイルアップロード用URL取得API

申請や承認時に申請文書にファイルを添付するためのアップロードURLを生成して返します。
ファイルをアップロードするたびに、都度本APIでURLを生成する必要があります。

APIのURL

  /attach/getuploadurl

Request

※追加パラメータは特にありません。「各API共通のパラメータ」で指定されているRequestは指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
url アップロード用URL 英数字 このURLに対してファイルをアップロードしてください
※詳細は「ファイル添付API」の説明を参照                        
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



ファイル添付API

申請や承認時に申請文書にファイルを添付するAPIです。
ファイルをアップロードするたびに、都度「
添付ファイルアップロード用URL取得API」APIでURLを生成し、そのURLにに対してPOSTしてください。

※ 
enctype="multipart/form-data" 指定でアップロードしてください。

    

APIのURL

  ※「添付ファイルアップロード用URL取得API」にて取得したURL

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
file_name 添付ファイル名 文字列 任意 例:明細書.xls ※指定がなければ「Content-Disposition」から取得したファイル名で登録します
attach_file 添付ファイルデータ バイナリ 必須 ※type="file" にあたる項目
※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
file_id 内部添付ファイルID 英数字 例:file-20150805235318veow7yIQEu2EKffx アップした添付ファイルに割り当てられた内部ID                     
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。



添付ファイルダウンロードAPI

文書に添付されたファイルをダウンロードするAPIです。
※本APIはJSON形式のResponseデータではなく、ファイルストリームデータを返します。また、結果は、HTTPステータスにて返ります。

APIのURL

  /attach/download

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
doc_id 文書内部ID 英数字 必須 例:doc-20151015084918BS8zmTNzdE8atMbF 対象文書の内部ID
file_id 内部添付ファイルID 英数字 必須 例:file-20150805235318veow7yIQEu2EKffx 添付ファイルの内部ID(文書詳細取得APIやファイルアップロードAPIで取得可能)






※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

※JSON形式のResponseではなく、ファイルデータがバイナリ形式で出力されます

Response:HTTPステータス

 ステータス   説明  備考                                
200 OK(正常) ファイルがダウンロードされます             
400 Invalid Request パラメータが正しくない、など
403 Forbidden 文書や添付ファイルにアクセスする権限がない、など             
404 NotFound 文書が見つからない、など
※その他 予期しないエラー



ユーザー一覧取得API

ユーザー情報の一覧を取得するAPIです。
※メールアドレス「email」昇順で取得します。

APIのURL

  /users/list

Request

 キー   説明  型/桁数  必須  主な値、例        備考                                
max_results 取得最大件数    数字 任意 例:50 最大取得件数を指定(0~)
※APIの上限を超える指定値の場合は、API側の設定が優先されます。
start_cursor 次結果取得用トークン 英数字 任意 データ数が多い場合、一度の取得で全件取得できない場合があります。その場合、Responseの 「next_cursor」 にて返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。

※「各API共通のパラメータ」で指定されているRequestも指定してください。


Response

 キー   説明  型/桁数  主な値、例        備考                                
next_cursor 次結果取得用トークン 英数字  取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。Requestの「start_cursor」にセット
datas ユーザー一覧 JSON配列
取得されるユーザー一覧配列
※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

datasの要素

 キー   説明  型/桁数  主な値、例                                                   備考                                
email メールアドレス 英数字  例:user001@yourdomain.com ユーザーのメールアドレス。ユーザー情報を変更するうえでのキー項目になります。
family_name 氏名(姓) 文字列 例:浅尾
given_name 氏名(名) 文字列 例:貴行
department_1 部署1(事業所) 文字列 例:東京事業所
department_2 部署2(部署) 文字列 例:ソリューション事業部
department_3 部署3(課・グループ) 文字列 例:クラウド課
department_4 部署4 文字列

department_5 部署5 文字列

job_title 役職 文字列 例:部長
boss_email_1 承認者1 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_2 承認者2 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_3 承認者3 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_4 承認者4 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_5 承認者5 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_6 承認者6 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_7 承認者7 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_8 承認者8 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_9 承認者9 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_10 承認者10 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_11 承認者11 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_12 承認者12 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_13 承認者13 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_14 承認者14 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_15 承認者15 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_16 承認者16 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_17 承認者17 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_18 承認者18 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_19 承認者19 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_20 承認者20 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
employee_id 社員番号 英数字 例:s000011
user_attribute_1 追加属性1 文字列

user_attribute_2 追加属性2 文字列

user_attribute_3 追加属性3 文字列

user_attribute_4 追加属性4 文字列

user_attribute_5 追加属性5 文字列

workflow_groups ワークフローグループ 配列 例:["営業部門", "人事部門"]
deputy_approvers 代理承認者のメールアドレス 配列 例:["user001@yourdomain.com", "user002@yourdomain.com"] このユーザーの代理承認者として設定されているユーザーのID一覧
ghost_writers 代理申請者のメールアドレス 配列 例:["user001@yourdomain.com", "user002@yourdomain.com"] このユーザーの代理申請者として設定されているユーザーのID一覧
concurrent_users 兼務ユーザー 配列 兼務者のメールアドレス
例:["user001@yourdomain.com", "user002@yourdomain.com"]
このユーザーが兼務している部署(ユーザー)のID一覧。兼務者を設定したユーザーは本務(本人)だけでなく兼務者としても申請、承認、回覧などを行えるようになります。
language 言語 英数字 ユーザーの言語
例:・en…英語
・cn…中国語
・ko…韓国語
・pt…ポルトガル語
   ・
   ・
・ja…日本語(デフォルト)​

timezone タイムゾーン 英数字 ユーザのタイムゾーン
primary_email メール送信用アドレス 英数字
※指定すると「email」ではなく指定アドレスにメールが送信されます。



ユーザー詳細取得API

ユーザー情報を1件取得するAPIです。

APIのURL

  /users/get

Request    

 キー   説明  型/桁数  必須  主な値、例        備考                                
email ユーザーID(メールアドレス) 英数字 必須 例:user001@yourdomain.com

※「各API共通のパラメータ」で指定されているRequestも指定してください。

Response

 キー   説明  型/桁数  主な値、例        備考                                
data ユーザー詳細 JSON            

※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。

dataの要素


 キー   説明  型/桁数  主な値、例                                                   備考                                
email メールアドレス 英数字  例:user001@yourdomain.com ユーザーのメールアドレス。ユーザー情報を変更するうえでのキー項目になります。
family_name 氏名(姓) 文字列 例:浅尾
given_name 氏名(名) 文字列 例:貴行
department_1 部署1(事業所) 文字列 例:東京事業所
department_2 部署2(部署) 文字列 例:ソリューション事業部
department_3 部署3(課・グループ) 文字列 例:クラウド課
department_4 部署4 文字列

department_5 部署5 文字列

job_title 役職 文字列 例:部長
boss_email_1 承認者1 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_2 承認者2 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_3 承認者3 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_4 承認者4 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_5 承認者5 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_6 承認者6 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_7 承認者7 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_8 承認者8 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_9 承認者9 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_10 承認者10 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_11 承認者11 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_12 承認者12 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_13 承認者13 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_14 承認者14 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_15 承認者15 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_16 承認者16 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_17 承認者17 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_18 承認者18 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_19 承認者19 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
boss_email_20 承認者20 英数字 例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。
employee_id 社員番号 英数字 例:s000011
user_attribute_1 追加属性1 文字列

user_attribute_2 追加属性2 文字列

user_attribute_3 追加属性3 文字列

user_attribute_4 追加属性4 文字列

user_attribute_5 追加属性5 文字列

workflow_groups ワークフローグループ 配列 例:["営業部門", "人事部門"]
deputy_approvers 代理承認者のメールアドレス 配列 例:["user001@yourdomain.com", "user002@yourdomain.com"] このユーザーの代理承認者として設定されているユーザーのID一覧
ghost_writers 代理申請者のメールアドレス 配列 例:["user001@yourdomain.com", "user002@yourdomain.com"] このユーザーの代理申請者として設定されているユーザーのID一覧
concurrent_users 兼務ユーザー 配列 兼務者のメールアドレス
例:["user001@yourdomain.com", "user002@yourdomain.com"]
このユーザーが兼務している部署(ユーザー)のID一覧。兼務者を設定したユーザーは本務(本人)だけでなく兼務者としても申請、承認、回覧などを行えるようになります。
language 言語 英数字 ユーザーの言語
例:・en…英語
・cn…中国語
・ko…韓国語
・pt…ポルトガル語
   ・
   ・
・ja…日本語(デフォルト)​

timezone タイムゾーン 英数字 ユーザのタイムゾーン
primary_email メール送信用アドレス 英数字
※指定すると「email」ではなく指定アドレスにメールが送信されます。



利用にあたっての諸注意事項のまとめ

・公開APIはサポート対象外となります。基本的にはお客様にて動作をご確認の上、ご利用ください。

・AjaxなどJavaScriptからAPIを利用する場合、APIキーの扱い、管理には十分注意してください。
 APIキーをJavaScriptやHTMLに直接埋め込む実装は非推奨です。

API利用の都度、毎回アクセストークンの取得をする実装は避けてください。
 認証APIではアクセストークンと一緒にトークンの期限も返しています。
 この期限が切れる少し前までアクセストークンを保持して使いまわす、あるいはアクセストークンの認証エラー時に再取得するといった実装をお願いします。



今後の拡張構想・リリース予定

今後のリリース予定の機能をここに記載するようにします!リリースしたら項目を削除し、リリース履歴の方に移動します!

・ディスカッション機能関連のAPI(質問、回答、承認者コメント、など)
・ツリー形コメント関連のAPI
・通知API(プッシュ通知)

※これ以外にもどんどん機能拡張をしていきますのでどうぞご期待ください!
※ここで挙げている項目は検討段階のものもございますので、検証の結果、やむを得ず対応されない場合もございます。その際は、なにとぞご容赦ください。



リリース履歴

リリース履歴の主なものをここに記載するようにします!

・文書詳細取得APIに検索条件「文書番号」(doc_no)を追加…doc_idに加えてdoc_no指定でも文書情報が取得可能に (2018.12.06)
・クロスドメインでのアクセスを許容するように変更(2017.08.27)
・ユーザー一覧、ユーザー詳細取得APIを追加(2017.08.15)
・取得系APIの管理者権限対応:「viewer_email」を未指定でAPIコールすると全件を対象としてデータ取得可能に(2017.06.30)
・文書一覧取得APIに検索条件「文書ステータス」(status)を追加 (2017.06.29)
・文書削除APIを追加
 (2016.12.14)
・公開APIのリリース (2015.08.13)

Comments