ジャンプ先

• リクエスト
• レスポンス
• 例

使用可能な縮約階層ネットワークの取得

get

https://localhost:7011/chrest/v1/configuration/networks

使用可能なすべての縮約階層ネットワークとステータスを表示します。

リクエスト

この操作のリクエスト・パラメータはありません。

この操作にはリクエスト本文はありません。

トップに戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

存在する縮約階層ネットワークとステータスを表示しています。

本文()

ルート・スキーマ: AvailableNetworksResponse

型: object

ソースの表示

• error: string
• networks: array networks

{
    "type":"object",
    "properties":{
        "networks":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AvailableNetworksResponse_networks"
            }
        },
        "error":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: networks

型: array

ソースの表示

• 配列: object AvailableNetworksResponse_networks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AvailableNetworksResponse_networks"
    }
}

ネストされたスキーマ: AvailableNetworksResponse_networks

型: object

ソースの表示

• chName: string
  生成された縮約階層ネットワークの名前
• networkName: string
  データベース内のNDMネットワークの名前

  例: HERE_SF_NET
• status: string
  許容値: [ "Building", "Loaded", "Failed", "ReadyToLoad" ]

{
    "type":"object",
    "properties":{
        "chName":{
            "type":"string",
            "description":"Name of generated contraction hierarchy network"
        },
        "networkName":{
            "type":"string",
            "description":"Name of NDM network in database",
            "example":"HERE_SF_NET"
        },
        "status":{
            "type":"string",
            "enum":[
                "Building",
                "Loaded",
                "Failed",
                "ReadyToLoad"
            ]
        }
    }
}

トップに戻る

例

次の例は、すべての縮約階層ネットワークの表示方法を示しています。

curl -v -X GET "https://localhost:8011/chrest/v1/configuration/networks"

レスポンス・ヘッダーの例

次にレスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK Date: Tue, 14 Jan 2020 18:35:41 GMT Content-Type: application/json; charset=UTF-8

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{"networks":[{"chName":"sample","networkName":"TL_NYC_NET","status":"Loaded"},{"chName":"heresf","networkName":"HERE_SF_NET","status":"Loaded"}]}

トップに戻る