{ "openapi": "3.0.1", "info": { "title": "NGSI-LD Temporal Entity Attributes", "version": "latest" }, "components": { "parameters": { "entityId": { "name": "entityId", "description": "Entity Id", "in": "path", "required": true, "schema": { "type": "string", "format": "uri" } }, "attrId": { "name": "attrId", "description": "Attribute Id", "in": "path", "required": true, "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name" } }, "instanceId": { "name": "instanceId", "description": "Instance Id", "in": "path", "required": true, "schema": { "type": "string", "format": "uri" } } } }, "paths": { "/temporal/entities/{entityId}/attrs/": { "post": { "description": "Add new attributes to an existing Temporal Entity within an NGSI-LD system", "operationId": "addTemporalEntityAttrs", "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" } ], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad request", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } } } } }, "/temporal/entities/{entityId}/attrs/{attrId}": { "delete": { "description": "Attribute from Temporal Representation of Entity deletion", "operationId": "removeEntityTemporalAttr", "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/attrId" } ], "responses": { "204": { "description": "No Content." }, "400": { "description": "Bad Request", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } } } } }, "/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": { "patch": { "description": "Allows modifying a specific Attribute (Property or Relationship) instance, identified by its instanceId, of a Temporal Representation of an Entity.", "operationId": "modifyEntityTemporalAttrInstance", "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/attrId" }, { "$ref": "#/components/parameters/instanceId" } ], "requestBody": { "required": true, "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporalFragment" } } } }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad request", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } } } }, "delete": { "description": "Attribute Instance deletion by instance id.", "operationId": "removeEntityTemporalAttrInstance", "tags": ["Temporal Evolution", "Temporal"], "parameters": [ { "$ref": "#/components/parameters/entityId" }, { "$ref": "#/components/parameters/attrId" }, { "$ref": "#/components/parameters/instanceId" } ], "responses": { "204": { "description": "No Content." }, "400": { "description": "Bad Request", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json;application/ld+json": { "schema": { "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails" } } } } } } } } }