11.1. APIの位置づけ¶
IM-FormaDesigner for Accel Platform では、ユーザによる画面操作を経由することなく、プログラム上から案件の処理を行うための API を提供しています。
API を利用することで、以下のようなことが実現できます。
- 業務システムから申請用データを生成し、ジョブ・プログラムから全ユーザに向けて一括で申請処理を行う
- 特定のノードに到達した際に、条件に合致する場合は到達処理・ユーザプログラムにて当該ノードを自動で処理する
API のインタフェースの詳細については「 IM-FormaDesigner for Accel Platform APIドキュメント 」を参照してください
本ドキュメントでは、API の基本的な利用方法と注意事項について説明します。
注意
IM-Workflow の API も提供されていますが、IM-FormaDesigner for Accel Platform と連携したフロー定義に関しては必ず IM-FormaDesigner のAPIを利用してください。
IM-FormaDesigner の API を経由することで、IM-FormaDesigner が IM-Workflow のコンテンツ定義に設定している後処理（アクション処理ユーザプログラム）に対して入力値の情報を連動することが可能です。IM-Workflow のAPIを直接利用した場合は、入力値が後処理に正しく連動されず、エラーが発生します。
注意
また、IM-BIS と連携したフロー定義に関しては、同様に IM-BIS のAPIを利用してください。
IM-BIS の API については「 IM-BIS for Accel Platform APIドキュメント 」を参照してください。