Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
NGSI Linked Data
NGSI-LD
Commits
8c0b23eb
Commit
8c0b23eb
authored
Nov 19, 2018
by
canterafonsj
Browse files
Entities closer and closer
parent
e588196b
Changes
1
Hide whitespace changes
Inline
Side-by-side
spec/updated/entities-spec.json
View file @
8c0b23eb
{
"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"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel"
}
},
"geometry"
:
{
"name"
:
"geometry"
,
"description"
:
"Geometry"
,
"in"
:
"query"
,
"required"
:
false
,
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry"
}
},
"coordinates"
:
{
"name"
:
"coordinates"
,
"description"
:
"Coordinates serialized as a string"
,
"in"
:
"query"
,
"required"
:
false
,
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/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
}
}
}
},
"paths"
:
{
"/entities/"
:
{
"get"
:
{
"description"
:
"Retrieve a set of entities which matches a specific query from an NGSI-LD system"
,
"operationId"
:
"queryEntities"
,
"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"
}
],
"responses"
:
{
"200"
:
{
"description"
:
"OK"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#"
},
"examples"
:
{
"simple"
:
{
"externalValue"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json"
}
}
}
}
},
"400"
:
{
"description"
:
"Bad request"
,
"content"
:
{
"application/json"
:
{
"schema"
:
{
"$ref"
:
""
}
}
}
}
}
}
}
}
"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"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel"
}
},
"geometry"
:
{
"name"
:
"geometry"
,
"description"
:
"Geometry"
,
"in"
:
"query"
,
"required"
:
false
,
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry"
}
},
"coordinates"
:
{
"name"
:
"coordinates"
,
"description"
:
"Coordinates serialized as a string"
,
"in"
:
"query"
,
"required"
:
false
,
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/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
}
}
}
},
"paths"
:
{
"/entities/"
:
{
"get"
:
{
"description"
:
"Retrieve a set of entities which matches a specific query from an NGSI-LD system"
,
"operationId"
:
"queryEntities"
,
"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"
}
],
"responses"
:
{
"200"
:
{
"description"
:
"OK"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#"
},
"examples"
:
{
"simple"
:
{
"externalValue"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json"
}
}
}
}
},
"400"
:
{
"description"
:
"Bad request"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
},
"post"
:
{
"description"
:
"Create a new Entity within an NGSI-LD system"
,
"operationId"
:
"createEntity"
,
"requestBody"
:
{
"required"
:
true
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#"
},
}
}
},
"responses"
:
{
"201"
:
{
"description"
:
"Created. Contains the resource URI of the created Entity"
},
"400"
:
{
"description"
:
"Bad request"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
},
"409"
:
{
"description"
:
"Already exists"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
},
"422"
:
{
"description"
:
"Unprocessable Entity"
,
"content"
:
{
"application/json;application/ld+json"
:
{
"schema"
:
{
"$ref"
:
"https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
}
}
}
}
}
}
}
}
}
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment