vdb-builder API API documentation version v1
http://localhost:8080/vdb-bench/api/v1
/vdbs
get
List available vdbs
put
post
get /vdbs
List available vdbs
HTTP status code 200
Body
Type: application/json
Example:
{
"vdbs": [
{
"id": "portfolio",
"_links": [
{
"rel": "self",
"href": "/vdbs/portfolio"
},
{
"rel": "content",
"href": "/vdb/portfolio"
}
]
},
{
"id": "tweet-example",
"_links": [
{
"rel": "self",
"href": "/vdbs/tweet-example"
},
{
"rel": "content",
"href": "/vdb/tweet-example"
}
]
},
{
"id": "parts",
"_links": [
{
"rel": "self",
"href": "/vdbs/parts"
},
{
"rel": "content",
"href": "/vdb/parts"
}
]
}
]
}
put /vdbs
post /vdbs
get
Retrieve the meta data for the given vdb
put
delete
get /vdbs/{vdbId}
Retrieve the meta data for the given vdb
URI Parameters
- vdbId: required (string )
Headers
- Accept: required (one of application/json,application/xml )
HTTP status code 200
Body
Type: application/json
Example:
{
"vdbs": [
{
"id": "portfolio",
"_links": [
{
"rel": "self",
"href": "/vdbs/portfolio"
},
{
"rel": "content",
"href": "/vdb/portfolio"
}
]
},
{
"id": "tweet-example",
"_links": [
{
"rel": "self",
"href": "/vdbs/tweet-example"
},
{
"rel": "content",
"href": "/vdb/tweet-example"
}
]
},
{
"id": "parts",
"_links": [
{
"rel": "self",
"href": "/vdbs/parts"
},
{
"rel": "content",
"href": "/vdb/parts"
}
]
}
]
}
Type: application/xml
Example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vdbs>
<vdb id="portfolio">
<links>
<link rel="self" href="/vdbs/portfolio"></link>
<link rel="content" href="/vdb/portfolio"></link>
</links>
</vdb>
<vdb id="tweet-example">
<links>
<link rel="self" href="/vdbs/tweet-example"></link>
<link rel="content" href="/vdb/tweet-example"></link>
</links>
</vdb>
<vdb id="parts">
<links>
<link rel="self" href="/vdbs/parts"></link>
<link rel="content" href="/vdb/parts"></link>
</links>
</vdb>
</vdbs>
HTTP status code 404
Body
Type: application/json
Example:
No vdb named portfolio
put /vdbs/{vdbId}
URI Parameters
- vdbId: required (string )
/vdb
get
Retrieve the content for the given vdb
post
get /vdb/{vdbId}
Retrieve the content for the given vdb
URI Parameters
- vdbId: required (string )
Headers
- Accept: required (one of application/json,application/xml )
HTTP status code 200
Body
Type: application/json
Example:
{
"vdb": [
{
"id": "portfolio",
"name": "Portfolio",
"version": 1,
"description": "The Portfolio Dynamic VDB"
},
{
"id": "tweet-example",
"name": "Tweet Example",
"version": 1,
"description": "The Tweet Example VDB"
},
{
"id": "parts",
"name": "Parts",
"version": 1,
"description": "The Parts VDB"
}
]
}
Type: application/xml
Example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vdb-contents>
<vdb id="portfolio" name="Portfolio" version="1">
<description>The Portfolio Dynamic VDB</description>
</vdb>
<vdb id="tweet-example" name="Tweet Example" version="1">
<description>The Tweet Example VDB</description>
</vdb>
<vdb id="parts" name="Parts" version="1">
<description>The Parts VDB</description>
</vdb>
</vdb-contents>
HTTP status code 404
Body
Type: application/json
Example:
No vdb named portfolio
Type: application/xml
Example:
No vdb content for vdb named portfolio
HTTP status code 406
Request has invalid Accept header
post /vdb/{vdbId}
URI Parameters
- vdbId: required (string )