The Neo4j Manual v3.1.0-SNAPSHOT20.13. Node labels

Figure 20.52. Starting Graph

Figure 20.53. Final Graph

Example request

"Person"

Example response

Figure 20.54. Starting Graph

Figure 20.55. Final Graph

Example request

[ "Person", "Actor" ]

Example response

Labels with empty names are not allowed, however, all other valid strings are accepted as label names. Adding an invalid label to a node will lead to a HTTP 400 response.

Example request

""

Example response

{
  "message": "Unable to add label, see nested exception.",
  "exception": "BadInputException",
  "fullname": "org.neo4j.server.rest.repr.BadInputException",
  "stackTrace": [
    "org.neo4j.server.rest.web.DatabaseActions.addLabelToNode(DatabaseActions.java:310)",
    "org.neo4j.server.rest.web.RestfulGraphDatabase.addNodeLabel(RestfulGraphDatabase.java:446)",
    "java.lang.reflect.Method.invoke(Method.java:497)",
    "org.neo4j.server.rest.transactional.TransactionalRequestDispatcher.dispatch(TransactionalRequestDispatcher.java:145)",
    "org.neo4j.server.rest.dbms.AuthorizationDisabledFilter.doFilter(AuthorizationDisabledFilter.java:48)",
    "org.neo4j.server.rest.web.CollectUserAgentFilter.doFilter(CollectUserAgentFilter.java:69)",
    "java.lang.Thread.run(Thread.java:745)"
  ],
  "cause": {
    "exception": "ConstraintViolationException",
    "cause": {
      "exception": "IllegalTokenNameException",
      "fullname": "org.neo4j.kernel.api.exceptions.schema.IllegalTokenNameException",
      "stackTrace": [
        "org.neo4j.kernel.impl.api.DataIntegrityValidatingStatementOperations.checkValidTokenName(DataIntegrityValidatingStatementOperations.java:255)",
        "org.neo4j.kernel.impl.api.DataIntegrityValidatingStatementOperations.labelGetOrCreateForName(DataIntegrityValidatingStatementOperations.java:88)",
        "org.neo4j.kernel.impl.api.OperationsFacade.labelGetOrCreateForName(OperationsFacade.java:874)",
        "org.neo4j.kernel.impl.core.NodeProxy.addLabel(NodeProxy.java:582)",
        "org.neo4j.server.rest.web.DatabaseActions.addLabelToNode(DatabaseActions.java:305)",
        "org.neo4j.server.rest.web.RestfulGraphDatabase.addNodeLabel(RestfulGraphDatabase.java:446)",
        "java.lang.reflect.Method.invoke(Method.java:497)",
        "org.neo4j.server.rest.transactional.TransactionalRequestDispatcher.dispatch(TransactionalRequestDispatcher.java:145)",
        "org.neo4j.server.rest.dbms.AuthorizationDisabledFilter.doFilter(AuthorizationDisabledFilter.java:48)",
        "org.neo4j.server.rest.web.CollectUserAgentFilter.doFilter(CollectUserAgentFilter.java:69)",
        "java.lang.Thread.run(Thread.java:745)"
      ],
      "message": "\u0027\u0027 is not a valid token name. Only non-null, non-empty strings are allowed.",
      "errors": [
        {
          "code": "Neo.ClientError.Schema.TokenNameError",
          "message": "\u0027\u0027 is not a valid token name. Only non-null, non-empty strings are allowed."
        }
      ]
    },
    "fullname": "org.neo4j.graphdb.ConstraintViolationException",
    "stackTrace": [
      "org.neo4j.kernel.impl.core.NodeProxy.addLabel(NodeProxy.java:592)",
      "org.neo4j.server.rest.web.DatabaseActions.addLabelToNode(DatabaseActions.java:305)",
      "org.neo4j.server.rest.web.RestfulGraphDatabase.addNodeLabel(RestfulGraphDatabase.java:446)",
      "java.lang.reflect.Method.invoke(Method.java:497)",
      "org.neo4j.server.rest.transactional.TransactionalRequestDispatcher.dispatch(TransactionalRequestDispatcher.java:145)",
      "org.neo4j.server.rest.dbms.AuthorizationDisabledFilter.doFilter(AuthorizationDisabledFilter.java:48)",
      "org.neo4j.server.rest.web.CollectUserAgentFilter.doFilter(CollectUserAgentFilter.java:69)",
      "java.lang.Thread.run(Thread.java:745)"
    ],
    "message": "Invalid label name \u0027\u0027.",
    "errors": [
      {
        "code": "Neo.ClientError.Schema.ConstraintValidationFailed",
        "message": "Invalid label name \u0027\u0027."
      }
    ]
  },
  "errors": [
    {
      "code": "Neo.ClientError.Request.InvalidFormat",
      "message": "Unable to add label, see nested exception."
    }
  ]
}

This removes any labels currently on a node, and replaces them with the labels passed in as the request body.

Figure 20.56. Starting Graph

Figure 20.57. Final Graph

Example request

[ "Actor", "Director" ]

Example response

Figure 20.58. Starting Graph

Figure 20.59. Final Graph

Example request

Example response

Figure 20.60. Starting Graph

Figure 20.61. Final Graph

Example request

Example response

Figure 20.62. Final Graph

Example request

Example response

[ "Actor", "Director" ]

Figure 20.63. Final Graph

Example request

Example response

[ {
  "metadata" : {
    "id" : 82,
    "labels" : [ "Actor" ]
  },
  "data" : {
    "name" : "Donald Sutherland"
  },
  "paged_traverse" : "http://localhost:7474/db/data/node/82/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "outgoing_relationships" : "http://localhost:7474/db/data/node/82/relationships/out",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/out/{-list|&|types}",
  "create_relationship" : "http://localhost:7474/db/data/node/82/relationships",
  "labels" : "http://localhost:7474/db/data/node/82/labels",
  "traverse" : "http://localhost:7474/db/data/node/82/traverse/{returnType}",
  "extensions" : { },
  "all_relationships" : "http://localhost:7474/db/data/node/82/relationships/all",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/82/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/82",
  "incoming_relationships" : "http://localhost:7474/db/data/node/82/relationships/in",
  "properties" : "http://localhost:7474/db/data/node/82/properties",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/in/{-list|&|types}"
}, {
  "metadata" : {
    "id" : 84,
    "labels" : [ "Actor", "Director" ]
  },
  "data" : {
    "name" : "Clint Eastwood"
  },
  "paged_traverse" : "http://localhost:7474/db/data/node/84/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "outgoing_relationships" : "http://localhost:7474/db/data/node/84/relationships/out",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/out/{-list|&|types}",
  "create_relationship" : "http://localhost:7474/db/data/node/84/relationships",
  "labels" : "http://localhost:7474/db/data/node/84/labels",
  "traverse" : "http://localhost:7474/db/data/node/84/traverse/{returnType}",
  "extensions" : { },
  "all_relationships" : "http://localhost:7474/db/data/node/84/relationships/all",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/84/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/84",
  "incoming_relationships" : "http://localhost:7474/db/data/node/84/relationships/in",
  "properties" : "http://localhost:7474/db/data/node/84/properties",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/in/{-list|&|types}"
} ]

You can retrieve all nodes with a given label and property by passing one property as a query parameter. Notice that the property value is JSON-encoded and then URL-encoded.

If there is an index available on the label/property combination you send, that index will be used. If no index is available, all nodes with the given label will be filtered through to find matching nodes.

Currently, it is not possible to search using multiple properties.

Figure 20.64. Final Graph

Example request

Example response

[ {
  "metadata" : {
    "id" : 87,
    "labels" : [ "Person" ]
  },
  "data" : {
    "name" : "Clint Eastwood"
  },
  "paged_traverse" : "http://localhost:7474/db/data/node/87/paged/traverse/{returnType}{?pageSize,leaseTime}",
  "outgoing_relationships" : "http://localhost:7474/db/data/node/87/relationships/out",
  "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/87/relationships/out/{-list|&|types}",
  "create_relationship" : "http://localhost:7474/db/data/node/87/relationships",
  "labels" : "http://localhost:7474/db/data/node/87/labels",
  "traverse" : "http://localhost:7474/db/data/node/87/traverse/{returnType}",
  "extensions" : { },
  "all_relationships" : "http://localhost:7474/db/data/node/87/relationships/all",
  "all_typed_relationships" : "http://localhost:7474/db/data/node/87/relationships/all/{-list|&|types}",
  "property" : "http://localhost:7474/db/data/node/87/properties/{key}",
  "self" : "http://localhost:7474/db/data/node/87",
  "incoming_relationships" : "http://localhost:7474/db/data/node/87/relationships/in",
  "properties" : "http://localhost:7474/db/data/node/87/properties",
  "incoming_typed_relationships" : "http://localhost:7474/db/data/node/87/relationships/in/{-list|&|types}"
} ]

By default, the server will return labels in use only. If you also want to return labels not in use, append the "in_use=0" query parameter.

Example request

Example response

[ "Actor", "Director", "Person" ]