追加情報の設定

印刷する
共有
PDF

追加情報の設定

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

会社の人事ポリシーによる社員の属性のうち、基本情報に含まれていない項目は、追加情報にて直接入力して管理できる APIです。Y/N型、選択型、日付型、記述型などの様々な方式にて必要な項目を追加でき、必要に応じて社員情報検索に表示することができます。

追加 API

追加情報設定を追加します。

リクエスト URL

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

リクエストヘッダ

Header	Description
x-ncp-apigw-timestamp	- 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
x-ncp-iam-access-key	- NAVERクラウドプラットフォームポータル{target=「_blank」}または Sub Accountから発行された Access Key ID
x-ncp-apigw-signature-v2	- 上記例の Bodyを Access Key IDとマッピングされる Secret Keyで暗号化した署名 - HMAC暗号化アルゴリズムは HmacSHA256を使用

リクエスト Pathパラメータ

パラメータ	タイプ	容量	要否	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > Default settings > Integration key`
externalKey	String	36	Y	追加情報の外部キー

リクエスト Bodyパラメータ

パラメータ	タイプ		容量	要否	説明
fieldType	String		50	Y	フィールドタイプ
name	String		100	Y	属性名
i18nNames	Map			N	属性多言語名の Map<Locale、 String> i18nNames
fieldUsedType	String		100	N	追加情報のユーザーアカウントのタイプ(一般社員:MEM)
searchDispYn	String		1	Y	社員検索の表示有無
userDispYn	String		1	Y	プロフィールの修正に表示有無
userMod	String		20	Y	ユーザー修正の有無(ユーザー修正可能: CHANGE/ユーザー修正不可: UNCHANGED/ユーザー未表示: INVISIBLE)
attrItemList	List			N	選択型のデータリスト
		externalKey		N	外部キー
		itemName		N	選択型の属性基本名
		i18nItemNames		N	選択型の属性多言語名の Map<Locale、String> i18nNames
		fieldTypeItemOrd	Int	N	並べ替え

リクエスト例

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
   "fieldUsedType" :"MEM",
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "INPUT",
     "name": "社員番号",
    "i18nNames": {
            "ko_KR": "사원번호",
            "en_US": "empno"
        },
    "userMod": "CHANGE"
 }

or

{
   "fieldUsedType" :"MEM",
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "在職",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "休職",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "在職の有無",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "CHANGE"
}

レスポンス例

HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "在職",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "休職",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "在職の有無",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "CHANGE"
}

修正 API

追加情報設定を修正します。

リクエスト URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

リクエストヘッダ

Header	Description
x-ncp-apigw-timestamp	* 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの * API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
x-ncp-iam-access-key	* NAVERクラウドプラットフォームポータル{target=「_blank」}または Sub Accountから発行された Access Key ID
x-ncp-apigw-signature-v2	* 上記例の Bodyを Access Key IDとマッピングされる Secret Keyで暗号化した署名 * HMAC暗号化アルゴリズムは HmacSHA256を使用

リクエスト Pathパラメータ

パラメータ	タイプ	容量	要否	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > Default settings > Integration key`
externalKey	String	36	Y	追加情報の外部キー

リクエスト Bodyパラメータ

パラメータ	タイプ		容量	要否	説明
fieldType	String		50	Y	フィールドタイプ
name	String		100	Y	属性名
i18nNames	Map			N	属性多言語名の Map<Locale、 String> i18nNames
searchDispYn	String		1	Y	社員検索の表示有無
userDispYn	String		1	Y	プロフィールの修正に表示有無
userMod	String		20	Y	ユーザー修正の有無(ユーザー修正可能: CHANGE/ユーザー修正不可: UNCHANGED/ユーザー未表示: INVISIBLE)
attrItemList	List			N	選択型のデータリスト
		externalKey		N	外部キー
		itemName		N	選択型の属性基本名
		i18nItemNames		N	選択型の属性多言語名の Map<Locale、String> i18nNames
		fieldTypeItemOrd	Int	N	並べ替え

リクエスト例

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp:1505290625682
x-ncp-apigw-api-key:DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key:D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "INPUT",
     "name": "社員番号",
    "i18nNames": {
            "ko_KR": "사원번호",
            "en_US": "empno"
        },
    "userMod": "UNCHANGED"
 }

or

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "在職",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "休職",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "在職の有無",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "INVISIBLE"
}

レスポンス例

HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "在職",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "In office"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "休職",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "On leave of absence"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "在職の有無",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "INVISIBLE"
}

削除 API

追加情報設定を削除します。

リクエスト URL

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

リクエストヘッダ

Header	Description
x-ncp-apigw-timestamp	- 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
x-ncp-iam-access-key	- NAVERクラウドプラットフォームポータル{target=「_blank」}または Sub Accountから発行された Access Key ID
x-ncp-apigw-signature-v2	- 上記例の Bodyを Access Key IDとマッピングされる Secret Keyで暗号化した署名 - HMAC暗号化アルゴリズムは HmacSHA256を使用

リクエスト Pathパラメータ

パラメータ	タイプ	容量	要否	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > Default settings > Integration key`
externalKey	String	36	Y	追加情報の外部キー

全体リスト API

設定した追加情報の全体リストを読み込みます。

リクエスト URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattrs

リクエストヘッダ

Header	Description
x-ncp-apigw-timestamp	- 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす
x-ncp-iam-access-key	- NAVERクラウドプラットフォームポータル{target=「_blank」}または Sub Accountから発行された Access Key ID
x-ncp-apigw-signature-v2	- 上記例の Bodyを Access Key IDとマッピングされる Secret Keyで暗号化した署名 - HMAC暗号化アルゴリズムは HmacSHA256を使用

リクエスト Pathパラメータ

パラメータ	タイプ	容量	要否	説明
companyId	String	36	Y	連携キー(CompanyId) `Developers > Default settings > Integration key`

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
[
    {
        "fieldType": "SELECT",
        "searchDispYn": "Y",
        "userModYn": "N",
        "dispOrd": 0,
        "name": "シャトルバスの搭乗情報",
        "i18nNames": {
            "ko_KR": "셔틀",
            "en_US": "Shuttle"
        },
        "attrItemList": [
            {
                "fieldTypeItemOrd": 0,
                "itemName": "カンナム",
                "i18nItemNames": {
                    "ko_KR": "강남_ko",
                    "en_US": "강남_en"
                }
            },
            {
                "fieldTypeItemOrd": 1,
                "itemName": "チャムシル",
                "i18nItemNames": {
                    "ko_KR": "잠실_ko",
                    "en_US": "잠실_en"
                }
            },
            {
                "fieldTypeItemOrd": 2,
                "itemName": "ソウル駅",
                "i18nItemNames": {
                    "ko_KR": "ソウル역_ko",
                    "en_US": "ソウル역_en"
                }
            },
            {
                "fieldTypeItemOrd": 3,
                "itemName": "シンドリム",
                "i18nItemNames": {
                    "ko_KR": "신도림_ko",
                    "en_US": "신도림_en"
                }
            },
            {
                "fieldTypeItemOrd": 4,
                "itemName": "インチョン",
                "i18nItemNames": {
                    "ko_KR": "인천_ko",
                    "en_US": "인천_en"
                }
            },
            {
                "fieldTypeItemOrd": 5,
                "itemName": "スウォン",
                "i18nItemNames": {
                    "ko_KR": "수원_ko",
                    "en_US": "수원_en"
                }
            },
            {
                "fieldTypeItemOrd": 6,
                "itemName": "アニャン",
                "i18nItemNames": {
                    "ko_KR": "안양_ko",
                    "en_US": "안양_en"
                }
            }
        ]
    }
]

レスポンス

HTTPステータスコードでリターンされ、 Body情報として転送します。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
201	Created	リソース作成成功に対するレスポンスコード
400	Bad Request	一般的なリクエスト失敗に使用(多くの場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードは、クライアント側のエラーを表すために使用され、 - 5XX番台のエラーコードは、サーバ側のエラーを表すために使用される

提供されるフィールドタイプ fieldType

fieldType	説明
INPUT	記述型
DATE	日付型
YESNO	Y/N型
SELECT	選択型

この記事は役に立ちましたか?

What's Next

追加情報社員別設定

説明
追加 API
修正 API
削除 API
全体リスト API
レスポンス
提供されるフィールドタイプ fieldType

タグ

WORKPLACE