外部参照でのカスタムフィールド値の使用
この例では、Workfront API を呼び出し、カスタムフィールドから外部検索フィールドにデータを取り込む方法を示しています。 例えば、カスタムフィールドは「Custom Colors」と呼ばれます。
-
カスタムフォームを開きます。
-
画面の左側で、「外部ルックアップ」を見つけて、キャンバス上のセクションにドラッグします。
-
フィールドの ラベル と 名前 を入力します。
-
フィールドの 形式 を選択します。
-
API の URL 呼び出しを「ベース API の URL」フィールドに入力します。
例
$$HOST/attask/api/v18.0/PORT/search?ID={portfolioID}&fields=parameterValues
-
このルックアップフィールドが API で参照しているフィールドの 依存関係 を確認します。
「依存関係」フィールドには、オブジェクトの詳細ページに存在する任意のカスタムフィールドまたはネイティブフィールドを使用できます。
-
「HTTP メソッド」を選択します。
これは、ほとんどの場合、Get になります。
-
JSON パス を入力して、API 呼び出しの結果を取得します。
例
$.data[*].parameterValues.["DE:Combo Colors"]
- 「parameterValues」は、操作しているオブジェクトのWorkfront内のカスタムフィールドを指します。
- 例えば、「DE:Combo Colors」は、取得する値を含む特定のカスタムフィールドです。
メモ
同じ Workfront インスタンスに対して呼び出しを行う場合は、ヘッダー の情報は必要ありません。 -
「適用」をクリックします。
カスタムフォームがWorkfront オブジェクトに追加されると、「コンボカラー」フィールドのすべての値が外部検索フィールドドロップダウンに表示されます。
Workfront Planning API 用の外部参照フィールドの設定
Workfront Planning API では、Get メソッドを使用してレコードタイプ ID でレコードを検索するためのエンドポイントを使用できます。 このエンドポイントを使用して、外部参照フィールドで Planning レコードを参照できます。
-
ベース API の URL:
$$HOST/maestro/api/v1/records/search?recordTypeId={recordTypeID}
-
HTTP メソッド: Get
-
JSON パス:
$.records[*].data.{fieldID}
{fieldID} は、エンドユーザーのカスタムフォーム上で外部検索の検索結果に表示するフィールドです。
詳しくは、Workfront Planning API を参照してください。
パブリック API 用の外部参照フィールドの設定
外部検索を使用して、外部のパブリック API を呼び出し、データを取得できます。
この例では、ドロップダウンオプションにすべての国名をハードコーディングする必要がないように、国の API(https://api.first.org/data/v1/countries など)を呼び出す方法を示します。
-
カスタムフォームを開きます。
-
画面の左側で、「外部ルックアップ」を見つけて、キャンバス上のセクションにドラッグします。
-
フィールドの ラベル と 名前 を入力します。
-
フィールドの 形式 を選択します。
-
API の URL 呼び出しを「ベース API の URL」フィールドに入力します。
- $$QUERY を追加すると、エンドユーザーに対するクエリフィルタリングを実装できます。
例
すべての国を一覧表示します。https://api.first.org/data/v1/countriesユーザーがドロップダウンフィールド内の任意の国を検索できるようにします。https://api.first.org/data/v1/countries?q=$$QUERY
ユーザーが地域内の国を検索できるようにします。https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY
- 使用可能なは、Workfront の別のカスタムフィールドで定義されます。
- ユーザーがフォーム上で地域を選択すると、外部検索フィールドには、その地域の国(API で地域が定義されている国)のみが表示されます。 また、ユーザーは、選択した地域の国を検索することもできます。
-
このルックアップフィールドが API で参照しているフィールドの 依存関係 を確認します。
「依存関係」フィールドには、オブジェクトの詳細ページに存在する任意のカスタムフィールドまたはネイティブフィールドを使用できます。
この例では、
{DE:Region}
は、地域カスタムフィールドの値に置き換えられます。 -
「HTTP メソッド」を選択します。
これは、ほとんどの場合、Get になります。
-
JSON パス を入力して、API 呼び出しから結果を取得します。
このオプションを使用すると、API URL から返された JSON からデータを抽出できます。これは、JSON 内のどの値がドロップダウンオプションに表示されるかを選択する手段の役割を果たします。
例
$.data[*].country
-
(オプション)「ヘッダーを追加」をクリックし、API での認証に必要なキーと値のペアを入力するか貼り付けます。
メモ
「ヘッダー」フィールドは、資格情報を保存する安全な場所ではないので、入力して保存する内容には注意する必要があります。 -
(オプション)ユーザーがドロップダウンで複数の値を選択できるようにするには、「複数選択ドロップダウン」を選択します。
-
「適用」をクリックします。
カスタムフォームが Workfront オブジェクト(この例ではプロジェクト)に追加されると、次のようになります。