Built-in Endpoints JSON Catalog
The request
1
curl -X GET "http://server_ip:9000/endpoints?builtin=true"
Copied!
generates the following output, appropriately 400 lines long when formatted. In addition to listing each endpoint, the JSON output also lists all the required and optional parameters for each endpoint. In turn, each parameter is described by some or all of these attributes:
  • default
  • max_count
  • min_count
  • type
  • max_length
  • is_id
  • id_type
While this information alone is not sufficient for a full understanding of each endpoint, the descriptive names of parameters and the attribute values go a long way towards this goal.
1
{
2
"DELETE /graph/{graph_name}/delete_by_type/vertices/{vertex_type}" : {
3
"parameters" : {
4
"ack" : {
5
"default" : "all",
6
"max_count" : 1,
7
"min_count" : 1,
8
"options" : [ "all", "none" ],
9
"type" : "STRING"
10
},
11
"permanent" : {
12
"default" : "false",
13
"max_count" : 1,
14
"min_count" : 1,
15
"type" : "BOOL"
16
},
17
"vertex_type" : {
18
"type" : "TYPENAME"
19
}
20
}
21
},
22
"DELETE /graph/{graph_name}/edges/{source_vertex_type}/{source_vertex_id}/{edge_type}/{target_vertex_type}/{target_vertex_id}" : {
23
"parameters" : {
24
"edge_type" : {
25
"max_count" : 1,
26
"min_count" : 0,
27
"type" : "STRING"
28
},
29
"filter" : {
30
"max_count" : 1,
31
"max_length" : 2560,
32
"min_count" : 0,
33
"type" : "STRING"
34
},
35
"limit" : {
36
"max_count" : 1,
37
"min_count" : 0,
38
"type" : "UINT64"
39
},
40
"not_wildcard" : {
41
"max_count" : 1,
42
"min_count" : 0,
43
"type" : "BOOL"
44
},
45
"permanent" : {
46
"default" : "false",
47
"max_count" : 1,
48
"min_count" : 1,
49
"type" : "BOOL"
50
},
51
"select" : {
52
"max_count" : 1,
53
"max_length" : 2560,
54
"min_count" : 0,
55
"type" : "STRING"
56
},
57
"sort" : {
58
"max_count" : 1,
59
"max_length" : 2560,
60
"min_count" : 0,
61
"type" : "STRING"
62
},
63
"source_vertex_id" : {
64
"id_type" : "$source_vertex_type",
65
"is_id" : true,
66
"max_count" : 1,
67
"max_length" : 256,
68
"min_count" : 1,
69
"type" : "STRING"
70
},
71
"source_vertex_type" : {
72
"max_count" : 1,
73
"min_count" : 1,
74
"type" : "TYPENAME"
75
},
76
"target_vertex_id" : {
77
"id_type" : "$target_vertex_type",
78
"is_id" : true,
79
"max_count" : 1,
80
"max_length" : 256,
81
"min_count" : 0,
82
"type" : "STRING"
83
},
84
"target_vertex_type" : {
85
"max_count" : 1,
86
"min_count" : 0,
87
"type" : "TYPENAME"
88
},
89
"timeout" : {
90
"default" : "0",
91
"max_count" : 1,
92
"min_count" : 0,
93
"type" : "UINT32"
94
}
95
}
96
},
97
"DELETE /graph/{graph_name}/vertices/{vertex_type}/{vertex_id}" : {
98
"parameters" : {
99
"filter" : {
100
"max_count" : 1,
101
"max_length" : 2560,
102
"min_count" : 0,
103
"type" : "STRING"
104
},
105
"limit" : {
106
"max_count" : 1,
107
"min_count" : 0,
108
"type" : "UINT64"
109
},
110
"permanent" : {
111
"default" : "false",
112
"max_count" : 1,
113
"min_count" : 1,
114
"type" : "BOOL"
115
},
116
"sort" : {
117
"max_count" : 1,
118
"max_length" : 2560,
119
"min_count" : 0,
120
"type" : "STRING"
121
},
122
"timeout" : {
123
"default" : "0",
124
"max_count" : 1,
125
"min_count" : 0,
126
"type" : "UINT32"
127
},
128
"vertex_id" : {
129
"id_type" : "$vertex_type",
130
"is_id" : true,
131
"max_count" : 1,
132
"max_length" : 2560,
133
"min_count" : 0,
134
"type" : "STRING"
135
},
136
"vertex_type" : {
137
"type" : "TYPENAME"
138
}
139
}
140
},
141
"GET /echo" : {
142
"parameters" : {
143
"sleep" : {
144
"default" : "0",
145
"type" : "INT32"
146
}
147
}
148
},
149
"GET /endpoints" : {
150
"parameters" : {
151
"builtin" : {
152
"default" : "false",
153
"max_count" : 1,
154
"min_count" : 0,
155
"type" : "BOOL"
156
},
157
"dynamic" : {
158
"default" : "false",
159
"max_count" : 1,
160
"min_count" : 0,
161
"type" : "BOOL"
162
},
163
"static" : {
164
"default" : "false",
165
"max_count" : 1,
166
"min_count" : 0,
167
"type" : "BOOL"
168
}
169
}
170
},
171
"GET /graph/{graph_name}/edges/{source_vertex_type}/{source_vertex_id}/{edge_type}/{target_vertex_type}/{target_vertex_id}" : {
172
"parameters" : {
173
"count_only" : {
174
"default" : "false",
175
"max_count" : 1,
176
"min_count" : 0,
177
"type" : "BOOL"
178
},
179
"edge_type" : {
180
"max_count" : 1,
181
"min_count" : 0,
182
"type" : "STRING"
183
},
184
"filter" : {
185
"max_count" : 1,
186
"max_length" : 2560,
187
"min_count" : 0,
188
"type" : "STRING"
189
},
190
"limit" : {
191
"max_count" : 1,
192
"min_count" : 0,
193
"type" : "UINT64"
194
},
195
"not_wildcard" : {
196
"max_count" : 1,
197
"min_count" : 0,
198
"type" : "BOOL"
199
},
200
"select" : {
201
"max_count" : 1,
202
"max_length" : 2560,
203
"min_count" : 0,
204
"type" : "STRING"
205
},
206
"sort" : {
207
"max_count" : 1,
208
"max_length" : 2560,
209
"min_count" : 0,
210
"type" : "STRING"
211
},
212
"source_vertex_id" : {
213
"id_type" : "$source_vertex_type",
214
"is_id" : true,
215
"max_count" : 1,
216
"max_length" : 256,
217
"min_count" : 1,
218
"type" : "STRING"
219
},
220
"source_vertex_type" : {
221
"max_count" : 1,
222
"min_count" : 1,
223
"type" : "TYPENAME"
224
},
225
"target_vertex_id" : {
226
"id_type" : "$target_vertex_type",
227
"is_id" : true,
228
"max_count" : 1,
229
"max_length" : 256,
230
"min_count" : 0,
231
"type" : "STRING"
232
},
233
"target_vertex_type" : {
234
"max_count" : 1,
235
"min_count" : 0,
236
"type" : "TYPENAME"
237
},
238
"timeout" : {
239
"default" : "0",
240
"max_count" : 1,
241
"min_count" : 0,
242
"type" : "UINT32"
243
}
244
}
245
},
246
"GET /graph/{graph_name}/vertices/{vertex_type}/{vertex_id}" : {
247
"parameters" : {
248
"count_only" : {
249
"default" : "false",
250
"max_count" : 1,
251
"min_count" : 0,
252
"type" : "BOOL"
253
},
254
"filter" : {
255
"max_count" : 1,
256
"max_length" : 2560,
257
"min_count" : 0,
258
"type" : "STRING"
259
},
260
"limit" : {
261
"max_count" : 1,
262
"min_count" : 0,
263
"type" : "UINT64"
264
},
265
"select" : {
266
"max_count" : 1,
267
"max_length" : 2560,
268
"min_count" : 0,
269
"type" : "STRING"
270
},
271
"sort" : {
272
"max_count" : 1,
273
"max_length" : 2560,
274
"min_count" : 0,
275
"type" : "STRING"
276
},
277
"timeout" : {
278
"default" : "0",
279
"max_count" : 1,
280
"min_count" : 0,
281
"type" : "UINT32"
282
},
283
"vertex_id" : {
284
"id_type" : "$vertex_type",
285
"is_id" : true,
286
"max_count" : 1,
287
"max_length" : 2560,
288
"min_count" : 0,
289
"type" : "STRING"
290
},
291
"vertex_type" : {
292
"type" : "TYPENAME"
293
}
294
}
295
},
296
"GET /statistics/{graph_name}" : {
297
"parameters" : {
298
"seconds" : {
299
"default" : "10",
300
"type" : "UINT32"
301
},
302
"segments" : {
303
"default" : "10",
304
"max" : "100",
305
"min" : "1",
306
"type" : "UINT32"
307
}
308
}
309
},
310
"GET /version" : null,
311
"POST /builtins" : null,
312
"POST /echo" : {
313
"parameters" : {
314
"sleep" : {
315
"default" : "0",
316
"type" : "INT32"
317
}
318
}
319
},
320
"POST /graph/{graph_name}" : {
321
"parameters" : {
322
"ack" : {
323
"default" : "all",
324
"max_count" : 1,
325
"min_count" : 1,
326
"options" : [ "all", "none" ],
327
"type" : "STRING"
328
}
329
}
330
}
331
}
Copied!
Last modified 1yr ago
Export as PDF
Copy link