IGP.md · Admin/InteractiveGraph

* [command=init](#commandinit)
	* [request parameter](#requestparameter)
	* [response body](#responsebody)
* [command=loadGraph](#commandloadGraph)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=getNodesInfo](#commandgetNodesInfo)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=search](#commandsearch)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=getNeighbours](#commandgetNeighbours)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=findRelations](#commandfindRelations)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=getMoreRelations](#commandgetMoreRelations)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)
* [command=stopFindRelations](#commandstopFindRelations)
	* [request parameter](#requestparameter-1)
	* [response body](#responsebody-1)

# InteractiveGraphProtocol

InteractiveGraphProtocol(IGP) defines a set of graph interaction interfaces via HTTP protocol.

An IGP request is a HTTP POST request, which contains a `command` parameter in query string and a JSON parameter in request body, like:

```
curl 'http://localhost:9999/graphserver/connector-neodb?command=getNodesInfo' -d '{"nodeIds":[84]}'
```
Here, the command is `getNodesInfo` and the parameter is:
```
{
    "nodeIds": [84]
}
```

An IGP response is a HTTP response with a body in JSON format, like:

```
HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Access-Control-Allow-Origin: *
Content-Type: text/json;charset=utf-8
Content-Length: 669
Date: Sun, 14 Oct 2018 03:22:37 GMT
{
  "infos": [
    "\u003cp align\u003dcenter\u003e  \u003cimg width\u003d150 src\u003d\"./images/photo/贾宝玉.jpg\"\u003e\u003cbr\u003e  \u003cb\u003e贾宝玉[84]\u003c/b\u003e\u003c/p\u003e\u003cp align\u003dleft\u003e\"荣国府衔玉而诞的公子，贾政与王夫人之次子，阖府捧为掌上明珠，对他寄予厚望，他却走上了叛逆之路，痛恨八股文，批判程朱理学，给那些读书做官的人起名“国贼禄蠹”。他不喜欢“正经书”，却偏爱《牡丹亭》《西厢记》之类的“杂书”。他终日与家里的女孩们厮混，爱她们美丽纯洁，伤悼她们的薄命悲剧。\"\u003c/p\u003e"
  ]
}
```
Here, a JSON object is returned within a `infos` property, which contains an array of informations of a set of requested nodes(nodeIds=[84]).

Each IGP response has a `Content-Type` header with value `text/json;charset=utf-8`. For cross-domain applications, a `Access-Control-Allow-Origin` header is often required.

## <a name='commandinit'></a>command=init
Be requested when a client/browser is to connect to this server.

### <a name='requestparameter'></a>request parameter

This command requires no parameter, so pass an empty object is ok.

example:
```
{}
```

### <a name='responsebody'></a>response body

| name | value type |description | example |
|--|--|--|--|
|product|string|product name of connector|'neo4j'|
|backendType|string|backend graphdb type, may be 'neo4j-db', 'neo4j-bolt' or 'neo4j-gson'|'neo4j-bolt'|
|nodesCount|number|number of nodes|327|
|edgesCount|number|number of edges|694|
|categories|object|categories of all nodes, in name-title pairs format|{"person": "人物"}|

example:
```
{
  "edgesCount": 694,
  "nodesCount": 327,
  "backendType": "neo4j-db",
  "categories": {
    "person": "人物",
    "event": "事件",
    "location": "地点"
  },
  "product": "neo4j"
}
```
## <a name='commandloadGraph'></a>command=loadGraph
Be requested when a client/browser is to load whole graph data, including nodes and edges.

### <a name='requestparameter-1'></a>request parameter
This command requires no parameter, so pass an empty object is ok.