mirror of https://gitee.com/bigwinds/arangodb
954 lines
66 KiB
JSON
954 lines
66 KiB
JSON
{
|
|
"basePath": "/",
|
|
"swaggerVersion": "1.1",
|
|
"apiVersion": "0.1",
|
|
"apis": [
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the graph was created successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph was created successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if it failed. The response body contains an error document in this case. <br><br> <em>Examples</em> <br><br>",
|
|
"code": "400"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until document has been synced to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "graph",
|
|
"description": "The call expects a JSON object as body with the following attributes: <em>_key</em>: The name of the new graph. <em>vertices</em>: The name of the vertices collection. <em>edges</em>: The name of the egde collection. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Creates a new graph. <br><br> Returns an object with an attribute <em>graph</em> containing a list of all graph properties. <br><br>",
|
|
"summary": "create graph",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/\n{ \n \"_key\" : \"graph\", \n \"vertices\" : \"vertices\", \n \"edges\" : \"edges\" \n}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: 1177757859\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_key\" : \"graph\", \n \"_rev\" : \"1177757859\", \n \"edgeDefinitions\" : [ \n { \n \"collection\" : \"edges\", \n \"from\" : [ \n \"vertices\" \n ], \n \"to\" : [ \n \"vertices\" \n ] \n } \n ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br>",
|
|
"nickname": "createGraph"
|
|
}
|
|
],
|
|
"path": "/_api/graph"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the graph was found (in case <em>graph-name</em> was specified) or the list of graphs was assembled successfully (in case <em>graph-name</em> was not specified). <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph was not found. This response code may only be returned if <em>graph-name</em> is specified in the request. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-None-Match\" header is given and the current graph has not a different version. This response code may only be returned if <em>graph-name</em> is specified in the request. <br><br>",
|
|
"code": "304"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current graph has a different version. This response code may only be returned if <em>graph-name</em> is specified in the request. <br><br> <em>Examples</em> <br><br> get graph by name <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": false,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-None-Match",
|
|
"description": "If <em>graph-name</em> is specified, then this header can be used to check whether a specific graph has changed or not. <br><br> If the \"If-None-Match\" header is given, then it must contain exactly one etag. The document is returned if it has a different revision than the given etag. Otherwise a <em>HTTP 304</em> is returned. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-Match",
|
|
"description": "If <em>graph-name</em> is specified, then this header can be used to check whether a specific graph has changed or not. <br><br> If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "<br><br> If <em>graph-name</em> is specified, returns an object with an attribute <em>graph</em> containing a JSON object with all properties of the specified graph. <br><br> If <em>graph-name</em> is not specified, returns a list of graph objects. <br><br>",
|
|
"summary": "get the properties of a specific or all graphs",
|
|
"httpMethod": "GET",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl --data-binary @- --dump - http://localhost:8529/_api/graph/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 1179068579\n\n{ \n \"graph\" : { \n \"_id\" : \"_graphs/graph\", \n \"_key\" : \"graph\", \n \"_rev\" : \"1179068579\", \n \"edgeDefinitions\" : [ \n { \n \"collection\" : \"edges\", \n \"from\" : [ \n \"vertices\" \n ], \n \"to\" : [ \n \"vertices\" \n ] \n } \n ] \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n</code></pre><br><br><br> get all graphs <br><br><br><br><pre><code class=\"json\">shell> curl --data-binary @- --dump - http://localhost:8529/_api/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"graphs\" : [ \n { \n \"_id\" : \"_graphs/graph2\", \n \"_key\" : \"graph2\", \n \"_rev\" : \"1181821091\", \n \"edgeDefinitions\" : [ \n { \n \"collection\" : \"edges2\", \n \"from\" : [ \n \"vertices2\" \n ], \n \"to\" : [ \n \"vertices2\" \n ] \n } \n ] \n }, \n { \n \"_id\" : \"_graphs/graph1\", \n \"_key\" : \"graph1\", \n \"_rev\" : \"1180772515\", \n \"edgeDefinitions\" : [ \n { \n \"collection\" : \"edges1\", \n \"from\" : [ \n \"vertices1\" \n ], \n \"to\" : [ \n \"vertices1\" \n ] \n } \n ] \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n</code></pre><br>",
|
|
"nickname": "getThePropertiesOfASpecificOrAllGraphs"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the graph was deleted and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph was deleted and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current graph has a different version <br><br> <em>Examples</em> <br><br> delete graph by name <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-Match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Deletes graph, edges and vertices <br><br>",
|
|
"summary": "delete graph",
|
|
"httpMethod": "DELETE",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/graph/graph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"deleted\" : true, \n \"error\" : false, \n \"code\" : 200 \n}\n</code></pre><br>",
|
|
"nickname": "deleteGraph"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the graph was created successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph was created successfully and <em>waitForSync</em> was <em>false</em>. <br><br> <em>Examples</em> <br><br>",
|
|
"code": "202"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until document has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "vertex",
|
|
"description": "The call expects a JSON object as body with the vertex properties: <ul class=\"swagger-list\"><li><em>_key</em>: The name of the vertex (optional). <li>further optional attributes."
|
|
}
|
|
],
|
|
"notes": "Creates a vertex in a graph. <br><br> Returns an object with an attribute <em>vertex</em> containing a list of all vertex properties. <br><br>",
|
|
"summary": "create vertex",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex\n{ \n \"_key\" : \"v1\", \n \"optional1\" : \"val1\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1186212003\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1186212003\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "createVertex"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertex"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the graph was found <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header is given and the current graph has not a different version <br><br>",
|
|
"code": "304"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or vertex was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-None-Match\" header or <em>rev</em> is given and the current graph has a different version <br><br> <em>Examples</em> <br><br> get vertex properties by name <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The name of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of a vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-None-Match",
|
|
"description": "If the \"If-None-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has a different revision than the given etag. Otherwise a <em>HTTP 304</em> is returned. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-Match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Returns an object with an attribute <em>vertex</em> containing a list of all vertex properties. <br><br>",
|
|
"summary": "get vertex",
|
|
"httpMethod": "GET",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 1188047011\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1188047011\", \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n</code></pre><br>",
|
|
"nickname": "getVertex"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertex/{vertex-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the vertex was deleted and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "is returned if the vertex was deleted and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the vertex was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current vertex has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The name of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until document has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of a vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "If-Match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Deletes vertex and all in and out edges of the vertex <br><br>",
|
|
"summary": "delete vertex",
|
|
"httpMethod": "DELETE",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\n\n{ \n \"deleted\" : true, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "deleteVertex"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertex/{vertex-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the vertex was updated successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the vertex was updated successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the vertex was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current vertex has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The name of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until vertex has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of a vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "vertex",
|
|
"description": "The call expects a JSON object as body with the new vertex properties. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is updated, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Replaces the vertex properties. <br><br> Returns an object with an attribute <em>vertex</em> containing a list of all vertex properties. <br><br>",
|
|
"summary": "update vertex",
|
|
"httpMethod": "PUT",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{ \n \"optional1\" : \"val2\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1192831139\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1192831139\", \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "updateVertex"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertex/{vertex-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the vertex was updated successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the vertex was updated successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the vertex was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current vertex has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The name of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until vertex has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of a vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "keepNull",
|
|
"description": "Modify the behavior of the patch command to remove any attribute <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "graph",
|
|
"description": "The call expects a JSON object as body with the properties to patch. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is updated, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Partially updates the vertex properties. <br><br> Setting an attribute value to <em>null</em> in the patch document will cause a value of <em>null</em> be saved for the attribute by default. If the intention is to delete existing attributes with the patch command, the URL parameter <em>keepNull</em> can be used with a value of <em>false</em>. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of <em>null</em>. <br><br> Returns an object with an attribute <em>vertex</em> containing a list of all vertex properties. <br><br>",
|
|
"summary": "update vertex",
|
|
"httpMethod": "PATCH",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{ \n \"optional1\" : \"vertexPatch\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1195190435\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1195190435\", \n \"optional1\" : \"vertexPatch\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertex/v1\n{ \n \"optional1\" : null \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1195714723\n\n{ \n \"vertex\" : { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1195714723\", \n \"optional1\" : null \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "updateVertex"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertex/{vertex-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the cursor was created <br><br> <em>Examples</em> <br><br> Select all vertices <br><br>",
|
|
"code": "201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "filter",
|
|
"description": "The call expects a JSON object as body to filter the result: <br><br>"
|
|
}
|
|
],
|
|
"notes": "Returns a cursor. <br><br> The call expects a JSON object as body to filter the result: <br><br> <ul class=\"swagger-list\"><li><em>batchSize</em>: the batch size of the returned cursor <li><em>limit</em>: limit the result size <li><em>count</em>: return the total number of results (default \"false\") <li><em>filter</em>: a optional filter </ul> The attributes of filter <ul class=\"swagger-list\"><li><em>properties</em>: filter by an array of vertex properties </ul> The attributes of a property filter <ul class=\"swagger-list\"><li><em>key</em>: filter the result vertices by a key value pair <li><em>value</em>: the value of the <em>key</em> <li><em>compare</em>: a compare operator",
|
|
"summary": "get vertices",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertices\n{ \n \"batchSize\" : 100 \n}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v3\", \n \"_key\" : \"v3\", \n \"_rev\" : \"1198336163\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v2\", \n \"_key\" : \"v2\", \n \"_rev\" : \"1197942947\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v5\", \n \"_key\" : \"v5\", \n \"_rev\" : \"1199122595\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_key\" : \"v4\", \n \"_rev\" : \"1198729379\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1197549731\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"extra\" : { \n \"stats\" : { \n \"writesExecuted\" : 0, \n \"writesIgnored\" : 0, \n \"scannedFull\" : 5, \n \"scannedIndex\" : 0, \n \"filtered\" : 0 \n }, \n \"warnings\" : [ ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br>",
|
|
"nickname": "getVertices"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertices"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the cursor was created <br><br> <em>Examples</em> <br><br> Select all vertices <br><br>",
|
|
"code": "201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The key of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "graph",
|
|
"description": "The call expects a JSON object as body to filter the result: <br><br>"
|
|
}
|
|
],
|
|
"notes": "Returns a cursor. <br><br> The call expects a JSON object as body to filter the result: <br><br> <ul class=\"swagger-list\"><li><em>batchSize</em>: the batch size of the returned cursor <li><em>limit</em>: limit the result size <li><em>count</em>: return the total number of results (default \"false\") <li><em>filter</em>: a optional filter </ul> The attributes of filter <ul class=\"swagger-list\"><li><em>direction</em>: Filter for inbound (value \"in\") or outbound (value \"out\") neighbors. Default value is \"any\". <li><em>labels</em>: filter by an array of edge labels (empty array means no restriction) <li><em>properties</em>: filter neighbors by an array of edge properties </ul> The attributes of a property filter <ul class=\"swagger-list\"><li><em>key</em>: filter the result vertices by a key value pair <li><em>value</em>: the value of the <em>key</em> <li><em>compare</em>: a compare operator",
|
|
"summary": "get vertices",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"any\", \"properties\":[] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1201154211\", \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"vertices/v4\", \n \"_key\" : \"v4\", \n \"_rev\" : \"1202333859\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"extra\" : { \n \"stats\" : { \n \"writesExecuted\" : 0, \n \"writesIgnored\" : 0, \n \"scannedFull\" : 0, \n \"scannedIndex\" : 0, \n \"filtered\" : 0 \n }, \n \"warnings\" : [ ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br><br><br> Select vertices by direction and property filter <br><br><br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/vertices/v2\n{\"batchSize\" : 100, \"filter\" : {\"direction\" : \"out\", \"properties\":[ { \"key\": \"optional1\", \"value\": \"val2\", \"compare\" : \"==\" }, ] }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"vertices/v4\", \n \"_key\" : \"v4\", \n \"_rev\" : \"1208232099\", \n \"optional1\" : \"val2\" \n }, \n { \n \"_id\" : \"vertices/v1\", \n \"_key\" : \"v1\", \n \"_rev\" : \"1207052451\", \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"extra\" : { \n \"stats\" : { \n \"writesExecuted\" : 0, \n \"writesIgnored\" : 0, \n \"scannedFull\" : 0, \n \"scannedIndex\" : 0, \n \"filtered\" : 0 \n }, \n \"warnings\" : [ ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br>",
|
|
"nickname": "getVertices"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/vertices/{vertex-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the edge was created successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the edge was created successfully and <em>waitForSync</em> was <em>false</em>. <br><br> <em>Examples</em> <br><br>",
|
|
"code": "202"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until edge has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "edge",
|
|
"description": "The call expects a JSON object as body with the edge properties: <br><br>"
|
|
}
|
|
],
|
|
"notes": "Creates an edge in a graph. <br><br> The call expects a JSON object as body with the edge properties: <br><br> <ul class=\"swagger-list\"><li><em>_key</em>: The name of the edge (optional, if edge collection allows user defined keys). <li><em>_from</em>: The name of the from vertex. <li><em>_to</em>: The name of the to vertex. <li><em>$label</em>: A label for the edge (optional). <li>further optional attributes. </ul> Returns an object with an attribute <em>edge</em> containing the list of all edge properties. <br><br>",
|
|
"summary": "create edge",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edge\n{ \n \"_key\" : \"edge1\", \n \"_from\" : \"vert2\", \n \"_to\" : \"vert1\", \n \"optional1\" : \"val1\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1213999267\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1213999267\", \n \"_from\" : \"vertices/vert2\", \n \"_to\" : \"vertices/vert1\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "createEdge"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edge"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the edge was found <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header is given and the current edge has not a different version <br><br>",
|
|
"code": "304"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or edge was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-None-Match\" header or <em>rev</em> is given and the current edge has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "edge-name",
|
|
"description": "The name of the edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of an edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-none-match",
|
|
"description": "If the \"If-None-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has a different revision than the given etag. Otherwise a <em>HTTP 304</em> is returned. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Returns an object with an attribute <em>edge</em> containing a list of all edge properties. <br><br>",
|
|
"summary": "get edge",
|
|
"httpMethod": "GET",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 1216882851\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1216882851\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n \"error\" : false, \n \"code\" : 200 \n}\n</code></pre><br>",
|
|
"nickname": "getEdge"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edge/{edge-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the edge was deletd successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "200"
|
|
},
|
|
{
|
|
"reason": "is returned if the edge was deleted successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the edge was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current edge has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "edge-name",
|
|
"description": "The name of the edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until edge has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of an edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Deletes an edge of the graph <br><br>",
|
|
"summary": "delete edge",
|
|
"httpMethod": "DELETE",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\n\n{ \n \"deleted\" : true, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "deleteEdge"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edge/{edge-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the edge was updated successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the edge was updated successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the edge was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current edge has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "edge-name",
|
|
"description": "The name of the edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until edge has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of an edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "edge",
|
|
"description": "The call expects a JSON object as body with the new edge properties. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Replaces the optional edge properties. <br><br> The call expects a JSON object as body with the new edge properties. <br><br> Returns an object with an attribute <em>edge</em> containing a list of all edge properties. <br><br>",
|
|
"summary": "update edge",
|
|
"httpMethod": "PUT",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{ \n \"optional1\" : \"val2\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1223960739\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1223960739\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val2\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "updateEdge"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edge/{edge-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the edge was updated successfully and <em>waitForSync</em> was <em>true</em>. <br><br>",
|
|
"code": "201"
|
|
},
|
|
{
|
|
"reason": "is returned if the edge was updated successfully and <em>waitForSync</em> was <em>false</em>. <br><br>",
|
|
"code": "202"
|
|
},
|
|
{
|
|
"reason": "is returned if the graph or the edge was not found. The response body contains an error document in this case. <br><br>",
|
|
"code": "404"
|
|
},
|
|
{
|
|
"reason": "\"If-Match\" header or <em>rev</em> is given and the current edge has a different version <br><br> <em>Examples</em> <br><br>",
|
|
"code": "412"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "edge-name",
|
|
"description": "The name of the edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "waitForSync",
|
|
"description": "Wait until edge has been sync to disk. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "rev",
|
|
"description": "Revision of an edge <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Boolean",
|
|
"paramType": "query",
|
|
"required": false,
|
|
"name": "keepNull",
|
|
"description": "Modify the behavior of the patch command to remove any attribute <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "edge-properties",
|
|
"description": "The call expects a JSON object as body with the properties to patch. <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "header",
|
|
"name": "if-match",
|
|
"description": "If the \"If-Match\" header is given, then it must contain exactly one etag. The document is returned, if it has the same revision ad the given etag. Otherwise a <em>HTTP 412</em> is returned. As an alternative you can supply the etag in an attribute <em>rev</em> in the URL. <br><br>"
|
|
}
|
|
],
|
|
"notes": "Partially updates the edge properties. <br><br> Setting an attribute value to <em>null</em> in the patch document will cause a value of <em>null</em> be saved for the attribute by default. If the intention is to delete existing attributes with the patch command, the URL parameter <em>keepNull</em> can be used with a value of <em>false</em>. This will modify the behavior of the patch command to remove any attributes from the existing document that are contained in the patch document with an attribute value of <em>null</em>. <br><br> Returns an object with an attribute <em>edge</em> containing a list of all edge properties. <br><br>",
|
|
"summary": "update edge",
|
|
"httpMethod": "PATCH",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edge/edge1\n{ \n \"optional3\" : \"val3\" \n}\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 1227499683\n\n{ \n \"edge\" : { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1227499683\", \n \"_from\" : \"vertices/vert1\", \n \"_to\" : \"vertices/vert2\", \n \"$label\" : null, \n \"optional1\" : \"val1\", \n \"optional3\" : \"val3\" \n }, \n \"error\" : false, \n \"code\" : 202 \n}\n</code></pre><br>",
|
|
"nickname": "updateEdge"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edge/{edge-name}"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the cursor was created <br><br> <em>Examples</em> <br><br> Select all edges <br><br>",
|
|
"code": "201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "edge-properties",
|
|
"description": "The call expects a JSON object as body to filter the result: <br><br>"
|
|
}
|
|
],
|
|
"notes": "Returns a cursor. <br><br> The call expects a JSON object as body to filter the result: <br><br> <ul class=\"swagger-list\"><li><em>batchSize</em>: the batch size of the returned cursor <li><em>limit</em>: limit the result size <li><em>count</em>: return the total number of results (default \"false\") <li><em>filter</em>: a optional filter </ul> The attributes of filter <ul class=\"swagger-list\"><li><em>labels</em>: filter by an array of edge labels <li><em>properties</em>: filter by an array of edge properties </ul> The attributes of a property filter <ul class=\"swagger-list\"><li><em>key</em>: filter the result edges by a key value pair <li><em>value</em>: the value of the <em>key</em> <li><em>compare</em>: a compare operator",
|
|
"summary": "get edges",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edges\n{ \n \"batchSize\" : 100 \n}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge2\", \n \"_key\" : \"edge2\", \n \"_rev\" : \"1232152739\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v3\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_key\" : \"edge3\", \n \"_rev\" : \"1232677027\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1231628451\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge4\", \n \"_key\" : \"edge4\", \n \"_rev\" : \"1233201315\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v5\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"extra\" : { \n \"stats\" : { \n \"writesExecuted\" : 0, \n \"writesIgnored\" : 0, \n \"scannedFull\" : 4, \n \"scannedIndex\" : 0, \n \"filtered\" : 0 \n }, \n \"warnings\" : [ ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br>",
|
|
"nickname": "getEdges"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edges"
|
|
},
|
|
{
|
|
"operations": [
|
|
{
|
|
"errorResponses": [
|
|
{
|
|
"reason": "is returned if the cursor was created <br><br> <em>Examples</em> <br><br> Select all edges <br><br>",
|
|
"code": "201"
|
|
}
|
|
],
|
|
"parameters": [
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "graph-name",
|
|
"description": "The name of the graph <br><br>"
|
|
},
|
|
{
|
|
"dataType": "String",
|
|
"paramType": "path",
|
|
"required": true,
|
|
"name": "vertex-name",
|
|
"description": "The name of the vertex <br><br>"
|
|
},
|
|
{
|
|
"dataType": "Json",
|
|
"paramType": "body",
|
|
"required": true,
|
|
"name": "edge-properties",
|
|
"description": "The call expects a JSON object as body to filter the result: <br><br>"
|
|
}
|
|
],
|
|
"notes": "<br><br> Returns a cursor. <br><br> The call expects a JSON object as body to filter the result: <br><br> <ul class=\"swagger-list\"><li><em>batchSize</em>: the batch size of the returned cursor <li><em>limit</em>: limit the result size <li><em>count</em>: return the total number of results (default \"false\") <li><em>filter</em>: a optional filter </ul> The attributes of filter <ul class=\"swagger-list\"><li><em>direction</em>: Filter for inbound (value \"in\") or outbound (value \"out\") neighbors. Default value is \"any\". <li><em>labels</em>: filter by an array of edge labels <li><em>properties</em>: filter neighbors by an array of properties </ul> The attributes of a property filter <ul class=\"swagger-list\"><li><em>key</em>: filter the result vertices by a key value pair <li><em>value</em>: the value of the <em>key</em> <li><em>compare</em>: a compare operator",
|
|
"summary": "get edges",
|
|
"httpMethod": "POST",
|
|
"examples": "<br><br><pre><code class=\"json\">shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/graph/graph/edges/v2\n{\"batchSize\" : 100, \"filter\" : { \"direction\" : \"any\" }}\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n \"result\" : [ \n { \n \"_id\" : \"edges/edge1\", \n \"_key\" : \"edge1\", \n \"_rev\" : \"1237526691\", \n \"_from\" : \"vertices/v1\", \n \"_to\" : \"vertices/v2\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n }, \n { \n \"_id\" : \"edges/edge3\", \n \"_key\" : \"edge3\", \n \"_rev\" : \"1238575267\", \n \"_from\" : \"vertices/v2\", \n \"_to\" : \"vertices/v4\", \n \"$label\" : null, \n \"optional1\" : \"val1\" \n } \n ], \n \"hasMore\" : false, \n \"extra\" : { \n \"stats\" : { \n \"writesExecuted\" : 0, \n \"writesIgnored\" : 0, \n \"scannedFull\" : 0, \n \"scannedIndex\" : 0, \n \"filtered\" : 0 \n }, \n \"warnings\" : [ ] \n }, \n \"error\" : false, \n \"code\" : 201 \n}\n</code></pre><br>",
|
|
"nickname": "getEdges"
|
|
}
|
|
],
|
|
"path": "/_api/graph/{graph-name}/edges/{vertex-name}"
|
|
}
|
|
]
|
|
}
|