OMFLOW Doc
搜索文档…
OMFLOW Doc
中文
目錄
介紹
OMFLOW概觀
OMFLOW 流程引擎
軟體及硬體需求
OMFLOW 版本紀錄
軟體安裝
安裝在Windows
安裝在 Linux
安裝Booster
安裝Dashboard
使用Docker
開源版安裝
啟用HTTPS
變更資料中心網址
架設PyPI伺服器
更新Apache Server至2.4.XX
常見錯誤
快速上手(Quick Start)
初始設定
人員及組織
建立應用、流程
更新內建流程
功能介紹
首頁
我的任務
服務請求
服務管理
資料收集
應用管理
Apps
人員管理
系統設定
內建流程
報表
API介紹
安全碼
快速開單、推單
我的任務
查詢表單
事件
組織圖
使用者
組織
請假紀錄
由
GitBook
提供支持
快速開單、推單
當自訂表單上架後,可使用API直接進行開單,也可針對停留在人工輸入元件的表單使用API進行推單,而相關API可直接在本系統檢視。
取得API
進入
主選單>應用管理>已上架應用
,選擇欲查詢的應用並進入到流程列表。
找到欲查詢的流程,點選最右方的設定。
點擊後會出現介面如下,以下將一一介紹頁籤:
欄位設定:自訂該流程的表單列表顯示欄位。
開單API
:開單時所使用的API格式。
查詢API
:查詢時所使用的API格式。
推單API
:推單時所使用的API格式。
開單
點開後,選擇「開單API」頁籤,即可看到該流程API範例,如下圖。
安全碼需帶入<security>,並修改formdata中包含"<>"的內容。
其中formdata至少須填上必填欄位內容,是否必填由
應用管理 > 應用設計 > 表單欄位設計
決定。
開單成功時,會有兩種回傳。
一、流程的開始元件沒有使用
驗證
功能,此時會回傳data_no,也稱作單號。
1
{
2
"status": "200",
3
"message": "開單成功。",
4
"result": "<data_no>"
5
}
Copied!
二、開始元件使用了驗證功能時,不會回傳data_no。
1
{
2
"status": "200",
3
"message": "開單成功。",
4
"result": ""
5
}
Copied!
開單失敗回傳如下所示:
1
{
2
"status": "404",
3
"message": "開單失敗。"
4
}
Copied!
附加檔案
開單時,若表單已開啟附加檔案功能,也可同時上傳檔案,如下圖:
Python範例如下:
1
import requests,json
2
3
url = '<開單API網址>'
4
formdata = [{"id": "FORMITM_2","value": "<輸入>"}]
5
values={
6
"security": "<sevurity>",
7
"omflow_restapi": 1,
8
"action": "create",
9
"formdata": json.dumps(inputjson)
10
}
11
files={'files': open('<檔案路徑>','rb')}
12
requests.post( url, data=values, files=files )
Copied!
查詢
選擇「查詢API」頁籤,透過這支API可以查詢資料最新的id,所有開過的單皆需要取得<data_id>才能進行推單,且
<data_id>在表單過程中可能不斷變換或是不只一筆
,因此在推單先都需要先進行查詢。
將開單成功時所回傳的data_no帶入,即可查詢該單目前最新的id。
查詢成功時回傳如下:
1
{
2
"status": "200",
3
"message": "查詢成功。",
4
"result": [
5
{
6
"data_id": "<資料的唯一編號,推單時使用>",
7
"stop_chart_text": "<停留的關卡名稱(人工輸入元件名稱)>"
8
},...
9
]
10
}
Copied!
回傳結果可能不只一個,當流程設計中含有
並行
時,可能會一張單會有多個id同時進行,因此需要靠元件名稱來進行判斷並推單。
註:無論查詢結果是一個還是多個,都是以陣列形式回傳。
查詢失敗時回傳如下:
1
{
2
"status": "404",
3
"message": "查詢失敗。"
4
}
Copied!
推單
選擇「推單API」頁籤,可以看到推單的範例。
data_id須透過查詢API取得。
推單成功時回傳如下:
1
{
2
"status": "200",
3
"message": "推單成功。",
4
"result": ""
5
}
Copied!
推單失敗時回傳如下:
1
{
2
"status": "404",
3
"message": "推單失敗。"
4
}
Copied!
API介紹 - 以前
安全碼
下一个 - API介紹
我的任務
最近更新
4mo ago
复制链接
内容
取得API
開單
附加檔案
查詢
推單