ハイパーテキスト アプリケーション言語 (HAL)

IIS 管理 API には、 ハイパーテキスト アプリケーション言語 (HAL) と呼ばれるすべてのリソースに特別なデータが含まれています。 HAL は、リソースをリンクするための標準化された方法を提供する一連の規則です。 HAL は、クライアントが HTTP 要求の Accept ヘッダーに application/hal+json を含む場合にのみリソースに含まれます。

_links

_links プロパティは、API で使用される HAL の最も一般的な形式です。 _links オブジェクトには、関連するリソースを取得する方法を示すメンバーが含まれています。

_linksを含むリソースでは、一部の_linksメンバーが除外されています。

{
    "name": "Default Web Site",
    "id": "{id}",
    "physical_path": "%SystemDrive%\\inetpub\\wwwroot"
    .
    .
    .
    "application_pool": {
        "name": "DefaultAppPool",
        "id": "{app_pool_id}",
        "status": "started",
        "_links": {
            "self": {
                "href": "/api/webserver/application-pools/{app_pool_id}"
            }
        }
    },
    "_links": {
        "authentication": {
            "href": "/api/webserver/authentication/{authentication_id}"
        },
        "self": {
            "href": "/api/webserver/websites/{id}"
        },
        "webapps": {
            "href": "/api/webserver/webapps?website.id={id}"
        }
    }
}

このリソースの例は、IIS の Web サイトです。 _links プロパティは、認証設定にアクセスする方法、Web サイトの Web サイトのアプリケーションを表示する方法、リソースの URI をコンシューマーに伝えます。

セルフ

_linksを含むすべてのリソースには、セルフ リンクがあります。 このリンクは、リソースが存在する URI を提供します。 この URI は、リソースを更新または削除するときに PATCH 要求と DELETE 要求を送信する必要がある URI と同じです。

HAL の要求

HAL は JSON データ形式の拡張です。 リソースに HAL が含まれている場合、アプリケーション /hal+json のコンテンツ タイプがあります。 API から HAL を受信するには、クライアントは HTTP 要求の Accept ヘッダーに application/hal+json を指定する必要があります。