REST API
Urban Strategy provides a REST API based on the OpenAPI 3.0 specification, which can be used to import data. The REST API offers alternative access to the DT Platform, outside the standard webinterface. The structure of the functions in the API is in line with the categorization of data within the DT data store
Downloads
A .yaml file of the OpenAPI specification can be found here: openapi .yaml version
Access Token
GET /login
Summary:
Obtain a token
Description:
Use your Email and Password to get the token
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| query | Email as UserId | Yes | string | |
| password | query | Password belonging to Email | Yes | string |
Responses:
| Code | Description |
|---|---|
| 200 | Successful acquired token |
| 400 | Bad request |
| 401 | Invalid Email/Password supplied |
Help
GET /data/help
Summary:
Obtain Help
Description:
Displays a small help text
Bins
GET /data/bins
Summary:
Get all bins in the store
Description:
Retrieve a list of the Bins in the Urban Strategy storage
GET /data/bin/{Bin}/statistics
Summary:
Get statistics of a single bin in the store
Description:
Get statistics of a single Bin in the Urban Strategy storage
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
GET /data/bins/*/statistics
Summary:
Get statistics of all bins in the store
Description:
Get statistics of all the Bins in the Urban Strategy storage
GET /data/bin/{Bin}/get
Summary:
Get collections of a single bin
Description:
Get collections of a single Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
GET /data/bin/{SrcBin}/copy/{DstBin}
Summary:
Copy Bin to a new Bin
Description:
Copy Bin to a new Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| SrcBin | path | Name of the Source Bin | Yes | string |
| DstBin | path | Name of the (new) Destination Bin | Yes | string |
GET /data/bin/{Bin}/remove
Summary:
Remove/Delete a single bin
Description:
Remove/Delete a single Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
GET /data/bin/{Bin}/unload
Summary:
Unload a bin from the store. (Only used by uploader tools)
Description:
Unload a bin from the store. (Only used by uploader tools)
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
GET /data/bins/*/commit
Summary:
Commit data for every bin
Description:
Commit data for every bin
Collections
GET /data/collection/{Bin}/get/{Collection}
Summary:
Get collection data
Description:
Get collection data
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
| filter | query | Specify SQL like field filter. filter options: https://docs.microsoft.com/en-us/dotnet/api/system.data.datacolumn.expression?view=netcore-3.1 | No | string |
| format | query | Optional specify the output format (json default) | No | string |
| separator | query | Optional specify the separator (tab default) | No | string |
| geometry | query | 1=generic json array(default), 2=wkt Polygon, 3=wkt Multi polygon, 4=wkt Line, 5=wkt Point, 6=JSON array, 7=override, always use point | No | integer |
| id | query | id10=derive id10 field (decimal representation of first 3 fields of guid) from id, od=derive origin/destination from id | No | string |
| fields | query | list of case sensitive fields separated by commas to return by request | No | [ string ] |
| download | query | trigger a browser to download the data instead of showing it directly | No | integer |
| expressions | query | { |
No | string |
| aggregation | query | { |
No | string |
GET /data/collection/{Bin}/timestamps/{Collection}
Summary:
List available timestamps for this collection
Description:
List available timestamps for this collection
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
PUT /data/collection/{Bin}/set/{Collection}
Summary:
Update or Add Collection data
Description:
Update or Add Collection data
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
GET /data/collection/{SrcBin}/copy/{SrcCollection}
Summary:
Copy Bin to a new Bin
Description:
Copy Bin to a new Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| SrcBin | path | Name of the Source Bin | Yes | string |
| SrcCollection | path | Name of the Source Collection | Yes | string |
| newbinname | query | Name of the (new) Destination Bin | Yes | string |
| newcollectionname | query | Name of the (new) Collection | Yes | string |
GET /data/collection/{Bin}/remove/{Collection}
Summary:
Remove collection from bin
Description:
Remove Collection from Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
GET /data/collection/{Bin}/truncate/{Collection}
Summary:
Truncate collection from bin
Description:
Truncate Collection from Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
GET /data/collection/{Bin}/truncatets/{Collection}
Summary:
Truncate collection from bin
Description:
Truncate Collection from Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
| timestampgroup | query | Specify the timestampgroup for truncation | No | integer |
GET /data/collection/{Bin}/unload/{Collection}
Summary:
Unload a collection from the store. (Only used by uploader tools)
Description:
Unload a collection from the store. (Only used by uploader tools)
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
GET /data/collection/{Bin}/fingerprint/{Collection}
Summary:
Calculate fingerprint of a collection.
Description:
Calculate fingerprint of a collection.
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Collection | path | Name of the Collection | Yes | string |
Schema
GET /data/schema/{Schema}/get
Summary:
Get schema
Description:
Get schema
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Schema | path | Name of the Schema | Yes | string |
| format | query | Specify output format json (default), csv or html | No | string |
PUT /data/schema/{Schema}/set
Summary:
Update schema
Description:
Update schema
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Schema | path | Name of the Schema | Yes | string |
Key value sets
GET /data/keyvalueset/{Bin}/get/{KeyValueSet}
Summary:
Get a key-value set from a Bin
Description:
Get a key-value set from a Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| KeyValueSet | path | Name of the KeyValue Set | Yes | string |
| values | query | Specify the output format. | No | string |
PUT /data/keyvalueset/{Bin}/set/{KeyValueSet}
Summary:
Update or Add a key-value set to the Bin
Description:
Update or Add a key-value set to the Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| KeyValueSet | path | Name of the KeyValue Set | Yes | string |
GET /data/keyvalueset/{Bin}/remove/{KeyValueSet}
Summary:
Remove a key-value set from a Bin
Description:
Remove a key-value set from a Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| KeyValueSet | path | Name of the KeyValue Set | Yes | string |
GET /data/keyvalueset/{Bin}/truncate/{KeyValueSet}
Summary:
Truncate a key-value set from a Bin
Description:
Truncate a key-value set from a Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| KeyValueSet | path | Name of the KeyValue Set | Yes | string |
GET /data/keyvalueset/{Bin}/fingerprint/{KeyValueSet}
Summary:
Calculate the fingerprint of a key-value set from a Bin
Description:
Calculate the fingerprint of a key-value set from a Bin
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| KeyValueSet | path | Name of the KeyValue Set | Yes | string |
Matrices
GET /data/matrix/{Bin}/get/{Matrix}
Summary:
Get matrix data
Description:
Get Matrix data
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Matrix | path | Name of the Matrix | Yes | string |
| fields | query | list of case sensitive fields separated by commas to return by request | No | [ string ] |
| format | query | Optional specify the output format (json default) | No | string |
| separator | query | Optional specify the separator (tab default) | No | string |
| download | query | trigger a browser to download the data instead of showing it directly | No | integer |
GET /data/matrix/{Bin}/remove/{Matrix}
Summary:
Remove matrix
Description:
Remove Matrix
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Matrix | path | Name of the Matrix | Yes | string |
GET /data/matrix/{Bin}/truncate/{Matrix}
Summary:
Truncate matrix
Description:
Truncate Matrix
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Matrix | path | Name of the Matrix | Yes | string |
GET /data/matrix/{Bin}/unload/{Matrix}
Summary:
Unload a matrix from the store. (Only used by uploader tools)
Description:
Unload a Matrix from the store. (Only used by uploader tools)
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Matrix | path | Name of the Matrix | Yes | string |
GET /data/matrix/{Bin}/fingerprint/{Matrix}
Summary:
Calculate the fingerprint of a matrix
Description:
Calculate the fingerprint of a Matrix
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| Matrix | path | Name of the Matrix | Yes | string |
Analytical modules
GET /data/models
Summary:
Retrieve a list of the available models
Description:
Retrieve a list of the available models
GET /data/models/{Bin}/start/{SetupName}
Summary:
Start a model
Description:
Start a model
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| Bin | path | Name of the Bin | Yes | string |
| SetupName | path | Setup Name of the Model | Yes | string |
| version | query | optional setup version number | No | string |
| node | query | optional node name of the setup | No | string |
| stopAt | query | optional excel date/time when at latest stop model | No | number |
| state | query | optional initial model state | No | integer |
| desiredState | query | optional desired model state | No | integer |
| stateGroup | query | optional state manager group | No | integer |
| stateRequested | query | optional state manager requested state | No | integer |
| waitForSetupSeconds | query | optional time to wait before setup becomes available | No | integer |
| maxIdleTime | query | optional maximum allowed idle time (fraction of day) | No | number |
GET /data/models/{InstanceId}/stop
Summary:
Stop a model
Description:
Stop a model
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| InstanceId | path | The Instance Id | Yes | string |
GET /data/models/{InstanceId}/stop/force
Summary:
Force a model to stop
Description:
Force a model to stop
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| InstanceId | path | The Instance Id | Yes | string |
PUT /data/models/*/state
Summary:
Request model state. Will return when the model goes through a change to the
Description:
Request model state. Will return when the model goes through a change to the
Log
GET /data/instances/{InstanceId}/log
Summary:
Fetch a log remotely
Description:
Fetch a log remotely
Parameters:
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| InstanceId | path | The Instance Id | Yes | string |