Spatial REST API

縮約階層の構成のポスト

post

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

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

リクエスト

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

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

application/json

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

ルート・スキーマ: schema

型: object

ソースの表示

createNetworkRequest: object CreateNetworkRequest
loadNetworkRequest: object LoadNetworkRequest
metadataRequest: object MetadataRequest

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

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

型: object

ソースの表示

booleanLinkUserDataColumns: array booleanLinkUserDataColumns
byteLinkUserDataColumns: array byteLinkUserDataColumns
chName(required): string

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

例: sample
costColumns: array costColumns
costScaleFactors(required): array costScaleFactors
costUnits(required): array costUnits
dbUser(required): string

例: here_sf
floatLinkUserDataColumns: array floatLinkUserDataColumns
intLinkUserDataColumns: array intLinkUserDataColumns
jndiName(required): string

例: jdbc/here_sf
networkName(required): string

例: HERE_SF_NET
processGeometry: boolean

デフォルト値: false
shortLinkUserDataColumns: array shortLinkUserDataColumns
stringLinkUserDataColumns: array stringLinkUserDataColumns

{
    "required":[
        "chName",
        "costScaleFactors",
        "costUnits",
        "dbUser",
        "jndiName",
        "linkCostColumns",
        "networkName"
    ],
    "type":"object",
    "properties":{
        "chName":{
            "type":"string",
            "description":"Name of generated contraction hierarchy network.",
            "example":"sample"
        },
        "networkName":{
            "type":"string",
            "example":"HERE_SF_NET"
        },
        "dbUser":{
            "type":"string",
            "example":"here_sf"
        },
        "jndiName":{
            "type":"string",
            "example":"jdbc/here_sf"
        },
        "processGeometry":{
            "type":"boolean",
            "default":false
        },
        "costColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costScaleFactors":{
            "type":"array",
            "items":{
                "type":"number"
            }
        },
        "booleanLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "byteLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "floatLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "intLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shortLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "stringLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: object

ソースの表示

chName(required): string

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

例: sample

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

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

型: object

ソースの表示

chName(required): string

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

例: sample

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: number

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

トップに戻る

レスポンス

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

application/json

200レスポンス

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

ルート・スキーマ: NetworkConfigurationResponse

型: object

ソースの表示

createNetworkResponse: object CreateNetworkResponse
error: string
loadNetworkResponse: object LoadNetworkResponse
metadataResponse: object MetadataResponse

{
    "type":"object",
    "properties":{
        "metadataResponse":{
            "$ref":"#/components/schemas/MetadataResponse"
        },
        "createNetworkResponse":{
            "$ref":"#/components/schemas/CreateNetworkResponse"
        },
        "loadNetworkResponse":{
            "$ref":"#/components/schemas/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

ソースの表示

booleanLinkUserDataColumns: array booleanLinkUserDataColumns
byteLinkUserDataColumns: array byteLinkUserDataColumns
chName: string

生成された縮約階層ネットワークの名前。
costScaleFactors: array costScaleFactors
costUnits: array costUnits
dbUser: string
error: string
floatLinkUserDataColumns: array floatLinkUserDataColumns
intLinkUserDataColumns: array intLinkUserDataColumns
jndiName: string
linkCostColumns: array linkCostColumns
networkName: string
networkVersion: string
processLinkGeometries: boolean
processNodeGeometries: boolean
shortLinkUserDataColumns: array shortLinkUserDataColumns
stringLinkUserDataColumns: array stringLinkUserDataColumns

{
    "type":"object",
    "properties":{
        "chName":{
            "type":"string",
            "description":"Name of generated contraction hierarchy network."
        },
        "networkName":{
            "type":"string"
        },
        "networkVersion":{
            "type":"string"
        },
        "dbUser":{
            "type":"string"
        },
        "jndiName":{
            "type":"string"
        },
        "processNodeGeometries":{
            "type":"boolean"
        },
        "processLinkGeometries":{
            "type":"boolean"
        },
        "linkCostColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costUnits":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "costScaleFactors":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        },
        "booleanLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "byteLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "floatLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "intLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "shortLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "stringLinkUserDataColumns":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "error":{
            "type":"string"
        }
    }
}

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: integer

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: array

ソースの表示

配列: string

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

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

型: 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","dbUser":"here_sf", "jndiName":"jdbc/here_sf", "processGeometry":true, "linkCostColumns":["LENGTH","LENGTH/S"], "costUnits":["meter","second"], "costScaleFactors":[10, 10], "intLinkUserDataColumns":["S", "F"], "booleanLinkUserDataColumns":["FLOOR((5-F)/3)"], "stringLinkUserDataColumns":["NAME"] }}

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

{"loadNetworkRequest":{"chName":"example"}}

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

{"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","dbUser" : "here_sf",jndiName" : "jdbc/here_sf","processNodeGeometries" : true,"processLinkGeometries" : true,"linkCostColumns" : ["LENGTH","LENGTH/S"],"costUnits" : ["meter","second"],"costScaleFactors" : [10.0, 10.0], "intLinkUserDataColumns" : ["S", "F"], "booleanLinkUserDataColumns" : ["FLOOR((5-F)/3)"], "stringLinkUserDataColumns" : ["NAME"]}}

トップに戻る