関連レコードの取得

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

目的

getRelatedRecordsメソッドを使用して、関連データを取得できます。

たとえば、キャンペーンに関連する候補者や、クライアントに関連するタスクを取得できます。

リクエストURL

XMLフォーマット。

https://recruit.zoho.com/recruit/private/xml/Notes/getRelatedRecords?authtoken=AuthToken&scope=recruitapi&id=Record ID&parentModule=Module Name&version=2

JSONフォーマット。

https://recruit.zoho.com/recruit/private/json/Notes/getRelatedRecords?authtoken=AuthToken&scope=recruitapi&id=Record ID&parentModule=Module Name&version=2

OAuth認証の場合

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

スコープ

Scope=ZohoRecruit.modules.all

（または）

Scope=ZohoRecruit.modules.{scope_name}.{operation_type}

使用可能なスコープ名（大文字と小文字を区別）	操作の種類
referral, campaign, assessment, vendor, attachment, forecast, note, call, event, task, candidate, jobopening, client, department, interview, contact & custom（すべてのカスタムタブの場合）	ALL - データへのすべての権限 READ - タブからデータを取得

Authtoken認証の場合

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

リクエストパラメーター

パラメーター	データ型	詳細
parentModule*	文字列	関連データを取得する対象のタブ例：キャンペーンに関連する候補者を取得する場合、キャンペーンが親のタブです。
id*	整数	関連データを取得する対象データのID
newFormat	整数	newFormat=1：Recruitのアカウントからデータを挿入する際に、値が「null」の項目を除外します。 newFormat=2：Recruitのアカウントからデータを挿入する際に、値が「null」の項目を含めます。
fromIndex	整数	初期値-1
toIndex	整数	初期値-20 最大値-200
version*	整数	使用する値：version=2：最新のAPI実装に基づいてレスポンスを取得します。

メモ：

*が付いたパラメーターは必須です。
getRelatedRecordsメソッドでは、カスタムルックアップ項目はサポートされていません。

サポート対象の関連リスト

getRelatedRecordsメソッドでは現在、メモと添付ファイルのタブがサポートされています。

例

データに添付されたファイルを表示するには

URLフォーマット：

https://recruit.zoho.com/recruit/private/xml/Attachments/getRelatedRecords?authtoken=Your_Auth Token&newFormat=1&scope=recruitapi&parentModule=Candidates&id=508020000000957321

レスポンス例：

<![CDATA[ 履歴書 ]]>

</FL>

</row>
<row no='2'>
<FL val='id'>5080200000000906253</FL>
<FL val='ファイル名'>
<![CDATA[ image.jpeg ]]>
</FL>
<FL val='サイズ'>
<![CDATA[ 8.55KB ]]>
</FL>
<FL val='更新日時'>
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val='SMOWNERID'>508020000000065849</FL>
<FL val='添付したユーザー'>
<![CDATA[ charles stone]]>
</FL>

<![CDATA[ その他 ]]>

</FL>

</row>
<row no='3'>
<FL val='id'>5080200000009873561</FL>
<FL val='ファイル名'>
<![CDATA[ sample-image.jpg ]]>
</FL>
<FL val='サイズ'>
<![CDATA[ 11.47KB ]]>
</FL>
<FL val='更新日時'>
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val='SMOWNERID'>508020000000065849</FL>
<FL val='添付したユーザー'>
<![CDATA[ charles stone]]>

<![CDATA[ その他 ]]>

</FL>

</FL>
</row>
<row no='4'>
<FL val='id'>5080200000001928374</FL>
<FL val='ファイル名'>
<![CDATA[ test-img.jpg ]]>
</FL>
<FL val='サイズ'>
<![CDATA[ 8.16KB ]]>
</FL>
<FL val='更新日時'>
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val='SMOWNERID'>508020000000065849</FL>
<FL val='添付したユーザー'>
<![CDATA[ charles stone]]>
</FL>

<![CDATA[ その他 ]]>

</FL>

</row>
</Attachments>
</result>
</response>

データに関連するメモを取得するには

URL形式：

https://recruit.zoho.com/recruit/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=recruitapi&id=RECORD_ID&parentModule=タブ名

レスポンス例：

<![CDATA[ メモ ]]>

</FL>