Tools4MSP API v2

This is the documentation of the last Tools4MSP API version.

Documentations of the previous API versions are availabe here:

Tools4MSP API v1

# 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/v2/schema.js"></script>

# Install the Python client library
$ pip install coreapi

auth

createuser > create

POST /api/v2/auth/createuser/

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

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

# Interact with the API endpoint
action = ["auth", "createuser &gt; create"]
result = client.action(schema, action)

casestudies

list

GET /api/v2/casestudies/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`cstype`
`module`
`tag`
`owner`

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

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

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 = ["casestudies", "list"]
var params = {
    page: ...,
    page_size: ...,
    cstype: ...,
    module: ...,
    tag: ...,
    owner: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["casestudies", "list"]
params = {
    "page": ...,
    "page_size": ...,
    "cstype": ...,
    "module": ...,
    "tag": ...,
    "owner": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v2/casestudies/

Request Body

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

Parameter	Description
`label` required	CaseStudy title
`description`	CaseStudy description
`module` required	Module type. Accepted values are: cea, muc, partrac, pmar, testmodule, geodatamaker
`cstype` required	CaseStudy type. Accepted values are: default, customized
`tag`	Free tag, label or keyword to facilitate CaseStudy identification and search
`resolution`	Default resolution for raster based analysis (meters)
`domain_area`	GeoJSON rapresentation of the CaseStudy domain area (MultiPolygon Lat Log WGS84)
`domain_area_terms` required
`visibility`

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

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

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 = ["casestudies", "create"]
var params = {
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
    visibility: ...,
}
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/v2/")

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

read

GET /api/v2/casestudies/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`cstype`
`module`
`tag`
`owner`

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

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

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 = ["casestudies", "read"]
var params = {
    id: ...,
    cstype: ...,
    module: ...,
    tag: ...,
    owner: ...,
}
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/v2/")

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

update

PUT /api/v2/casestudies/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`cstype`
`module`
`tag`
`owner`

Request Body

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

Parameter	Description
`label` required	CaseStudy title
`description`	CaseStudy description
`module` required	Module type. Accepted values are: cea, muc, partrac, pmar, testmodule, geodatamaker
`cstype` required	CaseStudy type. Accepted values are: default, customized
`tag`	Free tag, label or keyword to facilitate CaseStudy identification and search
`resolution`	Default resolution for raster based analysis (meters)
`domain_area`	GeoJSON rapresentation of the CaseStudy domain area (MultiPolygon Lat Log WGS84)
`domain_area_terms` required
`visibility`

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

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

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 = ["casestudies", "update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
    visibility: ...,
    cstype: ...,
    module: ...,
    tag: ...,
    owner: ...,
}
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/v2/")

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

partial_update

PATCH /api/v2/casestudies/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`cstype`
`module`
`tag`
`owner`

Request Body

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

Parameter	Description
`label`	CaseStudy title
`description`	CaseStudy description
`module`	Module type. Accepted values are: cea, muc, partrac, pmar, testmodule, geodatamaker
`cstype`	CaseStudy type. Accepted values are: default, customized
`tag`	Free tag, label or keyword to facilitate CaseStudy identification and search
`resolution`	Default resolution for raster based analysis (meters)
`domain_area`	GeoJSON rapresentation of the CaseStudy domain area (MultiPolygon Lat Log WGS84)
`domain_area_terms`
`visibility`

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

# Interact with the API endpoint
$ coreapi action 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 visibility=... -p cstype=... -p module=... -p tag=... -p owner=...

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 = ["casestudies", "partial_update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    module: ...,
    cstype: ...,
    tag: ...,
    resolution: ...,
    domain_area: ...,
    domain_area_terms: ...,
    visibility: ...,
    cstype: ...,
    module: ...,
    tag: ...,
    owner: ...,
}
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/v2/")

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

delete

DELETE /api/v2/casestudies/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`cstype`
`module`
`tag`
`owner`

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

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

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 = ["casestudies", "delete"]
var params = {
    id: ...,
    cstype: ...,
    module: ...,
    tag: ...,
    owner: ...,
}
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/v2/")

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

asyncrun

GET /api/v2/casestudies/{id}/asyncrun/

[DEPRECATED: see asyncrunpost] Execute an analysis for the current CaseStudy according to the CaseStudy configuration. The reference to a new CaseStudyRun will be returned.

Path Parameters

The following parameters should be included in the URL path.

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

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/v2/

# Interact with the API endpoint
$ coreapi action casestudies asyncrun -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 = ["casestudies", "asyncrun"]
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/v2/")

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

asyncrunpost

POST /api/v2/casestudies/{id}/asyncrunpost/

Execute an analysis for the current CaseStudy according to the CaseStudy configuration. The reference to a new CaseStudyRun will be returned.

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`label`
`description`
`domain_area`
`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/v2/

# Interact with the API endpoint
$ coreapi action casestudies asyncrunpost -p id=... -p label=... -p description=... -p domain_area=... -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 = ["casestudies", "asyncrunpost"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    domain_area: ...,
    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/v2/")

# Interact with the API endpoint
action = ["casestudies", "asyncrunpost"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "domain_area": ...,
    "selected_layers": ...,
    "runtypelevel": ...,
}
result = client.action(schema, action, params=params)

clone

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

[DEPRECATED: see cloneupdate] Clone/duplicate the CaseStudy. The reference to the new CaseStudy will be returned.

Path Parameters

The following parameters should be included in the URL path.

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

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

# Interact with the API endpoint
$ coreapi action 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 = ["casestudies", "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/v2/")

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

cloneupdate

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

Clone/duplicate the CaseStudy allowing the updating of parameters/metadata. The reference to the new CaseStudy will be returned.

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`label` required	CaseStudy title
`description`	CaseStudy description
`tag`	Free tag, label or keyword to facilitate CaseStudy identification and search

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

# Interact with the API endpoint
$ coreapi action 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 = ["casestudies", "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/v2/")

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

run

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

Execute an analysis for the current CaseStudy according to the CaseStudy configuration. The reference to a new CaseStudyRun will be returned.

Path Parameters

The following parameters should be included in the URL path.

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

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)
`pivot_layer`	Codedlabel of the Pivot Layer to use for the analysis

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

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

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 = ["casestudies", "run"]
var params = {
    id: ...,
    selected_layers: ...,
    runtypelevel: ...,
    pivot_layer: ...,
}
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/v2/")

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

setcontext

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

Set the input parameters for the current CaseStudy according to the specified context (see. thesaurus of available Contexts).

Path Parameters

The following parameters should be included in the URL path.

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

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

# Interact with the API endpoint
$ coreapi action casestudies setcontext -p context_label=... -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 = ["casestudies", "setcontext"]
var params = {
    context_label: ...,
    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/v2/")

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

inputs > list

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

API endpoint that allows CaseStudyInput 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/v2/

# Interact with the API endpoint
$ coreapi action 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 = ["casestudies", "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/v2/")

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

inputs > create

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

API endpoint that allows CaseStudyInput 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
`coded_label` required
`description`
`vizmode`

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

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

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 = ["casestudies", "inputs &gt; create"]
var params = {
    parent_lookup_casestudy__id: ...,
    coded_label: ...,
    description: ...,
    vizmode: ...,
}
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/v2/")

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

inputs > read

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

API endpoint that allows CaseStudyInput 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
`id` required	A unique integer value identifying this case study input.

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

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

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

inputs > update

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

API endpoint that allows CaseStudyInput 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
`id` required	A unique integer value identifying this case study input.

Request Body

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

Parameter	Description
`coded_label` required
`description`
`vizmode`

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

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

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 = ["casestudies", "inputs &gt; update"]
var params = {
    parent_lookup_casestudy__id: ...,
    id: ...,
    coded_label: ...,
    description: ...,
    vizmode: ...,
}
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/v2/")

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

inputs > partial_update

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

API endpoint that allows CaseStudyInput 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
`id` required	A unique integer value identifying this case study input.

Request Body

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

Parameter	Description
`coded_label`
`description`
`vizmode`

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

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

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 = ["casestudies", "inputs &gt; partial_update"]
var params = {
    parent_lookup_casestudy__id: ...,
    id: ...,
    coded_label: ...,
    description: ...,
    vizmode: ...,
}
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/v2/")

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

inputs > delete

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

API endpoint that allows CaseStudyInput 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
`id` required	A unique integer value identifying this case study input.

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

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

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

inputs > tupload

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

Upload a thumbnail image (eg. png) into a CaseStudyInput object.

Basic usage example in python

import requests
url = "https://api.tools4msp.eu/api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/tupload/
input_file = "[path to the thumbnail image]"
 
with open(input_file, 'rb') as f:
    files = {'file': f}
    r = requests.put(url, auth=('Token', TOKEN), files=files)

Path Parameters

The following parameters should be included in the URL path.

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

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/v2/

# Interact with the API endpoint
$ coreapi action casestudies inputs tupload -p parent_lookup_casestudy__id=... -p 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 = ["casestudies", "inputs &gt; tupload"]
var params = {
    parent_lookup_casestudy__id: ...,
    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/v2/")

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

inputs > upload

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

Upload an input parameters file (JSON) into a CaseStudyInput object.

Basic usage example in python

import requests
url = "https://api.tools4msp.eu/api/casestudies/{parent_lookup_casestudy__id}/inputs/{id}/upload/
input_file = "[path to the JSON file]"
 
with open(input_file, 'rb') as f:
    files = {'file': f}
    r = requests.put(url, auth=('Token', TOKEN), files=files)

Path Parameters

The following parameters should be included in the URL path.

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

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/v2/

# Interact with the API endpoint
$ coreapi action casestudies inputs upload -p parent_lookup_casestudy__id=... -p 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 = ["casestudies", "inputs &gt; upload"]
var params = {
    parent_lookup_casestudy__id: ...,
    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/v2/")

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

layers > list

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

API endpoint that allows CaseStudyLayers 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/v2/

# Interact with the API endpoint
$ coreapi action 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 = ["casestudies", "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/v2/")

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

layers > create

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

API endpoint that allows CaseStudyLayers 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
`coded_label` required
`description`

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

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

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 = ["casestudies", "layers &gt; create"]
var params = {
    parent_lookup_casestudy__id: ...,
    coded_label: ...,
    description: ...,
}
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/v2/")

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

layers > read

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

API endpoint that allows CaseStudyLayers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

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

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

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

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

layers > update

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

API endpoint that allows CaseStudyLayers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`coded_label` required
`description`

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

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

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 = ["casestudies", "layers &gt; update"]
var params = {
    parent_lookup_casestudy__id: ...,
    id: ...,
    coded_label: ...,
    description: ...,
}
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/v2/")

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

layers > partial_update

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

API endpoint that allows CaseStudyLayers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

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

Request Body

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

Parameter	Description
`coded_label`
`description`

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

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

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 = ["casestudies", "layers &gt; partial_update"]
var params = {
    parent_lookup_casestudy__id: ...,
    id: ...,
    coded_label: ...,
    description: ...,
}
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/v2/")

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

layers > delete

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

API endpoint that allows CaseStudyLayers to be viewed or edited.

Path Parameters

The following parameters should be included in the URL path.

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

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

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

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

layers > tupload

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

Upload a thumbnail image (eg. png) into a CaseStudyLayer object.

Basic usage example in python

import requests
url = "https://api.tools4msp.eu/api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/tupload/
input_file = "[path to the thumbnail image]"
 
with open(input_file, 'rb') as f:
    files = {'file': f}
    r = requests.put(url, auth=('Token', TOKEN), files=files)

Path Parameters

The following parameters should be included in the URL path.

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

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/v2/

# Interact with the API endpoint
$ coreapi action casestudies layers tupload -p parent_lookup_casestudy__id=... -p 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 = ["casestudies", "layers &gt; tupload"]
var params = {
    parent_lookup_casestudy__id: ...,
    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/v2/")

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

layers > upload

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

Upload a geotiff file into a CaseStudyLayer object. Projection, extension and resolution should be the same for all layers.

Basic usage example in python

import requests
url = "https://api.tools4msp.eu/api/casestudies/{parent_lookup_casestudy__id}/layers/{id}/upload/
input_file = "[path to the geotiff file]"
 
with open(input_file, 'rb') as f:
    files = {'file': f}
    r = requests.put(url, auth=('Token', TOKEN), files=files)

Path Parameters

The following parameters should be included in the URL path.

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

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/v2/

# Interact with the API endpoint
$ coreapi action casestudies layers upload -p parent_lookup_casestudy__id=... -p 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 = ["casestudies", "layers &gt; upload"]
var params = {
    parent_lookup_casestudy__id: ...,
    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/v2/")

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

casestudyruns

list

GET /api/v2/casestudyruns/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`casestudy`

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

# Interact with the API endpoint
$ coreapi action casestudyruns list -p page=... -p page_size=... -p casestudy=...

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 = ["casestudyruns", "list"]
var params = {
    page: ...,
    page_size: ...,
    casestudy: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["casestudyruns", "list"]
params = {
    "page": ...,
    "page_size": ...,
    "casestudy": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v2/casestudyruns/{id}/

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
`casestudy`

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

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

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 = ["casestudyruns", "read"]
var params = {
    id: ...,
    casestudy: ...,
}
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/v2/")

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

partial_update

PATCH /api/v2/casestudyruns/{id}/

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
`casestudy`

Request Body

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

Parameter	Description
`label`
`description`
`domain_area`
`visibility`

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

# Interact with the API endpoint
$ coreapi action casestudyruns partial_update -p id=... -p label=... -p description=... -p domain_area=... -p visibility=... -p casestudy=...

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 = ["casestudyruns", "partial_update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    domain_area: ...,
    visibility: ...,
    casestudy: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["casestudyruns", "partial_update"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "domain_area": ...,
    "visibility": ...,
    "casestudy": ...,
}
result = client.action(schema, action, params=params)

delete

DELETE /api/v2/casestudyruns/{id}/

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
`casestudy`

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

# Interact with the API endpoint
$ coreapi action casestudyruns delete -p id=... -p casestudy=...

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 = ["casestudyruns", "delete"]
var params = {
    id: ...,
    casestudy: ...,
}
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/v2/")

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

codedlabels

list

GET /api/v2/codedlabels/

Query Parameters

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

Parameter	Description
`group`
`case_study_id`
`search`

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

# Interact with the API endpoint
$ coreapi action codedlabels list -p group=... -p case_study_id=... -p search=...

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 = ["codedlabels", "list"]
var params = {
    group: ...,
    case_study_id: ...,
    search: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["codedlabels", "list"]
params = {
    "group": ...,
    "case_study_id": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v2/codedlabels/{code}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`code` required

Query Parameters

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

Parameter	Description
`group`
`case_study_id`
`search`

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

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

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 = ["codedlabels", "read"]
var params = {
    code: ...,
    group: ...,
    case_study_id: ...,
    search: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["codedlabels", "read"]
params = {
    "code": ...,
    "group": ...,
    "case_study_id": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

contexts

list

GET /api/v2/contexts/

Query Parameters

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

Parameter	Description
`label`
`search`

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

# Interact with the API endpoint
$ coreapi action contexts list -p label=... -p search=...

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 = ["contexts", "list"]
var params = {
    label: ...,
    search: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["contexts", "list"]
params = {
    "label": ...,
    "search": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v2/contexts/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`label`
`search`

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

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

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 = ["contexts", "read"]
var params = {
    id: ...,
    label: ...,
    search: ...,
}
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/v2/")

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

domainareas

list

GET /api/v2/domainareas/

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

# Interact with the API endpoint
$ coreapi action domainareas 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 = ["domainareas", "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/v2/")

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

read

GET /api/v2/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.

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

# Interact with the API endpoint
$ coreapi action domainareas 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 = ["domainareas", "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/v2/")

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

pressureweights

list

GET /api/v2/pressureweights/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`context__label`
`pres__code`
`use__code`

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

# Interact with the API endpoint
$ coreapi action pressureweights list -p page=... -p page_size=... -p context__label=... -p pres__code=... -p use__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 = ["pressureweights", "list"]
var params = {
    page: ...,
    page_size: ...,
    context__label: ...,
    pres__code: ...,
    use__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/v2/")

# Interact with the API endpoint
action = ["pressureweights", "list"]
params = {
    "page": ...,
    "page_size": ...,
    "context__label": ...,
    "pres__code": ...,
    "use__code": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v2/pressureweights/

Request Body

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

Parameter	Description
`context` required
`use` required
`pres` required
`weight` required
`distance`
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action pressureweights create -p context=... -p use=... -p pres=... -p weight=... -p distance=... -p confidence=... -p references=... -p notes=...

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 = ["pressureweights", "create"]
var params = {
    context: ...,
    use: ...,
    pres: ...,
    weight: ...,
    distance: ...,
    confidence: ...,
    references: ...,
    notes: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["pressureweights", "create"]
params = {
    "context": ...,
    "use": ...,
    "pres": ...,
    "weight": ...,
    "distance": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v2/pressureweights/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this Pressure weight.

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`use__code`

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

# Interact with the API endpoint
$ coreapi action pressureweights read -p id=... -p context__label=... -p pres__code=... -p use__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 = ["pressureweights", "read"]
var params = {
    id: ...,
    context__label: ...,
    pres__code: ...,
    use__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/v2/")

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

update

PUT /api/v2/pressureweights/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this Pressure weight.

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`use__code`

Request Body

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

Parameter	Description
`context` required
`use` required
`pres` required
`weight` required
`distance`
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action pressureweights update -p id=... -p context=... -p use=... -p pres=... -p weight=... -p distance=... -p confidence=... -p references=... -p notes=... -p context__label=... -p pres__code=... -p use__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 = ["pressureweights", "update"]
var params = {
    id: ...,
    context: ...,
    use: ...,
    pres: ...,
    weight: ...,
    distance: ...,
    confidence: ...,
    references: ...,
    notes: ...,
    context__label: ...,
    pres__code: ...,
    use__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/v2/")

# Interact with the API endpoint
action = ["pressureweights", "update"]
params = {
    "id": ...,
    "context": ...,
    "use": ...,
    "pres": ...,
    "weight": ...,
    "distance": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
    "context__label": ...,
    "pres__code": ...,
    "use__code": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v2/pressureweights/{id}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`id` required	A unique integer value identifying this Pressure weight.

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`use__code`

Request Body

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

Parameter	Description
`context`
`use`
`pres`
`weight`
`distance`
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action pressureweights partial_update -p id=... -p context=... -p use=... -p pres=... -p weight=... -p distance=... -p confidence=... -p references=... -p notes=... -p context__label=... -p pres__code=... -p use__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 = ["pressureweights", "partial_update"]
var params = {
    id: ...,
    context: ...,
    use: ...,
    pres: ...,
    weight: ...,
    distance: ...,
    confidence: ...,
    references: ...,
    notes: ...,
    context__label: ...,
    pres__code: ...,
    use__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/v2/")

# Interact with the API endpoint
action = ["pressureweights", "partial_update"]
params = {
    "id": ...,
    "context": ...,
    "use": ...,
    "pres": ...,
    "weight": ...,
    "distance": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
    "context__label": ...,
    "pres__code": ...,
    "use__code": ...,
}
result = client.action(schema, action, params=params)

sensitivities

list

GET /api/v2/sensitivities/

Query Parameters

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

Parameter	Description
`page`	A page number within the paginated result set.
`page_size`	Number of results to return per page.
`context__label`
`pres__code`
`env__code`

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

# Interact with the API endpoint
$ coreapi action sensitivities list -p page=... -p page_size=... -p context__label=... -p pres__code=... -p env__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 = ["sensitivities", "list"]
var params = {
    page: ...,
    page_size: ...,
    context__label: ...,
    pres__code: ...,
    env__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/v2/")

# Interact with the API endpoint
action = ["sensitivities", "list"]
params = {
    "page": ...,
    "page_size": ...,
    "context__label": ...,
    "pres__code": ...,
    "env__code": ...,
}
result = client.action(schema, action, params=params)

create

POST /api/v2/sensitivities/

Request Body

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

Parameter	Description
`context` required
`pres` required
`env` required
`impact_level`
`recovery`
`sensitivity` required
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action sensitivities create -p context=... -p pres=... -p env=... -p impact_level=... -p recovery=... -p sensitivity=... -p confidence=... -p references=... -p notes=...

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 = ["sensitivities", "create"]
var params = {
    context: ...,
    pres: ...,
    env: ...,
    impact_level: ...,
    recovery: ...,
    sensitivity: ...,
    confidence: ...,
    references: ...,
    notes: ...,
}
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/v2/")

# Interact with the API endpoint
action = ["sensitivities", "create"]
params = {
    "context": ...,
    "pres": ...,
    "env": ...,
    "impact_level": ...,
    "recovery": ...,
    "sensitivity": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
}
result = client.action(schema, action, params=params)

read

GET /api/v2/sensitivities/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`env__code`

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

# Interact with the API endpoint
$ coreapi action sensitivities read -p id=... -p context__label=... -p pres__code=... -p env__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 = ["sensitivities", "read"]
var params = {
    id: ...,
    context__label: ...,
    pres__code: ...,
    env__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/v2/")

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

update

PUT /api/v2/sensitivities/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`env__code`

Request Body

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

Parameter	Description
`context` required
`pres` required
`env` required
`impact_level`
`recovery`
`sensitivity` required
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action sensitivities update -p id=... -p context=... -p pres=... -p env=... -p impact_level=... -p recovery=... -p sensitivity=... -p confidence=... -p references=... -p notes=... -p context__label=... -p pres__code=... -p env__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 = ["sensitivities", "update"]
var params = {
    id: ...,
    context: ...,
    pres: ...,
    env: ...,
    impact_level: ...,
    recovery: ...,
    sensitivity: ...,
    confidence: ...,
    references: ...,
    notes: ...,
    context__label: ...,
    pres__code: ...,
    env__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/v2/")

# Interact with the API endpoint
action = ["sensitivities", "update"]
params = {
    "id": ...,
    "context": ...,
    "pres": ...,
    "env": ...,
    "impact_level": ...,
    "recovery": ...,
    "sensitivity": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
    "context__label": ...,
    "pres__code": ...,
    "env__code": ...,
}
result = client.action(schema, action, params=params)

partial_update

PATCH /api/v2/sensitivities/{id}/

Path Parameters

The following parameters should be included in the URL path.

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

Query Parameters

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

Parameter	Description
`context__label`
`pres__code`
`env__code`

Request Body

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

Parameter	Description
`context`
`pres`
`env`
`impact_level`
`recovery`
`sensitivity`
`confidence`
`references`
`notes`

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

# Interact with the API endpoint
$ coreapi action sensitivities partial_update -p id=... -p context=... -p pres=... -p env=... -p impact_level=... -p recovery=... -p sensitivity=... -p confidence=... -p references=... -p notes=... -p context__label=... -p pres__code=... -p env__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 = ["sensitivities", "partial_update"]
var params = {
    id: ...,
    context: ...,
    pres: ...,
    env: ...,
    impact_level: ...,
    recovery: ...,
    sensitivity: ...,
    confidence: ...,
    references: ...,
    notes: ...,
    context__label: ...,
    pres__code: ...,
    env__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/v2/")

# Interact with the API endpoint
action = ["sensitivities", "partial_update"]
params = {
    "id": ...,
    "context": ...,
    "pres": ...,
    "env": ...,
    "impact_level": ...,
    "recovery": ...,
    "sensitivity": ...,
    "confidence": ...,
    "references": ...,
    "notes": ...,
    "context__label": ...,
    "pres__code": ...,
    "env__code": ...,
}
result = client.action(schema, action, params=params)