アクションだけでなく、ひな形や申請データ、申請・承認履歴の取得、添付ファイルのアップロード、ダウンロードなど、ワークフローの機能がAPI経由で利用できます。リリース履歴APIのプロトコル、インタフェース、URL・プロトコルはHTTPSです。・結果はJSON形式(application/json)で返ります・HTTPメソッドはPOST(KeyValue型)です。各パラメータごとにKeyとValueをPOSTしてください。・文字コードは「UTF-8」です。APIのルートURLは以下のとおりです。https://workflow.nextset.jp/nextset/api/public/actions/submitAPIKEYの取得ワークフロー管理ガジェットの「連携設定」タブから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ではありません)。どのユーザーの権限でデータの取得や申請などのアクションを行うか(GUI上のログインユーザーと同等)※空にすると管理者権限で全データを対象として取得できます(更新系のAPIでは必須です)。Response各APIで共通のResponseのパラメータです。code、error_codeの値をチェックしてAPIの処理が正常に終了したかなどを判断して下さい。ResponseはJSON形式です。・file_size_too_large:ファイルサイズが上限を超えています・not_found_attach_file:添付ファイルが見つかりませんでした。※ここに上げたステータス以外のステータスが返る場合もあります認証API各API共通のアクセス用アクセストークンを取得するAPIです。ここで取得したアクセストークンを使って各APIにアクセスします。(例:admin@yourdomain.com)※「認証API」では「各API共通のパラメータ」で指定されているRequestは不要です。ここで指定されているパラメータのみご指定ください。APIにアクセスするためのアクセストークン。アクセストークンが失効するまでの時間(秒)失効後は、改めて認証APIでアクセストークンを取得する必要があります。APIのコール元のプログラムではこの期限を保持しておき、適切なタイミングで認証APIにて新しいリクエストトークンを取得するようにしてください。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。ひな形一覧取得APIひな形の一覧を取得するAPIです。ひな形のタイトルや基本設定などが取得できます。内容HTMLなど、詳細情報の取得は、「ひな形詳細取得API」をご利用ください。最大取得件数を指定(0~)※APIの上限を超える指定値の場合は、API側の設定が優先されます。データ数が多い場合、一度の取得で全件取得できない場合があります。返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。※「各API共通のパラメータ」で指定されているRequestも指定してください。取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。※協定世界時(UTC)ひな形詳細取得APIひな形の詳細取得するAPIです。ひな形のタイトルや基本設定に加えて内容HTML,承認ルートHTMLも取得できます。例:template-20150521041941is2i9bxftLWiCsLv※「各API共通のパラメータ」で指定されているRequestも指定してください。JSON※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。※協定世界時(UTC)文書一覧取得API申請文書の一覧を取得するAPIです。詳細情報の取得は、「文書詳細取得API」をご利用ください。最大取得件数を指定(0~)※APIの上限を超える指定値の場合は、API側の設定が優先されます。データ数が多い場合、一度の取得で全件取得できない場合があります。返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。※「各API共通のパラメータ」で指定されているRequestも指定してください。取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。※協定世界時(UTC)文書詳細取得API申請文書1件の詳細情報を取得するAPIです。文書の内部ID(文書一覧APIで取得できます)※「各API共通のパラメータ」で指定されているRequestも指定してください。JSON※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。本申請文書に添付されたファイルの情報(内部ID、ファイル名)が配列でセットされます。ファイル内部IDは「添付ファイル取得API」でファイルをダウンロードする際に使用できます。文書削除API申請文書1件を削除するAPIです。※更新しない場合は指定なしでOKです。・update_data:更新データ・update_option:更新の動作に関するオプション※「各API共通のパラメータ」で指定されているRequestも指定してください。Response※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。承認プロセス取得API1つの申請文書の承認プロセス一覧情報を取得するAPIです。各承認プロセスの設定やステータス、承認候補者アドレス一覧などが取得できます。文書の内部ID(文書一覧APIで取得できます)※「各API共通のパラメータ」で指定されているRequestも指定してください。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。※協定世界時(UTC)アクション履歴一覧API1つの申請文書の申請や承認のアクション履歴一覧を取得するAPIです。各アクションを実施したユーザーやその日時、コメントなどが確認できます。文書の内部ID(文書一覧APIで取得できます)※「各API共通のパラメータ」で指定されているRequestも指定してください。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。承認か回覧かはapprove_typeで判別可能です。※協定世界時(UTC)申請API申請処理を行うAPIです。このAPIでは、ひな形を指定して新しい申請書を一件発行します。登録したい値「doc_values」パラメータでJSON形式でセットすることで各input項目に対しての入力値をセットすることができます。ひな形で指定されている以下の特殊クラスに関しては「doc_values」で値を指定しない場合、自動で値がセットされます。代理申請者の場合、本来の申請者のアドレスをセット※本項目をセットすると代理申請扱いとなります。申請時に使用する承認ルートの番号を指定(1~)※未指定の場合は、承認ルート1が使用されます。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。}]開封通知をONにする承認候補者情報をセット(申請者用)※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。※更新しない場合は指定なしでOKです。・update_data:更新データ・update_option:更新の動作に関するオプション※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。承認・回覧API文書に対して承認、回覧処理を行うAPIです。アクションが、実際に、承認、回覧(決裁)のどれにあたるかは承認プロセスの定義に準じます。承認時に更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。ひな形で指定されている以下の特殊クラスに関しては自動で値がセットされます。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。}]開封通知をONにする承認候補者情報をセット(承認者用)※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。※更新しない場合は指定なしでOKです。・update_data:更新データ・update_option:更新の動作に関するオプション※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。否決API文書に対して否決処理を行うAPIです。否決時に更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。}]開封通知をONにする承認候補者情報をセット(承認者用)※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。※更新しない場合は指定なしでOKです。・update_data:更新データ・update_option:更新の動作に関するオプション※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。差戻しAPI文書に対して差戻し処理を行うAPIです。画面上の一番下のコメント欄に当たる※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。差し戻し再申請API申請者まで差戻された文書を再申請するAPIです。代理申請者の場合、本来の申請者のアドレスをセット※本項目をセットすると代理申請扱いとなります。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。}]開封通知をONにする承認候補者情報をセット(申請者用)※承認ルート側で開封通知設定が無効なプロセス、および存在しない承認候補者の場合は無視されます。※更新しない場合は指定なしでOKです。・update_data:更新データ・update_option:更新の動作に関するオプション※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。申請取下げAPI申請された文書を申請者自身が取下げを行うAPIです。画面上の一番下のコメント欄に当たる※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。更新API文書に対して更新処理を行うAPIです。更新処理とは、承認プロセスは進めず、登録内容や承認候補者の変更のみ行う処理です。更新したい項目については、「doc_values」パラメータでJSON形式でセットしてください。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して追加がなければ未指定でOKです。※承認候補者は通常、承認ルートHTMLのapprover属性の定義に基づいてセットされます。それに対して削除がなければ未指定でOKです。・email...承認候補者メールアドレス※「各API共通のパラメータ」で指定されているRequestも指定してください。文書に登録されている各データ※文書番号など、API側で自動セット、発行される値の確認などに利用できます※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。添付ファイルアップロード用URL取得API申請や承認時に申請文書にファイルを添付するためのアップロードURLを生成して返します。ファイルをアップロードするたびに、都度本APIでURLを生成する必要があります。APIのURL/attach/getuploadurlRequest※追加パラメータは特にありません。「各API共通のパラメータ」で指定されているRequestは指定してください。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。ファイル添付API申請や承認時に申請文書にファイルを添付するAPIです。ファイルをアップロードするたびに、都度「添付ファイルアップロード用URL取得API」APIでURLを生成し、そのURLにに対してPOSTしてください。指定でアップロードしてください。※「各API共通のパラメータ」で指定されているRequestも指定してください。アップした添付ファイルに割り当てられた内部ID※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。添付ファイルダウンロードAPI文書に添付されたファイルをダウンロードするAPIです。※本APIはJSON形式のResponseデータではなく、ファイルストリームデータを返します。結果は、HTTPステータスにて返ります。添付ファイルの内部ID(文書詳細取得APIやファイルアップロードAPIで取得可能)※「各API共通のパラメータ」で指定されているRequestも指定してください。予期しないエラーユーザー一覧取得APIユーザー情報の一覧を取得するAPIです。※メールアドレス「email」昇順で取得します。最大取得件数を指定(0~)※APIの上限を超える指定値の場合は、API側の設定が優先されます。データ数が多い場合、一度の取得で全件取得できない場合があります。返されるトークンをセットして再度APIをコールすることにより続きのデータを取得することができます。※「各API共通のパラメータ」で指定されているRequestも指定してください。取得結果に続きがある場合に返される、続きの結果を取得するためのトークン。※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。ユーザーのメールアドレス。ユーザー情報を変更するうえでのキー項目になります。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。このユーザーが兼務している部署(ユーザー)のID一覧。兼務者を設定したユーザーは本務(本人)だけでなく兼務者としても申請、承認、回覧などを行えるようになります。※指定すると「email」ではなく指定アドレスにメールが送信されます。ユーザー詳細取得APIユーザー情報を1件取得するAPIです。例:user001@yourdomain.com※「各API共通のパラメータ」で指定されているRequestも指定してください。JSON※「各API共通のパラメータ」で定義されているResponseパラメータも返ってきますので処理結果の判定などに使用してください。ユーザーのメールアドレス。ユーザー情報を変更するうえでのキー項目になります。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。例:ユーザーに紐づく承認者メールアドレス、あるいは承認グループIDをセットします。このユーザーが兼務している部署(ユーザー)のID一覧。兼務者を設定したユーザーは本務(本人)だけでなく兼務者としても申請、承認、回覧などを行えるようになります。※指定すると「email」ではなく指定アドレスにメールが送信されます。利用にあたっての諸注意事項のまとめ・公開APIはサポート対象外となります。基本的にはお客様にて動作をご確認の上、ご利用ください。・AjaxなどJavaScriptからAPIを利用する場合、APIキーの扱い、管理には十分注意してください。APIキーをJavaScriptやHTMLに直接埋め込む実装は非推奨です。・API利用の都度、毎回アクセストークンの取得をする実装は避けてください。認証APIではアクセストークンと一緒にトークンの期限も返しています。この期限が切れる少し前までアクセストークンを保持して使いまわす、あるいはアクセストークンの認証エラー時に再取得するといった実装をお願いします。コメント、など)・ツリー形コメント関連のAPI・通知API(プッシュ通知)※これ以外にもどんどん機能拡張をしていきますのでどうぞご期待ください!※ここで挙げている項目は検討段階のものもございますので、検証の結果、やむを得ず対応されない場合もございます。その際は、なにとぞご容赦ください。