概要
HRBC Connect API 3.12.31では、User Read APIで指定できるParameterに[field]を追加し、任意のfieldを取得できるように機能拡張を実施致します。
本機能拡張による挙動については、明示的にParameterを指定した場合にのみ影響し、既存のアプリへの影響はありません。
(「HRBC」は「PORTERS」の旧名称です。)
【お詫びとご案内】 ※2018/06/14追記
2018/06/12ならびに6/14に、HRBC 3.12.31リリースに合わせてHRBC Connect API 3.12.31のリリースを実施致しましたが、HRBCに問題が発生したため、リリース差し戻しを実施致しました。
今後のリリースにつきましては、再度状況を確認の上、方針を検討致します。
ご迷惑をお掛けし、誠に申し訳ございません。
※2018/07/10追記
2018/07/10にリリースを実施致しました。
User Read APIの機能拡張
[対象となるAPI]
User Read
※上記以外のResource APIでは、今回拡張された任意のUser Fieldを指定して取得することはできません。
[変更点]
User Read APIで指定可能なParameterとしてfieldが追加され、任意のUser Fieldを指定できるようになります。
GET |
.../v1/user?partition=[value]&request_type=[value]&user_type=[value]&count=[value]&start=[value]&field=[value] |
---|
Input Variables
指定できるParameterの注意点ならびに変更点は以下の通りです。
必須 | Parameter | Definition |
---|---|---|
● | partition | 変更なし |
● | request_type | 変更なし |
ー | user_type | 変更なし |
ー | count | 変更なし |
ー | start | 変更なし |
ー | field | 出力する項目を指定します。指定できるFieldは、User - Field List / Timezone Listを参照してください。 省略した場合は以下の4項目が指定されたものとみなします。 1.User.P_Id 2.User.P_Type 3.User.P_Name 4.User.P_Mail |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。User APIで取扱可能な任意のFieldはありません。
Tag | Definition |
---|---|
User | 変更なし |
Total | 変更なし |
Count | 変更なし |
Start | 変更なし |
Code | 変更なし |
Item | 一つのUser情報を表します。Field要素を持ちます。 |
Field | 指定された項目の値を格納します。 |
Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、User Readで、氏名、部署、データ更新者を取得した場合の例です。
Input Parameter .../v1/user?partition=999999&&request_type=1&field=User.P_Name,User.P_Department,User.P_UpdatedBy |
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |