Data Core Module API (1.0.0)

Download OpenAPI specification:Download

E-mail: seongyun.kim@keti.re.kr License: Apache 2.0 Terms of Service

The data core module complies with the NGSI-LD API. It partially supports NGSI-LD API standard, and additionally provides HTTP API for data core internal data management and API for utilizing KAFKA interface. You can find out more about City Data Hub at http://citydatahub.kr/.

provision

provides the ability to manage provisioning server

Create Provisioning Server

Data model of water resource data, data set information creation/modification/deletion event to provision server information is created.

Request Body schema: application/json

id required	string
type required	string
description	string
provisionUri required	string
provisionProtocol required	string
provisionOrder required	integer
enabled required	boolean

Responses

Request samples

Payload

Content type

application/json

{"id": "dataServiceBroker01",
"type": "dataServiceBroker",
"description": "description1234",
"provisionUri": "http://10.12.0.32:8080",
"provisionProtocol": "http",
"provisionOrder": 2,
"enabled": true
}

Response samples

400

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve All of Provisioning Server

Data model of water resource data, data set information creation/modification/deletion event to all of provision server information is retrieved.

query Parameters

type	string Example: type=dataServiceBroker, bigDataStorageHandler, ingestInterface
provisionProtocol	string Example: provisionProtocol=http, kafka
enabled	boolean

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update Provisioning Server

Data model of water resource data, data set information creation/modification/deletion event to provision server information is updated.

path Parameters

id

required

string

Example: dataServiceBroker01

Provisioning Server ID

Request Body schema: application/json

type	string
description	string
provisionUri required	string
provisionProtocol required	string
enabled required	boolean

Responses

Request samples

Payload

Content type

application/json

{"type": "dataServiceBroker",
"description": "description1234555333",
"provisionUri": "http://10.12.0.32:8080",
"provisionProtocol": "http",
"enabled": true
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete Provisioning Server

Data model of water resource data, data set information creation/modification/deletion event to provision server information is deleted.

path Parameters

id

required

string

Example: ingestInterface03

Provisioning Server ID

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Each Provisioning Server

Data model of water resource data, data set information creation/modification/deletion event to each provision server information is retrieved.

path Parameters

id

required

string

Example: dataServiceBroker01

Provisioning Server ID

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

data model

provides the ability to manage data model

Create Data Model

Data model information representing schema information of water resource data is created. Model information includes namespace, type, and version. Based on the created data model, quality check is performed on water resource data.

Request Body schema: application/json

id required	string
type required	string
typeUri required	string
name	string
context required	Array of strings
description	string
indexAttributeNames	Array of strings
required	Array of objects (DataModelAttribute)

Responses

Request samples

Payload

Content type

application/json

{"id": "primerCustomer",
"type": "Customer",
"typeUri": "https://uri.etsi.org/ngsi-ld/primer/Customer",
"name": "string",
"context": ["string"
],
"description": "string",
"indexAttributeNames": ["string"
],
"attributes": [{"attributeUri": "string",
"name": "string",
"description": "string",
"attributeType": "Property, GeoProperty, Relationship",
"hasObservedAt": true,
"hasUnitCode": true,
"isRequired": true,
"accessMode": "Read-only",
"greaterThan": 0,
"greaterThanOrEqualTo": 0,
"lessThanOrEqualTo": 0,
"lessThan": 0,
"maxLength": "3,3",
"minLength": "3,3",
"valueType": "GeoJson, string",
"valueEnum": ["KR, EN"
],
"objectMembers": [{"name": "string",
"description": "string",
"isRequired": true,
"greaterThan": 0,
"greaterThanOrEqualTo": 0,
"lessThanOrEqualTo": 0,
"lessThan": 0,
"maxLength": "3,3",
"minLength": "3,3",
"valueType": "GeoJson, string",
"valueEnum": ["KR, EN"
],
"objectMembers": [{ }
]
}
],
"childAttributes": [{ }
]
}
]
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve All of Data Model

Retrieve all of water resource data model information.

query Parameters

id	string
type	string
typeUri	string
name	string

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update Data Model

Modify basic information except for the attribute information of the water resource data model.

path Parameters

id

required

string

Request Body schema: application/json

id required	string
type required	string
typeUri required	string
name	string
context required	Array of strings
description	string
indexAttributeNames	Array of strings
required	Array of objects (DataModelAttribute)

Responses

Request samples

Payload

Content type

application/json

{"id": "primerCustomer",
"type": "Customer",
"typeUri": "https://uri.etsi.org/ngsi-ld/primer/Customer",
"name": "string",
"context": ["string"
],
"description": "string",
"indexAttributeNames": ["string"
],
"attributes": [{"attributeUri": "string",
"name": "string",
"description": "string",
"attributeType": "Property, GeoProperty, Relationship",
"hasObservedAt": true,
"hasUnitCode": true,
"isRequired": true,
"accessMode": "Read-only",
"greaterThan": 0,
"greaterThanOrEqualTo": 0,
"lessThanOrEqualTo": 0,
"lessThan": 0,
"maxLength": "3,3",
"minLength": "3,3",
"valueType": "GeoJson, string",
"valueEnum": ["KR, EN"
],
"objectMembers": [{"name": "string",
"description": "string",
"isRequired": true,
"greaterThan": 0,
"greaterThanOrEqualTo": 0,
"lessThanOrEqualTo": 0,
"lessThan": 0,
"maxLength": "3,3",
"minLength": "3,3",
"valueType": "GeoJson, string",
"valueEnum": ["KR, EN"
],
"objectMembers": [{ }
]
}
],
"childAttributes": [{ }
]
}
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete Data Model

Delete water resource data model information.

path Parameters

id

required

string

Responses

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Data Model

Retrieve individual water resource data model information.

path Parameters

id

required

string

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

data set

provides the ability to manage data set

Create Data Set

Generate data set information of water resource data.

Request Body schema: application/json

id required	string
name required	string
description	string
updateInterval required	string
category required	string
providerOrganization required	string
providerSystem required	string
isProcessed required	boolean
ownership required	string
keywords	Array of strings
license required	string
providingApiUri	string
restrictions	string
datasetExtension	string
datasetItems required	string
targetRegions required	string
sourceDatasetIds	Array of strings
dataStoreUri required	Array of strings
qualityCheckEnabled required	string
dataIdentifierType	string
datamodelId	string

Responses

Request samples

Payload

Content type

application/json

{"id": "dataset001",
"name": "Daegu",
"description": "Daegu",
"updateInterval": "31th 00:00",
"category": "X01",
"providerOrganization": "Daegu",
"providerSystem": "Daegu",
"isProcessed": "D001",
"ownership": "Daegu",
"keywords": [["BUS",
"AIR"
]
],
"license": "L001",
"providingApiUri": "https://ww.data.go.kr/dataset/3078089/fileData.do",
"restrictions": "Change throughout the year",
"datasetExtension": "XML, CSV",
"datasetItems": "Bus Number",
"targetRegions": "Nationwide",
"sourceDatasetIds": [["Daegu City Population in 2018"
]
],
"dataStoreUri": ["string"
],
"qualityCheckEnabled": true,
"dataIdentifierType": "daeguBus",
"datamodelId": "primerCustomer"
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Data Set

Retrieve the entire list of data sets of water resource data.

query Parameters

name	string
updateInterval	string
category	string
providerOrganization	string
providerSystem	string
isProcessed	string
ownership	string
license	string
datasetItems	string
targetRegions	string
dataStoreUri	string Example: dataStoreUri=Kafka Topic&dataStoreUri=Hive URI&dataStoreUri=Postgres URI&dataStoreUri=Hbase URI
qualityCheckEnabled	string
datamodelId	string

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update Data Set

Modify data set information of water resource data.

path Parameters

id

required

string

Example: dataset001

Request Body schema: application/json

name	string
description	string
updateInterval	string
category	string
providerOrganization	string
providerSystem	string
isProcessed	string
ownership	string
keywords	Array of strings
license	string
providingApiUri	string
restrictions	string
datasetExtension	string
datasetItems	string
targetRegions	string
sourceDatasetIds	Array of strings
qualityCheckEnabled	string
dataIdentifierType	string
datamodelId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Daegu",
"description": "Daegu",
"updateInterval": "31th 00:00",
"category": "X01",
"providerOrganization": "Daegu",
"providerSystem": "Daegu",
"isProcessed": "D001",
"ownership": "Daegu",
"keywords": [["BUS",
"AIR"
]
],
"license": "L001",
"providingApiUri": "https://ww.data.go.kr/dataset/3078089/fileData.do",
"restrictions": "Change throughout the year",
"datasetExtension": "XML, CSV",
"datasetItems": "Bus Number",
"targetRegions": "Nationwide",
"sourceDatasetIds": [["Daegu City"
]
],
"qualityCheckEnabled": true,
"dataIdentifierType": "daeguBus",
"datamodelId": "primerCustomer"
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete Data Set

Delete data set information of water resource data.

path Parameters

id

required

string

Example: dataset001

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Data Set

Individually search data set information of water resource data.

path Parameters

id

required

string

Example: dataset001

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

data set flow

provides the ability to manage data set flow

Create Data Set Flow

Generate data set flow information of water resource data.

path Parameters

datasetId

required

string

Example: dataset001

Request Body schema: application/json

description	string
historyStoreType required	string
enabled required	boolean
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"historyStoreType": "partial, full, all",
"enabled": true,
"targetTypes": [{"type": "string",
"bigDataStoreageTypes": [["hive",
"hbase"
]
]
}
]
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update Data Set Flow

Modify data set flow information of water resource data.

path Parameters

datasetId

required

string

Example: dataset001

Request Body schema: application/json

description	string
historyStoreType required	string
enabled required	boolean
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"historyStoreType": "partial, full, all",
"enabled": true,
"targetTypes": [{"type": "string",
"bigDataStoreageTypes": [["hive",
"hbase"
]
]
}
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete Data Set Flow

Delete data set flow information of water resource data.

path Parameters

datasetId

required

string

Example: dataset001

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Data Set Flow

Individually inquire data set flow information of water resource data.

path Parameters

datasetId

required

string

Example: dataset001

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

provision transfer

provides the ability to manage data provision

Create Data Model Provision

Data model creation/modification/deletion events are transmitted based on provision server information.

Request Body schema: application/json

requestId required	string
eventTime required	string
to required	string
eventType required	string
required	object (dataModelProvisionAttributes)

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"eventTime": "string",
"to": "/datamodels/{id}",
"eventType": "created, updated, deleted",
"data": {"id": "string",
"type": "string",
"name": "string",
"context": ["string"
],
"description": "string",
"indexAttributeNames": ["string"
],
"attributes": [{ }
]
}
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update Data Set Provision

Data set creation/modification/deletion event is transmitted based on provision server information.

Request Body schema: application/json

requestId required	string
eventTime required	string
to required	string
eventType required	string
required	object (DataSet)

Responses

Request samples

Payload

Content type

application/json

{"requestId": "string",
"eventTime": "string",
"to": "/datasets",
"eventType": "created",
"data": {"id": "dataset001",
"name": "Daegu",
"description": "Daegu",
"updateInterval": "31th 00:00",
"category": "X01",
"providerOrganization": "Daegu",
"providerSystem": "Daegu",
"isProcessed": "D001",
"ownership": "Daegu",
"keywords": [["BUS",
"AIR"
]
],
"license": "L001",
"providingApiUri": "https://ww.data.go.kr/dataset/3078089/fileData.do",
"restrictions": "Change throughout the year",
"datasetExtension": "XML, CSV",
"datasetItems": "Bus Number",
"targetRegions": "Nationwide",
"sourceDatasetIds": [["Daegu City Population in 2018"
]
],
"dataStoreUri": ["string"
],
"qualityCheckEnabled": true,
"dataIdentifierType": "daeguBus",
"datamodelId": "primerCustomer"
}
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

data ingest

provides the ability to manage data ingest

Create or update a bundled entity

It is an HTTP interface that receives water resource data in a bundle and creates or updates it. The received data performs a quality check and returns the quality check result. - If URI QueryString options is 'update', it means Partial Upsert - If URI QueryString options is 'replace' or 'null', it means Full Upsert

Request Body schema: application/json

datasetId required	string
entities required	Array of objects (Entity)

Responses

Request samples

Payload

Content type

application/json

{"datasetId": "be1853c7-4906-4fb0-b9c6-d547426eb7e5",
"entities": [{ }
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update a bundled entity

Request Body schema: application/json

datasetId required	string
entities required	Array of objects (Entity)

Responses

Request samples

Payload

Content type

application/json

{"datasetId": "be1853c7-4906-4fb0-b9c6-d547426eb7e5",
"entities": [{ }
]
}

Response samples

400

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete data collection bundle entities

Request Body schema: application/json

datasetId required	string
required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"datasetId": "be1853c7-4906-4fb0-b9c6-d547426eb7e5",
"entities": [{"id": "urn:datahub:OffStreetParking:yatap_01"
}
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

verification history

provides the ability to manage verification history

Quality verification history inquiry

Inquire the history of quality inspections performed on water resource data.

query Parameters

startTime required	string Example: startTime=2020-01-01 00:00:00
endTime required	string Example: endTime=2021-01-02 00:00:00
datasetId	string
dataModelType	string
dataModelNamespace	string
dataModelVersion	string
entityId	string
isVerified	boolean
smartSearchValue	string
limit	integer
offset	integer

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Individual inquiry of quality verification history

Inquire individual history of quality inspection performed on water resource data.

path Parameters

seq

required

number

Example: 211

Responses

Response samples

200
400
500

Content type

application/json

{"seq": 0,
"testTime": "string",
"datasetId": "string",
"dataModelType": "string",
"dataModelVersion": "string",
"entityId": "string",
"isVerified": true,
"errorCode": "string",
"errorCause": "string",
"data": "string"
}

Query the number of cases by quality verification history result (success/failure)

Inquire the number of successes/failures of quality inspections performed on water resource data.

query Parameters

startTime required	string Example: startTime=2020-01-01 00:00:00
endTime required	string Example: endTime=2021-01-02 00:00:00
datasetId	string
dataModelType	string
dataModelNamespace	string
dataModelVersion	string
entityId	string
smartSearchValue	string

Responses

Response samples

200
400
500

Content type

application/json

{"successCount": 0,
"failureCount": 0
}

external platform authentication

provides the ability to manage external platform authentication

Generate external platform authentication

Generate authentication information of external interworking platform.

Request Body schema: application/json

id required	string
name required	string
description	string
receptionIps required	Array of strings
receptionDatasetIds required	Array of strings
dataInstancePrefix	string
receptionClientIds required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "KETI",
"description": "aabb",
"receptionIps": ["127.0.0.1"
],
"receptionDatasetIds": [["dataset001",
"dataset002"
]
],
"dataInstancePrefix": "dataInstancePrefix_1",
"receptionClientIds": [["xMXQN15EuVUWmrzxDwy1",
"BezLYnWjKXODd7jErzty"
]
]
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

See all external platform certifications

Inquires the entire list of authentication information of external interworking platforms.

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

External platform authentication modification

Modify the authentication information of the external interworking platform.

path Parameters

id

required

string

Example: cityhub10

Request Body schema: application/json

name required	string
description	string
receptionIps	Array of strings
receptionDatasetIds	Array of strings
dataInstancePrefix	string
receptionClientIds	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "KETI",
"description": "aabb",
"receptionIps": ["127.0.0.1"
],
"receptionDatasetIds": [["dataset001",
"dataset002"
]
],
"dataInstancePrefix": "dataInstancePrefix_1",
"receptionClientIds": [["xMXQN15EuVUWmrzxDwy1",
"BezLYnWjKXODd7jErzty"
]
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete external platform authentication

Delete the authentication information of the external interworking platform.

path Parameters

id

required

string

Example: cityhub10

Responses

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Individual inquiry of external platform certification

Individually inquires the authentication information of the external interworking platform.

path Parameters

id

required

string

Example: cityhub10

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

context source registration

provides the ability to manage context source registration

Create context source registration

Request Body schema: application/json

id	string
type required	string
name	string
description	string
required	Array of objects
	object
managementInterval	object
	object
observationSpace	object
operationSpace	object
expires	string
endpoint required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "ContextSourceRegistration",
"name": "string",
"description": "string",
"information": [{"entities": [{"id": "urn:datahub:OffStreetParking:yatap_01",
"type": "kr.citydatahub.OffStreetParking:1.0"
}
],
"properties": [["address",
"streedAddress"
]
],
"relationships": [["inAccident"
]
]
}
],
"observationInterval": {"start": "2020-11-17T20:48:09,290+09:00"
},
"managementInterval": { },
"location": {"type": "GeoProperty",
"value": {"type": "MultiPolygon",
"coordinates": [[127.11132,
37.393653
]
]
}
},
"observationSpace": { },
"operationSpace": { },
"expires": "string",
"endpoint": "http://my.csource.org:1026"
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retreive all context source

query Parameters

id	Array of strings Example: id=urn:datahub:OffStreetParking:yatap_01
type	string
idPattern	string Example: idPattern=.*47
attrs	Array of strings Example: attrs=address
q	string
csf	string
georel	string Example: georel=near;maxDistance==500
geometry	string
coordinates	string Example: coordinates=[[[127.108712213155,37.4039308909918], [127.10871370495,37.4038047517174], [127.109571955085,37.403820218985], [127.109569815879,37.4030452782807], [127.112506377227,37.4030583117045], [127.11267716721,37.4029424517435], [127.112700664842,37.3999870997203], [127.112644515041,37.3999596467278], [127.10677152971,37.3999425268874], [127.106612244893,37.4000404436483], [127.105312496268,37.4029681361633], [127.105390591903,37.4030498229114], [127.10655398512,37.4030495953737], [127.10653318449,37.403851395132], [127.106645485308,37.403906306877], [127.108712213155,37.4039308909918]]]
geoproperty	string Example: geoproperty=location
timeproperty	string Example: timeproperty=observationInterval
timerel	string Example: timerel=between
time	string Example: time=2018-01-08T05:09:55+09:00
endtime	string Example: endtime=2029-08-15T04:22:58Z

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update context source registration

path Parameters

registrationId

required

string

Example: urn:ngsi-ld:ContextSourceRegistration:yatap_01

Request Body schema: application/json

id	string
type required	string
name	string
description	string
required	Array of objects
	object
managementInterval	object
	object
observationSpace	object
operationSpace	object
expires	string
endpoint required	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "ContextSourceRegistration",
"name": "string",
"description": "string",
"information": [{"entities": [{"id": "urn:datahub:OffStreetParking:yatap_01",
"type": "kr.citydatahub.OffStreetParking:1.0"
}
],
"properties": [["address",
"streedAddress"
]
],
"relationships": [["inAccident"
]
]
}
],
"observationInterval": {"start": "2020-11-17T20:48:09,290+09:00"
},
"managementInterval": { },
"location": {"type": "GeoProperty",
"value": {"type": "MultiPolygon",
"coordinates": [[127.11132,
37.393653
]
]
}
},
"observationSpace": { },
"operationSpace": { },
"expires": "string",
"endpoint": "http://my.csource.org:1026"
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete context source registration

path Parameters

registrationId

required

string

Example: urn:ngsi-ld:ContextSourceRegistration:yatap_01

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retreive the context source

path Parameters

registrationId

required

string

Example: urn:ngsi-ld:ContextSourceRegistration:yatap_01

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

context source registration subscription

provides the ability to manage context source registration subscription

Create context source registration

Request Body schema: application/json

id	string
type required	string
name	string
description	string
	Array of objects
watchedAttributes	Array of strings
timeInterval	integer
q	string
geoQ	string
csf	string
isActive	boolean
required	object
expires	string
throttling	integer
temporalQ	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"id": "urn:ngsi-ld:CsourceRegistrationSubscription:myCsourceRegistrationSubscription",
"type": "Subscription",
"name": "string",
"description": "string",
"entities": [{"id": "urn:datahub:OffStreetParking:yatap_01",
"type": "kr.citydatahub.OffStreetParking:1.0"
}
],
"watchedAttributes": [["address"
]
],
"timeInterval": 0,
"q": "string",
"geoQ": "near;maxDistance==2000",
"csf": "string",
"isActive": true,
"notification": {"attributes": [["speed"
]
],
"format": "normalized",
"endpoint": {"uri": "http://my.endpoint.org/notify",
"accept": "application/json"
}
},
"expires": "2021-11-15T20:10:00,000+09:00",
"throttling": 0,
"temporalQ": "string",
"status": "string"
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retreive all context source

query Parameters

limit

integer

Example: limit=2

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update context source registration

path Parameters

subscriptionId

required

string

Example: urn:ngsi-ld:CsourceRegistrationSubscription:myCsourceRegistrationSubscription

Request Body schema: application/json

id	string
type required	string
name	string
description	string
	Array of objects
watchedAttributes	Array of strings
timeInterval	integer
q	string
geoQ	string
csf	string
isActive	boolean
required	object
expires	string
throttling	integer
temporalQ	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"id": "urn:ngsi-ld:CsourceRegistrationSubscription:myCsourceRegistrationSubscription",
"type": "Subscription",
"name": "string",
"description": "string",
"entities": [{"id": "urn:datahub:OffStreetParking:yatap_01",
"type": "kr.citydatahub.OffStreetParking:1.0"
}
],
"watchedAttributes": [["address"
]
],
"timeInterval": 0,
"q": "string",
"geoQ": "near;maxDistance==2000",
"csf": "string",
"isActive": true,
"notification": {"attributes": [["speed"
]
],
"format": "normalized",
"endpoint": {"uri": "http://my.endpoint.org/notify",
"accept": "application/json"
}
},
"expires": "2021-11-15T20:10:00,000+09:00",
"throttling": 0,
"temporalQ": "string",
"status": "string"
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete context source registration

path Parameters

subscriptionId

required

string

Example: urn:ngsi-ld:CsourceRegistrationSubscription:myCsourceRegistrationSubscription

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retreive the context source

path Parameters

subscriptionId

required

string

Example: urn:ngsi-ld:CsourceRegistrationSubscription:myCsourceRegistrationSubscription

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

entity

provides the ability to manage entity information

Create Entities

Request Body schema: application/json

object (Entity)

NGSI-LD entity defined in ETSI GS CIM 009

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

400
409
422

Content type

application/json

null

Query Entities

Get Entities. When the request is successfully delivered to the server, the corresponding entities are returned.

query Parameters

id	string List of entity ids to be retrieved
type	string Example: type=OffStreetParking List of entity types to be retrieved
idPattern	string Regular expression that shall be matched by entity ids
attrs	string List of Attributes (Properties or Relationships) to be retrieved
q	string Example: q=paymentAccepted.relationTest=="aaa";locationTag=="commercial" Query
csf	string Context Source filter
geometry	string Geometry
georel	string Geo relationship
coordinates	string Coordinates serialized
geoproperty	string The name of the Property that contains the geospatial data that will be used to resolve the geoquery.
geometryProperty	string Coordinates serialized
lang	string Coordinates serialized
scopeQ	string Coordinates serialized

Responses

Response samples

400

Content type

application/json

null

Retrieve Entity

path Parameters

entityId

required

string

Example: urn:datahub:OffStreetParking:yatap_01

Entity ID

query Parameters

attrs	string List of Attributes to be retrieved. If not specified, all Attributes related to the entity shall be retrieved
geometryProperty	string
lang	string

Responses

Response samples

400
404

Content type

application/json

null

Delete Entity

path Parameters

entityId

required

string

Entity ID

Responses

Response samples

400
404

Content type

application/json

null

retrieve Temporal Representation of an Entity

path Parameters

entityId

required

string

List of entity ids to be retrieved

Responses

Response samples

400
404

Content type

application/json

null

attribute

provides the ability to manage attribute information

Create Entity Attributes

path Parameters

entityId

required

string

Entity ID

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"attributeName": "name"
}

Response samples

400
404

Content type

application/json

null

Update Entity Attributes

Entity Fragment containing a complete representation of the Attributes to be updated.

path Parameters

entityId

required

string

Entity ID

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"attributeName": "name"
}

Response samples

400
404

Content type

application/json

null

Update Entity Attribute

Entity Fragment containing the elements of the attribute to be updated.

path Parameters

entityId required	string Entity ID
attrId required	string Attributes ID

Request Body schema: application/json

required

object

Responses

Request samples

Payload

Content type

application/json

{"attributeName": "name"
}

Response samples

400
404

Content type

application/json

null

Delete Entity Attribute

path Parameters

entityId required	string Entity ID
attrId required	string Attributes ID

Responses

Response samples

400
404

Content type

application/json

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

subscription

provides the ability to manage subscription information

Create Entities

Request Body schema: application/json

type required	string
	object
watchedAttributes	Array of strings Items Value: "attributeName"
q	string
	object
isActive	boolean
	object
expires	string

Responses

Request samples

Payload

Content type

application/json

{"type": "Subscription",
"entities": {"type": "OffStreetParking"
},
"watchedAttributes": ["attributeName"
],
"q": "speed>50",
"geoQ": {"georel": "near;maxDistance==2000",
"geometry": "Point",
"coordinates": ["Latitude"
]
},
"isActive": false,
"notification": {"attributes": ["attributeName"
],
"format": "normalized",
"endpoint": {"uri": "http://my.endpoint.org/notify",
"accept": "application/json"
}
},
"expires": "2020-11-15T20:10:00,000+09:00"
}

Response samples

400
409

Content type

application/json

null

Query Subscription

query Parameters

limit

string

Example: limit=2

Responses

Response samples

400

Content type

application/json

null

Retrieve Subscription

Get Subscription by ID

path Parameters

subscriptionId

required

string

Subscription ID

Responses

Response samples

400
404

Content type

application/json

null

Update Subscription

Entity Fragment containing the elements of the attribute to be updated.

path Parameters

subscriptionId

required

string

Subscription ID

Request Body schema: application/json

type required	string
	object
watchedAttributes	Array of strings Items Value: "attributeName"
q	string
	object
isActive	boolean
	object
expires	string

Responses

Request samples

Payload

Content type

application/json

{"type": "Subscription",
"entities": {"type": "OffStreetParking"
},
"watchedAttributes": ["attributeName"
],
"q": "speed>50",
"geoQ": {"georel": "near;maxDistance==2000",
"geometry": "Point",
"coordinates": ["Latitude"
]
},
"isActive": false,
"notification": {"attributes": ["attributeName"
],
"format": "normalized",
"endpoint": {"uri": "http://my.endpoint.org/notify",
"accept": "application/json"
}
},
"expires": "2020-11-15T20:10:00,000+09:00"
}

Response samples

400
404

Content type

application/json

null

Delete subscription

Delete Subscription

path Parameters

subscriptionId

required

string

Subscription ID

Responses

Response samples

400
404

Content type

application/json

null

temporal

provides the ability to manage temporal operation

Temporal Query Entities

query Parameters

id	string List of entity ids to be retrieved
type	string Example: type=OffStreetParking List of entity types to be retrieved
idPattern	string Regular expression that shall be matched by entity ids
attrs	string List of Attributes (Properties or Relationships) to be retrieved
q	string Example: q=paymentAccepted.relationTest=="aaa";locationTag=="commercial" Query
csf	string Context Source filter
georel	string Geo relationship
geometry	string Geometry
coordinates	string Coordinates serialized
geoproperty	string The name of the Property that contains the geospatial data that will be used to resolve the geoquery.
timeproperty	string The name of the Property that contains the temporal data that will be used to resolve the temporal query.
timerel	string Allowed values: "before", "after", "between"
time	string It shall be a DateTime
endTime	string It shall be a DateTime. Cardinality shall be 1 if timerel is equal to "between"
lastN	string Only the last n instances, per Attribute, per Entity (under the specified time interval) shall be retrieved

Responses

Response samples

400
422

Content type

application/json

null

multi tenants management

Create multi tenants rule

Request Body schema: application/json

id	string
userId required	string
clientId required	string
resourceId required	string
resourceType required	string
condition required	string
createDatetime	string
creatorId	string
modifyDatename	string
modifierId	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"userId": "string",
"clientId": "string",
"resourceId": "string",
"resourceType": "string",
"condition": "string",
"createDatetime": "string",
"creatorId": "string",
"modifyDatename": "string",
"modifierId": "string"
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve multi tenants rule

search multi tenants rule

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update multi tenants rule

path Parameters

id

required

string

Request Body schema: application/json

id	string
userId required	string
clientId required	string
resourceId required	string
resourceType required	string
condition required	string
createDatetime	string
creatorId	string
modifyDatename	string
modifierId	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"userId": "string",
"clientId": "string",
"resourceId": "string",
"resourceType": "string",
"condition": "string",
"createDatetime": "string",
"creatorId": "string",
"modifyDatename": "string",
"modifierId": "string"
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete multi tenants rule

path Parameters

id

required

string

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve multi tenants rule

Individually search multi tenants rule

path Parameters

id

required

string

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Csource Notification behavior

cSourceRegistration Notification URI

path Parameters

cSourceRegistrationNotificationURI

required

string

Example: endpoint when subsciption is entered

Request Body schema: application/json

attributes	Array of strings
format	string
endpoint	object
status	string

Responses

Request samples

Payload

Content type

application/json

{"attributes": ["Entity Attribute Names"
],
"format": "Entity representation",
"endpoint": "Notification endpoint description",
"status": "notification status"
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Service Excutor URI

path Parameters

serviceExcutorURI

required

string

Example: serviceExecutorURI

Request Body schema: application/json

id required	string
name required	string
entityId required	string
entityType	string
required	Array of objects (serviceExcutorAttr)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"entityId": "string",
"entityType": "string",
"attribs": [{"attribname": "string",
"value": { }
}
]
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Service Management

Create a Service

Request Body schema: application/json

id	string
type required	string
name	string
description	string
information required	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "ServiceRegistration",
"name": "string",
"description": "string",
"information": { }
}

Response samples

400
409
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve All Service

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Update a Service

path Parameters

id

required

string

Example: urn:ngsi-ld:serviceRegistration:csr800949

Request Body schema: application/json

id	string
type required	string
name	string
description	string
information required	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"type": "ServiceRegistration",
"name": "string",
"description": "string",
"information": { }
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Delete a Service

path Parameters

id

required

string

Example: urn:ngsi-ld:serviceRegistration:csr800949

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Retrieve Each Service

path Parameters

id

required

string

Example: urn:ngsi-ld:serviceRegistration:csr800949

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Service Mangement

Execute a Service

Request Body schema: application/json

id	string
serviceRegistrationId required	string
type required	string
executions required	object

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"serviceRegistrationId": "string",
"type": "ServiceRegistration",
"executions": { }
}

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Service Execution Status

Retrieve Service Execution Status

path Parameters

serviceId

required

string

Example: urn:ngsi-ld:serviceRegistration:csr800949

Responses

Response samples

400
500

Content type

application/json

Example

Error400

{"type": "https://uri.etsi.org/ngsi-ld/errors/BadRequestData",
"title": "BadRequestData",
"detail": "not a valid JSON document"
}

Entity Types and Attribute Relationship

Retrieve Available Entity Types

query Parameters

details

boolean

Example: details=true

header Parameters

Link	string Example: <http://example.org/ngsi-ld/latest/aggregatedContext.jsonld>

Responses

Response samples

200
400
500

Content type

application/json

"OK"

Retrieve Available Entity Type Information

path Parameters

type

required

string

header Parameters

Link	string Example: <http://example.org/ngsi-ld/latest/aggregatedContext.jsonld>

Responses

Response samples

200
400
500

Content type

application/json

"OK"

Retrieve Available Attributes

query Parameters

details

boolean

Example: details=true

header Parameters

Link	string Example: <http://example.org/ngsi-ld/latest/aggregatedContext.jsonld>

Responses

Response samples

201
400
500

Content type

application/json

"CREATED"

Retrieve Available Attribute Information

path Parameters

attrId

required

string

Responses

Response samples

200
400
409
500

Content type

application/json

"CREATED"