スクロール

Option - Read

Option Read Method

Option APIは、Resourceの選択肢情報に対するアクセスを提供します。

Option Readでは、指定した条件に対応するOptionのリストを取得することができます。

GET

https://{Request Host}/v1/option?partition=[value]&count=[value]&level=[value]&alias=[value]&enabled=[value]

 

Scope

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

option_r

 

Input Variables

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

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

必須 Parameter Definition
partition Partition Idを数値で指定します。
アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。
Count 取得するアイテムの最大数を指定します。
指定されていない場合は、全アイテムを出力します。
Level 取得するアイテムの階層レベルを指定します。
次の値を指定することができます。省略した場合は、-1が指定されたものとみなします。
 -1:すべての階層を出力
  0:aliasで指定されたアイテムの兄弟を出力
 1以上:aliasで指定された子供のアイテムを出力
Alias 取得するアイテムのaliasを指定します。
Enabled アイテムの使用/未使用の種別を指定します。
次の値を指定することができます。省略した場合は、-1が指定されたものとみなします。
 -1:すべてのアイテムを取得
  0:未使用のアイテムを取得
  1:使用中のアイテムを取得

 

Result Values

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

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

 

Output Values

出力値はXML形式で取得できます。Option APIで取扱可能な任意のFieldはありません。

Tag Definition
Option 条件に該当する選択肢項目を含むルート要素です。
Code 処理結果を表すcodeです。詳細は、Result Code Listを参照してください。
Item 選択肢項目です。
 Option.P_Id 選択肢のIDです。
 Option.P_Name 選択肢の名称です。
 Option.P_Alias 選択肢のエイリアスです。
 Option.P_ParentId 親のIDです。
 Option.P_Type 選択肢のタイプです。特定の目的の選択肢の場合は0以外の値が設定されています。
 0:通常の選択肢
 1:レジュメのフェーズ
 2:JOBのフェーズ
 3:プロセスのフェーズ
 4:アクティビティのフェーズ
 5:企業のフェーズ
 6:企業担当者のフェーズ
 7:個人連絡先のフェーズ
 8:売上のフェーズ
 9:契約のフェーズ
 Option.P_Order HRBC画面上での選択肢の並び順です。
 Items ネストしたItemのコレクションです。

 

Option Read Sample

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

次のサンプルは、「性別」の選択肢を取得した場合の例です。

Input Parameter

https://{Request Host}/v1/option?partition=999999&level=-1&alias=Option.P_Gender&enabled=-1

 

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Option>
 <Code>0</Code>
 <Item>
  <Option.P_Id>22</Option.P_Id>
  <Option.P_Name>性別</Option.P_Name>
  <Option.P_Alias>Option.P_Gender</Option.P_Alias>
  <Option.P_ParentId>0</Option.P_ParentId>
  <Option.P_Type>0</Option.P_Type>
  <Option.P_Order>1</Option.P_Order>
  <Items>
   <Item>
    <Option.P_Id>52</Option.P_Id>
    <Option.P_Name>男性</Option.P_Name>
    <Option.P_Alias>Option.P_Male</Option.P_Alias>
    <Option.P_ParentId>22</Option.P_ParentId>
    <Option.P_Type>0</Option.P_Type>
    <Option.P_Order>1</Option.P_Order>
    <Items/>
   </Item>
   <Item>
    <Option.P_Id>53</Option.P_Id>
    <Option.P_Name>女性</Option.P_Name>
    <Option.P_Alias>Option.P_Female</Option.P_Alias>
    <Option.P_ParentId>22</Option.P_ParentId>
    <Option.P_Type>0</Option.P_Type>
    <Option.P_Order>2</Option.P_Order>
    <Items/>
   </Item>
  </Items>
 </Item>
</Option>

 

  

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