カタログとレイヤーの設定を取得します

カタログ設定情報には、カタログおよびカタログ内のレイヤーが記述されています。 設定情報の例としては、カタログ名、 HERE リソースネーム （ HERE リソースネーム ）、説明、所有者などがあります。 カタログ内のレイヤーに関する設定情報には、各レイヤーのタイプ、 HERE リソースネーム 、およびスキーマが含まれます。

カタログの設定を取得する必要がある状況の 1 つに、データを公開または使用するプロセスを構築する場合があります。 データを公開および使用するための REST サービスでは、リクエストに特定の設定情報を入力する必要があるため、公開リクエストまたは消費リクエストを作成する前に、カタログの設定を取得する必要があります。

この項では、configv1 API を使用して設定情報を取得する方法の概要を示します。config API の使用方法の詳細については、『 API リファレンス』を参照してください。

1. 認可トークン を取得します。 詳細について は、『 Identity & Access Management Guide 』を参照してください。
2. API ルックアップサービスを使用して、configv1 API の API エンドポイントを取得します。 手順については 、『 API Lookup 開発者ガイド』を参照してください。
3. カタログの構成を取得するには、カタログの HERE リソースネーム が必要です。 カタログの HERE リソースネーム は、 HERE platform ポータルを使用するか config 、または API を使用してカタログのリストを取得することで検索できます。

   GET /<Base path for the config API from the API Lookup Service>/catalogs HTTP/1.1
   Host: <Hostname for the config API from the API Lookup Service>
   Authorization: Bearer <Authorization Token>
   Cache-Control: no-cache
   

4. カタログの HERE リソースネーム を取得したら config 、 API を使用して、カタログ内のレイヤーのレイヤーメタデータを含むカタログの構成を取得します。

   GET /<Base path for the config API from the API Lookup Service>/catalogs/<Catalog HRN> HTTP/1.1
   Host: <Hostname for the config API from the API Lookup Service>
   Authorization: Bearer <Authorization Token>
   Cache-Control: no-cache
   

configサービスの使用方法の詳細については 、『 API リファレンス』を参照してください。

例

以下は、 Java の HERE Live Weather Western Archive Europe カタログのカタログ設定を取得する方法の例です。

GET /config/v1/catalogs/<Catalog HRN> HTTP/1.1
Host: config.data.api.platform.here.com
Authorization: Bearer ABCDEfghiJkLMNOpQrSTUvWXyz1234567890
Cache-Control: no-cache

curl -X GET https://config.data.api.platform.here.com/config/v1/catalogs/<Catalog HRN> \
-H 'Authorization: Bearer ABCDEfghiJkLMNOpQrSTUvWXyz1234567890'
-H 'Cache-Control: no-cache'

HERE が応答です。 カタログ ID 、 HERE リソースネーム 、および名前を含むカタログ設定が提供されます。 さらに、カタログの「タイムスタンプインデックス」と「ライブウェザーアーカイブ西ヨーロッパ」の 2 つのレイヤーにレイヤーメタデータが提供されています。

{
    "id": "live-weather-archive-eu",
    "hrn": "<Catalog HRN>",
    "name": "HERE Live Weather Archive Western Europe",
    "summary": "This catalog contains Western Europe historical weather data with specialized pavement attributes that can be useful for advanced automotive use cases.",
    "description": "This catalog contains Western Europe historical weather data with specialized pavement attributes that can be useful for advanced automotive use cases.\n\nAttributes in this catalog include:\n\n    Air temperature\n    Dew point temperature\n    Humidity\n    Air Pressure\n    Visibility\n    Precipitation type (rain, snow, ice)\n    Intensity Of Precipitation\n    Pavement condition (slippery frost, packed snow, black ice …)\n    Pavement temperature\n    Wind speed and direction",
    "coverage": {
        "adminAreas": [
            "ES",
            "LU",
            "BE",
            "FI",
            "NO",
            "CH",
            "SE",
            "GB",
            "FR",
            "DK",
            "NL",
            "DE"
        ]
    },
    "owner": {
        "organisation": {
            "id": "olp-here"
        }
    },
    "tags": [
        "WeatherHistory"
    ],
    "billingTags": [],
    "created": "2017-11-07T21:43:50.563Z",
    "layers": [
        {
            "id": "timestamp-index",
            "hrn": "<Catalog HRN>",
            "name": "Time Stamp Index",
            "summary": "This layer maintains an index of the data that is stored in this Catalog. A version number is assigned for each data slice stored.",
            "description": "This layer maintains an index of the data that is stored in this Catalog. A version number is assigned for each data slice stored.",
            "coverage": {
                "adminAreas": [
                    "ES",
                    "LU",
                    "BE",
                    "FI",
                    "NO",
                    "CH",
                    "SE",
                    "GB",
                    "FR",
                    "DK",
                    "NL",
                    "DE"
                ]
            },
            "owner": {
                "organisation": {
                    "id": "olp-here"
                }
            },
            "partitioningScheme": "generic",
            "partitioning": {
                "scheme": "generic"
            },
            "contentType": "text/plain",
            "volume": {
                "volumeType": "durable"
            },
            "tags": [
                "TimeStamp"
            ],
            "billingTags": [],
            "created": "2017-11-07T22:20:02.004Z",
            "layerType": "versioned"
        },
        {
            "id": "archived-data",
            "hrn": "<Catalog HRN>",
            "name": "Live Weather Archive Western Europe",
            "summary": "This layer contains Western Europe historical weather data with specialized pavement attributes that can be useful for advanced automotive use cases.",
            "description": "This layer contains Western Europe historical weather data with specialized pavement attributes that can be useful for advanced automotive use cases.\n\nAttributes in this catalog include:\n\n    Air temperature\n    Dew point temperature\n    Humidity\n    Air Pressure\n    Visibility\n    Precipitation type (rain, snow)\n    Intensity Of Precipitation\n    Pavement condition (slippery frost, packed snow, black ice …)\n    Pavement temperature\n    Wind speed and direction",
            "coverage": {
                "adminAreas": [
                    "ES",
                    "LU",
                    "BE",
                    "FI",
                    "NO",
                    "CH",
                    "SE",
                    "GB",
                    "FR",
                    "DK",
                    "NL",
                    "DE"
                ]
            },
            "owner": {
                "organisation": {
                    "id": "olp-here"
                }
            },
            "schema": {
                "hrn": "<Schema HRN>"
            },
            "partitioningScheme": "heretile",
            "partitioning": {
                "tileLevels": [
                    8
                ],
                "scheme": "heretile"
            },
            "contentType": "application/x-protobuf",
            "volume": {
                "volumeType": "durable"
            },
            "tags": [
                "WeatherHistory",
                "ArchivedWeather"
            ],
            "billingTags": [],
            "created": "2017-11-07T22:32:26.694Z",
            "layerType": "versioned"
        }
    ],
    "version": 17
}