OMFLOW Doc
搜索文档…
使用者

一般搜尋

查詢符合特定條件的使用者資料
  • Method:POST
  • URL:/rest/accounts/api/user/list/
  • 輸入參數(postbody):範例格式如下。
所有api使用前須取得安全碼(security),取得方式請參閱取得安全碼
1
{
2
"security" : "<安全碼>",
3
"omflow_restapi" : 1,
4
"search_conditions" : [],
5
"search_columns" : [],
6
"exclude_conditions" : [],
7
"order_columns" : [],
8
"limit" : 100,
9
"start" : 0
10
}
Copied!
  • search_columns:選填,要查詢的欄位名稱。格式範例如下。
    1
    "search_columns" : ["id", "username", "nick_name"]
    Copied!
若未填 search_columns ,會回傳查詢表單所有欄位名稱、欄位值
  • search_conditions:選填,篩選出符合條件的資料。陣列中每個條件為JSON物件結構,每個條件之間為AND關係,預設為查詢所有資料。
    • column:欄位名稱,可參考回傳資料範例
    • condition:條件字元,分為下列五種。
      • =:篩選出與value完全相同的資料。
      • >:篩選出大於value的資料。
      • <:篩選出小於value的資料。
      • in:篩選出與value陣列中相同的資料。
      • contains:篩選出包含value的資料。
    • value:欄位值,依照 人員管理>使用者管理>使用者資料 而填入對應值。
1
"search_conditions" :
2
[
3
{
4
"column" : "username",
5
"condition" : "in",
6
"value" : ["admin", "user001"]
7
},
8
{
9
"column" : "id",
10
"condition" : ">",
11
"value" : 3
12
},
13
<其他條件>,...
14
]
Copied!
  • exclude_conditions:選填,排除掉符合條件的資料,格式與search_conditions相同,預設為不排除任何條件。
  • order_columns:選填,依照指定欄位進行排序。需要逆向排序請在欄位名稱前方加上"-"號,預設為以 ["id"] 進行排序。範例格式如下。
    1
    #正排序
    2
    "order_columns" : ["id"]
    3
    4
    #逆排序
    5
    "order_columns" : ["-id"]
    Copied!
  • limit:選填,填入數字取得至第幾筆資料,預設為100筆。
  • start:選填,填入數字從第幾筆資料開始取得,預設為第 0 筆。
例1:start=0,limit=100,回傳100筆資料。
例2:start=1,limit=100,回傳99筆資料。
例3:start=100,limit=100,回傳0筆資料。

一般搜尋回傳格式

API回傳範例如下:
1
{
2
"status": 200,
3
"message": "查詢成功。",
4
"result": [
5
{
6
"id": <使用者編號>,
7
"password": <加密過後的密碼>,
8
"last_login": <上次登入時間>,
9
"is_superuser": <是否為管理者>,
10
"username": <帳號>,
11
"first_name": <名字>,
12
"last_name": <姓氏>,
13
"is_active": <是否啟用>,
14
"email": <電子郵件>,
15
"nick_name": <顯示名稱>,
16
"birthday": <生日>,
17
"gender": <性別>,
18
"phone1": <電話>,
19
"phone2": <手機>,
20
"extension_no": <分機>,
21
"company": <公司名稱>,
22
"ad_flag": <是否整合ad>,
23
"ad_sid": <ad編號>,
24
"frequency": <前端刷新頻率>,
25
"updatetime": <更新時間>,
26
"delete": <是否刪除>,
27
"default_group": <預設組織>,
28
"ad_no": <員工編號>
29
},...
30
]
31
}
Copied!

組織搜尋

使用「組織代號」來搜尋這些組織底下有哪些使用者。
  • Method:POST
  • URL:/rest/accounts/api/user/list-by-group/
  • 輸入參數(postbody):範例格式如下。
所有api使用前須取得安全碼(security),取得方式請參閱取得安全碼
1
{
2
"security" : "<安全碼>",
3
"omflow_restapi" : 1,
4
"org_no" : [],
5
"org_name" : []
6
}
Copied!
  • secuity:必填,安全碼。
  • omflow_restapi:必填,1。
  • org_no:選填,組織代號,陣列內可放置多個組織代號。(與組織名稱二擇一)
  • org_name:選填,組織名稱,陣列內可放置多個組織代號。(與組織代號二擇一)
API回傳範例如下:
1
{
2
"status": 200,
3
"message": "讀取成功。",
4
"result": {
5
"<組織代號>": [
6
{
7
"user": <使用者編號>, #此為omflow資料庫使用之編號
8
"user__nick_name": <使用者顯示名稱>,
9
"user__username": <使用者帳號>,
10
"user__ad_no": <使用者員工編號>
11
},...
12
],
13
"<組織代號>": [
14
{
15
"user": <使用者編號>, #此為omflow資料庫使用之編號
16
"user__nick_name": <使用者顯示名稱>,
17
"user__username": <使用者帳號>,
18
"user__ad_no": <使用者員工編號>
19
},...
20
],
21
}
22
}
Copied!