Spendia Open API

従業員グループの条件更新

OpenAPI説明

本APIは従業員グループ下の条件の更新に利用します
前提条件：従業員グループを設定されること

リクエストURI

/api/openapi/userGroup/conditions

リクエスト形式

PUT

リクエスト例

{
  "companyCode": "CMP-001",
  "userGroupCode": "GROUP-001",
  "userGroupConditionGroups": [
    {
      "userGroupConditionItems": [
        {
          "conditionProperty": "Company",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "companyCode1",
            "companyCode2"
          ]
        },
        {
          "conditionProperty": "Department",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "departmentCode1",
            "departmentCode1"
          ]
        },
        {
          "conditionProperty": "EmployeeRank",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "rankCode1",
            "rankCode2"
          ]
        },
        {
          "conditionProperty": "EmployeeDuty",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "positionCode1",
            "positionCode2"
          ]
        },
        {
          "conditionProperty": "EmployeeType",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "typeCode1",
            "typeCode2"
          ]
        },
        {
          "conditionProperty": "UserPostExt",
          "conditionFieldCode": "UserPostExt-001",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserPostExt",
          "conditionFieldCode": "UserPostExt-002",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserInfoExt",
          "conditionFieldCode": "UserInfoExt-001",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserInfoExt",
          "conditionFieldCode": "UserInfoExt-002",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        }
      ]
    },
    {
      "userGroupConditionItems": [
        {
          "conditionProperty": "Company",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "companyCode1",
            "companyCode2"
          ]
        },
        {
          "conditionProperty": "Department",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "departmentCode1",
            "departmentCode1"
          ]
        },
        {
          "conditionProperty": "EmployeeRank",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "rankCode1",
            "rankCode2"
          ]
        },
        {
          "conditionProperty": "EmployeeDuty",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "positionCode1",
            "positionCode2"
          ]
        },
        {
          "conditionProperty": "EmployeeType",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "typeCode1",
            "typeCode2"
          ]
        },
        {
          "conditionProperty": "UserPostExt",
          "conditionFieldCode": "UserPostExt-001",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserPostExt",
          "conditionFieldCode": "UserPostExt-002",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserInfoExt",
          "conditionFieldCode": "UserInfoExt-001",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        },
        {
          "conditionProperty": "UserInfoExt",
          "conditionFieldCode": "UserInfoExt-002",
          "conditionLogic": "I",
          "enabled": true,
          "conditionValues": [
            "valueCode1",
            "valueCode2"
          ]
        }
      ]
    }
  ]
}

リクエスト項目

フィールド名 カテゴリ 必須 キー 規則 説明
companyCode String 最大36文字 会社コード

会社のtokenで登録する場合、該当項目は無効です
userGroupCode String ○ ○ 最大50文字 従業員グループコード
userGroupConditionGroups List ○ 従業員条件リスト

UserGroupConditionGroup

項目名 タイプ 必須 規則 説明
userGroupConditionItems List 〇 従業員条件リスト

UserGroupConditionItem

項目名 タイプ 必須 規則 説明
conditionProperty String 〇 条件種類

Company：会社 ※会社tokenの場合、会社を使用しません
Department：部門
EmployeeRank：ランク
EmployeeDuty：職務
EmployeeType：タイプ
UserPostExt：所属情報拡張項目
UserInfoExt：個人情報拡張項目
conditionLogic String 〇 条件ロジック

部門以外

I：含む
E：含まない
部門

IC：含む／指定部門+子部門
I：含む／指定部門のみ
EC：含まない／指定部門+子部門
E：含まない／指定部門のみ
conditionFieldCode String 拡張項目コード

下記二種類のみ，該当項目入力必須です
UserPostExt
UserInfoExt
conditionValues List 〇 条件値リスト
enabled Boolean 有効フラグ
true/false
デフォルトはtrue

OpenAPIリターン例

成功例

{
  "message": "success",
  "errorCode": "0000",
  "key": "GROUP-001"
}

失敗例

{
  "message": "パラメータ:{0}は指定必須の項目です",
  "errorCode": "120003"
}

項目説明

フィールド名 カテゴリ 説明
message String エラーメッセージ
errorCode String エラーコード
key String 従業員リスト

エラーコード説明

errorCode message 説明
120003 パラメータ:{0}は指定必須の項目です
0013 パラメータ:{0}は{1}文字以内で指定してください
spd.12366.003 従業員グループ:{0}は存在しないか、無効になっています
spd.12366.005 会社:{0}は存在しないか、無効になっています
spd.12366.004 部門:{0}は存在しないか、無効になっています
spd.12366.007 ランクの値セット値:{0}は存在しないか、無効になっています
spd.12366.008 職務の値セット値:{0}は存在しないか、無効になっています
spd.12366.009 従業員タイプの値セット値:{0}は存在しないか、無効になっています
spd.12366.010 個人情報拡張項目のコード:{0}は存在しません
spd.12366.011 個人情報拡張項目の値セット値:{0}は存在しないか、無効になっています
spd.12366.012 所属情報拡張項目のコード:{0}は存在しません
spd.12366.013 所属情報拡張項目の値セット値:{0}は存在しないか、無効になっています
spd.12366.014 条件種類:{0}は存在しません
spd.12366.015 条件ロジック:{0}は存在しません

← 従業員グループの条件取得 →