UrbanMind JSON API (1.0.0)

Download OpenAPI specification:

This is the OpenAPI specification for the UrbanMind JSON API.

Returns the health status of the service.

Authorizations:

None

Responses

Response samples

500
default

Content type

application/json

{"message": "string"
}

Retrieve distribution data

Downloads the data associated with the given distribution ID. This endpoint is similar to the one used by the HTML UI but is intended for programmatic use. Requires a valid bearer token and X-Participant-ID header for authentication.

Authorizations:

bearerAuth

path Parameters

id

required

string <uuid>

UUID in path

header Parameters

X-Participant-ID

required

string <uuid>

UUID of the participant making the request. This header is used to identify which participant's OpenID Connect configuration should be used for token validation.

Responses

Response samples

401
404
default

Content type

application/json

{"message": "string"
}

Context Information Consumption

Query entities

5.7.2 Query Entities (excluding batch entity queries).

This operation allows querying an NGSI-LD system.

Authorizations:

None

query Parameters

id	Array of strings List of entity IDs to filter
type	Array of strings List of entity types to filter
idPattern	string Regular expression pattern for entity IDs
attrs	Array of strings List of attribute names to include
pick	Array of strings List of attribute names to pick
omit	Array of strings List of attribute names to omit
q	string Query string
csf	string Context source filter
geometry	string Geometry type
georel	string Geospatial relationship
coordinates	string Coordinates for geospatial query
geoproperty	string Geospatial property
geometryProperty	string Geometry property
lang	string Language
scopeQ	string Scope query
containedBy	string Contained by
join	string Join
joinLevel	string Join level
datasetId	string Dataset ID
entityMap	string Entity map
limit	integer Limit
count	boolean Count
options	string Options for entities
format	string Format for entities
local	boolean Local query

header Parameters

NGSILD-EntityMap	string <uri> If present, the EntityMap supplied is used for determining the set of Entities requested during the query operation. The location of the EntityMap used in the query/retrieval operation is returned in the response.
Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400
501

Content type

application/json

[{"id": "string",
"type": "string"
}
]

Entity retrieval by id

5.7.1 Retrieve Entity.

This operation allows retrieving an NGSI-LD Entity.

Authorizations:

None

path Parameters

entityId

required

string

Entity identifier

query Parameters

type	Array of strings List of entity types to filter
attrs	Array of strings List of attribute names to include
pick	Array of strings List of attribute names to pick
omit	Array of strings List of attribute names to omit
geometryProperty	string Geometry property
lang	string Language
containedBy	string Contained by
join	string Join
joinLevel	string Join level
datasetId	string Dataset ID
entityMap	string Entity map
options	string Options for entities
format	string Format for entities
local	boolean Local query

header Parameters

NGSILD-EntityMap	string <uri> If present, the EntityMap supplied is used for determining the set of Entities requested during the query operation. The location of the EntityMap used in the query/retrieval operation is returned in the response.
Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400
404
501

Content type

application/json

{"id": "string",
"type": "string"
}

Retrieve available entity types

5.7.5 Retrieve Available Entity Types.

This operation allows retrieving a list of NGSI-LD entity types for which entity instances exist within the NGSI-LD system.

5.7.6 Retrieve Details of Available Entity Types.

This operation allows retrieving a list with a detailed representation of NGSI-LD entity types for which entity instances exist within the NGSI-LD system.

Authorizations:

None

query Parameters

details	boolean If true, then detailed entity type information represented as an array with elements of the Entity Type data structure (clause 5.2.25) is to be returned.
local	boolean Local query

header Parameters

Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400

Content type

application/json

Example

EntityTypeList

{"id": "http://example.com",
"type": "EntityTypeList",
"typeList": ["string"
]
}

Details about available entity type

5.7.7 Retrieve Available Entity Type information.

This operation allows retrieving detailed entity type information about a specified NGSI-LD entity type for which entity instances exist within the NGSI-LD system. The detailed representation includes the type name (as short name if available in the provided @context), the count of available entity instances and details about attributes that existing instances of this entity type have, including their name (as short name if available in the provided @context) and a list of types the attribute can have (e.g. Property, Relationship or GeoProperty).

Authorizations:

None

path Parameters

type

required

string <uri> (Path)

Name of the entity type for which detailed information is to be retrieved. The Fully Qualified Name (FQN) as well as the short name can be used, given that the latter is part of the JSON-LD @context provided.

query Parameters

local

boolean

Local query

header Parameters

Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400
404

Content type

application/json

{"id": "http://example.com",
"type": "EntityTypeInfo",
"typeName": "string",
"entityCount": 0,
"attributeDetails": [{"id": "http://example.com",
"type": "Attribute",
"attributeName": "string",
"attributeTypes": ["string"
],
"typeNames": ["string"
]
}
]
}

Available attributes

5.7.8 Retrieve Available Attributes.

This operation allows retrieving a list of NGSI-LD attributes that belong to entity instances existing within the NGSI- LD system.

5.7.9 Retrieve Details of Available Attributes.

This operation allows retrieving a list with a detailed representation of NGSI-LD attributes that belong to entity instances existing within the NGSI-LD system.

Authorizations:

None

query Parameters

details	boolean If true, then detailed attribute information represented as an array with elements of the Attribute data structure (clause 5.2.28) is to be returned.
local	boolean Local query

header Parameters

Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400

Content type

application/json

Example

AttributeList

{"id": "http://example.com",
"type": "AttributeList",
"attributeList": ["string"
]
}

Details about available attribute

5.7.10 Retrieve Available Attribute Information.

This operation allows retrieving detailed attribute information about a specified NGSI-LD attribute that belongs to entity instances existing within the NGSI-LD system. The detailed representation includes the attribute name (as short name if available in the provided @context) and the type names for which entity instances exist that have the respective attribute, a count of available attribute instances and a list of types the attribute can have (e.g. Property, Relationship or GeoProperty).

Authorizations:

None

path Parameters

attrId

required

string <uri> (Path)

Name of the attribute for which detailed information is to be retrieved. The Fully Qualified Name (FQN) as well as the short name can be used, given that the latter is part of the JSON-LD @context provided.

query Parameters

local

boolean

Local query

header Parameters

Link	string <uri> 6.3.5 JSON-LD @context resolution In summary, from a developer's perspective, for POST, PATCH and PUT operations, if MIME type is "application/ld+json", then the associated @context shall be provided only as part of the request payload body. Likewise, if MIME type is "application/json", then the associated @context shall be provided only by using the JSON-LD Link header. No mixes are allowed, i.e. mixing options shall result in HTTP response errors. Implementations should provide descriptive error messages when these situations arise. In contrast, GET and DELETE operations always take their input @context from the JSON-LD Link Header.
NGSILD-Tenant	string 6.3.14 Tenant specification. The tenant to which the NGSI-LD HTTP operation is targeted.
Via	string 6.3.18 Limiting Distributed Operations If present, the listing of previously encountered Context Sources supplied is used when determining matching registrations. HTTP Via Header (IETF RFC 7230). Any Context Broker implementation passing a distributed operation request onward to another Context Source shall send an additional field value on the Via header field using its own unique Context Source "hostAlias" (see clause 5.2.40) as the pseudonym.
Accept	string

Responses

Response samples

200
400
404

Content type

application/json

{"id": "http://example.com",
"type": "Attribute",
"attributeName": "string",
"attributeTypes": ["string"
],
"typeNames": ["string"
]
}