カタログメタデータ を編集します

Catalog メタデータ は、カタログの管理 権限を持つユーザーなら誰でも編集できます。 config API を使用して、カタログの名前、概要、および説明を変更できます。config API の使用方法の詳細については 、『 API リファレンス』を参照してください。

カタログメタデータ を編集するには、次の手順を実行します。

1. 認可トークンを取得します。 手順について は、『 Identity & Access Management Guide 』を参照してください。
2. API ルックアップサービスを使用して、configv1 API の API エンドポイントを取得します。 手順については 、『 API Lookup 開発者ガイド』を参照してください。
3. config API に対するこのリクエストを使用して、カタログを編集します。 このリクエストの本文では、変更しないフィールドを含め、メタデータ の完全なセットを指定する必要があります。 変更しないフィールドには、フィールドの現在の値を指定します。 変更するフィールドに、そのフィールドの新しい値を指定します。

PUT /<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>
Content-Type: application/json
Authorization: Bearer <Authorization Token>
Cache-Control: no-cache

{
    "id": "<Catalog ID>",
    "name": "<Catalog Name>",
    "summary": "<Short description of catalog>",
    "description": "<Long description of catalog>"
}

1. 応答エレメント href には、カタログ更新プロセスのステータスを取得できる URL が含まれています。 例 :

   {
    "title": "Catalog Update",
    "href": "https://config.data.api.platform.here.com/config/v1/status/da167243-13cd-1312-1b72-2z5d2dea7460",
    "type": "urn:olp-types:status"
   }
   

   URL は、カタログの作成中にステータスを返します。 例 :

   {
    "status": "pending"
   }
   

2. カタログが更新されると、 URL は、変更されたフィールドと変更されていないフィールドを含むカタログメタデータ を返します。

   {
    "id": "<Catalog ID>",
    "name": "<Catalog Name>",
    "summary": "<Short description of catalog>",
    "description": "<Long description of catalog>",
    "owner": {
        "creator": {
            "id": "Mejk6DMxAq7kKI5lt2T2"
        },
        "organisation": {
            "id": "olp-here-test"
        }
    },
    "tags": [],
    "billingTags": [],
    "created": "2018-01-25T21:39:55.224Z",
    "layers": [],
    "version": 2
   }
   

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