temporal-entities-spec.json 7.25 KB
Newer Older
canterafonsj's avatar
canterafonsj committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "openapi": "3.0.1",
  "info": {
    "title": "NGSI-LD Temporal Entities",
    "version": "latest"
  },
  "components": {
    "parameters": {
      "timerel": {
        "name": "timerel",
        "description": "Time relationship",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/timerel"
        }
      },
      "time": {
        "name": "time",
        "description": "start time for temporal query",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "endTime": {
        "name": "endTime",
        "description": "end time for temporal query",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "format": "date-time"
        }
      },
      "timeproperty": {
        "name": "timeproperty",
        "description": "The name of the property that contains the temporal data that will be used to resolve the temporal query",
        "in": "query",
        "required": false,
        "schema": {
          "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name"
        }
      },
canterafonsj's avatar
canterafonsj committed
47
48
49
50
51
52
53
      "lastN": {
        "name": "lastN",
        "description": "Only retrieve last N instances",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
canterafonsj's avatar
Closer  
canterafonsj committed
54
          "minimum": 1
canterafonsj's avatar
canterafonsj committed
55
56
        }
      },
canterafonsj's avatar
canterafonsj committed
57
58
59
60
61
62
63
      "options": {
        "name": "options",
        "description": "Options dictionary",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
canterafonsj's avatar
Closer  
canterafonsj committed
64
65
66
67
          "enum": [
            "temporalValues",
            "sysAttrs"
          ]
canterafonsj's avatar
canterafonsj committed
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
        }
      }
    }
  },
  "paths": {
    "/temporal/entities/": {
      "get": {
        "description": "Query temporal evolution of Entities from an NGSI-LD system",
        "operationId": "queryTemporalEntities",
        "parameters": [
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/id"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/idPattern"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/type"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/attrs"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/q"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/georel"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geometry"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/coordinates"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/geoproperty"
          },
          {
            "$ref": "#/components/parameters/timerel"
          },
          {
canterafonsj's avatar
canterafonsj committed
109
            "$ref": "#/components/parameters/timeproperty"
canterafonsj's avatar
canterafonsj committed
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
          },
          {
            "$ref": "#/components/parameters/time"
          },
          {
            "$ref": "#/components/parameters/endTime"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/csf"
          },
          {
            "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/limit"
          },
          {
            "$ref": "#/components/parameters/options"
canterafonsj's avatar
canterafonsj committed
125
126
127
          },
          {
            "$ref": "#/components/parameters/lastN"
canterafonsj's avatar
canterafonsj committed
128
129
130
131
132
133
134
135
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
canterafonsj's avatar
Closer  
canterafonsj committed
136
                  "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporalList.json#/definitions/EntityTemporalList"
canterafonsj's avatar
canterafonsj committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
                },
                "examples": {
                  "simple": {
                    "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporalList-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 temporal representation of an Entity within an NGSI-LD system",
        "operationId": "createEntityTemporal",
        "requestBody": {
          "required": true,
          "content": {
            "application/json;application/ld+json": {
              "schema": {
canterafonsj's avatar
Closer  
canterafonsj committed
166
167
168
169
170
171
                "$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal"
              },
              "examples": {
                "simple": {
                  "externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json"
                }
canterafonsj's avatar
canterafonsj committed
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
              }
            }
          }
        },
        "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"
                }
              }
            }
          }
        }
      }
    }
  }
}