getSearchRecords

getSearchRecords

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

目的

このメソッドを使用すると、選択した項目に式を指定してデータを検索できます。

リクエストURL

XMLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Module/getSearchRecords?authtoken=AuthToken&scope=recruitapi

JSONフォーマット。
https://recruit.zoho.com/recruit/private/json/Module/getSearchRecords?authtoken=AuthToken&scope=recruitapi
メモ：Moduleは、Candidates、JobOpenings、Clients、Interviews、Contacts、CustomModule1、CustomModule2、CustomModule3、CustomModule4、CustomModule5を指します。

OAuth認証の場合

ヘッダー名
 値
Authorization
 Zoho-oauthtoken {access_token}

スコープ

Scope=ZohoRecruit.modules.all
（または）
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
使用可能なスコープ名（大文字と小文字を区別）
 操作の種類
referral, campaign, assessment, vendor, offer, attachment,
forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom（すべてのカスタムタブの場合 ）
ALL - データに対するすべての権限
READ - タブからデータを取得します

認証トークンによる認証の場合

パラメーター
 データ型
 詳細
authtoken*
 文字列
 Zohoの認証情報を認証するための、暗号化済みの英数字文字列です。
scope*
 文字列
 値には recruitapi を指定します

リクエストパラメーター

パラメーター
 データの種類
 詳細
selectColumns*
 文字列
 タブ（オプションの列）例：候補者（姓、Webサイト、メール）またはすべて
searchCondition*
 XML
 （作成者|=|ユーザー名）
newFormat
 整数（1または2）
 newFormat=1：Recruitのアカウントからデータを挿入する際に、「null」の値を持つ項目を除外します。
newFormat=2：Recruitのアカウントからデータを挿入する際に、「null」の値を持つ項目を含めます。
fromIndex
 整数
 初期値：1
toIndex
 整数
 初期値：20
最大値：200
version*
 整数
 version = 2：最新のAPI実装を基準にレスポンスを取得します。


メモ：「*」が付いているパラメーターは必須です。

求人固有のパラメーター

パラメーター
 データの種類
 詳細
publishURL
 真偽値

値をtrueに設定すると、求人の詳細URLと求人への応募の受け付けURLを取得できます。標準では、この値はfalseです。
メモ：求人URLは、求人がWebサイトで公開されている場合にのみ表示されます。

正規表現

このメソッドを使用する際は、selectColumnsパラメーターとsearchConditionパラメーターを必須として設定してください。API要求では、次の式を指定できます。
  1. is または =
  2. isn't または <>
  3. contains(*srcString*)
  4. starts with(srcString*)
  5. ends with(*srcString)
  6. doesn't contain
  7. < または is before
  8. > または is after
  9. <=
  10. =>

例

例1
候補者から姓、現在の雇用者、メール、携帯電話を選択し、メールに「@sample.com」が含まれるようにする場合、検索APIのリクエストは以下のようになります。
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Current Employer,Email,Mobile)&searchCondition=(Email|contains|*@sample.com*)

例2
候補者から姓、メール、Webサイト、経験年数を選択し、経験年数が2より大きくなるようにする場合、検索APIのリクエストは以下のようになります。
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Website,Experience in Years)&searchCondition=(Experience in Years|>|2)

例3
候補者から姓、メールを選択し、会社が「Zoho」で始まるようにする場合、検索APIのリクエストは以下のようになります。
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email)&searchCondition=(Current Employer|starts with|Zoho*)

等号（=）の例
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(First Name,Last Name,Email)&searchCondition=(Email|=|test@test.com)

未満（<）の例

メモ：値がnullの整数の項目は「0」に置換してください。値のない整数の項目は検索に含まれません。
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(customfield1|<|1000)

部分一致の例
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(Current Employer|contains|*oho*)

前方一致の例
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)&searchCondition=(Current Employer|starts with|zoho*)

後方一致の例
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=AuthToken&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|ends with|*zoho)





              Zoho Campaigns Resources

                Zoho WorkDrive Resources




                  • Desk Community Learning Series


                  • Digest


                  • Functions


                  • Meetups


                  • Kbase


                  • Resources


                  • Glossary


                  • Desk Marketplace


                  • MVP Corner


                  • Word of the Day


                  • Ask the Experts






                          Latest Feature Updates



                                  • Related Articles

                                  • APIメソッド

                                    お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。 メソッド名 目的 getRecords APIリクエストで指定されたすべてのユーザーデータを取得する getRecordById データIDに基づいて個別のデータを取得する addRecords 指定したZoho Recruitのタブにデータを挿入する updateRecords ...

                                  Resources

                                  Videos

                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                  eBooks

                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                  Webinars

                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                  CRM Tips

                                  Make the most of Zoho CRM with these useful tips.