スクロール

Process - Read

Process Read Method

Process APIは、Process Resourceに対するアクセスを提供します。

Process Readでは、指定した検索条件に対応するProcessのデータを取得することができます。

GET

https://{Request Host}/v1/process?partition=[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&itemstate=[value]&keywords=[value,...]&order=[value,...]

 

Scope

Process Readを行うために必要なアクセス権は次の通りです。

process_r, candidate_r, resume_r, client_r, recruiter_r, job_r, user_r, option_r

 

Input Variables

GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。

また、指定できるParameterは以下の通りです。

Parameter間の条件はAND指定されたものとして検索されます。

必須 Parameter Definition
partition Partition Idを数値で指定します。
アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。
count 取得するデータの件数を数値で指定します。
指定できる値の範囲は、1~200までです。省略した場合は10が指定されたものとみなします。
start 取得するデータの開始インデックスです。0以上の値を数値で指定します。
field 出力する項目を指定します。省略した場合はProcess.P_Idが指定されたものとみなします。
詳細は、Read API - Parameter > Read - Fieldを参照してください。
指定できるFieldは、Process - Field Listを参照してください。
condition 検索する条件を指定します。
詳細は、Read API - Parameter > Read - Conditionを参照してください。
指定できるFieldは、Process - Field Listを参照してください。

但し、itemstateにdeleted、または、allを指定する場合、conditionに指定できるFieldと条件は次の3種類です。
尚、次の3種類の条件を複数指定することは可能です。
 1.Process.P_Id
 2.Process.P_UpdateDate
   指定可能な値は、Request日時から90日前の同時刻までの間の値です。それ以前の日時を指定することはできません。
   省略した場合は、Request日時の90日前の同時刻が指定されたものとみなします。
 3.Process.P_UpdatedBy
itemstate 取得するデータの状態を指定します。
次の値を指定することができます。省略した場合は、existingが指定されたものとみなします。
 existing:削除されていないデータを取得
 deleted :削除されたデータを取得
 all        :すべての状態のデータを取得

※itemstate=allとitemstate=deleted
 については更新日が90日以内という検索条件が自動で追加されます。

 (itemstate=existingとitemstateなし
 については、上記の検索条件は追加されません。)

※deletedまたはallを指定した場合、conditionに指定できる条件に制限が発生します。

keywords 取得するデータの条件をキーワードで指定します。
詳細は、Read API - Parameter > Read - Keywordsを参照してください。
order 出力時のデータの並び順を指定します。省略した場合は、Process.P_Id:ascが指定されたものとみなします。
詳細は、Read API - Parameter > Read - Orderを参照してください。
指定できるFieldは、Process - Field Listを参照してください。

 

Result Values

処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。

エラーが発生した場合は、200以外の値が返ります。

 

Output Values

出力値はXML形式で取得できます。

Tag Definition
Process 条件に該当するProcessを含むルート要素です。
取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。
Processの一つずつをItem要素として列挙します。
 Total Processの属性。指定した検索条件で取得できる総件数を示します。
 Count Processの属性。今回取得したデータの件数を示します。
 Start Processの属性。今回取得したデータの開始インデックスを示します。
Code 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。
Item 一つのProcess情報を表します。Field要素を持ちます。
 Field 指定された項目の値を格納します。
要素の名称は、Process - Field Listを参照してください。

 

Process Read Sample

※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。

次のサンプルは、Process Readでプロセス=JOB打診を条件に指定して、Process ID、JOB ID、ポジション、レジュメID、個人氏名を取得した場合の例です。

Input Parameter

https://{Request Host}/v1/process?partition=999999&field=Process.P_Id,Process.P_Job(Job.P_Id,Job.P_Position),Process.P_Resume,Process.P_Candidate(Person.P_Name)&condition=Process.P_Phase=Option.P_ProcessSoundOut

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Process Total="2" Count="2" Start="0">

 <Code>0</Code>
 <Item>
  <Process.P_Id>1234</Process.P_Id>
  <Process.P_Job>
   <Job>
    <Job.P_Id>10001</Job.P_Id>
    <Job.P_Position>法人営業</Job.P_Position>
   </Job>
  </Process.P_Id>

  <Process.P_Resume>
   <Resume>
    <Resume.P_Id>20001</Resume.P_Id>
   </Resume>
  </Process.P_Resume>
  <Process.P_Candidate>
   <Candidate>
    <Person.P_Name>山田 次郎</Person.P_Name>
   </Candidate>
  </Process.P_Candidate>

 <Item>
 <Item>
  <Process.P_Id>1235</Process.P_Id>
  <Process.P_Job>
   <Job>
    <Job.P_Id>10002</Job.P_Id>
    <Job.P_Position>通訳</Job.P_Position>
   </Job>
  </Process.P_Id>

  <Process.P_Resume>
   <Resume>
    <Resume.P_Id>20002</Resume.P_Id>
   </Resume>
  </Process.P_Resume>
  <Process.P_Candidate>
   <Candidate>
    <Person.P_Name>鈴木 桃子</Person.P_Name>
   </Candidate>
  </Process.P_Candidate>

 </Item>
</Process>

 

この記事は役に立ちましたか?
1人中1人がこの記事が役に立ったと言っています