部門情報個別取得

OpenAPI説明

当該OpenAPIは、個別に部門コード、またはOIDを指定して、照会する。

OpenAPI権限

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

リクエストURI

/api/openapi/department

リクエスト形式

GET

リクエストパラメータ例

• /api/openapi/department?departmentCode=TEC-1&baseDate=xxxx
• /api/openapi/department?departmentOID=58516027-c0c9-420a-aedf-f9d74ca4b2ed&baseDate=xxxx

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

departmentCodeとdepartmentOIDの片方をご指定

パラメータ名	タイプ	必須	説明
departmentCode	String		部門コード。最大36文字
departmentOID	UUID		部門OID
baseDate	String		基準日 日付フォーマット：yyyy-MM-dd

OpenAPIリターン例

{
    "name": "技術グループ2",
    "departmentOID": "fc030840-5e59-47b5-b58c-7b8014785cd5",
    "path": "技術センター|技術グループ2",
    "code": "TEC-2",
    "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"
        }
    ]
}

OpenAPIリターン項目

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	説明
6013009	日付フォーマットはyyyy-MM-ddです
120001	テナントの権限がありません