entities-spec.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "NGSI-LD Entities",
    "version": "latest"
  },
  "components": {
    "parameters": {
      "id": {
        "name": "id",
        "description": "Comma separated list of URIs to be retrieved",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "uri"
        }
      },
      "type": {
        "name": "type",
        "description": "Comma separated list of Entity type names to be retrieved",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      "idPattern": {
        "name": "idPattern",
        "description": "Regular expression that must be matched by Entity ids",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "regexp"
        }
      },
      "attrs": {
        "name": "attrs",
        "description": "Comma separated list of attribute names (properties or relationships) to be retrieved",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      "q": {
        "name": "q",
        "description": "Query",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      "georel": {
        "name": "georel",
        "description": "Geo-relationship",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "http://localhost:8090/schema/common.json#/definitions/georel"
        }
      },
      "geometry": {
        "name": "geometry",
        "description": "Geometry",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "http://localhost:8090/schema/common.json#/definitions/geometry"
        }
      },
      "coordinates": {
        "name": "coordinates",
        "description": "Coordinates serialized as a string",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "http://localhost:8090/schema/common.json#/definitions/coordinates"
        }
      },
      "geoproperty": {
        "name": "geoproperty",
        "description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      "csf": {
        "name": "csf",
        "description": "Context Source Filter",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "minLength": 1
        }
      },
      "limit": {
        "name": "limit",
        "description": "Pagination limit",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "minimum": 1
        }
      },
      "options":{
        "name": "options",
        "description": "Options dictionary",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": ["keyValues", "sysAttrs"]
        }
      }
    }
  },
  "paths": {
    "/entities/": {
      "get": {
        "description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system",
        "operationId": "queryEntities",
        "tags": ["Context Information", "Entities"],
        "parameters": [
          {
            "$ref": "#/components/parameters/id"
          },
          {
            "$ref": "#/components/parameters/idPattern"
          },
          {
            "$ref": "#/components/parameters/type"
          },
          {
            "$ref": "#/components/parameters/attrs"
          },
          {
            "$ref": "#/components/parameters/q"
          },
          {
            "$ref": "#/components/parameters/georel"
          },
          {
            "$ref": "#/components/parameters/geometry"
          },
          {
            "$ref": "#/components/parameters/coordinates"
          },
          {
            "$ref": "#/components/parameters/geoproperty"
          },
          {
            "$ref": "#/components/parameters/csf"
          },
          {
            "$ref": "#/components/parameters/limit"
          },
          {
            "$ref": "#/components/parameters/options"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
                  "$ref": "http://localhost:8090/schema/EntityList.json#/definitions/EntityList"
                },
                "examples": {
                  "simple": {
                    "externalValue": "http://localhost:8090/examples/EntityList-example.json"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
                  "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "post": {
        "description": "Create a new Entity within an NGSI-LD system",
        "operationId": "createEntity",
        "tags": ["Context Information", "Entities"],
        "requestBody": {
          "required": true,
          "content": {
            "application/json;application/ld+json": {
              "schema": {
                "$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created. Contains the resource URI of the created Entity"
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
                  "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Already exists",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
                  "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails"
                }
              }
            }
          },
          "422": {
            "description": "Unprocessable Entity",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
                  "$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  }
}