レコードの追加

レコードの追加

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

目的

addRecordsメソッドを使用すると、必要なZoho Recruitタブにデータを挿入できます。
メモ：これらのパラメーターを渡すには、GETメソッドではなくPOSTメソッドを使用してください。

リクエストURL

XMLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Module/addRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=Your_XML_Data
メモ：タブとは、候補者、求人、クライアント、面接、連絡先、カスタムタブ1、カスタムタブ2、カスタムタブ3、カスタムタブ4、カスタムタブ5を指します。

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*
 文字列
 Zohoの認証情報を認証するための、暗号化済みの英数字文字列です。
scope*
 文字列
 値には recruitapi を指定します

リクエストパラメーター

パラメーター
 データ型
 詳細
xmlData*
 XML
 これはXML文字列であり、フォーマットは取得したデータのXMLフォーマットでgetRecordsを実行した場合と同じにする必要があります。
wfTrigger
 真偽値
 Recruitのアカウントにデータを挿入する際にワークフローのルールを実行するには、値をtrueに設定します。標準では、このパラメーターはfalseです。
duplicateCheck
 整数
 重複データを確認してエラーレスポンスを返すには、値を「1」に設定します。また、重複データを確認し、登録されている場合に同じデータを更新するには「2」に設定します。
isApproval
 真偽値
 標準では、データは直接挿入されます。データを承認モードに保持するには、値をtrueに設定します。このパラメーターは、候補者、連絡先で使用できます。
newFormat
 整数
 newFormat=1：Recruitのアカウントからデータを挿入する際に、値が「null」の項目を除外します。
newFormat=2：Recruitのアカウントからデータを挿入する際に、値が「null」の項目を含めます。
version*
 整数
 version = 1：（初期値）これにより、機能強化前の以前のAPI実装を基準にレスポンスを取得します。
version = 2：これにより、最新のAPI実装を基準にレスポンスを取得します。
version = 4：1回のAPIメソッド呼び出しで複数のデータを追加し、複数のデータに対する重複の確認機能を実行します。
メモ：*が付いているパラメーターは必須です。

重複の確認項目

タブ名
 重複の確認項目
候補者
 メール
連絡先
 メール
クライアント
 クライアント名
求人
 求人名
面接
 面接名

補足メモ

Zoho Recruitのアカウントにデータを挿入する際には、役職に基づくアクセス権限設定（役職、権限、項目別の権限設定、データ共有ルール）が適用されます。

そのため、最上位の役職（例：採用管理者）と権限（例：管理者）を持つユーザーIDを使用してください。また、項目別の権限設定ですべての項目が有効になっていることを確認してください。
データを挿入する際には、日付と時刻をそれぞれ'MM/dd/yyyy'および'yyyy-MM-dd | HH:mm:ss'のフォーマットにしてください。

例

外部のアプリケーションからZoho Recruitにレコードを挿入する
URLのフォーマット。
https://recruit.zoho.com/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&version=4&xmlData=
XMLDATAのサンプル。
<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 >
候補者のXMLDATAサンプル。
<Candidates>
<row no='1'>
<FL val='SMOWNERID'>2000000016714</FL>
<FL val='Candidate Owner'>Scott@zohotest.com</FL>
<FL val='Source'>John</FL>
<FL val='Current employer'><![CDATA[VS&Co]]>
</FL><FL val='First Name'>John</FL>
<FL val='Last Name'>Gossling</FL>
<FL val='Email'>john@zohocorp.com</FL>
<FL val='Phone'>1234567890</FL>
<FL val='Candidate Status'>Qualified</FL>
<FL val='Is Hot Candidate'>true</FL>
<FL val='Salutation'>Mr.</FL>
<FL val='Street'>Street One</FL>
<FL val='City'>Chennai</FL>
<FL val='State'>Tamil Nadu</FL>
<FL val='Zip Code'>6000001</FL>
<FL val='Country'>India</FL>
</row>
</Candidates>
連絡先とクライアントのルックアップを含むタスクXMLDATAのサンプル。
<Tasks>
<row no='1'>
<FL val='SMOWNERID'>2000000016714</FL>
<FL val='タスク担当者'>Scott@zohotest.com</FL>
<FL val='件名'>デモ通話</FL>
<FL val='期限'>11/23/2009</FL>
<FL val='CONTACTID'>2000000018443</FL>
<FL val='SEID'>2000022218013</FL>
<FL val='SEMODULE'>クライアント</FL>
<FL val='ステータス'>進行中</FL>
<FL val='優先度'>最優先</FL>
<FL val='通知メールの送信'>false</FL>
<FL val='詳細'>サンプルの詳細</FL>
</row>
</Tasks>
連絡先とクライアントのルックアップを含むタスクXMLDATAのサンプル。
<Tasks>
<row no='1'>
<FL val='SMOWNERID'>2000000016714</FL>
<FL val='タスク担当者'>Scott@zohotest.com</FL>
<FL val='件名'>デモ通話</FL>
<FL val='期限'>11/23/2009</FL>
<FL val='CONTACTID'>2000000018443</FL>
<FL val='SEID'>2000022218013</FL>
<FL val='SEMODULE'>取引先</FL>
<FL val='ステータス'>進行中</FL>
<FL val='優先度'>最優先</FL>
<FL val='通知メールの送信'>false</FL>
<FL val='詳細'>サンプルの詳細</FL>
</row>
</Tasks>

メモの挿入とメインタブへの関連付け

XMLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Notes/addRecords?authtoken=AuthToken&scope=recruitapi&version=2
XMLDATAのサンプル。
<Notes>
<row no='1'>
<FL val='entityId'>6000000119069</FL><FL val='メモの種類'>ミーティング</FL><FL val='種類ID'>6000000021005</FL><FL val='メモの内容'><![CDATA[こんにちは]]></FL><FL val='親のタブ'>候補者</FL>
</row>
</Notes>
ここで、entityIDはメインデータ（候補者、クライアント、連絡先など）の一意のIDです。

Type Idは、getNoteTypes APIから取得できるメモの種類IDです。

データへの担当者の割り当て

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

注：次の例では、'authtoken'と'scope'の値を、ご自身で生成した値に置換してください。
タスク。
https://recruit.zoho.com/recruit/private/xml/Tasks/addRecords?authtoken=AuthToken&scope=recruitapi
&version=2&
xmlData=
<Tasks>
<row no='1'>
<FL val='件名'>通話</FL>
<FL val='期限'>2009-04-20</FL>
<FL val='ステータス'>延期</FL>
<FL val='CONTACTID'>2000000017017</FL>
</row>
</Tasks>
予定。
https://recruit.zoho.com/recruit/private/xml/Events/addRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&xmlData=
<Events>
<row no='1'>
<FL val='件名'>会議</FL>
<FL val='開始日時'>2009-08-04 01:00:00</FL>
<FL val='終了日時'>2009-08-05 01:00:00</FL>
<FL val='開催場所'>アメリカ合衆国</FL>
<FL val='通知メールの送信'>True</FL>
</row>
</Events>
連絡先とクライアントの関連付けを含む予定。
https://recruit.zoho.com/recruit/private/xml/Events/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=
<Events>
<row no='1'>
<FL val='Subject'>Conference</FL>
<FL val='Start DateTime'>2009-09-24 01:00:00</FL>
<FL val='End DateTime'>2009-09-25 01:00:00</FL>
<FL val='Venue'>Chennai</FL>
<FL val='CONTACTID'>2000000055003</FL>
<FL val='SEID'>2000000055007</FL>
<FL val='SEMODULE'>Clients</FL>
</row>
</Events>
クライアント。
https://recruit.zoho.com/recruit/private/xml/Clients/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=
<Clients>
<row no='1'>
<FL val='Client Name'><![CDATA[V3 Client]]></FL>
<FL val='Parent Client'><![CDATA[Client 2]]></FL>
<FL val='Client Manager'>john@zohocorp.com</FL>
<FL val='Website'>www.zillum.com</FL>
<FL val='Industry'>Real estate</FL>
<FL val='Fax'>99999999</FL>
</row>
</Clients>
連絡先。
https://recruit.zoho.com/recruit/private/xml/Contacts/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=
<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'>999999999</FL>
<FL val='Fax'>99999999</FL>
<FL val='Mobile'>99989989</FL>
</row>
</Contacts>
連絡先とクライアントのルックアップを使用した通話の挿入。
<Calls>
<row no='1'>
<FL val='SMOWNERID'>2000000018005</FL>
<FL val='Subject'>Product Support</FL>
<FL val='Call Type'>Inbound</FL>
<FL val='Call Purpose'>Prospecting</FL>
<FL val='CONTACTID'>2000000018001</FL>
<FL val='SEID'>2000000018003</FL>
<FL val='SEMODULE'>Clients</FL>
<FL val='Call Start Time'>2011-06-10 22:10:00</FL>
<FL val='Call Duration'>60:00</FL>
<FL val='Description'>Required Product Demo</FL>
<FL val='Billable'>true</FL>
<FL val='Call Result'>Successful</FL>
</row>
</Calls>
候補者のルックアップを使用した通話の挿入。
<Calls>
<row no='1'>
<FL val='SMOWNERID'>2000000018005</FL>
<FL val='Subject'>Demo</FL>
<FL val='Call Type'>Inbound</FL>
<FL val='Call Purpose'>Prospecting</FL>
<FL val='SEID'>2000000017201</FL>
<FL val='SEMODULE'>Candidates</FL>
<FL val='Call Start Time'>2011-06-10 22:10:00</FL>
<FL val='Call Duration'>60:00</FL>
<FL val='Description'>Demo Call</FL>
<FL val='Billable'>true</FL>
<FL val='Call Result'>Successful</FL>
</row>
</Calls>

「CDATA」の使用

目的。 
特殊文字を書式なしテキストとして扱い、XMLデータとして扱わないため
URLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Contacts/addRecords?version=2&authtoken=AuthToken&scope=recruitapi
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='Job Title'>Manager</FL>
<FL val='Phone'>1234567890</FL>
<FL val='Mobile'>292827622</FL>
<FL val='Account Name'> <![CDATA['A & A']]> </FL>
</row>
</Contacts>

複数データの挿入
URLフォーマット。

XMLDATAのサンプル。

<Candidates>
<row no='1'><FL val='Last Name'>testing</FL><FL val='Email'>test1@test.com</FL></row>
<row no='2'><FL val='Last Name'>testing</FL><FL val='Email'>test2@test.com</FL></row>
<row no='3'><FL val='Last Name'>testing</FL><FL val='Email'>test3@test.com</FL></row>
<row no='4'><FL val='Last Name'>testing</FL><FL val='Email'>test4@test.com</FL></row>
<row no='5'><FL val='Last Name'>testing</FL><FL val='Email'>test5@test.com</FL></row>
<row no='6'><FL val='Last Name'>testing</FL><FL val='Email'>test6@test.com</FL></row>
<row no='7'><FL val='Last Name'>testing</FL><FL val='Email'>test7@test.com</FL></row>
<row no='8'><FL val='Last Name'>testing</FL><FL val='Email'>test8@test.com</FL></row>
<row no='9'><FL val='Last Name'>testing</FL><FL val='Email'>test9@test.com</FL></row>
<row no='10'><FL val='Last Name'>testing</FL><FL val='Email'>test10@test.com</FL></row>
：
：
：

<row no='100'><FL val='Last Name'>testing</FL><FL val='Email'>test100@test.com</FL></row>
</Candidates >
メモ。
  1. addRecordsメソッドで複数のデータを挿入する場合。
  2. バージョン2では、複数のデータの重複の確認に対応しています
  3. 条件に一致するデータに対しては、ワークフローのルールは実行されません
  4. 複数のデータを挿入する場合、最初の100件のデータのみが処理対象になります。

複数データの重複の確認

目的。
addRecordsを使用して、複数のデータに対する重複の確認機能を実行できます。注意：version=4は必須パラメーターです。各データのAPI結果ステータスを表す3つの新しいコードを導入しました。コードは以下のとおりです。

2000 = データを追加しました
2001 = データを更新しました
2002 = データはすでに登録されています
URLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&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>
レスポンスのサンプル
duplicateCheck=1、version=4で、メールアドレスに該当するデータが存在するものと存在しないものが混在する場合、機能とレスポンスは以下のとおりです。

<response uri=/recruit/private/xml/Candidates/addRecords>
<result>
<row no=1>
<success>
<code>2000</code>
<details>
<FL val=Id>2000000120006</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>2002</code>
<details>
<FL val=Id>2000000120007</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>
duplicateCheck=1、version=4で、メールアドレスに該当するデータが存在しない場合、機能とレスポンスは以下のとおりです。

<response uri=/recruit/private/xml/Candidates/addRecords>
<result>
<row no=1>
<success>
<code>2000</code>
<details>
<FL val=Id>2000000120006</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>2000</code>
<details>
<FL val=Id>2000000120007</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>
duplicateCheck=1、version=4で、該当するメールアドレスのデータが存在する場合、機能とレスポンスは以下のようになります。

<response uri='/recruit/private/xml/Candidates/addRecords'>
<result>
<row no='1'>
<success>
<code>2002</code>
<details>
<FL val='Id'>2000000120006</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>2002</code>
<details>
<FL val='Id'>2000000120007</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>
duplicateCheck=2、version=4で、該当するメールアドレスのデータが存在しない場合、機能とレスポンスは以下のようになります。

<response uri='/recruit/private/xml/Candidates/addRecords'>
<result>
<row no='1'>
<success>
<code>2000</code>
<details>
<FL val='Id'>2000000120006</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>2000</code>
<details>
<FL val='Id'>2000000120007</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>
duplicateCheck=2、version=4で、そのメールアドレスのデータが存在する場合、機能とレスポンスは以下のようになります。

<response uri='/recruit/private/xml/Candidates/addRecords'>
<result>
<row no='1'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000120006</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'>2000000120007</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>
duplicateCheck=2、version=4で、そのメールアドレスのデータが存在するものと存在しないものが混在する場合、機能とレスポンスは以下のようになります。

<response uri='/recruit/private/xml/Candidates/addRecords'>
<response uri='/recruit/private/xml/Candidates/addRecords'>
<result>
<row no='1'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000120006</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>2000</code>
<details>
<FL val='Id'>2000000120007</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/addRecords'>
<result>
<row no='1'>
<success>
<code>2001</code>
<details>
<FL val='Id'>2000000120006</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>
</success>
</row>
<row no='2'>
<error>
<code>4832</code>
<details>年間収益項目に誤った値が指定されています</details>
</error>
</row>
</result>
</response>
メモ。
  1. メールアドレスは、［候補者］タブの重複の確認項目です。その他のタブでは、重複の確認項目が異なります。
  2. 開発者は、レスポンス内のデータ詳細がXMLデータでユーザーがリクエストした形式と同じ形式で示されるため、データIDを簡単に特定できます。
  3. 複数のデータで重複の確認を行うには、パラメーターURLでversion=2を渡す必要があります。