「レコードの検索を行う」

「レコードの検索を行う」

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

目的

選択した列の式でレコードを検索するために、この方法を使用できます。

リクエスト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
注意:モジュールとは、候補者、求人、顧客、面接、連絡先、カスタムモジュール1、カスタムモジュール2、カスタムモジュール3、カスタムモジュール4、およびカスタムモジュール5を指します。

OAuth 認証のための

ヘッダー名

承認
Zoho-oauthtoken {アクセストークン}

範囲

範囲=ZohoRecruit.modules.all
(または)
範囲=ZohoRecruit.modules.{scope_name}.{operation_type}
可能なスコープ名(大文字小文字を区別)
操作タイプ
紹介、キャンペーン、評価、ベンダー、オファー、 添付、
予測、ノート、コール、イベント、タスク、候補者、求人、クライアント、部署、インタビュー、連絡先、カスタム(すべてのカスタムモジュール用)
ALL - レコードへの完全なアクセス
READ - モジュールからレコードを取得

Authtoken 認証のために

パラメーター
データ型
説明
authtoken*
String
暗号化された英数字文字列を使用して、Zohoの資格情報を認証します。 
範囲*
文字列
値として指定する recruitapi

リクエストパラメータ

パラメーター
データ型
説明
selectColumns*
String
モジュール(オプション列) 例えば、 候補者(苗字、ウェブサイト、メール) または全て
検索条件*
XML
(作成者|=|ユーザー名)
新しいフォーマット
整数(1または2)
新しいフォーマット=1:Recruitアカウントからデータを挿入する際に、「null」値を含むフィールドを除外します。
新しいフォーマット=2:Recruitアカウントからデータを挿入する際に、「null」値を含むフィールドも含めます。
fromIndex
整数
デフォルト値 - 1
toIndex
整数
デフォルト値 - 20
最大値 - 200
バージョン*
整数
version = 2: これにより、最新のAPI実装に基づいて応答が取得されます。


注意:  マークが付いたパラメーターは必須です。

求人開設のための特定パラメータ

パラメータ
データ型
説明
publishURL
ブール値

値を true に設定すると、 求人詳細URL および 応募URL が表示されます。デフォルトでは、この値は false です。
注: 求人URLは、求人が「ウェブサイトに公開」されたときにのみ表示されます。

正規表現

この方法を使用する際には、selectColumns および searchCondition パラメータを必須として設定する必要があります。API リクエスト内で次の表現を指定できます:
  1. は、または=
  2. ではない、または<>
  3. 含む(*srcString*)
  4. で始まる(srcString*)
  5. で終わる(*srcString)
  6. 含まない
  7. <または、以前
  8. >または、以後
  9. <=
  10. =>

例1
若要選擇「姓」、「現任僱主」、「電子郵件」、「行動電話」從候選人,且電子郵件必須包含「@sample.com」,搜尋 API 請求應如下所示:
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Authトークン&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Current Employer,Email,Mobile)&searchCondition=(Email|contains|*@sample.com*)

例2
若要選擇「姓氏」、「電子郵件」、「網站」、「經驗年數」等從候選人中,且「經驗年數」必須大於 2,搜尋 API 請求應如下所示:
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Authトークン&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=Authトークン&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(苗字、メール)&searchCondition=(現在の雇用主|starts with|Zoho*)

例:イコール(=)
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Authトークン&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(First Name,Last Name,Email)&searchCondition=(Email|=|test@test.com)を指定してください。

例:小なり(<)

注:null値のIntegerフィールドを「0」に置き換えます。値のないIntegerフィールドは検索に含まれません。
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Authトークン&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=Authトークン&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(姓、メール、現在の会社)&searchCondition=(現在の会社|contains|*oho*)

例は以下から始まります
https://recruit.zoho.com/recruit/private/xml/Candidates/getSearchRecords?authtoken=Authトークン&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=Authトークン&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|ends with|*zoho)