概要
HRBC Connect API 3.12.29では、Read系APIにて削除済みレコードを取得できるように機能追加を実施致します。
本機能追加による挙動については、明示的にParameterを指定した場合にのみ影響し、既存のアプリへの影響はありません。
（「HRBC」は「PORTERS」の旧名称です。）
Read系APIの削除済みデータ取得
[対象となるAPI]
Client、Recruiter、Job、Candidate、Resume、Process、Activity、Contract、SalesのRead Method
[変更点]
指定可能なParameterとしてitemstateが追加され、データの状態を指定したリクエストが可能になります。
|
GET |
.../v1/{Resource}?partition=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&keywords=[value,...]&order=[value,...]&itemstate=[value] |
|---|
Input Variables
指定できるParameterの注意点ならびに変更点は以下の通りです。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | 変更なし |
| ー | count | 変更なし |
| ー | start | 変更なし |
| ー | field | 今回の機能追加に伴い、削除状態を表すField：{Resource}.P_Deletedが各Resourceに追加されます。 尚、Parameter指定方法に変更はありません。 |
| ー | condition | itemstateにexistingを指定する場合、または、itemstateを指定しない場合、変更はありません。 itemstateにdeleted、または、allを指定する場合、conditionに指定できるFieldと条件は次の3種類です。 尚、次の3種類の条件を複数指定することは可能です。 1．{Resource}.P_Id 2．{Resource}.P_UpdateDate 指定可能な値は、Request日時から90日前の同時刻までの間の値です。それ以前の日時を指定することはできません。 省略した場合は、Request日時の90日前の同時刻が指定されたものとみなします。 3．{Resource}.P_UpdatedBy ※削除済みデータについて、{Resource}.P_UpdateDate、{Resource}.P_UpdatedByの仕様は以下の通りです。 {Resource}.P_UpdateDate=削除日時 {Resource}.P_UpdatedBy＝削除される前の最終更新者 |
| ー | itemstate |
取得するデータの削除状態を指定することができます。 ※itemstate=allとitemstate=deleted （itemstate=existingとitemstateなし |
| ー | keywords | 変更なし |
| ー | order | 変更なし |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。今回の機能追加による変更はありません。
| Tag | Definition |
|---|---|
| {Resource} | 条件に該当する{Resource}を含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 {Resource}の一つずつをItem要素として列挙します。 |
| Total | {Resource}の属性。指定した検索条件で取得できる総件数を示します。 |
| Count | {Resource}の属性。今回取得したデータの件数を示します。 |
| Start | {Resource}の属性。今回取得したデータの開始インデックスを示します。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
| Item | 一つの{Resource}情報を表します。Field要素を持ちます。 |
| Field | 指定された項目の値を格納します。 要素の名称は、各ResourceのField Listを参照してください。 今回の機能追加に伴い、削除状態を表すField：{Resource}.P_Deletedが各Resourceに追加されます。 {Resource}.P_Deletedを出力したい場合、Request時にfield Parameterに指定しておく必要があります。 ※削除済みデータについて、{Resource}.P_UpdateDate、{Resource}.P_UpdatedByの仕様は以下の通りです。 {Resource}.P_UpdateDate=削除日時 {Resource}.P_UpdatedBy＝削除される前の最終更新者 |
Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、Client Readで、最終更新日がユーザーID：1を条件に、削除されたレコードを取得する場合の例です。
（条件にClient.P_UpdateDateを指定していないため、90日前の同日時以降に削除されたレコードを取得します。）
|
Input Parameter .../v1/client?partition=999999&field=Client.P_Id,Client.P_Name,Client.P_UpdateDate,Client.P_UpdatedBy,Client.P_Deleted&condition=Client.P_UpdatedBy:eq=1&itemstate=deleted |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |