Neat API¶

This API documentation is manually updated.

GET /dev/elastic/set/dolphins¶

Create and load dolphins index

Status Codes:	201 Created – Document index created

GET /dev/neo/set/dolphins¶

Drop database and upload dolphins JSON data into Neo4j

Status Codes:	201 Created – Neo4j graph loaded

GET /dev/elastic/search¶

Return the elastic results of a document search using query parameters.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

[
    {
        "_index": "dolphins",
        "_source": {
            "dolphins": [
                "Zap",
                "CCL"
            ]
        },
        "_id": "AVrDasjxocluSgWq6vsT",
        "_type": "dolphin_sighting",
        "_score": 2.6732156
    },
    {
        "_index": "dolphins",
        "_source": {
            "dolphins": [
                "Zap",
                "Double"
            ]
        },
        "_id": "AVrDasj8ocluSgWq6vsU",
        "_type": "dolphin_sighting",
        "_score": 2.6732156
    }
]

Query Parameters:
	label (string) – id of dolphin to search documents for
Status Codes:	200 OK – OK

GET /dev/elastic/reset¶

Drop elastic indexes

Status Codes:	204 No Content – Indexes dropped

GET /dev/elastic/seed¶

Seed a node (and mentioning documents) from elastic to neo, and return the node id

Example response:

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": "Zap"
}

Query Parameters:
	label (string) – id of dolphin to search documents for
Status Codes:	201 Created – Created graph node(s)

GET /dev/neo/fullgraph¶

Get JSON representing full graph

See Neo-D3-JSON Example Response.

Status Codes:	200 OK – OK

GET /dev/neo/reset¶

Drop neo4j database

Status Codes:	204 No Content – Database dropped

GET /configuration/synaptic-scout¶: Get JSON config for synaptic-scout

GET /¶: Get JSON representing endpoints

GET /dev/neo/subgraph/(string: central_node_id)¶

Get JSON representing subgraph centered on a single node

See Neo-D3-JSON Example Response.

Status Codes:	200 OK – OK

GET /explore/subgraph/(string: central_node_id)¶

Get JSON representing subgraph centered on a single node

See Neo-D3-JSON Example Response.

Status Codes:	200 OK – OK

GET /static/(path: filename)¶: Function used internally to send static files from the static folder to the browser.

New in version 0.5.