entity-by-id-spec.json 4.16 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
{
  "openapi": "3.0.1",
  "info": {
    "title": "NGSI-LD Entity By Id",
    "version": "latest"
  },
  "components": {
    "parameters": {
      "entityId": {
        "name": "entityId",
        "description": "Entity Id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "format": "uri"
        }
      },
      "type": {
        "name": "type",
        "description": "Entity Type",
        "in": "query",
        "required": false,
        "schema": {
André Costa's avatar
André Costa committed
25
          "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name"
canterafonsj's avatar
canterafonsj committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
        }
      },
      "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
        }
      }
    }
  },
  "paths": {
    "/entities/{entityId}": {
      "get": {
        "description": "Retrieve an specific Entity from an NGSI-LD system. It's possible to specify the Entity attributes to be retrieved by using query parameters",
        "operationId": "retrieveEntityById",
canterafonsj's avatar
canterafonsj committed
45
        "tags": ["Context Information"],
canterafonsj's avatar
canterafonsj committed
46
47
48
49
50
51
52
53
54
        "parameters": [
          {
            "$ref": "#/components/parameters/entityId"
          },
          {
            "$ref": "#/components/parameters/attrs"
          },
          {
            "$ref": "#/components/parameters/type"
55
56
          },
          {
André Costa's avatar
André Costa committed
57
            "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/entities-spec.json#/components/parameters/options"
canterafonsj's avatar
canterafonsj committed
58
          }
canterafonsj's avatar
canterafonsj committed
59
60
61
62
63
64
65
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
André Costa's avatar
André Costa committed
66
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity"
canterafonsj's avatar
canterafonsj committed
67
68
69
                },
                "examples": {
                  "simple": {
André Costa's avatar
André Costa committed
70
                    "externalValue": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json"
canterafonsj's avatar
canterafonsj committed
71
72
73
74
75
76
77
78
79
80
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
André Costa's avatar
André Costa committed
81
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
82
83
84
                }
              }
            }
canterafonsj's avatar
canterafonsj committed
85
86
87
88
89
90
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
André Costa's avatar
André Costa committed
91
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
92
93
94
95
96
97
98
99
100
                }
              }
            }
          }
        }
      },
      "delete": {
        "description": "Removes an specific Entity from an NGSI-LD system",
        "operationId": "removeEntityById",
canterafonsj's avatar
canterafonsj committed
101
        "tags": ["Context Information"],
canterafonsj's avatar
canterafonsj committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
        "parameters": [
          {
            "$ref": "#/components/parameters/entityId"
          },
          {
            "$ref": "#/components/parameters/type"
          }
        ],
        "responses": {
          "204": {
            "description": "No Content. The entity was removed successfully"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
André Costa's avatar
André Costa committed
119
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
120
121
122
123
124
125
126
127
128
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json;application/ld+json": {
                "schema": {
André Costa's avatar
André Costa committed
129
                  "$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
canterafonsj's avatar
canterafonsj committed
130
131
132
                }
              }
            }
canterafonsj's avatar
canterafonsj committed
133
134
135
136
137
          }
        }
      }
    }
  }
canterafonsj's avatar
canterafonsj committed
138
}