Indeed リソース ID(IRI)
Indeed リソース識別子(IRI)は、node クエリで Indeed のあらゆるエンティティを検索で きる、グローバルに一意な ID です。
概要
#GraphQL の Node インターフェースを実装するオブジェクトは、ルートレベルの node クエリと nodes クエリを使用して、id フィールドで検索できます。これには次の利点があります。
- エンティティタイプごとに ID で取得するクエリを用意する必要がありません。
- 詳細ビューのクエリがシンプルになります。
- すべてのオブジェクトに、クライアントのキャッシュキーとして使用できる一貫した
idフィールドがあります。
これを実現するには、各 id が次の条件を満たす必要があります。
- すべてのエンティティで一意であること。たとえば、
JobPostとEmployerRegistrationが同じ ID を共有することはできません。 - 返すオブジェクトのタイプを
nodeクエリが判断できること。
Indeed の ID は、Indeed リソース識別子(IRI)によって両方の条件を満たしています。
IRI 形式
#iri://{context}/{entityType}/{internalId}| 変数 | 値 |
|---|---|
{context} | オブジェクトを解決する GraphQL エンドポイントのホスト名です。 パートナーの場合は、常に |
{entityType} |
たとえば、Job Update API の |
{internalId} | Indeed がストレージからオブジェクトを取得するために使用する ID です。
|
GraphQL API リファレンス
#