従業員情報一括取得

OpenAPI説明

当該OpenAPIは、従業員の最終更新日の範囲を指定し、従業員情報を一括取得します。

OpenAPI権限

当該OpenAPIはテナント権限が必要です

リクエストURI

/api/openapi/users

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/users?startTime=2020-02-01 00:00:00&endTime=2020-02-02 00:00:00&baseDate=xxxx&page=1&size=10&companyOID=051dbcbe-02d5-45b0-9159-1e28da3b0412

リクエストパラメータ説明

パラメータ名	タイプ	必須	説明
startTime	String	○	検索スタート日時。フォーマット: yyyy-MM-dd HH:mm:ss
endTime	String	○	検索エンド日時。フォーマット: yyyy-MM-dd HH:mm:ss
page	int	○	ページ、第一ページ: page=1
size	int	○	ページごとの結果数。最大50
baseDate	String		日付フォーマット：yyyy-MM-dd
companyOID	UUID		会社OID

OpenAPIリターン例

{
    "total": 1,
    "current": 1,
    "pageSize": 10,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
    "data": [
        {
            "userOID": "cbd0bf2f-b355-4c2b-818b-6811d683ed40",
            "employeeId": "EMP-001",
            "fullName": "張三",
            "email": "san.zhang@spendia.jp",
            "company": {
                "oid": "8825b490-4454-4cdb-b061-7a440187e0f6",
                "code": "JP002"
            },
            "department": {
                "oid": "747cd010-073f-49f4-b44e-f8cd7e71f047",
                "code": "D1"
            },
            "onboardDate": "2019-12-27",
            "birthday": "1989-12-27",
            "gender": "2",
            "staffType": "01",
            "staffLevel": "3",
            "job": "1231",
            "position": "111",
            "loginCode": "A_001",
            "managerEmployeeId": "admin",
            "notificationStrategyCode": "policy_strategy_code",
            "status": "NORMAL",
            "isMFAEnabled": false,
            "customFields": [
                {
                    "fieldCode": "date",
                    "value": "2020-03-21T00:00:00.000Z"
                },
                {
                    "fieldCode": "time",
                    "value": "23:56"
                },
                {
                    "fieldCode": "country",
                    "value": "AE"
                }
            ],
            "postCustomFields": [
                {
                    "fieldCode": "order",
                    "value": "15"
                }
            ]
        }
    ]

}

OpenAPIリターン項目

PageResposne

パラメータ名	タイプ	説明
total	int	検索結果の総件数
current	int	当ページ数
pageSize	int	ページごとの結果数
pages	int	検索結果総ページ数
hasPrevious	boolean	前のページがあるかどうか
hasNext	boolean	次のページがあるかどうか
data	Employee[]	従業員データ

Employee

項目名	タイプ	規則	説明
userOID	UUID	36桁	従業員OID
employeeId	String	最大32文字	従業員番号
fullName	String	最大100文字	従業員名前
email	String	最大128文字	メールアドレス
company	EntitySummary	oidとcode	従業員所属会社
department	EntitySummary	oidとcode	従業員所属部門
onboardDate	Date	日付フォーマット：yyyy-MM-dd	入職日
birthday	String	日付フォーマット：yyyy-MM-dd	誕生日
gender	String	システム値セット：性別　最大50文字	性別
staffType	String	システム値セット：従業員タイプ　最大50文字	従業員タイプ
job	String	システム値セット：職務　最大50文字	職務
approvalLevel	String	システム値セット：承認レベル　最大10文字	承認レベル
staffLevel	String	システム値セット：ランク　最大50文字	ランク
loginCode	String	最大20文字	企業IDログイン用の従業員ID
managerEmployeeId	String	最大32文字	所属上役従業員番号
customFields	CustomField[]		従業員カスタマイズ項目リスト
postCustomFields	CustomField[]		職務カスタマイズ項目リスト
notificationStrategyCode	String	最大20文字	受信ポリシーコード
fromDate	String	日付フォーマット：yyyy-MM-dd	主務開始日
status	String		NORMAL-在職 LEAVING-退職待ち RESIGNED-退職済
isMFAEnabled	Boolean		二要素認証ログイン true：有効 false：無効

EntitySummary

項目名	タイプ	規則	説明
oid	UUID	36桁	エンティティOID
name	String	最大50文字	エンティティ名称
code	String	最大50文字	エンティティCode
path	String		エンティティパス（部門のみ）

CustomField

パラメータ名	タイプ	規則	説明
fieldCode	String	最大50文字	カスタマイズ項目コード
value	String	最大50文字	カスタマイズ項目値、カスタマイズ項目の設定が必須の場合はカスタマイズ項目値は必須入力です

失敗例

{
    "message": "テナントの権限がありません",
    "errorCode": "120001"
}

項目説明

項目名	タイプ	説明
message	String	メッセージを返す
errorCode	String	エラーコードを返す

エラーコード説明

errorCode	message	説明
120001	テナントの権限がありません
4003	時間のフォーマット:{0}。
120003	{0}は指定必須の項目です

← 離職従業員の再入職従業員情報個別取得 →