快速開單、推單

取得API

進入 主選單>應用管理>已上架應用 ，選擇欲查詢的應用並進入到流程列表。

找到欲查詢的流程，點選最右方的設定。

點擊後會出現介面如下：

欄位設定：自訂該流程的表單列表顯示欄位。
開單API：開單時所使用的API格式。
查詢API：查詢時所使用的API格式。
推單API：推單時所使用的API格式。

開單

點開後，選擇「開單API」頁籤，即可看到該流程API範例。

安全碼需帶入<security>，並修改formdata中包含"<>"的內容。
其中formdata至少須填上必填欄位內容，是否必填由表單欄位設計決定。詳細請參閱【應用管理 > 應用設計 > 表單欄位設計】章節

開單成功時，會有兩種回傳。

一、流程的開始元件沒有使用資料驗證功能，此時會回傳data_no，也稱作單號。

{
  "status": "200",
  "message": "開單成功。",
  "result": "<data_no>"
}

二、開始元件使用了驗證功能時，不會回傳data_no。

{
  "status": "200",
  "message": "開單成功。",
  "result": ""
}

開單失敗回傳如下所示：

{
  "status": "404",
  "message": "開單失敗。"
}

附加檔案

開單時，若表單已開啟附加檔案功能，也可同時上傳檔案。

Python範例如下：

import requests,json

url = '<開單API網址>'
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網址>'
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>在表單過程中可能不斷變換或是不只一筆**，因此在推單先都需要先進行查詢。

查詢成功時回傳如下：

{
  "status": "200",
  "message": "查詢成功。",
  "result": [
    {
      "data_id": "<資料的唯一編號，推單時使用>",
      "stop_chart_text": "<停留的關卡名稱(人工輸入元件名稱)>"
    },...
  ]
}

回傳結果可能不只一個，當流程設計中含有並行時，可能會一張單會有多個id同時進行，因此需要靠元件名稱來進行判斷並推單。
註：無論查詢結果是一個還是多個，都是以陣列形式回傳。

查詢失敗時回傳如下：

{
  "status": "404",
  "message": "查詢失敗。"
}

推單

選擇「推單API」頁籤，可以看到推單的範例。

推單成功時回傳如下：

{
  "status": "200",
  "message": "推單成功。",
  "result": ""
}

推單失敗時回傳如下：

{
  "status": "404",
  "message": "推單失敗。"
}

最后更新于1个月前