{ "opencollection": "1.0.0", "info": { "name": "ETSI ISG CIM / NGSI-LD API Entry Point Attributes API", "version": "latest" }, "items": [ { "info": { "name": "Attributes", "type": "folder" }, "items": [ { "info": { "name": "Get attribute data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/entities/:entityId/attrs/:attrName", "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Id of the entity" }, { "name": "attrName", "value": "", "type": "path", "description": "Name of the attribute to be retrieved." }, { "name": "type", "value": "", "type": "query", "description": "Entity type, to avoid ambiguity in case there are several\nentities with the same entity id." }, { "name": "metadata", "value": "", "type": "query", "description": "A list of metadata names to include in the response.\nSee \"Filtering out attributes and metadata\" section for more detail." } ] }, "docs": "Returns a JSON object with the attribute data of the attribute. The object follows the JSON\nrepresentation for attributes (described in \"JSON Attribute Representation\" section).\nResponse:\n* Successful operation uses 200 OK.\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n more details." }, { "info": { "name": "Update Attribute Data", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/entities/:entityId/attrs/:attrName", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Id of the entity to update" }, { "name": "attrName", "value": "", "type": "path", "description": "Attribute name" }, { "name": "type", "value": "", "type": "query", "description": "Entity type, to avoid ambiguity in case there are several\nentities with the same entity id." } ] }, "docs": "The request payload is an object representing the new attribute data. Previous attribute data\nis replaced by the one in the request. The object follows the JSON representation for attributes\n(described in \"JSON Attribute Representation\" section).\nResponse:\n* Successful operation uses 204 No Content\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n more details." }, { "info": { "name": "Remove a Single Attribute", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/entities/:entityId/attrs/:attrName", "params": [ { "name": "entityId", "value": "", "type": "path", "description": "Id of the entity." }, { "name": "attrName", "value": "", "type": "path", "description": "Attribute name." }, { "name": "type", "value": "", "type": "query", "description": "Entity type, to avoid ambiguity in case there are several\nentities with the same entity id." } ] }, "docs": "Removes an entity attribute.\nResponse:\n* Successful operation uses 204 No Content\n* Errors use a non-2xx and (optionally) an error payload. See subsection on \"Error Responses\" for\n more details." } ] } ], "bundled": true }