部門情報一括取得

OpenAPI説明

当該OpenAPIでは、最終更新日の範囲を指定して、部門情報を一括取得します。

OpenAPI権限

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

リクエストURI

/api/openapi/departments

リクエスト形式

GET

リクエストパラメータ例

/api/openapi/departments?startTime=2020-06-04 00:00:00&endTime=2020-06-04 23:59:59&baseDate=2021-03-03&page=1&size=2

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

パラメータ名	タイプ	必須	説明
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

OpenAPIリターン例

{
    "total": 2,
    "current": 1,
    "pageSize": 20,
    "pages": 1,
    "hasPrevious": false,
    "hasNext": false,
       "data": [
            {
                "name": "技術グループ1",
                "departmentOID": "fc030840-5e59-47b5-b58c-7b8014785cd5",
                "path": "技術センター|技術グループ1",
                "code": "TEC-1",
                "status": 101,
                "companyCode": "COM002",
                "parentOID": "d1bea8a6-bbef-40d2-bf1d-5ee724a01ca6",
                "fromDate": "2021-03-03",
                "toDate": "2021-03-04",
                "customFields": [
                    {
                        "fieldCode": "country",
                        "value": "AE"
                    },
                    {
                        "fieldCode": "gender",
                        "value": "1"
                    }
                ]
            },
            {
                "name": "技術グループ2",
                "departmentOID": "fc030840-5e59-47b5-b58c-7b8014785cd5",
                "path": "技術センター|技術グループ2",
                "code": "TEC-2",
                "status": 101,
                "companyCode": "COM002",
                "parentOID": "d1bea8a6-bbef-40d2-bf1d-5ee724a01ca6",
                "customFields": [
                    {
                        "fieldCode": "country",
                        "value": "AE"
                    },
                    {
                        "fieldCode": "gender",
                        "value": "1"
                    }
                ]
            }
        ]
}

OpenAPIリターン項目

PageResposne

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

Department

パラメータ名	タイプ	規則	説明
name	String	最大50文字	部門名称
departmentOID	UUID	36桁	部門OID
path	String	最大1000文字	部門パス
code	String	最大36文字	部門コード
status	int	101--有効;102--無効	ステータス
companyCode	String	最大35文字	所属会社コード
parentOID	UUID	36桁	上位部門OID
fromDate	String	日付フォーマット：yyyy-MM-dd	開始日
toDate	String	日付フォーマット：yyyy-MM-dd	終了日
customFields	CustomFields[]		部門カスタマイズ項目リスト

CustomFields

パラメータ名	タイプ	説明
fieldCode	String	カスタマイズ項目コード
value	String	カスタマイズ項目値

失敗例

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

項目説明

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

エラーコード説明

errorCode	message	説明
4002	無効な頁数です:{0}。
4003	時間のフォーマット:{0}。
6013009	日付フォーマットはyyyy-MM-ddです
120001	テナントの権限がありません
120003	パラメータ:{0}は指定必須の項目です