How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FIWARE Entities API

The Entities API from FIWARE — 11 operation(s) for entities.

FIWARE Entities API is one of 15 APIs that FIWARE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 20 operations across 11 paths, and defines 33 schemas. It is described by OpenAPI 3.0.3, at version latest.

20 operations 11 paths 33 schemas 3 DELETE5 GET3 PATCH8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
latest
Resource Areas
1

Paths & Operations 20

Across 11 paths, the API surfaces 20 operations — 3 DELETE, 5 GET, 3 PATCH, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Entities 20
GET
/entities/
Retrieve a set of entities which matches a specific query from an NGSI-LD system
queryEntities 12 params → 200400
POST
/entities/
Create a new Entity within an NGSI-LD system
createEntity body → 201400409422
GET
/entities/{entityId}
Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters
retrieveEntityById 4 params → 200400404
DELETE
/entities/{entityId}
Removes an specific Entity from an NGSI-LD system
removeEntityById 2 params → 204400404
POST
/entities/{entityId}/attrs/
Append new Entity attributes to an existing Entity within an NGSI-LD system
appendEntityAttrs 2 params body → 204207400404
PATCH
/entities/{entityId}/attrs/
Update existing Entity attributes within an NGSI-LD system
updateEntityAttrs 1 param body → 204207400404
PATCH
/entities/{entityId}/attrs/{attrId}
Update existing Entity attributes within an NGSI-LD system
partialAttrUpdate 2 params body → 204400404
DELETE
/entities/{entityId}/attrs/{attrId}
Removes an existing Entity attribute within an NGSI-LD system
removeEntityAttr 2 params → 204400404
POST
/entityOperations/create
Batch Entity creation
batchEntityCreation body → 200400
POST
/entityOperations/update
Batch Entity update
batchEntityUpdate 1 param body → 200400
POST
/entityOperations/upsert
Batch Entity upsert
batchEntityUpsert 1 param body → 200400
POST
/entityOperations/delete
Batch Entity delete
batchEntityDelete body → 200400
GET
/v2/entities
List Entities
List Entities 15 params → 200
POST
/v2/entities
Create Entity
Create Entity 3 params → 204
GET
/v2/entities/{entityId}
Retrieve Entity
Retrieve Entity 5 params → 200
DELETE
/v2/entities/{entityId}
Remove Entity
Remove Entity 2 params → 204
GET
/v2/entities/{entityId}/attrs
Retrieve Entity Attributes
Retrieve Entity Attributes 5 params → 200
PUT
/v2/entities/{entityId}/attrs
Replace all entity attributes
Replace all entity attributes 5 params → 204
POST
/v2/entities/{entityId}/attrs
Update or Append Entity Attributes
Update or Append Entity Attributes 5 params → 204
PATCH
/v2/entities/{entityId}/attrs
Update Existing Entity Attributes
Update Existing Entity Attributes 5 params → 204

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are EntityFragment (8 properties), Relationship (7 properties), GeoProperty (7 properties), Property (7 properties). Each schema is shown below with its type and property counts.

Entity
positionArray
array
An array of positions
LineString
object
2 properties
MultiLineString
object
2 properties
Geometry
Avalid GeoJSON geometry object
geometry
string
Name
string
NGSI-LD Name
Point
object
2 properties
Relationship
object
7 properties 2 required
georel
Property
object
7 properties 2 required
NotUpdatedDetails
object
2 properties
modifiedAt
string
Polygon
object
2 properties
EntityFragment
object
8 properties
position
array
A single position
BatchEntityError
object
2 properties
ProblemDetails
object
3 properties 1 required
linearRing
An array of four positions where the first equals the last
MultiPoint
object
2 properties
datasetId
string
coordinates
lineString
An array of two or more positions
EntityList
array
polygon
array
An array of linear rings
UpdateResult
object
2 properties
GeoProperty
object
7 properties 2 required
instanceId
string
observedAt
string
MultiPolygon
object
2 properties
LdContext
BatchOperationResult
object
2 properties
createdAt
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fiware-entities-api-openapi.yml Raw ↑

Other APIs FIWARE publishes across the network.

FIWARE API Entry Point API
FIWARE Attribute Value API
FIWARE Attributes API
FIWARE Batch Operations API
FIWARE Context Information API
FIWARE Context Sources API
FIWARE Context Subscription API
FIWARE CSourceRegistrations API
FIWARE CSourceSubscriptions API
FIWARE Registrations API
FIWARE Subscriptions API
FIWARE Temporal API
Where this information came from

This is an independent, third-party profile of FIWARE Entities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.