HR REST API

オーストラリア API リファレンス

Release

australia

ft:locale

ja-JP

ft:publication_title

オーストラリア API リファレンス

ft:clusterId

crapiref

bundleId

crapiref

workflow

Creator

HR REST API

リリースバージョン: Australia

更新日 2026年03月12日

所要時間：9分

HR REST API は、米国で勤務または居住している従業員に関する情報を返すエンドポイントを提供します。

この API にアクセスするには、sn_hr_core.usa_employee_only ロールと、ヒューマンリソース (HR) スコープ対象のアプリ:Core (com_sn_hr_core) プラグインがアクティブ化されている必要があります。

HR REST - GET /get_usa_employee_profile

米国に拠点を置く従業員の従業員プロファイル情報を返します。

返される情報は次のいずれかになります。

指定された従業員 ID の従業員プロファイル情報。
指定された日付以降に追加された従業員、または情報が更新された従業員の情報。

注:

従業員を返される結果に含めるには、このエンドポイントの職場または自宅の国を米国として指定する必要があります。

さらに、エンドポイントは、統合された CIC Plus アプリケーションに次のパラメーターを送信します (説明については、「戻り値」セクションを参照してください)。

従業員識別子
名
ミドルネーム
姓
メール
作業住所
作業区町村
作業状態
作業郵便番号
作業国
自宅住所
出身地
ホームステート
自宅郵便番号
出身国
生年月日
入社日

URL 形式

デフォルト URL: /api/sn_hr_core/hr_rest_api/get_usa_employee_profile

サポートされている要求パラメーター

表 : 1. パスパラメーター
名前	説明
なし

表 : 2. クエリパラメーター
パラメーター	説明
employee_identifier	従業員の一意の識別子。呼び出し元システムはこの値を生成し、システムと一致する任意の形式にすることができます。この値を取得するには、まず updated_after パラメーターを使用してエンドポイントを呼び出します。注: このパラメーターは、 updated_after パラメーターと相互に排他的です。このパラメーターは一意の従業員を定義しますが、 updated_after は指定された日付以降に作成/更新された従業員のグループを返します。データタイプ：文字列
sysparm_limit	返されるレコードの最大数。このレコード数を超える要求の場合は、 sysparm_offset パラメーターを使用してレコード取得をページネーションします。データタイプ：数値デフォルト：1000
sysparm_offset	レコード取得を開始する開始レコードインデックス。この値を使用して、レコード取得をページネーションします。この機能を使用すると、レコードの数に関係なく、すべてのレコードを小さな管理可能なチャンクで取得できます。たとえば、このエンドポイントを初めて呼び出すとき、 sysparm_offset は「0」に設定されます。使用可能なすべてのレコードを単純にページングするには、すべてのレコードの最後に到達するまで `sysparm_offset=sysparm_offset+sysparm_limit` を使用します。
updated_after	返す従業員データの決定に使用する日付。インスタンスに追加された、またはこの日付以降に情報が更新された米国を拠点とするすべての従業員 (職場または自宅) が、返される結果に含まれます。注: このパラメーターは、 employee_identifier パラメーターと相互に排他的です。データタイプ：文字列形式:YYYY-MM-DD HH:MM:SS または YYYY-MM-DD (時間のデフォルトは 00:00:00)

表 : 3. 要求本文パラメーター (XML または JSON)
名前	説明
なし

ヘッダー

次の要求ヘッダーと応答ヘッダーは、この HTTP アクションにのみ適用されるか、別の方法でこのアクションに適用されます。REST API で使用される一般的なヘッダーのリストについては、「サポートされている REST API ヘッダー」を参照してください。

表 : 4. 要求ヘッダー
ヘッダー	説明
承認	応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。デフォルト： application/json

表 : 5. 応答ヘッダー
ヘッダー	説明
次のページ	後続の呼び出しで取得する追加のデータがあるかどうかを示すフラグ。たとえば、検索条件に一致する従業員レコードが合計 120 件あり、sysparm_limitが 100 に設定されている場合、 Next-Page は true です。追加の結果が得られない場合は、 Next-Page false です。有効な値： true:追加のデータが利用可能であり、データの次のチャンクを取得するには別の呼び出しを行う必要があります。 false:追加データはありません。

ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

表 : 6. ステータスコード
ステータスコード	説明
200	成功。要求が正常に処理されました。
401	権限がありません。ユーザー認証情報が正しくないか、渡されていません。
404	見つかりません。要求されたアイテムが見つかりませんでした。
500	内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。

応答本文のパラメーター (JSON または XML)


要素	説明
生年月日	従業員の生年月日。データタイプ：文字列
会社	会社名。データタイプ：文字列
メール	従業員のメールアドレス。データタイプ：文字列
従業員識別子	一意の従業員識別子。データタイプ：文字列
名	従業員の名。データタイプ：文字列
入社日	従業員が雇用された日付。データタイプ：文字列
姓	従業員の姓。データタイプ：文字列
ミドルネーム	従業員のミドルネーム。データタイプ：文字列
再雇用	将来の使用のために。データタイプ：文字列
居住地の住所	従業員の自宅住所。データタイプ：文字列
レジデンスシティ	従業員の出身地。データタイプ：文字列
居住国	従業員の母国。データタイプ：文字列
居住地郵便番号	従業員の自宅の郵便番号。データタイプ：文字列
ResidenceState	従業員の都道府県。データタイプ：文字列
サフィックス	従業員のサフィックス (Mr.、Mrs.、Dr. など) データタイプ：文字列
作業住所	従業員の勤務先住所。データタイプ：文字列
作業区町村	従業員の勤務先の市区町村データタイプ：文字列
作業国	従業員の勤務先の国。データタイプ：文字列
作業郵便番号	従業員の勤務先の郵便番号。データタイプ：文字列
作業状態	従業員の作業ステータス。データタイプ：文字列

特定の従業員の情報に対するサンプル cURL 要求

curl -X GET "https://instance.servicenow.com/api/sn_hr_core/V1/hr_rest_api/get_usa_employee_profile?employee_identifier=231"
-H "accept: application/json" \
-u "username":"password"

{"result": [
 {
  "EmployeeIdentifier": "231",
  "FirstName": "Harold",
  "MiddleName": "William",
  "LastName": "Lewis",
  "Suffix": "Mr.",
  "Email": "Howard.Lewis@example.com",
  "BirthDate": "",
  "HireDate": "2021-02-18",
  "Company": "ServiceNow Inc",
  "ResidenceAddress": "",
  "ResidenceCity": "SD",
  "ResidenceState": "CA",
  "ResidencePostalCode": "",
  "ResidenceCountry": "",
  "WorkAddress": "2617 South Robinson Avenue, Oklahoma City",
  "WorkCity": "Oklahoma",
  "WorkState": "OK",
  "WorkPostalCode": "73109",
  "WorkCountry": "USA",
  "ReHire": ""
 }
]}

2019 年 5 月 18 日以降に追加/更新された従業員のリストのサンプル cURL 要求

curl -X GET "https://instance.servicenow.com/api/sn_hr_core/V1/hr_rest_api/get_usa_employee_profile?update_after=2019-05-18"
-H "accept: application/json" \
-u "username":"password"

{"result": [
 {
  "EmployeeIdentifier": "2345",
  "FirstName": "Cheryl",
  "MiddleName": "Lynn",
  "LastName": "Smith",
  "Suffix": "Mrs.",
  "Email": "Cheryl.Smith@example.com",
  "BirthDate": "",
  "HireDate": "2019-06-18",
  "Company": "ServiceNow Inc",
  "ResidenceAddress": "",
  "ResidenceCity": "SD",
  "ResidenceState": "CA",
  "ResidencePostalCode": "",
  "ResidenceCountry": "",
  "WorkAddress": "2617 South Robinson Avenue, Oklahoma City",
  "WorkCity": "Oklahoma",
  "WorkState": "OK",
  "WorkPostalCode": "73109",
  "WorkCountry": "USA",
  "ReHire": ""
  },
  {
  "EmployeeIdentifier": "1111",
  "FirstName": "Thomas",
  "MiddleName": "",
  "LastName": "Doe",
  "Suffix": "Mr.",
  "Email": "Thomas.Doe@example.com",
  "BirthDate": "1978-05-22",
  "HireDate": "2019-08-14",
  "Company": "",
  "ResidenceAddress": "",
  "ResidenceCity": "San Jose",
  "ResidenceState": "CA",
  "ResidencePostalCode": "",
  "ResidenceCountry": "",
  "WorkAddress": "13308 Midland Road, Poway",
  "WorkCity": "Poway",
  "WorkState": "CA",
  "WorkPostalCode": "",
  "WorkCountry": "USA",
  "ReHire": ""
  }
]}