Workday REST API を使用する構成

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：9分

    • Workday REST API を使用するアクションを実行するように ServiceNow インスタンスを設定します。

    始める前に

    • 統合ハブサブスクリプションを要求します。
    • Workday HRスポークを有効にします。
    • Workday からこれらの値を取得し、後で使用するために記録します。これらの値は、クライアントの登録に必要です。
      • クライアント ID
      • クライアント シークレット
      • Workday REST API エンドポイント
      • トークンエンドポイント
      • 認証エンドポイント
    • 必要なロール：admin

    このタスクについて

    Workday REST および Report-as-a-Service (RAAS) API は、OAuth 2.0 と連携し、Workday テナント内のリソースへのアクセスを許可します。OAuth 2.0 を使用するには、API クライアントの登録タスクを使用してクライアントをテナントに登録する必要があります。

    これらの REST ベースのスポークアクションを使用する必要がある場合には、Workday REST API を使用するように ServiceNow インスタンスを設定します。
    • 自分のフィードバック構造を取得
    • オブジェクトカスタムフィールドを検索
    • オブジェクトカスタムフィールドを更新
    • 給与明細書を検索
    • レポートを使用して総合報酬を検索
    • カスタムレポートを検索
    • 受信箱アイテムを検索
    • 従業員のメリットおよび利益計画の詳細を検索
    • 従業員の祝日カレンダー参照 WID を検索
    • 従業員のスケジュールカレンダー参照 WID を検索
    • 従業員の祝日カレンダーを検索
    • WQL ストリームを使用してルックアップ
    注:
    これらの構成は、REST ベースのスポークアクションを使用するために必要です。

    OAuth プロバイダーとして Workday HRを登録

    Workday HR インスタンスを OAuth プロバイダーとして登録し、ServiceNowインスタンスが OAuth 2.0 トークンを要求できるようにします。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > システム OAuth > アプリケーションレジストリー.
    2. [New] をクリックします。
      「どのような OAuth アプリケーションですか？」というメッセージが表示されます。
    3. [サードパーティ OAuth プロバイダーに接続します] を選択します。
    4. フォームに、これらの値を入力します。
      表 : 1. アプリケーションレジストリフォーム
      フィールド 説明
      名前 レコードを一意に識別する名前を入力します。たとえば、次のように入力します。 Workday HR OAuth
      アプリケーション レコードが適用可能なアプリケーション。[Workday HRスポーク] を選択します。
      クライアント ID クライアントの登録時に生成されたクライアント ID。
      クライアントシークレット クライアントの登録時に生成されたクライアントシークレット。
      認証 URL クライアントの登録時に生成された認証エンドポイント。
      トークン URL クライアントの登録時に生成されたトークンエンドポイント。
      リダイレクト URL 次の形式の OAuth コールバックエンドポイント： https://<instance>.service-now.com/oauth_redirect.do
      デフォルトの権限許可タイプ トークンを確立するために使用される権限許可のタイプ。[認証コード] を選択します。
      有効 アプリケーションレジストリを積極的に使用するためのオプション。
    5. フォームヘッダーを右クリックし、[保存] をクリックします。
      OAuth エンティティプロファイルが作成されます。

    Workday HR スポークのトークン URL の生成

    Workday アカウントに API クライアントを登録し、Workday HR スポークのトークン URL を生成します。

    始める前に

    必要なロール：admin

    手順

    1. Workday テナントにログインします。
    2. [検索] に移動し、[API クライアントの登録 (Register API Client)] タスクを入力します。
    3. [API クライアントの登録 (Register API Client)] で、詳細を入力します。
      フィールド 説明
      クライアント名 アプリのクライアント名です。たとえば、「Workday HR スポーク」です。
      クライアント権限許可タイプ 認証コード権限を選択します。
      アクセストークンタイプ アクセストークンタイプ： [ベアラー (Bearer)] を選択します。
      リダイレクト URI ServiceNow URL は、https://<instance>.service-now.com/oauth_redirect.do 形式で入力します。
      期限切れがないリフレッシュトークン 期限切れがないリフレッシュトークンを有効にするオプションです。
      スコープ (機能エリア) 必要な機能エリアを選択します。
      Workday 所有スコープを含める Workday 所有スコープを選択するオプションです。
    4. [OK] をクリックします。

    タスクの結果

    システムプロパティを構成するために、生成されたトークンエンドポイント値はコピーして保存してください。

    オプション 1:テンプレートで HR REST API を使用する構成Workday

    OAuth 認証テンプレートを使用して、 Workday HR REST API を使用するアクションを実行するように ServiceNow インスタンスを構成します。

    始める前に

    必要なロール：admin

    Workday HR REST API の接続の構成

    Workday HR REST API 接続を追加して構成し、Workday HR スポークで ServiceNow 要求を認証します。

    始める前に

    手順

    1. 移動先 すべて > プロセス自動化 > ワークフロースタジオ.
    2. [統合] を選択します。
    3. [Connections (接続)] タブを選択します。
    4. 検索ボックスを使用して、 WorkdayHR 接続エイリアスを検索します。
    5. [詳細を表示] をクリックします。
      Workday HR スポークの接続テンプレート
    6. クラウド接続を構成します。
      1. クラウド接続を追加、または編集します。
        • 既存の接続を設定するには、[構成] または [編集] を選択します。Workday HR スポークの接続テンプレートを使用した接続の構成
        • 新しい接続を作成して構成するには、[接続を追加] を選択します。
      2. 構成フォームの各フィールドに記入します。
      表 : 2. 構成フォーム
      フィールド 説明
      名前 接続を一意に識別する名前。たとえば、 Workday HR スポーク接続などです。
      接続 URL Workday HR に接続するための URL。次の形式を使用します: https://<workday_host>/ccx/service/<tenant_name>
      テナント名 Workday テナントの名前。たとえば、 bcone_gms1 などです。
      API バージョン 要求に使用する Workday API のバージョン。
      クライアント ID OAuth 認証用に Workday で生成されたクライアント ID。
      クライアントシークレット OAuth 認証用に Workday で生成されたクライアントシークレットです。
      認証 URL OAuth 接続を許可するために使用される URL。次の形式を使用します :https://<workday_host>/authorize
      トークン URL OAuth トークンの生成に使用される URL。次の形式を使用します: https://<workday_host>/token
      OAuth リダイレクト URL 認証成功後に Workday がリダイレクトされる URL。次の形式を使用します: https://<instance_name>.service-now.com/oauth_redirect.do
    7. [ 保存して OAuth トークンを取得] をクリックします。

    タスクの結果

    スポーク接続が設定され、使用する準備ができました。

    オプション 2:テンプレートなしで Workday HR REST API を使用する構成

    接続および認証情報レコードを手動で作成して、 Workday HR REST API を使用するアクションを実行するように ServiceNow インスタンスを設定します。

    始める前に

    必要なロール：admin

    Workday HRSpoke の認証情報レコードを作成

    Workday HR インスタンスの認証情報レコードを作成します。 Workday HRスポーク接続および資格情報エイリアスでは、これらの認証情報を使用してアクションを許可します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 認証情報.
    2. [New] をクリックします。

      「作成する認証情報のタイプは？」というメッセージが表示されます。

    3. [OAuth 2.0 認証情報] を選択します。
    4. フォームに、これらの値を入力します。
      表 : 3. OAuth 2.0 認証情報フォーム
      フィールド 説明
      名前 レコードを一意に識別する名前を入力します。例：Workday HR Cred。
      有効 認証情報レコードを積極的に使用するオプションです。
      OAuth エンティティ プロファイル Workday HR を OAuth プロバイダーとして登録する際に作成される OAuth エンティティプロファイル。例えば、 OAuth プロファイル。
    5. フォームヘッダーを右クリックし、[送信]をクリックします。
    6. OAuth トークンを生成するには、[OAuth トークンの 取得] 関連リンクをクリックします。

    Workday HR スポークの接続レコードの作成

    Workday HR インスタンスの接続レコードを作成します。Workday HR スポーク接続および資格情報エイリアスでは、これらの接続を使用して Workday HR でアクションを実行します。

    始める前に

    必要なロール：admin

    手順

    1. 移動先 すべて > 接続 & 認証情報 > 接続と認証情報エイリアス.
    2. エイリアスレコード WorkdayHR を開きます。
    3. [接続] タブで、[新規] をクリックします。
    4. フォームの各フィールドに入力します。
      注:
      Workday HR スポークアプリケーションで接続レコードを作成していることを確認してください。
      表 : 4. 接続フォーム
      フィールド 説明
      名前 レコードを一意に識別する名前を入力します。例を次に示します。 Workday HR 接続。
      認証情報 Workday HR スポーク用に作成された認証情報レコード。 例：Workday HR Cred。
      接続エイリアス 接続に関連付けられているエイリアスレコードです。
      接続 URL Workday HR インスタンスに接続するための URL。
      有効 接続レコードを積極的に使用するオプション
    5. [属性] タブで、次の値を入力します。
      フィールド 値
      テナント名 Workday アプリケーションのテナント名。
      バージョン v1
    6. [送信] をクリックします。