temporal-entity-by-id-spec.json 4.89 KB
Newer Older
canterafonsj's avatar
canterafonsj committed
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "openapi": "3.0.1",
  "info": {
    "title": "NGSI-LD Entity Temporal By Id",
    "version": "latest"
  },
  "components": {
  },
  "paths": {
    "/temporal/entities/{entityId}": {
      "get": {
        "description": "Retrieve the temporal representation of an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters",
        "operationId": "retrieveEntityTemporalById",
Stefan Wiedemann's avatar
Stefan Wiedemann committed
14
        "tags": ["Temporal Evolution", "Temporal"],
canterafonsj's avatar
canterafonsj committed
15
16
        "parameters": [
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
17
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId"
canterafonsj's avatar
canterafonsj committed
18
19
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
20
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/attrs"
canterafonsj's avatar
canterafonsj committed
21
22
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
23
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type"
canterafonsj's avatar
canterafonsj committed
24
          },  
canterafonsj's avatar
canterafonsj committed
25
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
26
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/options"
canterafonsj's avatar
canterafonsj committed
27
28
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
29
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timerel"
canterafonsj's avatar
canterafonsj committed
30
31
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
32
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/timeproperty"
canterafonsj's avatar
canterafonsj committed
33
34
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
35
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/time"
canterafonsj's avatar
canterafonsj committed
36
37
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
38
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/endTime"
canterafonsj's avatar
canterafonsj committed
39
40
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
41
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/components/parameters/lastN"
canterafonsj's avatar
canterafonsj committed
42
43
44
45
46
47
48
49
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
50
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/temporal/EntityTemporal.json#/definitions/EntityTemporal"
canterafonsj's avatar
canterafonsj committed
51
52
53
                },
                "examples": {
                  "simple": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
54
                    "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/EntityTemporal-example_C5.5.3.json"
canterafonsj's avatar
canterafonsj committed
55
56
57
58
59
60
61
62
63
64
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
65
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
66
67
68
69
70
71
72
73
74
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
75
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
76
77
78
79
80
81
82
                }
              }
            }
          }
        }
      },
      "delete": {
canterafonsj's avatar
canterafonsj committed
83
84
        "description": "Removes the temporal representation of an Entity from an NGSI-LD system",
        "operationId": "removeEntityTemporalById",
Stefan Wiedemann's avatar
Stefan Wiedemann committed
85
        "tags": ["Temporal Evolution", "Temporal"],
canterafonsj's avatar
canterafonsj committed
86
87
        "parameters": [
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
88
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/entityId"
canterafonsj's avatar
canterafonsj committed
89
90
          },
          {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
91
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities/entity-by-id-spec.json#/components/parameters/type"
canterafonsj's avatar
canterafonsj committed
92
93
94
95
96
97
98
99
100
101
102
          }
        ],
        "responses": {
          "204": {
            "description": "No Content. The entity was removed successfully"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
103
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
104
105
106
107
108
109
110
111
112
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
Stefan Wiedemann's avatar
Stefan Wiedemann committed
113
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
114
115
116
117
118
119
120
121
                }
              }
            }
          }
        }
      }
    }
  }
canterafonsj's avatar
canterafonsj committed
122
}