Jump to

• Request
• Response
• Examples

Post a configuration of a contraction hierarchy

post

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

By passing in the Network Configuration Request in json, you can configure contraction hierarchy networks.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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"
        }
    }
}

Nested Schema : CreateNetworkRequest

Type: object

Show Source

• booleanLinkUserDataColumns: array booleanLinkUserDataColumns
• byteLinkUserDataColumns: array byteLinkUserDataColumns
• chName(required): string
  Name of generated contraction hierarchy network.

  Example: sample
• costColumns: array costColumns
• costScaleFactors(required): array costScaleFactors
• costUnits(required): array costUnits
• dbUser(required): string
  Example: here_sf
• floatLinkUserDataColumns: array floatLinkUserDataColumns
• intLinkUserDataColumns: array intLinkUserDataColumns
• jndiName(required): string
  Example: jdbc/here_sf
• networkName(required): string
  Example: HERE_SF_NET
• processGeometry: boolean
  Default Value: 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"
            }
        }
    }
}

Nested Schema : LoadNetworkRequest

Type: object

Show Source

• chName(required): string
  name of generated contraction hierarchy network

  Example: sample

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

Nested Schema : MetadataRequest

Type: object

Show Source

• chName(required): string
  Name of generated contraction hierarchy network

  Example: sample

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

Nested Schema : booleanLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : byteLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : costColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : costScaleFactors

Type: array

Show Source

• Array of: number

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

Nested Schema : costUnits

Type: array

Show Source

• Array of: string

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

Nested Schema : floatLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : intLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : shortLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : stringLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Indicating either the request is being processed or error messages.

Body ()

Root Schema : NetworkConfigurationResponse

Type: object

Show Source

• 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"
        }
    }
}

Nested Schema : CreateNetworkResponse

Type: object

Show Source

• resposne: string
  Example: Conrtaction network is being built.

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

Nested Schema : LoadNetworkResponse

Type: object

Show Source

• resposne: string
  Example: Network is being loaded.

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

Nested Schema : MetadataResponse

Type: object

Show Source

• booleanLinkUserDataColumns: array booleanLinkUserDataColumns
• byteLinkUserDataColumns: array byteLinkUserDataColumns
• chName: string
  Name of generated contraction hierarchy network.
• 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"
        }
    }
}

Nested Schema : booleanLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : byteLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : costScaleFactors

Type: array

Show Source

• Array of: integer

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

Nested Schema : costUnits

Type: array

Show Source

• Array of: string

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

Nested Schema : floatLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : intLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : linkCostColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : shortLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Nested Schema : stringLinkUserDataColumns

Type: array

Show Source

• Array of: string

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

Back to Top

Examples

The following example shows how to configure contraction hierarchy network by submitting a POST request on the REST resource using cURL. Depending on the operation specified in the requestbody, the configuration job can be creating, loading a contraction network or getting meatadata of a contraction network.

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

Example of Request Body

The following example shows how to create a contraction hierarchy network.

{"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"] }}          

The following example shows how to load a contraction hierarchy network.

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

The following example shows how to get the metadata of a contraction hierarchy network.

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

Example of Response Header

The following shows an example of the response header.

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

Example of Response Body

The following example shows the contents of the response body in JSON format of create network request.

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

The following example shows the contents of the response body in JSON format of load network request.

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

The following example shows the contents of the response body in JSON format of metadata request.

{"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"]}}      

Back to Top