• 最終編集日時: 31 May 2021

候補者検索API

CCWの候補者検索APIを使用すると、顧客はCCWの申請書に提出された候補者に関するデータを取得できます。

CCWの候補者検索APIは、1つまたは複数のCCW申請書に提出された候補者に関するデータをクエリするために使用します。候補者の姓名、ステータス、確認する資格(派遣労働者として)などの検索基準は、CCW候補者検索APIを介して要求できます。特定のルックアップ基準に一致する候補データが返されます。

CCW候補者検索APIにアクセスするためのベースURLは次のとおりです。https ://<instance>/api/candidates/search

CCW APIの概要を参照して、CCW APIへのPOST要求の認証と送信方法を確認してください。リクエストには次の要素を含める必要があります。

申請ヘッダー

要求ヘッダーが認証に必要です。詳細については、CCWのAPI OverviewドキュメントのRequest Headersセクションを参照してください。

申請本文

メタオブジェクトデータオブジェクトの両方をAPI要求本文に渡す必要があります。

メタ

メタデータセクションは、より速いパフォーマンスを確保するために返される結果の数を定義します。含まれるもの:

  • 限度 :1つのAPI要求で返される結果の最大数を1から50の間で定義します(つまり、ページ上の結果の数)
    • リミットの値が空であるか、50を超える場合、デフォルトは50結果になります
    • 制限の値が1未満の場合にエラーを返します
  • 相殺 :要求が開始されるレコードを定義します。たとえば、limit = 30、offset = 51は、レコード51から始まる次の30レコードを返します。
    • オフセットの値が空の場合、デフォルトは0になります
    • オフセットの値が0未満の場合にエラーを返します。

データ

要求される1つ以上の特定のルックアップパラメータ(少なくとも1つの空でないパラメータを送信する必要があります)。

次の表は、候補ルックアップAPI要求本文内で渡すことができるすべてのデータパラメーターを定義します。

属性 データタイプ 必須ですか? 一意ですか? 説明
限度 番号 いいえ いいえ 1 -50 API呼び出しごとに返されるレコードの数
オフセット 番号 いいえ いいえ any 結果が始まる特定のレコード番号
iD number いいえ はい 任意の CCWの候補者の一意のID。候補者が申請書に提出されたときに生成されます。(確認APIに使用)。
number string (100) いいえ はい 任意の CCWで候補者に割り当てられた一意の番号。フォーマット:- CS <Client prefix>-<sequence-number>
first_name string (100) いいえ いいえ 任意の 候補者の名
last_name string (100) いいえ いいえ 任意の 候補者の姓
メール string (400) いいえ はい 任意の 応募者のメールアドレス
ステータス string (50) いいえ いいえ CCWの有効なステータスの1つ 以下の有効な候補者ステータステーブルを参照してください。
ccw_id string (8) いいえ はい any CCW ID
external_reference_number string (200) いいえ いいえ 任意の 応募者に関連付けられた一意のID
requisition_number string (100) いいえ いいえ 任意の 応募者に関連する申請書番号
hiring_manager_first_name string (100) いいえ いいえ 任意の 採用マネージャーの名
hiring_manager_last_name string (100) いいえ いいえ 任意の 採用マネージャーの姓
onboarding_eligibility_met 番号 いいえ いいえ 0.1

0 =適格、1 =不適格

confirmation_eligibility_met boolean いいえ いいえ true/falseまたはyes/noまたは1/0またはY/NまたはT/F 候補者に承認済みの作業指示があり、オンボーディング資格基準が満たされているかどうかを示します。
supplier_name string (200) いいえ いいえ 任意の サプライヤー名
start_date date いいえ いいえ 任意の アクティブワークオーダーの開始日、YYYY - MM - DD形式( ISO 8601標準フォーマット)
end_date 日付 いいえ いいえ any アクティブな作業注文の終了日、形式はYYYY - MM - DD

例の要求

POST/api/candidate/search

ホスト: <CCW FQDN>

権限付与:ベアラー <token>

Accept: "application/json"

相関ID :Z 098 Jth 56 Nkio 343 YY 1 vXt



{

    "meta ": {

        "limit ":" number ",

        "OFFSET ":" NUMBER "

    }

    "data ": {

        "id ":" number ",

        "number ":" string ",

        "FIRST_NAME ":"文字列",

        "LAST_NAME ":"文字列",

        "EMAIL ":"文字列",

        "ccw_id ":"番号",

        "STATUS ":"文字列",

        "EXTERNAL_REFERENCE_NUMBER ":"文字列",

        "requisition_number ":"文字列",

        "HIRING_MANAGER_FIRST_NAME ":"文字列",

        "hiring_manager_last_name ":"文字列",

        "onboarding_eligibility_met ":"文字列",

        "CONFIRMATION_ELIGIBILITY_MET ":"文字列",

        "SUPPLIER_NAME ":"文字列"

    }

}

API回答

API要求本文で送信されたすべてのルックアップパラメーターに一致する候補が返されます。次の表は、成功したAPI要求へのCCWからの応答に候補に含まれる可能性のあるすべてのパラメータを定義しています。

属性 申請本文オブジェクト データタイプ 説明
total_count meta number 検索条件に一致したレコード数
has_more meta boolean 「真」または「偽」-ルックアップ基準を満たす応募者が他にもいるかどうかを示します
iD data number CCWの候補者の一意のID。候補者が申請書に提出されたときに生成されます。(確認APIに使用)。
番号 データ string (100) CCWで候補者に割り当てられた一意の番号。形式: - CS <Client prefix>-<sequence-number>
first_name データ string (100) 候補者の名
last_name data string (100) 候補者の姓
eメール データ string (400) 応募者の電子メールアドレス
ステータス データ string (50) 以下の有効な候補者ステータステーブルを参照してください。
ccw_id data string (8) CCW ID
cw_number data string (100) 候補者に割り当てられたCW番号
external_reference_number data string (200) 応募者に関連付けられた一意のID
hiring_manager_first_name データ string (100) 採用マネージャーの名
hiring_manager_last_name data string (100) 採用マネージャーの姓
hiring_manager_user_name data string (512) 採用マネージャーのユーザー名
hiring_manager_email データ string (100) 採用マネージャーのメールアドレス
engagement_type data string (400) 臨時/ベンダー
employment_type data string (200) 雇用形態(W 2、1099など)
submitted_date データ 日付 候補者がYYYY - MM - DDT 24 HHMMSSZとしてフォーマットされた申請書に提出された日付。
最終選考に残されました data boolean 候補者が候補者リストに追加されたかどうかを示します
work_email データ string (400) 応募者に割り当てられた仕事用メールアドレス
日付_利用可能 data 日付 応募者が働くことができる日付。形式はYYYY - MM - DDT 24 HHMMSSZです。
sUBMITTED_TO_OTHER_REQUISITIONS data boolean 候補者が他の申請書に提出されたかどうかを示します
onboarding_status データ string (値を設定) 「提出前-完了」、「オンボーディング-再開」、「オンボーディング-一時停止」、「オンボーディング-完了」、「オンボーディング-キャンセル済み」、「開始済み」、「進行中」
onboarding_eligibility_met data boolean

0 =適格、1 =不適格

confirmation_eligibility_met data boolean 候補者に承認済みの作業指示があり、オンボーディング資格基準が満たされているかどうかを示します。
iD data.supplier number CCWでサプライヤーに割り当てられた一意のID
名前 data.supplier string (400) サプライヤー名
number data.supplier string (400) CCWでサプライヤーに割り当てられた一意の番号
first_name data.supplier.contact string (100) サプライヤー担当者の名
last_name data.supplier.contact string (100) サプライヤー担当者の姓
メール data.supplier.contact string (400) サプライヤー連絡先アドレス
iD data.requisition 番号 CCWで申請書に割り当てられた一意のID
number data.requisition string (100) CCWで申請書に割り当てられた一意の番号
タイプ data.requisition string (200) 依頼タイプ(例:識別された候補者、依頼者)
ジョブ_コード data.requisition string (500) 申請書ジョブコード
job_title data.requisition string (400) 申請書の役職
work_location_code data.requisition string (1000) 申請作業場所コード
work_location_name data.requisition string (40) 申請書作業場所名
type_of_service data.requisition string (200) 作業のタイプ
rate_type data.requisition string (100) 料金の種類
iD data.work_orders number CCWで作業指示書に割り当てられた一意のID
number data.work_orders string (200) CCWで作業指示書に割り当てられた一意の番号
有効 data.work_orders boolean 作業指示が有効かどうかを示します
contract_start_date data.work_orders 日付 作業注文開始日、形式はYYYY - MM - DDT 24 HHMMSSZ
contract_end_date data.work_orders 日付 作業注文終了日、形式はYYYY - MM - DDT 24 HHMMSSZ
iD data.statement_of_works number CCWでSOWに割り当てられた一意のID
number data.statement_of_works string (100) CCWでSOWに割り当てられた一意の番号
iD data.sows.task_order 番号 CCWでタスク注文に割り当てられた一意ID
number data.sows.task_order string (100) CCWでタスク注文に割り当てられた一意ID

回答例

以下は、少なくとも1人の応募者がルックアップ基準に一致した、成功した応答の例です。

メモ:

  • total_count : API要求の検索条件に一致した候補の 総数
  • has_more : trueまたはfalse。応答に含まれる応答に加えて、ルックアップ基準に一致する応募者が他にも存在するかどうかを示します
{

  "meta ": {

    "total_count ":1,

    "has_more ": false

  },

  "data ": [{

          "CANDIDATE ": {

             "id ": 622757,

             "number ":" CCW_CS_13897 ",

             "FIRST_NAME ":"セドリック",

             "LAST_NAME ":"ダニエルズ",

             "email ":" cedric.daniels@coupa.com ",

             "ccw_id ":" 23230203 ",

             "supplier ": {

                "id ": 526,

                "NAME ":"テストSupplier.Inc ",

                "number ":" 483735 ",

                "contact ": {

                    "FIRST_NAME ":"レスター",

                    "LAST_NAME ":"フリーマン",

                    "email ":" lester.freeman@supplierssample.com "

                }

             },

             "requisition ": {

                "id ":" 174011 ",

                "number ":" RS - REQ -27130 ",

                "TYPE ":"申請書を作成",

                "ジョブ_コード": "",

                "ジョブ_タイトル":"事務",

                "WORK_LOCATION_CODE ":" 04872 ",

                "WORK_LOCATION_NAME ":" 04872 - CRAFTSMAN CA ",

                "TYPE_OF_SERVICE ":"事務/専門職",

                "rate_type ":" 1時間あたり"

             },

             "hiring_manager_user_name ":"100DuChloe1.DuCollins1.1@coupadev.com ",

             "HIRING_MANAGER_FIRST_NAME ":"DuCollins1.1 ",

             "HIRING_MANAGER_LAST_NAME ":"100 DuChloe 1 ",

             "hiring_manager_email ":"100DuChloe1.DuCollins1.1@coupadev.com ",

             "ENGAGEMENT_TYPE ":"通常",

             "employment_type ":"1099 ",

             "status ":" wo - accepted ",

             "SUBMITTED_DATE ":"2020 -07 -28 T 14:36:22 Z ",

             "cw_number ":"RS - CW -059713 ",

             "number ":"RS - CS -0060176 ",

             "SHORT_LISTED ": false,

             "work_email ":"仕事のメール",

             "date_available ": null,

             "submitted_to_other_requirements ": false,

             "onboarding_status ":"開始",

             "onboarding_eligibility_met ":1,

             "confirmation_eligibility_met ": false,

             "statement_of_works ": [],

             "work_orders ": [

              {

                "id ": 224583,

                "number ":" RS - WO -059860 ",

                "ACTIVE ":" TRUE ",

                "CONTRACT_START_DATE ":" 2020 -07 -01 T 04:00:00 Z ",

                "CONTRACT_END_DATE ":" 2020 -12 -31 T 05:00:00 Z "

                "EXTERNAL_REFERENCE_NUMBER ":"外部参照番号"

              }

            ]

          }

        ],

        "meta ": {

        "total_count ":1,

        "has_more ": false

    }

}

以下は、応募者がルックアップ基準を満たしていない場合の応答例です。

{   

  "meta ": {     

    "total_count ":0,     

    "has_more ": false   

  },   

  "data ": [] 

}

有効な候補者ステータス

CCWのCandidate APIへのリクエストで渡される有効な候補者ステータス値は次のとおりです。

ステータス名 ステータスコード
候補者が承認されました 候補者が承認されました
候補者面接 candidate - interviewing
候補者ノーショー candidate - no - show
拒否された候補者 候補者が却下されました
承認のための候補者の再キューイング candidate - requeue - approval
候補者が取り下げ済み candidate - Withdrawn
提出しないでください candidate - do - not - submit
登録が開始されました candidate - onboarding - started
OTHが承認されました oth - accepted
OTH拡張 oth - extended
OTHの発行 oth - issued
OTH拒否がロックされました oth - rejected - locked
OTHが拒否されました oth - rejected
取り下げ済みのOTH

oth - withdraw

再提出が申請されました re - submit - requested
承認のために送信されました submitted - for - approvals
マネージャーに送信されました マネージャーに送信済み
プログラム管理者に送信されました submitted - to - program - admin
WOが承認されました wo - accepted
WOキャンセル済み wo - canceled
WOの発行 wo - issued
拒否されたWO wo - rejected

エラーコード

API要求が失敗すると、応答に次のいずれかのエラーコードが含まれます。

HTTPステータスコード エラーコード エラーサブコード エラーメッセージ
400 E 4000000 E 4000001 不適切な申請です。1つ以上の必須HTTPヘッダーが見つかりません
400 E 4000000 E 4000003 入力本文が予想されるスキーマと一致しません
400 E 4000000 E 4000004 無効な{field name}値
400 E 4000000 E 4000005 {field name}は{max}文字以内にする必要があります
401 E 4010000 E 4010001 認証に失敗しました。コンシューマーアプリに関連付けられている資格情報を確認する
401 E 4010000 E 4010002 認証に失敗しました。アクセストークンが無効または期限切れです
403 E 4030000 E 4030001 アクセス権がありません。そのユーザーはアクションを実行する権限を持っていません
403 E 4030000 E 4030002 アクセス権がありません。範囲が無効です
403 E 4030000 E 4030003 アクセス権がありません。APIユーザーが無効です。ユーザーがアクティブで、APIユーザーとして設定されていることを確認します。
404 E 4040000 E 4040001 見つかりません
405 E 4050000 E 4050001 方法がサポートされていません。サービスは要求されたHTTPメソッドをサポートしていません
500 E 5000000 E 5000001 システムまたはアプリケーションのエラーが発生しました。Coupa CW管理者にお問い合わせください

 

関連アイテム


候補者確定API

31 May 2021

サードパーティアプリケーションを介して候補者のオンボーディングアクティビティの一部またはすべてを管理する顧客は、CCW候補者確認APIを使用して、候補者を派遣労働者として一度に1人ずつ確認するプロセスを自動化できます。

CCW APIの概要

31 May 2021

CCWのREST APIを使用すると、顧客とパートナーは新しいアプリケーションを構築し、新しい方法でCCWと統合して、派遣労働力の管理に関する能力を向上させることができます。

APIエクスプローラー

31 May 2021

CCWのREST APIエクスプローラーは、ユーザーがCCW APIをテストして探索できるインタラクティブなツールです。

Coupa Core API

RESTful APIは、Coupaプラットフォームでデータの読み取り、編集、統合を行うための堅牢なアクセスを提供します。