Web Service Method: Request a List of Training Boxes
Abstract
Web Service Method: Request a List of Training Boxes
Description |
|---|
Get a list of existing training boxes. |
URL: /PoolParty/api/classification/{project}/boxes
Content-Type
Content-Type: */*
Request
Supported Methods |
|---|
GET |
Path Variables
Variable | Description |
|---|---|
{project} | The project UUID or textual identifier |
Response
This method returns execution results in JSON format.
JsonBucketList
Attribute | Type |
|---|---|
jsonBoxList | Array of JsonBucket |
message | String |
plainMessage | String |
reportable | boolean |
success | boolean |
Example Response of a JsonBucketList
{
"jsonBoxList" : [ {
"name" : "some name",
"language" : "nl",
"uri" : "https://semantic-web.com/api/uri#9163"
} ],
"plainMessage" : "some plainMessage",
"success" : true,
"reportable" : true,
"message" : "some message"
}JsonBucket
Attribute | Type | Comment |
|---|---|---|
language | String | Language of box (en|de|es|fr|...) |
name | String | Box name |
uri | String | Box id |
Example Response of a JsonBucket
{
"name" : "some name",
"language" : "nl",
"uri" : "https://semantic-web.com/api/uri#8514"
}