-
Notifications
You must be signed in to change notification settings - Fork 15
API Overview
See also linkedin and facebook examples
Returns details about the Neo4j database like the location of the database and the number of nodes.
Returns all nodes in the database. Use this method with caution, this could crash your server if you have a database with more then a few thousand nodes.
Creates a new node in the neo4j database. Any parameters based in the body of the POST will be treated as properties for the node and will be stored in the database.
Returns the properties for the specified node, where :node_id is the numeric id for the node
Updates the properties of the specified node, where :node_id is the numeric id for the node. Any parameters pased in the body of the PUT will be treated as properties for the node. If you add a new parameters (i.e. age=4) which previously were not on the node, neo4jr-social will still add that property to the node.
Deletes the specified node, where :node_id is the numeric id for the node.
Creates a relations for the specified node, where :node_id is the numeric id for the node. This is how you designate how two nodes are related to each other.
- Required: to – this is the node id of the node you want to make a relationship to. This is a one-way relationship. If you want both nodes to be related to each other you will need to make individual POSTs for each direction of the relationship.
- Required: type – this is the type of the relationship, i.e. ‘friends’. This can be any string that is sensible in your domain.
- Optional: Any other parameters you supply in the body of the POST will be added as properties to the relationship. For example if you were making ‘friend’ relationships and wanted to add a date since the friendship started you could pass a ‘since’ parameter in the POST.
Returns relationships to other nodes for the specified node, where :node_id is the numeric id for the node.
- Optional: type – Specify a type if only certain relationships are of interest
This returns all the ways two nodes are connected to each other and is similar to LinkedIn’s degrees of separation.
- Required: to – the id of the node that your trying to find a path to from the starting node, :node_id
- Required: type – the type of relationships between nodes to follow
- Optional: depth – maximum degrees of separation to find, the default is 2 degrees. Note: There may be performance impacts if this number is to high.
- Optional: direction – What direction of relationships to follow, the default is ‘both’
This returns the shortest path of two nodes that are connected to each other
- Required: to – the id of the node that your trying to find a path to from the starting node, :node_id
- Required: type – the type of relationships between nodes to follow
This returns node suggestions for the given :node_id. This is similar to facebook friend suggestions where your friend’s friends that your not friends with are suggested to you.
- Required: type – the type of relationships between nodes to follow
- Optional: level – the degree of separation that you want recommendations for, the default is 1 degree away which is similar to facebook’s behavior