ジャンプ先

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

縮約階層ネットワークの構成の投稿

POST

/chrest/v1/configuration

json/xmlのネットワーク構成リクエストに渡すことで、縮約階層ネットワークを構成できます。

リクエスト

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

• application/json
• application/xml

本文()

縮約ネットワークの作成、ロード、メタデータ問合せなどの操作を指定します。

ルート・スキーマ: NetworkConfigurationRequest

型: object

ソースの表示

• createNetworkRequest (オプション): object CreateNetworkRequest
• loadNetworkRequest (オプション): object LoadNetworkRequest
• metadataRequest (オプション): object MetadataRequest

{
    "type":"object",
    "properties":{
        "metadataRequest":{
            "$ref":"#/definitions/MetadataRequest"
        },
        "createNetworkRequest":{
            "$ref":"#/definitions/CreateNetworkRequest"
        },
        "loadNetworkRequest":{
            "$ref":"#/definitions/LoadNetworkRequest"
        }
    }
}

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

型: object

ソースの表示

• chName: string
  生成された縮約階層ネットワークの名前。

  例: sample
• dbPassword: string
• dbUrl: string
• dbUser: string
• networkName: string
  例: HERE_SF_NET
• primaryCostScaleFactor (オプション): integer
• primaryCostUnit (オプション): string
• primaryLinkCostColumn (オプション): string
• processGeometry (オプション): boolean
• processTurnRestrictions (オプション): boolean
• secondaryCostScaleFactors (オプション): array secondaryCostScaleFactors
• secondaryCostUnits (オプション): array secondaryCostUnits
• secondaryLinkCostColumns (オプション): array secondaryLinkCostColumns

{
    "type":"object",
    "required":[
        "chName",
        "dbPassword",
        "dbUrl",
        "dbUser",
        "networkName"
    ],
    "properties":{
        "chName":{
            "type":"string",
            "example":"sample",
            "description":"Name of generated contraction hierarchy network."
        },
        "networkName":{
            "type":"string",
            "example":"HERE_SF_NET"
        },
        "dbUrl":{
            "type":"string"
        },
        "dbUser":{
            "type":"string"
        },
        "dbPassword":{
            "type":"string"
        },
        "processGeometry":{
            "type":"boolean"
        },
        "processTurnRestrictions":{
            "type":"boolean"
        },
        "primaryLinkCostColumn":{
            "type":"string"
        },
        "primaryCostUnit":{
            "type":"string"
        },
        "primaryCostScaleFactor":{
            "type":"integer"
        },
        "secondaryLinkCostColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "secondaryCostUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "secondaryCostScaleFactors":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

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

型: object

ソースの表示

• chName: string
  生成された縮約階層ネットワークの名前。

  例: sample
• considerTurnRestrictions (オプション): boolean
• networkName: string
  例: HERE_SF_NET

{
    "type":"object",
    "required":[
        "chName",
        "networkName"
    ],
    "properties":{
        "chName":{
            "type":"string",
            "example":"sample",
            "description":"Name of generated contraction hierarchy network."
        },
        "networkName":{
            "type":"string",
            "example":"HERE_SF_NET"
        },
        "considerTurnRestrictions":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースの表示

• chName: string
  生成された縮約階層ネットワークの名前

  例: sample

{
    "type":"object",
    "required":[
        "chName"
    ],
    "properties":{
        "chName":{
            "type":"string",
            "example":"sample",
            "description":"Name of generated contraction hierarchy network"
        }
    }
}

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

型: array

ソースの表示

• 配列: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

トップに戻る

レスポンス

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

• application/json
• application/xml

200レスポンス

リクエストが処理中であること、またはエラー・メッセージを示しています。

本文()

ルート・スキーマ: NetworkConfigurationResponse

型: object

ソースの表示

• createNetworkResponse (オプション): object CreateNetworkResponse
• error (オプション): string
• loadNetworkResponse (オプション): object LoadNetworkResponse
• metadataResponse (オプション): object MetadataResponse

{
    "type":"object",
    "properties":{
        "metadataResponse":{
            "$ref":"#/definitions/MetadataResponse"
        },
        "createNetworkResponse":{
            "$ref":"#/definitions/CreateNetworkResponse"
        },
        "loadNetworkResponse":{
            "$ref":"#/definitions/LoadNetworkResponse"
        },
        "error":{
            "type":"string"
        }
    }
}

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

型: object

ソースの表示

• resposne (オプション): string
  例: Conrtaction network is being built.

{
    "type":"object",
    "properties":{
        "resposne":{
            "type":"string",
            "example":"Conrtaction network is being built."
        }
    }
}

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

型: object

ソースの表示

• resposne (オプション): string
  例: Network is being loaded.

{
    "type":"object",
    "properties":{
        "resposne":{
            "type":"string",
            "example":"Network is being loaded."
        }
    }
}

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

型: object

ソースの表示

• chName (オプション): string
  生成された縮約階層ネットワークの名前。
• dbUrl (オプション): string
• dbUser (オプション): string
• error (オプション): string
• networkName (オプション): string
• networkVersion (オプション): string
• primaryCostScaleFactor (オプション): integer
• primaryCostUnit (オプション): string
• primaryLinkCostColumn (オプション): string
• processLinkGeometries (オプション): boolean
• processNodeGeometries (オプション): boolean
• processTurnRestrictions (オプション): boolean
• secondaryCostScaleFactors (オプション): array secondaryCostScaleFactors
• secondaryCostUnits (オプション): array secondaryCostUnits
• secondaryLinkCostColumns (オプション): array secondaryLinkCostColumns

{
    "type":"object",
    "properties":{
        "chName":{
            "type":"string",
            "description":"Name of generated contraction hierarchy network."
        },
        "networkName":{
            "type":"string"
        },
        "networkVersion":{
            "type":"string"
        },
        "dbUrl":{
            "type":"string"
        },
        "dbUser":{
            "type":"string"
        },
        "processNodeGeometries":{
            "type":"boolean"
        },
        "processLinkGeometries":{
            "type":"boolean"
        },
        "processTurnRestrictions":{
            "type":"boolean"
        },
        "primaryLinkCostColumn":{
            "type":"string"
        },
        "primaryCostUnit":{
            "type":"string"
        },
        "primaryCostScaleFactor":{
            "type":"integer"
        },
        "secondaryLinkCostColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "secondaryCostUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "secondaryCostScaleFactors":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "error":{
            "type":"string"
        }
    }
}

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

型: array

ソースの表示

• 配列: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、縮約階層ネットワークを構成する方法を示しています。リクエスト本文に指定されている操作に応じて、構成ジョブは縮約ネットワークの作成、ロード、縮約ネットワークのメタデータの取得のいずれかになります。

curl -v -X POST "https://localhost:8011/chrest/v1/configuration" -H "Content-Type: application/json" -d @request_body.json 

リクエスト本文の例

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

{"createNetworkRequest": { "chName":"example", "networkName":"NETWORK_NAME", "dbUrl":"jdbc:oracle:thin:@localhost:port:sid", "dbUser":"username", "dbPassword":"password", "processGeometry":true, "processTurnRestrictions":false, "primaryLinkCostColumn":"LENGTH", "primaryCostUnit":"meter", "primaryCostScaleFactor":10, "secondaryLinkCostColumns":["LENGTH/S"], "secondaryCostUnits":["second"], "secondaryCostScaleFactors":[10] }}					

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

{"loadNetworkRequest":{"chName":"example","networkName":"NETWORK_NAME","considerTurnRestrictions":false}}				

次の例は、縮約階層ネットワークのメタデータを取得する方法を示しています。

{"metadataRequest":{"chName":"example"}}				

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

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

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

レスポンス本文の例

次の例は、ネットワーク作成リクエストのJSON形式のレスポンス本文の内容を示しています。

{"createNetworkResponse" : {"response" : "Conrtaction network is being built."}}			

次の例は、ネットワーク・ロード・リクエストのJSON形式のレスポンス本文の内容を示しています。

{"loadNetworkResponse" : {"response" : "Network is being loaded."}}				

次の例は、メタデータ・リクエストのJSON形式のレスポンス本文の内容を示しています。

{"metadataResponse" : {"chName" : "sample","networkName" : "NETWORK_NAME","dbUrl" : "jdbc:oracle:thin:@localhost:port:sid","dbUser" : "xth","processNodeGeometries" : true,"processLinkGeometries" : true,"processTurnRestrictions" : false,"primaryLinkCostColumn" : "LENGTH","secondaryLinkCostColumns" : [ "LENGTH/S" ],"primaryCostUnit" : "meter","secondaryCostUnits" : [ "second" ],"primaryCostScaleFactor" : 10.0,"secondaryCostScaleFactors" : [ 10.0 ]}}			

トップに戻る