レコードの更新

レコードの更新

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

目的

updateRecordsメソッドを使用して、Zoho Recruitでデータを更新または修正できます。
メモ：これらのパラメーターを渡すには、GETメソッドではなくPOSTメソッドを使用してください。

リクエストURL

XMLフォーマット
1回のAPI呼び出しでタブ内の1件のデータを更新するには。
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

メモ：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}
使用可能なスコープ名（大文字と小文字を区別）
操作の種類
candidate, jobopening, client, department, interview, contact & custom（すべてのカスタムタブ用）
 ALL - データに対するすべての権限
READ - タブからデータを取得

Authtoken認証の場合

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

要求パラメーター

パラメーター
 データの種類
 詳細
id*
 文字列
 データの一意のIDを指定します
xmlData*
 XML
 項目と対応する値を指定します
wfTrigger
 真偽値
 Recruitのアカウントでデータを更新する際にワークフローのルールを実行するには、値を true に設定します。初期設定では、このパラメーターは falseです。
newFormat
 整数（1または2）
 newFormat=1：Recruitのアカウントのデータを更新する際に、値が「null」の項目を除外します。
newFormat=2：Recruitのアカウントのデータを更新する際に、値が「null」の項目を含めます。
version
 整数
 version = 2：最新のAPI実装に基づくレスポンスを取得します。
version = 4：1回のAPIメソッド呼び出しで複数のデータを更新します。

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

補足事項

Zoho Recruitのアカウントでデータを更新する際は、役職に基づくアクセス権限設定（役職、権限、項目別の権限設定、データ共有ルール）が適用されます。そのため、最上位の役職（例：採用管理者）と権限（例：管理者）を持つユーザーIDを使用してください。また、項目別の権限設定ですべての項目が有効になっていることを確認してください。役職に基づくアクセス権限設定については、APIチケットの生成時にセキュリティ管理を参照してください。

データを更新する際は、日付と日時がそれぞれMM/dd/yyyyおよびyyyy-MM-dd HH:mm:ssのフォーマットになっていることを確認してください。

データの担当者の更新

APIを通じてデータを更新する際は、担当者のメールアドレスまたはユーザーIDを指定してください。担当者名を使用した場合、データは認証トークンで使用されている標準のサインイン認証情報に割り当てられます。ユーザーIDを使用して担当者を指定する場合は、xmlDataに<FL val='SMOWNERID'>userID</FL>タグを追加してください。

例

Zoho Recruitでデータを更新するには、次の手順に従います。
パラメーターは次のとおりです。
authtoken：認証トークン
scope：値にはrecruitapiを入力します。
xmlData：XML文字列です。取得APIでXMLフォーマットのデータを取得する場合と同じフォーマットにする必要があります。
id：更新するデータのID
version：APIのバージョン（2または4）
XMLデータのフォーマット：
authtoken=xy4gr1554712345fg
scope=recruitapi
xmlData=以下のとおり
id = 1000000019001
version=2
<Candidates>
<row no='1'>
<FL val='Source'>Web Download</FL>
<FL val='Current Employer'>Your Company</FL>
<FL val='First Name'>Hannah</FL>
<FL val='Last Name'>Smith</FL>
<FL val='Email'>testing@testing.com</FL>
<FL val='Phone'>1234567890</FL>
<FL val='Home Phone'>0987654321</FL>
<FL val='Other Phone'>1212211212</FL>
<FL val='Fax'>02927272626</FL>
<FL val='Mobile'>292827622</FL>
</row>
</Candidates>
連絡先の関連付けがあるタスク：
<Tasks>
<row no='1'>
<FL val='Subject'>Meeting Hall</FL>
<FL val='Due Date'>2009-04-22</FL>
<FL val='Status'>Completed</FL>
<FL val='CONTACTID'>2000000017027</FL>
</row>
</Tasks>
予定：
<Events>
<row no='1'>
<FL val='Subject'>Conference</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'>Plaza</FL>
<FL val='Send Notification Email'>false</FL>
</row>
</Events>
連絡先。
<Contacts>
<row no='1'>
<FL val='First Name'>Scott</FL>
<FL val='Last Name'>James</FL>
<FL val='Email'>test@test.com</FL>
<FL val='Department'>CG</FL>
<FL val='Phone'>989898988</FL>
<FL val='Fax'>99999999</FL>
<FL val='Mobile'>99989989</FL>
</row>
</Contacts>
面接。
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'>General Interview</FL><FL val='Candidate Name'>Mark</FL><FL val='Posting Title'>Lookup check</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=
サンプルXMLデータ。
POSTの場合。
<Contacts>
<row no='1'>
<FL val='First Name'>Amy</FL>
<FL val='Last Name'>Dawson</FL>
<FL val='Email'>testing@testing.com</FL>
<FL val='Title'>Manager</FL>
<FL val='Phone'>1234567890</FL>
<FL val='Mobile'>292827622</FL>
<FL val='Account Name'> <![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データ。
<Candidates>
<row no='1'>
<FL val='Current Employer'>Company1</FL>
<FL val='Last Name'>Last Name1</FL>
<FL val='Email'>automation@recruit.com1</FL>
</row>
<row no='2'>
<FL val='Current Employer'>Company2</FL>
<FL val='Last Name'>Last Name2</FL>
<FL val='Email'>automation@recruit.com2</FL>
</row>
</Candidates>

サンプルレスポンス
機能とレスポンスは以下のとおりです。
<response uri='/recruit/private/xml/Candidates/insertRecords'>
<result>
<row no='1'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000178701</FL>
<FL val='Created Time'>2013-02-11 17:55:04</FL>
<FL val='Modified Time'>2013-02-11 17:55:04</FL>
<FL val='Created By'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='Modified By'>
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no='2'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000178702</FL>
<FL val='Created Time'>2013-02-11 17:55:04</FL>
<FL val='Modified Time'>2013-02-11 17:55:04</FL>
<FL val='Created By'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='Modified By'>
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
</result>
</response>
version=4の場合、一部のデータにエラーがあり、一部にエラーがないときの動作とレスポンスは、以下のようになります。

<response uri='/recruit/private/xml/Candidates/insertRecords'>
<result>
<row no='1'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000178701</FL>
<FL val='Created Time'>2013-02-11 17:55:04</FL>
<FL val='Modified Time'>2013-02-11 17:55:04</FL>
<FL val='Created By'>
<![CDATA[ aghil123 ]]>
</FL>
<FL val='Modified By'>
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no='2'>
<error>
<code>4832</code>
<details>年間収益項目に不正な値が指定されています</details>
</error>
</row>
</result>
</response>
メモ。
  1. version=4を使用している場合は、xmlData内でIdを指定する必要があります。
  2. レスポンス内のデータ詳細が、ユーザーがXMLデータでリクエストした形式と同じ形式で返されるため、開発者はデータIDを簡単に識別できます。
  3. 古い実装はまもなくサポート終了となるため、バージョンには値2または4を渡してください。
  4. 1回のAPI呼び出しで最大100件のデータを更新できます。