スクロール

Read API - Parameter

Read - Field

Standard

Read MethodのField句の指定方法は次のようになります。項目を複数指定する場合は、カンマで区切って指定します。

  field=[Field Alias],[Field Alias]...

次の例は、JOB ReadでJOB IDとポジション名を指定しています。

  field=Job.P_Id,Job.P_Position

 

System[Reference] & User Type

上位ResourceのFieldやUserのFieldを参照したい場合、System[Reference] TypeまたはUser TypeのField Aliasの後に()を追記し、()内に上位Resourceの取得したいField Aliasを指定します。

()の値を指定しない場合、上位ResourceのIDのみが出力されます。

どのFieldがSystem[Reference] TypeまたはUser Typeに当たるかは、各ResourceのField Listを確認してください。

  field=[Field Alias]([Field Alias],[Field Alias]...)...

次の例は、JOB Readで、上位Resourceである企業の項目から企業IDと企業名を取得しています。

  field=Job.P_Client(Client.P_Id,Client.P_Name)

 

{Resource}.P_OwnerなどのUser Typeの場合、参照できるfieldは以下の4項目のみです。

 User Read APIで取得できるfieldとは異なりますので、ご注意ください。

  1.User.P_Id
  2.User.P_Type
  3.User.P_Name
  4.User.P_Mail

 

Read - Condition

Read MethodのCondition句の指定方法は次のようになります。条件が複数ある場合は、カンマで区切って指定します。複数項目が指定された場合は、項目間はANDの条件になります。

  condition=[Field Alias]:[Condition Suffix]=[Value],[Field Alias]:[Condition Suffix]=[Value]...

次の例では、JOB IDが100以上、JOBの更新日が2012/03/18 00:00:00以上、ポジション名がプログラマに部分一致するという条件を指定しています。

  condition=Job.P_Id:ge=100,Job.P_UpdateDate:ge=2012/03/18%2000:00:00,Job.P_Position:part=プログラマ

 

但し、Parameter:itemstateにdeleted、または、allを指定する場合、conditionに指定できるFieldは次の3種類のみです。

尚、次の3種類の条件を複数指定することは可能です。

 1.{Resource}.P_Id
 2.{Resource}.P_UpdateDate
   省略した場合は、90日前の同日時が指定されたものとみなします。
   指定可能な最大値は、90日前の同日時までです。
 3.{Resource}.P_UpdatedBy

※削除済みデータについて、{Resource}.P_UpdateDate、{Resource}.P_UpdatedByの仕様は以下の通りです。
 {Resource}.P_UpdateDate=削除日時
 {Resource}.P_UpdatedBy=削除される前の最終更新者

 

itemstateにexistingを指定する場合、または、itemstateを指定しない場合はこの限りではありません。

詳細は、各Resource APIページをご確認ください。

※Parameter:itemstateは、2018/04/10より利用可能です。

 

Suffix for Number type

対象Field Type:Number、Currency、DateTime、Date、Age

数値や日付の項目を条件に指定する場合、項目ごとに条件を指定することができます。

特に指定がない場合、Suffixを省略すると、eqが指定されたものとして動作します。 

Suffix Format Description
gt [Field Alias]:gt=[Value] [Field Alias]は、[Value]より大きい ([Field Alias]>[Value])
ex. Job.P_MinSalary:gt=3000000
or [Field Alias]:or=[Value] [Field Alias]は、Valueに指定した値をOR条件で指定します。複数指定する場合はコロンで区切ります。
Phase APIのIdおよびResource Idにしか使用できません。
ex. Job.P_Id:or=10003:43405
ge [Field Alias]:ge=[Value] [Field Alias]は、[Value]以上である ([Field Alias]>=[Value])
ex. Job.P_MinSalary:ge=3000000
eq [Field Alias]:eq=[Value] [Field Alias]は、[Value]と等しい ([Field Alias]=[Value]]
ex. Job.P_Id=100
le [Field Alias]:le=[Value] [Field Alias]は、[Value]以下である ([Field Alias]<=[Value])
ex. Job.P_MaxSalary:le=5000000
lt [Field Alias]:lt=[Value] [Field Alias]は、[Value]より小さい ([Field Alias]<[Value])
ex. Job.P_MaxSalary:lt=5000000

 

Suffix for Text type

対象Field Type:SinglelineText、MultilineText、Telephone、Mail、URL

文字列の項目を条件に指定する場合、項目ごとに条件を指定することができます。

特に指定がない場合、Suffixを省略すると、partが指定されたものとして動作します。

Suffix Format Description
full [Field Alias]:full=[Value] [Value]で指定した文字列に完全に一致する
ex. Job.P_Position:full=Programmer
part [Field Alias]:part=[Value] [Value]で指定した文字列に部分一致する
ex. Job.P_Memo:part=短期

 

Suffix for Option type

対象Field Type:Option

選択肢の項目を条件に指定する場合、項目ごとに条件を指定することができます。

特に指定がない場合、Suffixを省略するとorが指定されたものとして動作します。

Suffix Format Description
or [Field Alias]:or=[Value1]:[ValueN]... Valueに指定した値をOR条件で指定します。複数指定する場合はコロンで区切ります。
ex. Job.P_JobCategory:or=Option.P_SE:Option.P_PG
and [Field Alias]:and=[Value1]:[ValueN]... Valueに指定した値をAND条件で指定します。複数指定する場合はコロンで区切ります。
ex. Job.P_JobCategory:and=Option.P_SE:Option.P_PG

 

Read - Keywords

検索対象Field Type:MultilineText、SinglelineText、Telephone、Mail、URL

Read MethodのKeywordsの指定方法について解説します。

取得するデータの条件をキーワードで指定します。

複数のキーワードを指定したい場合は、カンマ(,)で区切ることによって、複数の条件を指定することができます。

列挙したキーワードはOR指定されたものとして検索されます。AND指定での検索はできません。

キーワードに指定できる文字数はカンマを含めて100文字までです。

  Keyword=[Keyword1],[Keyword2]...

 

Telephone型の情報を検索する場合、キーワードとなる電話番号は数字のみにする(ハイフンを取り除くなど)必要があります。

Telephone以外の情報を検索する場合、次の点に留意してください。

  1. 大文字と小文字、タブとスペース、英数および以下で列挙される記号の全角と半角は区別せず検索が行われます。
      !”#$%&’()=-|¥^[{@`}]*:+;_/?.>,<~゛-゜。「」、・
  1. 以下の各グループに属する記号は同一グループ内の記号と区別せず検索が行われます。
      グループ1   “”〝〞"”
      グループ2   ’’''
      グループ3   -ー-

 

Read - Order

対象Field Type:NumberCurrencyAgeDateDateTimeSystem

Read MethodのOrder句の指定方法は次のようになります。並び順を複数指定する場合は、カンマで区切って指定します。

Field Aliasとして指定できるのは、対象のResourceのField Listで定義されているのもののみです。

  order=[Field Alias]:desc,[Field Alias]:asc

次の例では、JOBの更新日を降順、JOBの登録日を昇順として指定しています。

  order =Job.P_UpdateDate:desc,Job.P_RegistrationDate:desc

Suffix Format Description
desc [Field Alias]:desc [Field Alias]に指定された項目の降順で出力します。
ex. Job.P_UpdateDate:desc
asc [Field Alias]:asc [Field Alias]に指定された項目の昇順で出力します。
ex. Job.P_UpdateDate:asc

 

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