「レコードの更新方法」

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

目的

Zoho Recruit のレコードを更新または変更するために、updateRecords メソッドを使用することができます。

注意: これらのパラメータを渡す際は、GET メソッドの代わりに POST メソッドを使用してください。

リクエストURL

XML 形式

1 回の API 呼び出しでモジュールに単一レコードを更新するには：

https://recruit.zoho.com/recruit/private/xml/Module/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&id=Record ID&xmlData=XMLData

1 回の API 呼び出しでモジュールに複数レコードを更新するには：

https://recruit.zoho.com/recruit/private/xml/Module/updateRecords?authtoken=AuthToken&scope=recruitapi&version=4&xmlData=XMLData

ご注意:モジュールとは、候補者、求人、クライアント、インタビュー、連絡先、カスタムモジュール1、カスタムモジュール2、カスタムモジュール3、カスタムモジュール4、カスタムモジュール5を指します。

OAuth 認証のため

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

スコープ

範囲=ZohoRecruit.modules.all

(または)
範囲=ZohoRecruit.modules.{scope_name}.{operation_type}

可能なスコープ名（大文字と小文字を区別）	操作タイプ
候補者、求人、顧客、部門、面接、連絡先、およびカスタム（すべてのカスタムモジュール））	ALL - レコードへの完全なアクセス READ - モジュールからレコードを取得

認証トークン認証について

パラメーター	データタイプ	説明
authtoken*	文字列	Zohoの認証情報を認証するための暗号化された英数字文字列です。
範囲*	文字列	値を次のように指定します recruitapi

リクエストパラメーター

パラメーター	データ型	説明
id*	String	レコードの固有のIDを指定してください
xmlData*	XML	指定されたフィールドとその値
wfTrigger	ブール型	Recruitアカウントでレコードを更新する際に、ワークフロールールをトリガーするために値を true に設定します。デフォルトでは、このパラメータは false です。
新しいフォーマット	整数 (1または2)	新しいフォーマット=1：Recruitアカウントからデータを更新する際に、「null」値のフィールドを除外します。新しいフォーマット=2：Recruitアカウントからデータを更新する際に、「null」値のフィールドも含めます。
バージョン	整数	バージョン = 2: これにより、最新のAPI実装に基づいて応答が取得されます。バージョン = 4: 単一のAPIメソッド呼び出しで複数のレコードを更新する。

注意: *でマークされたパラメーターは必須です。

追加のノート

Zoho Recruitアカウントでデータを更新する際、ロールベースのセキュリティ（ロール、プロファイル、フィールドレベルのセキュリティ、データ共有ルール）が適用されます。したがって、最高のロール（例：レクルーター管理者）とプロファイル（例：管理者）を持つユーザーIDを使用してください。また、フィールドレベルのセキュリティ設定ですべてのフィールドが有効になっていることを確認してください。ロールベースのセキュリティ設定については、API Ticketを生成する際に「セキュリティ管理」を参照してください。

データを更新する際には、日付と時刻がそれぞれ、「MM/dd/yyyy」「yyyy-MM-dd HH:mm:ss」の形式であることを確認してください。

レコードの所有者を更新する

レコードの更新をAPI経由で行う場合、レコードの所有者のメールアドレスまたはユーザーIDを指定してください。レコードの所有者の名前を使用すると、Auth Tokenで使用されるデフォルトのログイン資格情報にレコードが割り当てられます。ユーザーIDをレコードの所有者として指定する場合は、xmlDataに <FL val='SMOWNERID'>userID</FL> タグを追加してください。

例

Zoho Recruitのレコードを更新するには、以下の手順を実行してください。

URL形式:
https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords

パラメータは以下の通りである必要があります：

authtoken: 認証トークン

範囲：recruitapiを値として指定します。

xmlData：これはXML文字列であり、fetch APIでXML形式でレコードを取得する際の形式と同じである必要があります。

id: 更新するレコードのID

バージョン：APIのバージョン（2または4）

XMLデータ形式：

https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords?newFormat=1&authtoken=AuthToken&scope=recruitapi&xmlData=XMLDATA

authtoken=xy4gr1554712345fg

スコープ=recruitapi

xmlData= 以下に記載

ID = 1000000019001

バージョン=2

<候補者>
<行番号='1'>
<FL val='ソース'>ウェブダウンロード</FL>
<FL val='現在の雇用主'>会社</FL>
<FL val='名'>ハンナ</FL>
<FL val='姓'>スミス</FL>
<FL val='メール'>testing@testing.com</FL>
<FL val='電話'>1234567890</FL>
<FL val='自宅電話'>0987654321</FL>
<FL val='その他の電話'>1212211212</FL>
<FL val='FAX'>02927272626</FL>
<FL val='携帯電話'>292827622</FL>
</行>
</候補者>

タスクとコンタクトマッピング:

https://recruit.zoho.com/recruit/private/xml/Tasks/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017022
&xmlData=

イベント：

https://recruit.zoho.com/recruit/private/xml/Events/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017023
&xmlData=

<Events>
<row no='1'>
<FL val='Subject'>会議</FL>
<FL val='Start DateTime'>2009-08-04 01:00:00</FL>
<FL val='End DateTime'>2009-08-05 01:00:00</FL>
<FL val='Venue'>プラザ</FL>
<FL val='Send Notification Email'>false</FL>
</row>
</Events>

連絡先:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017024
&xmlData=

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi
<連絡先>
<row no='1'>
<FL val='名'>スコット</FL>
<FL val='姓'>ジェームズ</FL>
<FL val='メール'>test@test.com</FL>
<FL val='部門'>CG</FL>
<FL val='電話'>989898988</FL>
<FL val='FAX'>99999999</FL>
<FL val='携帯'>99989989</FL>
</row>
</連絡先>

インタビュー：

https://recruit.zoho.com/recruit/private/xml/Interviews/updateRecords?authtoken=491e5e3374b0132324lqs2f1scb18cd0&
version=2&scope=recruitapi&id=508020000000366001&xmlData=

<Interviews>
<row no='1'>
<FL val='Interview Owner'>VT</FL><FL val='Interview Name'><![CDATA[Interview1]]></FL><FL val='Client Name'>Client 2</FL><FL val='Interviewer'>john@zohocorp.com</FL><FL val='Type'>一般インタビュー</FL><FL val='Candidate Name'>Mark</FL><FL val='Posting Title'>ルックアップチェック</FL><FL val='Start DateTime'>2015-01-23 15:30:00</FL>
</row>
</Interviews>

'CDATA'の使用

目的：

特殊文字をXMLデータではなく、プレーンテキストとして考慮する

URLフォーマット:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=

URLフォーマット:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=

URLフォーマット:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=

URL形式:

https://recruit.zoho.com/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=

サンプルXMLデータ:

as POST:

<Contacts>
<row no='1'>
<FL val='名前'>エイミー</FL>
<FL val='苗字'>ドーソン</FL>
<FL val='メール'>testing@testing.com</FL>
<FL val='役職'>マネージャー</FL>
<FL val='電話'>1234567890</FL>
<FL val='携帯'>292827622</FL>
<FL val='アカウント名'> <![CDATA['A & A']]> </FL>
</row>
</Contacts>

複数レコードの更新

目的：

updateRecordsを使用することで、1つのupdateRecords APIメソッドで複数のレコードを更新することができます。version=4は必須パラメータであることに注意してください。

各レコードのAPI結果ステータスを表す新しいコードを導入しました。コードは以下の通りです：

2001 = レコードの更新に成功しました

URL形式：

https://recruit.zoho.com/recruit/private/xml/Candidates/updateRecords?authtoken=AuthToken&scope=recruitapi&version=4&xmlData=

サンプルXMLデータ：

<候補者>
<row no='1'>
<FL val='現在の雇用主'>会社1</FL>
<FL val='姓'>姓1</FL>
<FL val='メール'>automation@recruit.com1</FL>
</row>
<row no='2'>
<FL val='現在の雇用主'>会社2</FL>
<FL val='姓'>姓2</FL>
<FL val='メール'>automation@recruit.com2</FL>
</row>
</候補者>

サンプル応答

以下が機能と応答となります：

「<response uri='/recruit/private/xml/Candidates/insertRecords'>」
<result> 結果
<row no='1'>「1番目の行」
<成功>
<code>2001</code>
<summary>Technical Help Guide</summary> This guide will help you troubleshoot technical issues related to our products.</details> <details> <summary>テクニカルヘルプガイド</summary> このガイドは、当社製品に関連するテクニカル問題のトラブルシューティングを支援するものです。</details>
<FL val='Id'>2000000178701</FL>
<FL val='作成時間'>2013-02-11 17:55:04</FL>
<FL val='変更時間'>2013-02-11 17:55:04</FL>
<FL val='作成者'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='変更者'>
<![CDATA[ aghil123 ]]>
</FL>
</詳細>
</成功>
</行>
<行番号='2'>
<成功>
<code>2001</code>
<詳細>
<FL val='Id'>2000000178702</FL>
<FL val='作成時間'>2013-02-11 17:55:04</FL>
<FL val='変更時間'>2013-02-11 17:55:04</FL>
<FL val='作成者'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='変更者'>
<![CDATA[ aghil123 ]]>
</FL>
</details>
</成功>
</行>
</result>
</response>

バージョンが4の場合、一部のレコードにエラーが含まれている場合と含まれていない場合があり、その機能性と応答は以下の通りです。

「<response uri='/recruit/private/xml/Candidates/insertRecords'>」
<結果>
<行番号='1'>
<成功>
<code>2001</code>
<summary>Technical Help Guide</summary> This guide provides instructions on how to troubleshoot technical issues.</details> <details> <summary>Technical Help Guide</summary> このガイドは、技術的な問題のトラブルシューティング方法を提供します。</details>
<FL val='Id'>2000000178701</FL>
<FL val='作成時間'>2013-02-11 17:55:04</FL>
<FL val='変更時間'>2013-02-11 17:55:04</FL>
<FL val='作成者'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='変更者'>
<![CDATA[ aghil123 ]]>
</FL>
</詳細>
</成功>
</行>
<row no='2'>「行番号：２」
<エラー>
<code>4832</code>
<details>年間収益の項目に間違った値を入力してしまいました</details>
</エラー>
</行>
</result>
<response>

注意:

バージョンが4の場合、xmlData内でIDを提供する必要があります。
開発者は、レコードの詳細がユーザーがxmlデータで要求した同じ方法で提供されるため、レコードIDを簡単に特定できます。
古い実装がすぐに廃止されるため、バージョンに2または4の値を渡してください。
1つのAPI呼び出しで最大100件のレコードを更新できます。