Neo4j 3.5

Author: martin-neotech

antora.yml

@@ -1,12 +1,12 @@
 name: http-api
 title: HTTP API
-version: '4.4-preview'
-prerelease: true
+version: '3.5'
+prerelease: false
 start_page: ROOT:index.adoc
 nav:
 - modules/ROOT/content-nav.adoc
 asciidoc:
   attributes:
-    neo4j-version: '4.4'
-    neo4j-version-exact: '4.4.0'
-    neo4j-buildnumber: '4.4'
+    neo4j-version: '3.5'
+    neo4j-version-exact: '3.5.29'
+    neo4j-buildnumber: '3.5'

modules/ROOT/content-nav.adoc

@@ -1,20 +1,15 @@
 * xref:index.adoc[]
 * xref:introduction.adoc[]
-* xref:discovery.adoc[]
 * xref:actions/index.adoc[]
-** xref:actions/transaction-flow.adoc[]
-** xref:actions/query-format.adoc[]
-** xref:actions/result-format.adoc[]
+** xref:actions/begin-and-commit-a-transaction-in-one-request.adoc[]
+** xref:actions/execute-multiple-statements.adoc[]
 ** xref:actions/begin-a-transaction.adoc[]
 ** xref:actions/execute-statements-in-an-open-transaction.adoc[]
 ** xref:actions/reset-transaction-timeout-of-an-open-transaction.adoc[]
 ** xref:actions/commit-an-open-transaction.adoc[]
 ** xref:actions/rollback-an-open-transaction.adoc[]
-** xref:actions/begin-and-commit-a-transaction-in-one-request.adoc[]
-** xref:actions/execute-multiple-statements.adoc[]
 ** xref:actions/include-query-statistics.adoc[]
 ** xref:actions/return-results-in-graph-format.adoc[]
-** xref:actions/expired-transactions.adoc[]
 ** xref:actions/handling-errors.adoc[]
 ** xref:actions/handling-errors-in-an-open-transaction.adoc[]
 * xref:security/index.adoc[]

modules/ROOT/pages/actions/begin-a-transaction.adoc

@@ -3,61 +3,57 @@
 [[http-api-begin-a-transaction]]
 = Begin a transaction
 
-A new transaction can be started by posting zero or more Cypher queries to the transaction endpoint.
-The server will respond with the results of your queries, as well as the location of your new transaction.
-
-Transactions expire automatically after a period of inactivity (i.e. queries and a commit).
-By default this is `60` seconds.
-
-To keep a transaction alive without submitting new queries, an empty statement list can be posted to the transaction URI.
+You begin a new transaction by posting zero or more Cypher statements to the transaction endpoint. The server will respond with the result of your statements, as well as the location of your open transaction.
 
 _Example request_
 
-* *+POST+*  +http://localhost:7474/db/neo4j/tx+
+* *+POST+*  +http://localhost:7474/db/data/transaction+
 * *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
 [source, JSON, role="nocopy"]
 ----
 {
-  "statements" : [ {
-    "statement" : "CREATE (n $props) RETURN n",
-    "parameters" : {
-      "props" : {
-        "name" : "My Node"
+  "statements": [
+    {
+      "statement": "CREATE (n $props) RETURN n",
+      "parameters": {
+        "props": {
+          "name": "My Node"
+        }
       }
     }
-  } ]
+  ]
 }
 ----
 
 _Example response_
 
 * *+201:+* +Created+
-* *+Content-Type:+* +application/json;charset=utf-8+
-* *+Location:+* +http://localhost:7474/db/neo4j/tx/16+
+* *+Content-Type:+* +application/json+
+* *+Location:+* +http://localhost:7474/db/data/transaction/10+
 
 [source, JSON, role="nocopy"]
 ----
 {
+  "commit" : "http://localhost:7474/db/data/transaction/10/commit",
   "results" : [ {
     "columns" : [ "n" ],
     "data" : [ {
       "row" : [ {
         "name" : "My Node"
       } ],
       "meta" : [ {
-        "id" : 11,
+        "id" : 10,
         "type" : "node",
         "deleted" : false
       } ]
     } ]
   } ],
-  "errors" : [ ],
-  "commit" : "http://localhost:7474/db/neo4j/tx/16/commit",
   "transaction" : {
-    "expires" : "Mon, 20 Sep 2021 07:57:37 GMT"
-  }
+    "expires" : "Mon, 27 Sep 2021 08:28:00 +0000"
+  },
+  "errors" : [ ]
 }
 ----
 

modules/ROOT/pages/actions/begin-and-commit-a-transaction-in-one-request.adoc

@@ -3,13 +3,11 @@
 [[http-api-begin-and-commit-a-transaction-in-one-request]]
 = Begin and commit a transaction in one request
 
-== Begin and commit request
-
 If there is no need to keep a transaction open across multiple HTTP requests, you can begin a transaction, execute statements, and commit within a single HTTP request.
 
 _Example request_
 
-* *+POST+* +http://localhost:7474/db/neo4j/tx/commit+
+* *+POST+* +http://localhost:7474/db/data/transaction/commit+
 * *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
@@ -18,10 +16,7 @@ _Example request_
 {
   "statements": [
     {
-      "statement": "MATCH (n) WHERE id(n) = $nodeId RETURN n",
-      "parameters": {
-        "nodeId": 7
-      }
+      "statement": "CREATE (n) RETURN id(n)"
     }
   ]
 }
@@ -30,74 +25,16 @@ _Example request_
 _Example response_
 
 * *+200:+* +OK+
-* *+Content-Type:+* +application/json;charset=utf-8+
-
-[source, JSON, role="nocopy"]
-----
-{
-  "results" : [ {
-    "columns" : [ "n" ],
-    "data" : [ {
-      "row" : [ { } ],
-      "meta" : [ {
-        "id" : 7,
-        "type" : "node",
-        "deleted" : false
-      } ]
-    } ]
-  } ],
-  "errors" : [ ]
-}
-----
-
-
-== Legacy Endpoints label:deprecated[]
-
-[IMPORTANT]
-====
-The API described in this section of the manual has been deprecated and will be removed in Neo4j 5.0.
-====
-
-Starting with Neo4j version 4.3, statements submitted via these endpoints will be processed by the user's respective _home database_.
-Previous versions rely on the the globally configured _default database_.
-
-_Example request_
-
-* *+POST+* +http://localhost:7474/db/neo4j/tx/commit+
-* *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
-[source, JSON, role="nocopy"]
-----
-{
-  "statements": [
-    {
-      "statement": "MATCH (n) WHERE id(n) = $nodeId RETURN n",
-      "parameters": {
-        "nodeId": 2
-      }
-    }
-  ]
-}
-----
-
-_Example response_
-
-* *+200:+* +OK+
-* *+Content-Type:+* +application/json;charset=utf-8+
-
 [source, JSON, role="nocopy"]
 ----
 {
   "results" : [ {
-    "columns" : [ "n" ],
+    "columns" : [ "id(n)" ],
     "data" : [ {
-      "row" : [ { } ],
-      "meta" : [ {
-        "id" : 2,
-        "type" : "node",
-        "deleted" : false
-      } ]
+      "row" : [ 6 ],
+      "meta" : [ null ]
     } ]
   } ],
   "errors" : [ ]

modules/ROOT/pages/actions/commit-an-open-transaction.adoc

@@ -1,13 +1,14 @@
 :description: Commit a transaction.
 
 [[http-api-commit-an-open-transaction]]
-= Commit a transaction
+= Commit an open transaction
 
-When you have executed all the statements for the transaction, and want to commit the changes to the database, you can use `POST db/\{name}/tx/\{txid}/commit`, which can also include any final statements to execute before committing.
+Given you have an open transaction, you can send a commit request.
+Optionally, you can submit additional statements along with the request that will be executed before committing the transaction.
 
 _Example request_
 
-* *+POST+*  +http://localhost:7474/db/neo4j/tx/2/commit+
+* *+POST+*  +http://localhost:7474/db/data/transaction/6/commit+
 * *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
@@ -16,10 +17,7 @@ _Example request_
 {
   "statements": [
     {
-      "statement": "MATCH (n) WHERE id(n) = $nodeId RETURN n",
-      "parameters": {
-        "nodeId": 6
-      }
+      "statement": "CREATE (n) RETURN id(n)"
     }
   ]
 }
@@ -28,20 +26,16 @@ _Example request_
 _Example response_
 
 * *+200:+* +OK+
-* *+Content-Type:+* +application/json;charset=utf-8+
+* *+Content-Type:+* +application/json+
 
 [source, JSON, role="nocopy"]
 ----
 {
   "results" : [ {
-    "columns" : [ "n" ],
+    "columns" : [ "id(n)" ],
     "data" : [ {
-      "row" : [ { } ],
-      "meta" : [ {
-        "id" : 6,
-        "type" : "node",
-        "deleted" : false
-      } ]
+      "row" : [ 5 ],
+      "meta" : [ null ]
     } ]
   } ],
   "errors" : [ ]

modules/ROOT/pages/actions/execute-multiple-statements.adoc

@@ -8,7 +8,7 @@ The response will contain the result of each statement.
 
 _Example request_
 
-* *+POST+*  +http://localhost:7474/db/neo4j/tx/commit+
+* *+POST+*  +http://localhost:7474/db/data/transaction/commit+
 * *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
@@ -17,9 +17,14 @@ _Example request_
 {
   "statements": [
     {
-      "statement": "MATCH (n) WHERE id(n) = $nodeId RETURN n",
+      "statement": "CREATE (n) RETURN id(n)"
+    },
+    {
+      "statement": "CREATE (n $props) RETURN n",
       "parameters": {
-        "nodeId": 3
+        "props": {
+          "name": "My Node"
+        }
       }
     }
   ]
@@ -29,15 +34,23 @@ _Example request_
 _Example response_
 
 * *+200:+* +OK+
-* *+Content-Type:+* +application/json;charset=utf-8+
+* *+Content-Type:+* +application/json+
 
-[source,javascript]
+[source, JSON, role="nocopy"]
 ----
 {
   "results" : [ {
+    "columns" : [ "id(n)" ],
+    "data" : [ {
+      "row" : [ 2 ],
+      "meta" : [ null ]
+    } ]
+  }, {
     "columns" : [ "n" ],
     "data" : [ {
-      "row" : [ { } ],
+      "row" : [ {
+        "name" : "My Node"
+      } ],
       "meta" : [ {
         "id" : 3,
         "type" : "node",

modules/ROOT/pages/actions/execute-statements-in-an-open-transaction.adoc

@@ -1,14 +1,13 @@
 :description: Run queries in a transaction.
 
 [[http-api-execute-statements-in-an-open-transaction]]
-= Run queries inside a transaction
+= Execute statements in an open transaction
 
-Once you have an open transaction by calling `db/\{name}/tx`, you can run additional statements that form part of your transaction by calling the newly created transaction endpoint.
-The endpoint will be in the form `db/\{name}/tx/\{txid}`, where `txid` is provided in the response of the initial call to begin the transaction.
+Given that you have an open transaction, you can make a number of requests, each of which executes additional statements, and keep the transaction open by resetting the transaction timeout.
 
 _Example request_
 
-* *+POST+*  +http://localhost:7474/db/neo4j/tx/18+
+* *+POST+*  +http://localhost:7474/db/data/transaction/12+
 * *+Accept:+* +application/json;charset=UTF-8+
 * *+Content-Type:+* +application/json+
 
@@ -26,27 +25,27 @@ _Example request_
 _Example response_
 
 * *+200:+* +OK+
-* *+Content-Type:+* +application/json;charset=utf-8+
+* *+Content-Type:+* +application/json+
 
 [source, JSON, role="nocopy"]
 ----
 {
+  "commit" : "http://localhost:7474/db/data/transaction/12/commit",
   "results" : [ {
     "columns" : [ "n" ],
     "data" : [ {
       "row" : [ { } ],
       "meta" : [ {
-        "id" : 12,
+        "id" : 11,
         "type" : "node",
         "deleted" : false
       } ]
     } ]
   } ],
-  "errors" : [ ],
-  "commit" : "http://localhost:7474/db/neo4j/tx/18/commit",
   "transaction" : {
-    "expires" : "Mon, 20 Sep 2021 07:57:38 GMT"
-  }
+    "expires" : "Mon, 27 Sep 2021 08:28:00 +0000"
+  },
+  "errors" : [ ]
 }
 ----