Skip to main content
API docs by Redocly

ETSI ISG CIM / NGSI-LD API (latest)

Download OpenAPI specification:Download

E-mail: NGSI-LD@etsi.org

This OAS file describes the NGSI-LD API defined by the ETSI ISG CIM group. This Cross-domain Context Information Management API allows to provide, consume and subscribe to context information in multiple scenarios and involving multiple stakeholders

Find out more about the ETSI ISG Context Information Management

ETSI

European Telecommunications Standards Institute

Find out more

CIM

Context Information Management

Find out more

JSON-LD

JSON for Linked Data

Find out more

NGSI-LD API

API defined by the ETSI ISG CIM

Preliminary Specification

Context Information

queryEntities

Retrieve a set of entities which matches a specific query from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

csf
string non-empty

Context Source Filter

limit
integer >= 1

Pagination limit

options
string
Enum: "keyValues" "sysAttrs"

Options dictionary

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createEntity

Create a new Entity within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveEntityById

Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

options
string
Enum: "keyValues" "sysAttrs"

Options dictionary

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

removeEntityById

Removes an specific Entity from an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

Responses

Response samples

Content type
application/json;application/ld+json
{}

appendEntityAttrs

Append new Entity attributes to an existing Entity within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
options
string
Value: "noOverwrite"

Indicates that no attribute overwrite shall be performed

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{
  • "updated": [
    ],
  • "notUpdated": [
    ]
}

updateEntityAttrs

Update existing Entity attributes within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{
  • "updated": [
    ],
  • "notUpdated": [
    ]
}

partialAttrUpdate

Update existing Entity attributes within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityAttr

Removes an existing Entity attribute within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

Entities

queryEntities

Retrieve a set of entities which matches a specific query from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

csf
string non-empty

Context Source Filter

limit
integer >= 1

Pagination limit

options
string
Enum: "keyValues" "sysAttrs"

Options dictionary

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createEntity

Create a new Entity within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveEntityById

Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

options
string
Enum: "keyValues" "sysAttrs"

Options dictionary

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

removeEntityById

Removes an specific Entity from an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

Responses

Response samples

Content type
application/json;application/ld+json
{}

appendEntityAttrs

Append new Entity attributes to an existing Entity within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
options
string
Value: "noOverwrite"

Indicates that no attribute overwrite shall be performed

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{
  • "updated": [
    ],
  • "notUpdated": [
    ]
}

updateEntityAttrs

Update existing Entity attributes within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{
  • "updated": [
    ],
  • "notUpdated": [
    ]
}

partialAttrUpdate

Update existing Entity attributes within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": {
    },
  • "property2": {
    }
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityAttr

Removes an existing Entity attribute within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

batchEntityCreation

Batch Entity creation

Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityUpdate

Batch Entity update

query Parameters
options
string
Value: "noOverwrite"
Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityUpsert

Batch Entity upsert

query Parameters
options
string
Enum: "replace" "update"
Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityDelete

Batch Entity delete

Request Body schema: application/json;application/ld+json
required
Array (non-empty)
string <uri>

Responses

Request samples

Content type
application/json;application/ld+json
[]

Response samples

Content type
application/json;application/ld+json
{}

Context Subscription

retrieveSubscriptions

Retrieves the subscriptions available in an NGSI-LD system

query Parameters
limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createSubscription

Creates a new Subscription within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
Any of
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string
id
required
string <uri>
type
required
string
Value: "Subscription"
required
object (NotificationParams)
status
string
Enum: "active" "paused" "expired"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveSubscriptionById

Retrieves a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

updateSubscription

Updates a specific Subscription within an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string"
}

Response samples

Content type
application/json;application/ld+json
{}

removeSubscription

Removes a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

Subscriptions

retrieveSubscriptions

Retrieves the subscriptions available in an NGSI-LD system

query Parameters
limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createSubscription

Creates a new Subscription within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
Any of
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string
id
required
string <uri>
type
required
string
Value: "Subscription"
required
object (NotificationParams)
status
string
Enum: "active" "paused" "expired"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveSubscriptionById

Retrieves a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

updateSubscription

Updates a specific Subscription within an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string"
}

Response samples

Content type
application/json;application/ld+json
{}

removeSubscription

Removes a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

Context Sources

queryCsources

Retrieve a set of context sources which matches a specific query from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[]

registerCsource

Registers a new context source within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (RegistrationInfo) non-empty
object (TimeInterval)
object (TimeInterval)
Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

expires
string <date-time>
name
string non-empty
description
string non-empty
endpoint
required
string <uri>
id
required
string <uri>
type
required
string
Value: "ContextSourceRegistration"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
property name*
additional property
any

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "information": [
    ],
  • "observationInterval": {
    },
  • "managementInterval": {
    },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "endpoint": "http://example.com",
  • "id": "http://example.com",
  • "type": "ContextSourceRegistration",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveCsource

Retrieves a specific context source registration from an NGSI-LD system

path Parameters
registrationId
required
string <uri>

Registration Id

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "information": [
    ],
  • "observationInterval": {
    },
  • "managementInterval": {
    },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "endpoint": "http://example.com",
  • "id": "http://example.com",
  • "type": "ContextSourceRegistration",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

removeCsource

Removes an specific context source registration within an NGSI-LD system

path Parameters
registrationId
required
string <uri>

Registration Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

retrieveCSourceSubscriptions

Retrieves the context source discovery subscriptions available in an NGSI-LD system

query Parameters
limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createCSourceSubscription

Creates a context source discovery Subscription within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
Any of
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string
id
required
string <uri>
type
required
string
Value: "Subscription"
required
object (NotificationParams)
status
string
Enum: "active" "paused" "expired"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveCSourceSubscriptionsById

Retrieves a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

updateCSourceSubscription

Updates a specific context source discovery Subscription within an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string"
}

Response samples

Content type
application/json;application/ld+json
{}

removeCSourceSubscription

Removes a specific Context Source Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

CSourceRegistrations

queryCsources

Retrieve a set of context sources which matches a specific query from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[]

registerCsource

Registers a new context source within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (RegistrationInfo) non-empty
object (TimeInterval)
object (TimeInterval)
Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

Point (object) or MultiPoint (object) or Polygon (object) or LineString (object) or MultiLineString (object) or MultiPolygon (object) (Geometry)

Avalid GeoJSON geometry object

expires
string <date-time>
name
string non-empty
description
string non-empty
endpoint
required
string <uri>
id
required
string <uri>
type
required
string
Value: "ContextSourceRegistration"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
property name*
additional property
any

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "information": [
    ],
  • "observationInterval": {
    },
  • "managementInterval": {
    },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "endpoint": "http://example.com",
  • "id": "http://example.com",
  • "type": "ContextSourceRegistration",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveCsource

Retrieves a specific context source registration from an NGSI-LD system

path Parameters
registrationId
required
string <uri>

Registration Id

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "information": [
    ],
  • "observationInterval": {
    },
  • "managementInterval": {
    },
  • "location": {
    },
  • "observationSpace": {
    },
  • "operationSpace": {
    },
  • "expires": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "description": "string",
  • "endpoint": "http://example.com",
  • "id": "http://example.com",
  • "type": "ContextSourceRegistration",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

removeCsource

Removes an specific context source registration within an NGSI-LD system

path Parameters
registrationId
required
string <uri>

Registration Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

CSourceSubscriptions

retrieveCSourceSubscriptions

Retrieves the context source discovery subscriptions available in an NGSI-LD system

query Parameters
limit
integer >= 1

Pagination limit

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createCSourceSubscription

Creates a context source discovery Subscription within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
Any of
object or string or (Array of strings or objects) (LdContext)
required
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string
id
required
string <uri>
type
required
string
Value: "Subscription"
required
object (NotificationParams)
status
string
Enum: "active" "paused" "expired"
createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveCSourceSubscriptionsById

Retrieves a specific Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string",
  • "id": "http://example.com",
  • "type": "Subscription",
  • "notification": {
    },
  • "status": "active",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z"
}

updateCSourceSubscription

Updates a specific context source discovery Subscription within an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (EntityInfo) non-empty
name
string non-empty
description
string non-empty
watchedAttributes
Array of strings (Name) non-empty unique [^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...]
timeInterval
number >= 0
expires
string <date-time>
isActive
boolean
throttling
number >= 1
q
string
object (GeoQuery)
csf
string

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "entities": [],
  • "name": "string",
  • "description": "string",
  • "watchedAttributes": [
    ],
  • "timeInterval": 0,
  • "expires": "2019-08-24T14:15:22Z",
  • "isActive": true,
  • "throttling": 1,
  • "q": "string",
  • "geoQ": {
    },
  • "csf": "string"
}

Response samples

Content type
application/json;application/ld+json
{}

removeCSourceSubscription

Removes a specific Context Source Subscription from an NGSI-LD system

path Parameters
subscriptionId
required
string <uri>

Subscription Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

Batch Operations

batchEntityCreation

Batch Entity creation

Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityUpdate

Batch Entity update

query Parameters
options
string
Value: "noOverwrite"
Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityUpsert

Batch Entity upsert

query Parameters
options
string
Enum: "replace" "update"
Request Body schema: application/json;application/ld+json
required
Array
object or string or (Array of strings or objects) (LdContext)
object (GeoProperty)
object (GeoProperty)
object (GeoProperty)
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Property (object) or Relationship (object) or GeoProperty (object)

Responses

Request samples

Content type
application/json;application/ld+json
[
  • {
    }
]

Response samples

Content type
application/json;application/ld+json
{}

batchEntityDelete

Batch Entity delete

Request Body schema: application/json;application/ld+json
required
Array (non-empty)
string <uri>

Responses

Request samples

Content type
application/json;application/ld+json
[]

Response samples

Content type
application/json;application/ld+json
{}

Temporal Evolution

queryTemporalEntities

Query temporal evolution of Entities from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

timerel
string (timerel)
Enum: "before" "after" "between"

Time relationship

timeproperty
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

The name of the property that contains the temporal data that will be used to resolve the temporal query

time
string <date-time>

start time for temporal query

endTime
string <date-time>

end time for temporal query

csf
string non-empty

Context Source Filter

limit
integer >= 1

Pagination limit

options
string
Enum: "temporalValues" "sysAttrs"

Options dictionary

lastN
integer >= 1

Only retrieve last N instances

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createUpdateEntityTemporal

Create or update temporal representation of an Entity within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveEntityTemporalById

Retrieve the temporal representation of an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

options
string
Enum: "temporalValues" "sysAttrs"

Options dictionary

timerel
string (timerel)
Enum: "before" "after" "between"

Time relationship

timeproperty
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

The name of the property that contains the temporal data that will be used to resolve the temporal query

time
string <date-time>

start time for temporal query

endTime
string <date-time>

end time for temporal query

lastN
integer >= 1

Only retrieve last N instances

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

removeEntityTemporalById

Removes the temporal representation of an Entity from an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

Responses

Response samples

Content type
application/json;application/ld+json
{}

addTemporalEntityAttrs

Add new attributes to an existing Temporal Entity within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityTemporalAttr

Attribute from Temporal Representation of Entity deletion

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

modifyEntityTemporalAttrInstance

Allows modifying a specific Attribute (Property or Relationship) instance, identified by its instanceId, of a Temporal Representation of an Entity.

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

instanceId
required
string <uri>

Instance Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityTemporalAttrInstance

Attribute Instance deletion by instance id.

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

instanceId
required
string <uri>

Instance Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

Temporal

queryTemporalEntities

Query temporal evolution of Entities from an NGSI-LD system

query Parameters
id
string <uri>

Comma separated list of URIs to be retrieved

idPattern
string <regexp>

Regular expression that must be matched by Entity ids

type
string non-empty

Comma separated list of Entity type names to be retrieved

attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

q
string non-empty

Query

string or string (georel)

Geo-relationship

geometry
string (geometry)
Enum: "Point" "MultiPoint" "LineString" "MultiLineString" "Polygon" "MultiPolygon"

Geometry

Array of position (numbers) or Array of positionArray (numbers) or Array of lineString (numbers) or Array of polygon (numbers) (coordinates)

Coordinates serialized as a string

geoproperty
string non-empty

The name of the property that contains the geo-spatial data that will be used to resolve the geoquery

timerel
string (timerel)
Enum: "before" "after" "between"

Time relationship

timeproperty
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

The name of the property that contains the temporal data that will be used to resolve the temporal query

time
string <date-time>

start time for temporal query

endTime
string <date-time>

end time for temporal query

csf
string non-empty

Context Source Filter

limit
integer >= 1

Pagination limit

options
string
Enum: "temporalValues" "sysAttrs"

Options dictionary

lastN
integer >= 1

Only retrieve last N instances

Responses

Response samples

Content type
application/json;application/ld+json
[
  • {
    }
]

createUpdateEntityTemporal

Create or update temporal representation of an Entity within an NGSI-LD system

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
required
string <uri>
type
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

retrieveEntityTemporalById

Retrieve the temporal representation of an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
attrs
string non-empty

Comma separated list of attribute names (properties or relationships) to be retrieved

type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

options
string
Enum: "temporalValues" "sysAttrs"

Options dictionary

timerel
string (timerel)
Enum: "before" "after" "between"

Time relationship

timeproperty
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

The name of the property that contains the temporal data that will be used to resolve the temporal query

time
string <date-time>

start time for temporal query

endTime
string <date-time>

end time for temporal query

lastN
integer >= 1

Only retrieve last N instances

Responses

Response samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

removeEntityTemporalById

Removes the temporal representation of an Entity from an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

query Parameters
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Entity Type

Responses

Response samples

Content type
application/json;application/ld+json
{}

addTemporalEntityAttrs

Add new attributes to an existing Temporal Entity within an NGSI-LD system

path Parameters
entityId
required
string <uri>

Entity Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityTemporalAttr

Attribute from Temporal Representation of Entity deletion

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

Responses

Response samples

Content type
application/json;application/ld+json
{}

modifyEntityTemporalAttrInstance

Allows modifying a specific Attribute (Property or Relationship) instance, identified by its instanceId, of a Temporal Representation of an Entity.

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

instanceId
required
string <uri>

Instance Id

Request Body schema: application/json;application/ld+json
required
object or string or (Array of strings or objects) (LdContext)
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
Array of objects (GeoProperty) non-empty
id
string <uri>
type
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

NGSI-LD Name

createdAt
string <date-time> (createdAt)
modifiedAt
string <date-time> (modifiedAt)
additional property
Array of Property (objects) or Array of Relationship (objects) or Array of GeoProperty (objects)

Responses

Request samples

Content type
application/json;application/ld+json
{
  • "@context": { },
  • "location": [
    ],
  • "observationSpace": [
    ],
  • "operationSpace": [
    ],
  • "id": "http://example.com",
  • "type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "property1": [
    ],
  • "property2": [
    ]
}

Response samples

Content type
application/json;application/ld+json
{}

removeEntityTemporalAttrInstance

Attribute Instance deletion by instance id.

path Parameters
entityId
required
string <uri>

Entity Id

attrId
required
string (Name) non-empty ^((\d|[a-zA-Z]|_)+(:(\d|[a-zA-Z]|_)+)?(#\d+)?...

Attribute Id

instanceId
required
string <uri>

Instance Id

Responses

Response samples

Content type
application/json;application/ld+json
{}