Labelbase API

# Install the command line client
$ pip install coreapi-cli

<!-- Load the JavaScript client library -->
<script src="/static/rest_framework/js/coreapi-0.1.1.js"></script>
<script src="/api-reference/schema.js"></script>

# Install the Python client library
$ pip install coreapi

labelbase

list

GET /api/v0/labelbase/

Retrieve labelbase with the given id or return all.

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "list"]
result = client.action(schema, action)

create

POST /api/v0/labelbase/

Create the new labelbase.

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "create"]
result = client.action(schema, action)

update

PUT /api/v0/labelbase/

Update labelbase with the given id.

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase update

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "update"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "update"]
result = client.action(schema, action)

delete

DELETE /api/v0/labelbase/

Delete the labelbase with the given id.

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase delete

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "delete"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "delete"]
result = client.action(schema, action)

read

GET /api/v0/labelbase/{id}/

Retrieve labelbase with the given id or return all.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase read -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "read"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

create_0

POST /api/v0/labelbase/{id}/

Create the new labelbase.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase create_0 -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "create_0"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "create_0"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

update_0

PUT /api/v0/labelbase/{id}/

Update labelbase with the given id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase update_0 -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "update_0"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "update_0"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

delete_0

DELETE /api/v0/labelbase/{id}/

Delete the labelbase with the given id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase delete_0 -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "delete_0"]
var params = {
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "delete_0"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

label > list

GET /api/v0/labelbase/{labelbase_id}/label/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label list -p labelbase_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; list"]
var params = {
    labelbase_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; list"]
params = {
    "labelbase_id": ...,
}
result = client.action(schema, action, params=params)

label > create

POST /api/v0/labelbase/{labelbase_id}/label/

Create the new label within a labelbase accessed by the given id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label create -p labelbase_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; create"]
var params = {
    labelbase_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; create"]
params = {
    "labelbase_id": ...,
}
result = client.action(schema, action, params=params)

label > update

PUT /api/v0/labelbase/{labelbase_id}/label/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label update -p labelbase_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; update"]
var params = {
    labelbase_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; update"]
params = {
    "labelbase_id": ...,
}
result = client.action(schema, action, params=params)

label > delete

DELETE /api/v0/labelbase/{labelbase_id}/label/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label delete -p labelbase_id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; delete"]
var params = {
    labelbase_id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; delete"]
params = {
    "labelbase_id": ...,
}
result = client.action(schema, action, params=params)

label > read

GET /api/v0/labelbase/{labelbase_id}/label/{id}/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label read -p labelbase_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; read"]
var params = {
    labelbase_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; read"]
params = {
    "labelbase_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

label > create_0

POST /api/v0/labelbase/{labelbase_id}/label/{id}/

Create the new label within a labelbase accessed by the given id.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label create_0 -p labelbase_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; create_0"]
var params = {
    labelbase_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; create_0"]
params = {
    "labelbase_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

label > update_0

PUT /api/v0/labelbase/{labelbase_id}/label/{id}/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label update_0 -p labelbase_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; update_0"]
var params = {
    labelbase_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; update_0"]
params = {
    "labelbase_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)

label > delete_0

DELETE /api/v0/labelbase/{labelbase_id}/label/{id}/

Label

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`labelbase_id` required
`id` required

# Load the schema document
$ coreapi get http://labelbase.space/api-reference/

# Interact with the API endpoint
$ coreapi action labelbase label delete_0 -p labelbase_id=... -p id=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["labelbase", "label &gt; delete_0"]
var params = {
    labelbase_id: ...,
    id: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("http://labelbase.space/api-reference/")

# Interact with the API endpoint
action = ["labelbase", "label &gt; delete_0"]
params = {
    "labelbase_id": ...,
    "id": ...,
}
result = client.action(schema, action, params=params)