ユーザー

一般的な検索

特定の条件を満たすユーザーデータをクエリする。

Method：POST
URL：/rest/accounts/api/user/list/
パラメータ入力(postbody)：形式の例は次のとおりです。

すべてのAPIは、使用前にセキュリティコード(security)とともに取得する必要があります。取得方法については、【RESTAPI > セキュリティコード】を参照してください。

{
	"security" : "<セキュリティコード>",
	"omflow_restapi" : 1,
	"search_conditions" : [],
	"search_columns" : [],
	"exclude_conditions" : [],
	"order_columns" : [],
	"limit" : 100,
	"start" : 0
}

search_columns：オプション、クエリする項目名。フォーマット例は以下のとおりです。
```
"search_columns" : ["id", "username", "nick_name"]
```

若未填 search_columnsが入力されていない場合、クエリフォームのすべてのフィールド名、フィールド值が返されます。

search_conditions：オプションで、条件を満たすデータを除外します。配列内の各条件はJSONオブジェクト構造であり、各条件はAND関係です。デフォルトでは、すべてのデータがクエリされます。 (1) column：項目名ID。 (2) condition：条件文字。次の5つのタイプに分けられます。
- =：value値とまったく同じデータを除外します。
- ：value値より大きいデータを除外します。
- <：value値未満のデータを除外します。
- in：value値の配列と同じデータを除外します。
- contains：value値を含むデータを除外します。 (3) value：フィールド値、依照【ユーザー管理 > ユーザー管理 > ユーザーデータ】により対応する値を入力します。

"search_conditions" :
[
    {
        "column" : "username",
        "condition" : "in",
        "value" : ["admin", "user001"]
    },
    {
        "column" : "id",
        "condition" : ">",
        "value" : 3
    },
    <その他の条件>,...
]

exclude_conditions：オプションで、条件を満たすデータを除外します。形式はsearch_conditionsと同じです。デフォルトでは、条件を除外しません。　 order_columns：オプションで、指定したフィールドに従ってソートします。逆順に並べ替える必要がある場合は、フィールド名の前に"-"記号を追加してください。デフォルトでは["id"]で並べ替えられます。
```
#ソート
"order_columns" : ["id"]

#逆ソート
"order_columns" : ["-id"]
```
limit：オプションで、数値を入力してデータ数を取得します。デフォルトは100です。
start：オプションで、取得する最初のデータから数を入力します。デフォルトは0番目です。

例1：start=0，limit=100，100データを返す。
例2：start=1，limit=100，99データを返す。
例3：start=100，limit=100，0データを返す。

一般的なクエリの戻り形式

APIの戻り例は次のとおりです。

{
    "status": 200,
    "message": "クエリ成功。",
    "result": [
        {
            "id": <ユーザ番号>,
            "password": <暗号化されたパスワード>,
            "last_login": <終ログイン時間>,
            "is_superuser": <管理者かどうか>,
            "username": <アカウント>,
            "first_name": <名前>,
            "last_name": <苗字>,
            "is_active": <有効にするかどうか>,
            "email": <メール>,
            "nick_name": <表示名>,
            "birthday": <誕生日>,
            "gender": <性別>,
            "phone1": <電話>,
            "phone2": <携帯>,
            "extension_no": <extension>,
            "company": <会社名>,
            "ad_flag": <adを統合するかどうか>,
            "ad_sid": <ad番号>,
            "frequency": <フロントエンドの更新頻度>,
            "updatetime": <更新時間>,
            "delete": <削除するかどうか>,
            "default_group": <デフォルトの組織>,
            "ad_no": <社員番号>
        },...
    ]
}

組織検索

「組織コード」を使用して、これらの組織の配下のユーザーを検索します。

Method：POST
URL：/rest/accounts/api/user/list-by-group/
パラメータ入力(postbody)：フォーマット例は以下のとおりです。

すべてのAPIは、使用前にセキュリティコード(security)とともに取得する必要があります。取得方法については、【RESTAPI > セキュリティコード】を参照してください。

{
	"security" : "<セキュリティコード>",
	"omflow_restapi" : 1,
	"org_no" : [],
	"org_name" : []
}

secuity：必要，セキュリティコード。
omflow_restapi：必要，1。
org_no：オプション，組織コード，複数の組織コードを配列に配置できます。（組織名と1つ選択してください）
org_name：オプション，組織名，複数の組織名を配列に配置できます。（組織コードと1つ選択してください）

APIの戻り例は次のとおりです。

{
    "status": 200,
    "message": "正常に読み取りました。",
    "result": {
        "<組織コード>": [
            {
                "user": <ユーザーID>, #これはomflowデータベースで使用される番号です
                "user__nick_name": <ユーザーの表示名>,
                "user__username": <ユーザーアカウント>,
                "user__ad_no": <ユーザーの社員番号>
            },...
        ],
        "<組織コード>": [
            {
                "user": <ユーザーID>, #これはomflowデータベースで使用される番号です
                "user__nick_name": <ユーザーの表示名>,
                "user__username": <ユーザーアカウント>,
                "user__ad_no": <ユーザーの社員番号>
            },...
        ],
    }
}

前へイベント次へ部門

最終更新 1 か月前