Banrai Simple Doc Store API (1.0)

Download OpenAPI specification:Download

Authentication

AuthHeader

Security Scheme Type API Key
Header parameter name: api-key

/add

Authorizations:
Request Body schema: application/json

The objects (nodes) to add and optionally connect.

object

Responses

Request samples

Content type
application/json
Example
{
  • "nodes": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "nodes": 3,
  • "invalid_nodes": 0,
  • "edges": 0,
  • "invalid_edges": 0
}

/connect

Authorizations:
Request Body schema: application/json

The objects (nodes) to connect. For pre-existing objects, reference the just the id attributes before attempting to connect them.

object

Responses

Request samples

Content type
application/json
Example
{
  • "nodes": [
    ],
  • "edges": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "nodes": 2,
  • "invalid_nodes": 0,
  • "edges": 2,
  • "invalid_edges": 0
}

/fetch/{id}

Authorizations:
path Parameters
id
required
string
Example: 3

The object id to retrieve (can also be a comma-separated list).

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/remove/{id}

Authorizations:
path Parameters
id
required
string
Example: 4

The object id to remove (can also be a comma-separated list).

Responses

Response samples

Content type
application/json
{
  • "deleted": 1
}

/search

Authorizations:
query Parameters
type
string
Enum: "contains" "startsWith"
Examples:
  • type=contains - find the request body anywhere in an object
  • type=startsWith - find the request body as a starting value in an object

An optional query parameter, to indicate the type of object search (if not present, defaults to exact match).

Request Body schema: application/json

The search criteria to use.

object

Responses

Request samples

Content type
application/json
Example
{
  • "type": "founder"
}

Response samples

Content type
application/json
Example
[
  • {
    },
  • {
    },
  • {
    }
]

/traverse

Authorizations:
query Parameters
id
required
string
Example: id=4

The list of object identifiers to traverse.

bodies
boolean
Default: false
Examples:
  • bodies=true - indicate a node (document) as "()", the full document contents, and edge details as "<-" for inbound, "->" for outbound
  • bodies=false - show only the id attributes

Whether or not to include the object contents in response.

Responses

Response samples

Content type
application/json
Example
[
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ],
  • [
    ]
]