部門情報更新

OpenAPI説明

当該OpenAPIは部門の更新に利用します。

制約・前提条件

上位部門指定有りの場合、実行順序（上位部門を先に登録）をご注意ください。
部門が期間（履歴）管理されます。
A部門が22年新設、23年から名称変更の場合、本APIで更新しますと、「A、名称１、2022/01/01〜2022/12/31」と「A、名称２、2023/01/01〜」との二つ履歴を生成します。
組織階層単位で上位下位部門の関係を一式しか保持しません。
上位部門変更に当たって、所属関係を保存する必要の場合、組織階層をコピー（作成）した上、新しい組織階層の期間内に変更してください。
【具体例へ】

OpenAPI権限

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

リクエストURI

/api/openapi/departments

リクエスト形式

PUT

リクエスト例

{
    "code": "TEC-1",
    "name": "技術グループ1",
    "companyCode": "COM002",
    "parentDepartmentCode": "TEC",
    "fromDate": "2021-03-03",
    "customFields": [
        {
            "fieldCode": "country",
            "value": "JP"
        }
    ]
}

リクエスト項目

Department

パラメータ名	タイプ	必須	キー	規則	説明
code	String	○	○	最大36文字	部門コード
name	String	○		最大50文字	部門名称
companyCode	String			最大36文字	所属会社コード
parentDepartmentCode	String			最大36文字	上位部門コード
customFields	CustomField[]			最大10個	部門カスタマイズ項目リスト
fromDate	String			日付フォーマット：yyyy-MM-dd	部門開始日

CustomField

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

OpenAPIリターン例

成功例

{
    "message": "success",
    "oid": "3249b50a-1e29-4cae-93ea-bfec4955fafa",
    "key": "TEC-1"
}

失敗例

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

項目説明

項目名	タイプ	説明
message	String	エラーメッセージを返す
errorCode	String	エラーコードを返す
oid	UUID	部門OID
key	String	部門コード

エラーコード説明

errorCode	message	説明
0013	パラメータ:{0}は{1}文字以内で指定してください
120001	テナントの権限がありません
120003	パラメータ:{0}は指定必須の項目です
120228	部門カスタマイズ項目は最大10個まで設定可能です。
120229	部門カスタマイズ項目のコードが必須入力です。
120230	部門カスタマイズ項目の値が必須入力です。
120231	部門カスタマイズ項目のコードが存在しません:{0}。
120232	部門カスタマイズ項目のコードが重複しています。
6047055	無効な会社コードです。
6061002	部門は存在しない
6061006	カスタマイズ項目:{0} の値は正しくありません
9312007	上位部門コードは無効です
9312008	上位部門に該当部門（キー項目）の下位部門を指定できません
6013009	日付フォーマットはyyyy-MM-ddです
6061002	部門は存在しない
61000003	短縮した期間({0}~{1})内に、有効な従業員が存在します
61000005	短縮した期間({0}~{1})内に、有効な下位部門が存在します
8702003	社員の所属会社が所属部門の会社と一致していません
2009	clientIdの取得に失敗しました。
120107	部門コードは既に存在している
6044007	部門名は空白にしてはいけないまたは50文字以上超えることができません
6044012	同級部門が最大999個しか登録できません。	同一上級部門の直下に、最大999個下位部門まで登録できます。
6047048	部門コードは既に存在している
6057001	コードは漢字を含むことができません
6057002	コードは不正な文字を含むことができません
6057003	コードの桁数は36位以上を超えることができません
6061005	カスタマイズ項目:{0} を入力してください
6061007	カスタマイズ項目:{0} の値は規則に従っていません
6061008	カスタマイズ項目:{0} の値正整数の文字数は正しくありません
6061009	カスタマイズ項目:{0} の数点は正しくありません
6061010	カスタマイズ項目:{0} が時間フォーマットではありません。
6061011	カスタマイズ項目:{0} は日付フォーマット{1}で指定してください
12020015	テナントは存在しない
61000004	今の基準日に、組織階層が存在しません
61000007	所属部門が{0}~{1}の期間内に無効または存在しません	下位部門の有効期間が上位部門の範囲外にしてはいけません。
61000015	項目:{0}に、「英字、数字、-、_」以外を入力しないでください

← 部門情報追加部門情報削除 →