フィールドの取得

フィールドの取得

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

目的

getFieldsメソッドを使用して、特定のタブで利用可能な項目の詳細を取得できます。

リクエストURL

XMLフォーマット。
https://recruit.zoho.com/recruit/private/xml/Module/getFields?authtoken=AuthToken&scope=recruitapi&version=2

JSONフォーマット。
https://recruit.zoho.com/recruit/private/json/Module/getFields?authtoken=AuthToken&scope=recruitapi&version=2

メモ:タブとは、候補者、求人、クライアント、面接、連絡先、カスタムタブ1、カスタムタブ2、カスタムタブ3、カスタムタブ4、カスタムタブ5を指します。

OAuth認証の場合

ヘッダー名

Authorization
Zoho-oauthtoken {access_token}

スコープ

Scope=ZohoRecruit.fields.all
(または)
Scope=ZohoRecruit.fields.{scope_name}.{operation_type}
使用可能なスコープ名(大文字と小文字を区別)
操作の種類
referral, campaign, assessment, vendor, event, task, candidate, jobopening, client, department, interview, contact & custom(すべてのカスタムタブの場合
ALL - データへのすべての権限
READ - タブからデータを取得

Authtoken認証の場合

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

リクエストパラメーター

パラメーター
データの種類
詳細
type
文字列

値には1または2を指定します

  • 1 - 概要表示からすべての項目を取得する場合
  • 2 - タブからすべての必須項目を取得する場合

メモ:タブからすべての項目を取得する場合は、typeを指定しないでください。

version*
整数
version=2 新しい実装によるレスポンスを取得するには、すべてのAPIでこのパラメーターを渡してください。
メモ:*が付いているパラメーターは必須です。
レスポンスの例。
<?xml version='1.0' encoding='UTF-8' ?>
<Candidates><section name='基本情報' dv='基本情報'><FL req='false' type='Text' isreadonly='false' maxlength='40' label='名' dv='名' customfield='false'/><FL req='false' type='AutoNumber' isreadonly='false' maxlength='120' label='候補者ID' dv='候補者ID' customfield='false'/><FL req='false' type='Email' isreadonly='false' maxlength='100' label='メール' dv='メール' customfield='false'/><FL req='true' type='Text' isreadonly='false' maxlength='80' label='姓' dv='姓' customfield='false'/><FL req='false' type='Phone' isreadonly='false' maxlength='30' label='電話' dv='電話' customfield='false'/><FL req='false' type='Phone' isreadonly='false' maxlength='30' label='携帯電話' dv='携帯電話' customfield='false'/><FL req='false' type='Website' isreadonly='false' maxlength='120' label='Webサイト' dv='Webサイト' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='30' label='Fax' dv='Fax' customfield='false'/><FL req='true' type='Text' isreadonly='false' maxlength='250' label='必須項目' dv='必須項目' customfield='true'/></section><section name='住所情報' dv='住所情報'><FL req='false' type='Text' isreadonly='false' maxlength='250' label='町名・番地' dv='町名・番地' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='30' label='市区町村' dv='市区町村' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='30' label='都道府県' dv='都道府県' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='30' label='郵便番号' dv='郵便番号' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='30' label='国' dv='国' customfield='false'/></section><section name='職務の詳細' dv='職務の詳細'><FL req='false' type='Double' isreadonly='false' maxlength='2' label='経験年数' dv='経験年数' customfield='false'/><FL req='false' type='Picklist' isreadonly='false' maxlength='120' label='保有する最高資格' dv='保有する最高資格' customfield='false'><val>-なし-</val><val>M.C.A.</val><val>B.E.</val><val>B.SC.</val><val>M.S.</val><val>B.Tech</val></FL><FL req='false' type='Picklist' isreadonly='false' maxlength='100' label='現在の役職' dv='現在の役職' customfield='false'><val>-なし-</val><val>新人</val><val>プロジェクト候補者</val><val>プロジェクトマネージャー</val></FL><FL req='false' type='Text' isreadonly='false' maxlength='100' label='現在の勤務先' dv='現在の勤務先' customfield='false'/><FL req='false' type='Currency' isreadonly='false' maxlength='16' fval='$0.00' label='希望給与' dv='希望給与' customfield='false'/><FL req='false' type='Currency' isreadonly='false' maxlength='16' fval='$0.00' label='現在の給料' dv='現在の給料' customfield='false'/><FL req='false' type='TextArea' isreadonly='false' maxlength='32000' label='資格・スキル' dv='資格・スキル' customfield='false'/><FL req='false' type='TextArea' isreadonly='false' maxlength='32000' label='追加情報' dv='追加情報' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='50' label='スカイプ ID' dv='スカイプ ID' customfield='false'/><FL req='false' type='Text' isreadonly='false' maxlength='50' label='Twitter' dv='Twitter' customfield='false'/><FL req='false' type='OwnerLookup' isreadonly='false' maxlength='25' label='更新したユーザー' dv='更新したユーザー' customfield='false'/><FL req='false' type='OwnerLookup' isreadonly='false' maxlength='25' label='作成したユーザー' dv='作成したユーザー' customfield='false'/><FL req='false' type='Picklist' isreadonly='false' maxlength='25' label='敬称' dv='敬称' customfield='false'><val>-なし-</val><val>Mr.</val><val>Mrs.</val><val>Ms.</val></FL><FL req='false' type='DateTime' isreadonly='false' maxlength='25' label='最終活動日時' dv='最終活動日時' customfield='false'/></section><section name='その他の情報' dv='その他の情報'><FL req='false' type='Picklist' isreadonly='false' maxlength='120' label='候補者のステータス' dv='候補者のステータス' customfield='false'><val>-なし-</val><val default='true'>新規</val><val>評価待ち</val><val>適格</val><val>不適格</val><val>無効な候補者</val><val>連絡済(到達)</val><val>今後対応</val><val>未連絡</val><val>連絡済(不在)</val><val>関連付け済み</val><val>クライアントに送信済み</val><val>クライアントが承認</val><val>クライアントが却下</val><val>面接設定予定</val><val>面接設定済み</val><val>面接不採用</val><val>面接中</val><val>保留</val><val>採用済み</val><val>不採用</val><val>不採用(採用可能)</val><val>内定予定</val><val>内定承諾済み</val><val>内定済み</val><val>内定辞退</val><val>内定取り消し</val><val>入社済み</val><val>不参加</val></FL><FL req='false' type='Picklist' isreadonly='false' maxlength='120' label='データ元' dv='データ元' customfield='false'><val>-なし-</val><val default='true'>ユーザーが追加</val><val>広告</val><val>API</val><val>電話営業(コールドコール)</val><val>埋め込み</val><val>社員からの紹介</val><val>外部からの紹介</val><val>Facebook</val><val>Google Apps</val><val>Googleからのインポート</val><val>インポート</val><val>解析ツールによりインポート</val><val>内部</val><val>パートナー</val><val>履歴書のメール取り込み</val><val>検索エンジン</val><val>Twitter</val><val>Zoho Recruitからインポート</val></FL><FL req='false' type='Lookup' isreadonly='false' maxlength='120' label='候補者の担当者' dv='候補者の担当者' customfield='false'/><FL req='false' type='Boolean' isreadonly='false' maxlength='50' label='メール対象外(オプトアウト)' dv='メール対象外(オプトアウト)' customfield='false' enabled='false'/></section><section name='添付ファイル情報' dv='添付ファイル情報'><FL req='false' type='UploadText' maxlength='250' label='履歴書' dv='履歴書' customfield='true'/><FL req='false' type='UploadText' maxlength='250' label='書式設定済みの履歴書' dv='書式設定済みの履歴書' customfield='true'/><FL req='false' type='UploadText' maxlength='250' label='添え状(カバーレター)' dv='添え状(カバーレター)' customfield='false'/><FL req='false' type='UploadText' maxlength='250' label='その他' dv='その他' customfield='true'/></section></Candidates>