Phase Read Method
Phase APIではリソースのPhaseに対するアクセスを提供します。
Readでは、指定した検索条件に対応するResourceのPhaseデータを取得することができます。
|
GET |
https://{Request Host}/v1/phase?partition=[value]&resource=[value]&resourceId=[value]&id=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&order=[value,...] |
|---|
Scope
Phase Readを行うために必要なアクセス権は次の通りです。
phase_r
Input Variables
GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。
また、指定できるParameterは以下の通りです。
Parameter間の条件はAND指定されたものとして検索されます。
| 必須 | Parameter | Definition |
|---|---|---|
| ● | partition | Partition Idを数値で指定します。 アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。 |
| ● | resource | 取得するResourceを指定します。 指定できる値は、Resource Listを参照してください。 |
| ー | resourceId | 関連するResourceのレコードのIdを指定します。 CandidateのId, JobのIdなどが該当します。 複数のIdを指定して or 検索する場合は、conditionパラメータにResourceIdを指定してください。 |
| ー | id | 取得したいPhaseのIdを指定します。 複数のIdを指定して or 検索する場合は、conditionパラメータにPhaseのIdを指定してください。 |
| ー | count | 取得するデータの件数を数値で指定します。 指定できる値の範囲は、1～200までです。省略した場合は10が指定されたものとみなします。 |
| ー | start | 取得するデータの開始インデックスです。 0以上の値を数値で指定します。省略した場合は0が指定されたものとみなします。 |
| ー | field | 出力する項目を指定します。省略した場合はPhase.P_Idが指定されたものとみなします。 詳細は、Read API - Parameter > Read - Fieldを参照してください。 指定できるFieldは、Phase - Field Listを参照してください。 |
| ー | condition | 検索する条件を指定します。 詳細は、Read API - Parameter > Read - Conditionを参照してください。 指定できるFieldは、Phase - Field Listを参照してください。 |
| ー | order | 出力時のデータの並び順を指定します。省略した場合は、Phase.P_Id:ascが指定されたものとみなします。 詳細は、Read API - Parameter > Read - Orderを参照してください。 指定できるFieldは、Phase - Field Listを参照してください。 |
Result Values
処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。
エラーが発生した場合は、200以外の値が返ります。
Output Values
出力値はXML形式で取得できます。
| Tag | Definition |
|---|---|
| Phase | 条件に該当するPhaseを含むルート要素です。 取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 Phaseの一つずつをItem要素として列挙します。 |
| Total | Phaseの属性。指定した検索条件で取得できる総件数を示します。 |
| Count | Phaseの属性。今回取得したデータの件数を示します。 |
| Start | Phaseの属性。今回取得したデータの開始インデックスを示します。 |
| Code | 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。 |
| Item | 一つのPhase情報を表します。Field要素を持ちます。 |
| Field | 指定された項目の値を格納します。 要素の名称は、Phase - Field Listを参照してください。 |
Phase Read Sample
※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。
次のサンプルは、レジュメID=10001のフェーズ履歴を取得した場合の例です。
|
Input Parameter https://{Request Host}/v1/phase?partition=999999&resource=17&resourceId=10001&field=Id,Resource,ResourceId,Phase,Date,Recent |
|
Output XML <?xml version="1.0" encoding="UTF-8" standalone="yes"?> |