役職追加

    役職情報を追加します。

    参考

    • ドメインの役職の使用有無が「true」に設定されていることが必要

    API の種類

    サーバー API

    Request URL

    • サービス: https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/positions
    • テスト: https://sandbox-apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/positions

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Request Body

    パラメーター タイプ 上限 必須 説明
    externalKey String 100 字 Y 役職の External Key。ドメイン内でユニークでなければなりません。
    特殊文字 \%#/? は使えません。
    sortLevel Integer Y 整列順。重複を許可します。
    name String 100 字 Y 役職名。ドメイン内でユニークでなければなりません。
    許容される特殊文字: !@&()-_+[]{},./
    i18nNames List N 多言語名リスト。多言語コード。付録の言語コード参照。
       name String 100 字 Y 多言語名。
    許容される特殊文字: !@&()-_+[]{},./
       language String Y 言語コード

    Request Example

    POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/positions
    
    {
        "externalKey": "EX123",
        "sortLevel": 5,
        "name": "社員",
        "i18nNames": [
            {
              "name":"사원",
              "language":"ko_KR"
            },
            {
              "name":"Staff",
              "language":"en_US"
            },
            {
              "name":"员工",
              "language":"zh_CN"
            },
            {
              "name":"職員",
              "language":"zh_TW"
            }
        ]
    }
    

    Response

    API 呼び出しに成功すると HTTP 200 コードと追加された役職情報を返します。

    {
        "externalKey": "EX123",
        "sortLevel": 5,
        "name": "社員",
        "i18nNames": [
            {
              "name":"사원",
              "language":"ko_KR"
            },
            {
              "name":"Staff",
              "language":"en_US"
            },
            {
              "name":"员工",
              "language":"zh_CN"
            },
            {
              "name":"職員",
              "language":"zh_TW"
            }
        ]
    }
    

    Error code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードは組織連携REST APIエラーコードを参照してください。