簡易起票、簡易処理

簡易起票、簡易処理

APIの取得

メインメニュー>アプリケーション管理>リリース済みアプリケーション にて調べたいアプリケーションのプロセス一覧を表示します。 ni 調べたいプロセスの右側の設定ボタンをクリックします。

クリック後以下のインターフェースが表示されます。

  • カラム設定:プロセスのフォームリストの表示列をカスタマイズします。

  • 起票API:起票時に使用するAPI形式。

  • クエリAPI:検索時に使用するAPI形式。

  • 処理API:処理を進めるときに使用するAPI形式。

起票

クリックした後、「起票API」タブを選択すると、該当APIの例が表示されます。

セキュリティコードを<security>に設定する必要があり、formdataの"<>"内容を変更する必要があります。

formdataは少なくとも必須入力欄の内容を設定する必要があります。必須入力欄かどうかは、フォームフィールド設計で決めます。 詳細は【アプリケーション管理 >アプリケーション設計 > フォームフィールド設計】を参照して確認してください。

起票成功時、2種類の戻り情報があります。

一、プロセスの開始要素でデータ検証機能を使用していない場合, data_noを起票番号として返します。

{
  "status": "200",
  "message": "起票成功。",
  "result": "<data_no>"
}

二、検証機能を使用している場合、data_noは返しません。

{
  "status": "200",
  "message": "起票成功。",
  "result": ""
}

起票に失敗すると、次のように返します。

{
  "status": "404",
  "message": "起票失敗。"
}

ファイル添付

フォームのファイル添付機能が有効になっている場合は、起票時に下のように同時にファイルをアップロードすることもできます。

Pythonでの例は以下のとおり

import requests,json

url = '<起票APIのURL>'
formdata = [{"id": "FORMITM_2","value": "<入力値>"}]
values={
  "security": "<sevurity>",
  "omflow_restapi": 1,
  "action": "create",
  "formdata": json.dumps(formdata)
}
files={'files': open('<ファイルパス>','rb')}
requests.post( url, data=values, files=files )

ファイルフィールドがあってファイルをアップロードする例は下記のとおりです(ファイルフィールドはFORMITM_3と仮定)

import requests,json

url = '<起票APIのURL>'
formdata = [{"id": "FORMITM_1","value": "<入力>"}]
files_item = ['FORMITM_3'] #このパラメータを追加必要
values={
  "security": '<security>',
  "omflow_restapi": 1,
  "action": "create",
  "formdata": json.dumps(formdata),
  "files_item": json.dumps(files_item) #このパラメータを追加必要
}
files={'files': open('<ファイルパス>','rb'), 'FORMITM_3':open('<ファイルパス>','rb')}
response = requests.post( url, data=values, files=files )

クエリ

「クエリAPI」タブを選択します。このAPIを使用して、フォームデータの最新のIDを検索できます。全ての起票済みのフォームデータは<data_id>を取得しないと処理できず、かつ_フォームデータの<data_id>は、処理プロセスにおいて絶えず変更されていたり、1データに留まらない可能性があります_。そのため、処理前にクエリを実行する必要があります。

クエリが成功すると、次のようなデータが戻されます。

{
  "status": "200",
  "message": "クエリ成功。",
  "result": [
    {
      "data_id": "<データのユニークなID番号、処理時に使用する>",
      "stop_chart_text": "<滞留している処理名称 (手動入力要素の名称)>"
    },...
  ]
}

回返される結果は1個ではない可能性があります。プロセス設計に並行が含まれる場合、1つの起票データが複数のidで同時進行している場合があります。その為、要素名称で判断した上で、処理を行う必要があります。

注:クエリ結果が1つか複数かに関わらず、配列形式で返されます。

クエリが失敗した場合の応答は次のとおりです。

{
  "status": "404",
  "message": "クエリ失敗。"
}

処理

「処理API」タブを選択すると、フォーム処理の例が表示されます。

処理に成功すると、次のような応答を返します。

{
  "status": "200",
  "message": "処理成功。",
  "result": ""
}

処理に失敗した場合、次のような応答を返します。

{
  "status": "404",
  "message": "処理失敗。"
}

最終更新