Tools4MSP 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="/docs/schema.js"></script>

# Install the Python client library
$ pip install coreapi

api

casestudies > list

GET /api/casestudies/

Return the list of available CaseStudies.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cstype`
`module`
`tag`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies list -p cstype=... -p module=... -p tag=...

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 = ["api", "casestudies &gt; list"]
var params = {
    cstype: ...,
    module: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; list"]
params = {
    "cstype": ...,
    "module": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > create

POST /api/casestudies/

Add a new Case Study Adds a new Case Study to the server. To ad additional inputs use the following methods: * see [/casestudies/{casestudyId}/layers](#api-casestudies-layers-create) for adding a new Layer * see [/casestudies/{casestudyId}/inputs](#api-casestudies-inputs-create) from adding new input parameters or datasets

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`label` required
`description`
`module` required
`cstype` required
`tag`
`resolution`	resoution of analysis (meters)
`domain_area`	polygon geometry(Lat Log WGS84)
`domain_area_terms`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies create -p label=... -p description=... -p module=... -p cstype=... -p tag=... -p resolution=... -p domain_area=... -p domain_area_terms=...

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 = ["api", "casestudies &gt; create"]
var params = {
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; create"]
params = {
    "label": ...,
    "description": ...,
    "module": ...,
    "cstype": ...,
    "tag": ...,
    "resolution": ...,
    "domain_area": ...,
    "domain_area_terms": ...,
}
result = client.action(schema, action, params=params)

casestudies > read

GET /api/casestudies/{id}/

Return a user instance.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cstype`
`module`
`tag`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies read -p id=... -p cstype=... -p module=... -p tag=...

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 = ["api", "casestudies &gt; read"]
var params = {
    id: ...,
    cstype: ...,
    module: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; read"]
params = {
    "id": ...,
    "cstype": ...,
    "module": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > update

PUT /api/casestudies/{id}/

Update a user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cstype`
`module`
`tag`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`label` required
`description`
`module` required
`cstype` required
`tag`
`resolution`	resoution of analysis (meters)
`domain_area`	polygon geometry(Lat Log WGS84)
`domain_area_terms`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies update -p id=... -p label=... -p description=... -p module=... -p cstype=... -p tag=... -p resolution=... -p domain_area=... -p domain_area_terms=... -p cstype=... -p module=... -p tag=...

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 = ["api", "casestudies &gt; update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
    cstype: ...,
    module: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; update"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "module": ...,
    "cstype": ...,
    "tag": ...,
    "resolution": ...,
    "domain_area": ...,
    "domain_area_terms": ...,
    "cstype": ...,
    "module": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > partial_update

PATCH /api/casestudies/{id}/

Update one or more fields on an existing user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cstype`
`module`
`tag`

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`label`
`description`
`module`
`cstype`
`tag`
`resolution`	resoution of analysis (meters)
`domain_area`	polygon geometry(Lat Log WGS84)
`domain_area_terms`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies partial_update -p id=... -p label=... -p description=... -p module=... -p cstype=... -p tag=... -p resolution=... -p domain_area=... -p domain_area_terms=... -p cstype=... -p module=... -p tag=...

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 = ["api", "casestudies &gt; partial_update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
    cstype: ...,
    module: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; partial_update"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "module": ...,
    "cstype": ...,
    "tag": ...,
    "resolution": ...,
    "domain_area": ...,
    "domain_area_terms": ...,
    "cstype": ...,
    "module": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > delete

DELETE /api/casestudies/{id}/

Remove an existing user.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`cstype`
`module`
`tag`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies delete -p id=... -p cstype=... -p module=... -p tag=...

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 = ["api", "casestudies &gt; delete"]
var params = {
    id: ...,
    cstype: ...,
    module: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; delete"]
params = {
    "id": ...,
    "cstype": ...,
    "module": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > clone

GET /api/casestudies/{id}/clone/

Clone the Case Study :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies clone -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 = ["api", "casestudies &gt; clone"]
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; clone"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

casestudies > cloneupdate

POST /api/casestudies/{id}/cloneupdate/

Clone the Case Study :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`label` required
`description`
`tag`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies cloneupdate -p id=... -p label=... -p description=... -p tag=...

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 = ["api", "casestudies &gt; cloneupdate"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    tag: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; cloneupdate"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

casestudies > run

GET /api/casestudies/{id}/run/

Run the module :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`selected_layers`	Comma-separated list of layer codes
`runtypelevel`	Level of run type: 3 (default)

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies run -p id=... -p selected_layers=... -p runtypelevel=...

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 = ["api", "casestudies &gt; run"]
var params = {
    id: ...,
    selected_layers: ...,
    runtypelevel: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; run"]
params = {
    "id": ...,
    "selected_layers": ...,
    "runtypelevel": ...,
}
result = client.action(schema, action, params=params)

casestudies > setcontext

GET /api/casestudies/{id}/setcontext/{context_label}/

Run the module :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required
`context_label` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies setcontext -p id=... -p context_label=...

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 = ["api", "casestudies &gt; setcontext"]
var params = {
    id: ...,
    context_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; setcontext"]
params = {
    "id": ...,
    "context_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > list

GET /api/casestudies/{parent_lookup_casestudy__id}/inputs/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs list -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; inputs &gt; list"]
var params = {
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; list"]
params = {
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > create

POST /api/casestudies/{parent_lookup_casestudy__id}/inputs/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs create -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; inputs &gt; create"]
var params = {
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; create"]
params = {
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > read

GET /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs read -p id=... -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; inputs &gt; read"]
var params = {
    id: ...,
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; read"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > update

PUT /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs update -p id=... -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; inputs &gt; update"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; update"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > partial_update

PATCH /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs partial_update -p id=... -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; inputs &gt; partial_update"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; partial_update"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > delete

DELETE /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/

API endpoint that allows CaseStudy Input datasets to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs delete -p id=... -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; inputs &gt; delete"]
var params = {
    id: ...,
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; delete"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > tupload

PUT /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/tupload/

Upload the thumbnail :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs tupload -p id=... -p parent_lookup_casestudy__id=... -p file=...

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 = ["api", "casestudies &gt; inputs &gt; tupload"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    file: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; tupload"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

casestudies > inputs > upload

PUT /api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/upload/

Upload the file :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study input.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies inputs upload -p id=... -p parent_lookup_casestudy__id=... -p file=...

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 = ["api", "casestudies &gt; inputs &gt; upload"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    file: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; inputs &gt; upload"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > list

GET /api/casestudies/{parent_lookup_casestudy__id}/layers/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers list -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; layers &gt; list"]
var params = {
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; list"]
params = {
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > create

POST /api/casestudies/{parent_lookup_casestudy__id}/layers/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers create -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; layers &gt; create"]
var params = {
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; create"]
params = {
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > read

GET /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers read -p id=... -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; layers &gt; read"]
var params = {
    id: ...,
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; read"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > update

PUT /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers update -p id=... -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; layers &gt; update"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; update"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > partial_update

PATCH /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`thumbnail`
`coded_label`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers partial_update -p id=... -p parent_lookup_casestudy__id=... -p thumbnail=... -p coded_label=...

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 = ["api", "casestudies &gt; layers &gt; partial_update"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    thumbnail: ...,
    coded_label: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; partial_update"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "thumbnail": ...,
    "coded_label": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > delete

DELETE /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/

API endpoint that allows CaseStudy Layers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers delete -p id=... -p parent_lookup_casestudy__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 = ["api", "casestudies &gt; layers &gt; delete"]
var params = {
    id: ...,
    parent_lookup_casestudy__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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; delete"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > tupload

PUT /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/tupload/

Upload the thumbnail :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers tupload -p id=... -p parent_lookup_casestudy__id=... -p file=...

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 = ["api", "casestudies &gt; layers &gt; tupload"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    file: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; tupload"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

casestudies > layers > upload

PUT /api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/upload/

Upload the file :param request: :param args: :param kwargs: :return:

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this case study layer.
`parent_lookup_casestudy__id` required

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`file` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudies layers upload -p id=... -p parent_lookup_casestudy__id=... -p file=...

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 = ["api", "casestudies &gt; layers &gt; upload"]
var params = {
    id: ...,
    parent_lookup_casestudy__id: ...,
    file: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; layers &gt; upload"]
params = {
    "id": ...,
    "parent_lookup_casestudy__id": ...,
    "file": ...,
}
result = client.action(schema, action, params=params)

casestudyruns > list

GET /api/casestudyruns/

API endpoint that allows CaseStudyRuns to be viewed.

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudyruns 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 = ["api", "casestudyruns &gt; 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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "casestudyruns &gt; list"]
result = client.action(schema, action)

casestudyruns > read

GET /api/casestudyruns/{id}/

API endpoint that allows CaseStudyRuns to be viewed.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api casestudyruns 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 = ["api", "casestudyruns &gt; 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("https://api.tools4msp.eu/docs/")

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

codedlabels > list

GET /api/codedlabels/

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api codedlabels 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 = ["api", "codedlabels &gt; 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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "codedlabels &gt; list"]
result = client.action(schema, action)

codedlabels > read

GET /api/codedlabels/{code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`code` required

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api codedlabels read -p code=...

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 = ["api", "codedlabels &gt; read"]
var params = {
    code: ...,
}
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("https://api.tools4msp.eu/docs/")

# Interact with the API endpoint
action = ["api", "codedlabels &gt; read"]
params = {
    "code": ...,
}
result = client.action(schema, action, params=params)

domainareas > list

GET /api/domainareas/

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`label`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action api domainareas list -p label=...

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 = ["api", "domainareas &gt; list"]
var params = {
    label: ...,
}
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("https://api.tools4msp.eu/docs/")

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

domainareas > read

GET /api/domainareas/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this domain area.

Query Parameters

The following parameters should be included as part of a URL query string.

Parameter	Description
`label`

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

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

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 = ["api", "domainareas &gt; read"]
var params = {
    id: ...,
    label: ...,
}
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("https://api.tools4msp.eu/docs/")

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

openapi

list

GET /openapi/

# Load the schema document
$ coreapi get https://api.tools4msp.eu/docs/

# Interact with the API endpoint
$ coreapi action openapi 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 = ["openapi", "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("https://api.tools4msp.eu/docs/")

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