Tools4MSP API v1

DEPRECATION NOTICE: this API version was deprecated.

The documentation of the last API version is available here: Tools4MSP API v2

# 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

api

casestudies > list

GET /api/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`
`owner`

# 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=... -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 = ["api", "casestudies &gt; list"]
var params = {
    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/")

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

casestudies > create

POST /api/api/casestudies/

Add a new Case Study Adds a new Case Study to the server. To add additional inputs use the following methods:

see /casestudies/{casestudyId}/layers for adding a new Layer
see /casestudies/{casestudyId}/inputs 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	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/

# 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=... -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 = ["api", "casestudies &gt; 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/")

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

casestudies > read

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

Return a CaseStudy instance.

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/

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

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

casestudies > update

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

Update a CaseStudy.

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/

# 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 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 = ["api", "casestudies &gt; 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/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; 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)

casestudies > partial_update

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

Update one or more fields on an existing CaseStudy.

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/

# 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 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 = ["api", "casestudies &gt; 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/")

# Interact with the API endpoint
action = ["api", "casestudies &gt; 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)

casestudies > delete

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

Remove an existing CaseStudy.

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/

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

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

casestudies > clone

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

# 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/api/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/

# 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/api/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/

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

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

casestudies > setcontext

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

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

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

casestudies > inputs > list

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

# 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/api/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/

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

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

casestudies > inputs > read

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

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

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

casestudies > inputs > update

PUT /api/api/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/

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

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

casestudies > inputs > partial_update

PATCH /api/api/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/

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

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

casestudies > inputs > delete

DELETE /api/api/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/

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

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

casestudies > inputs > tupload

PUT /api/api/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/

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

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

casestudies > inputs > upload

PUT /api/api/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/

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

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

casestudies > layers > list

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

# 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/api/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/

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

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

casestudies > layers > read

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

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

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

casestudies > layers > update

PUT /api/api/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/

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

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

casestudies > layers > partial_update

PATCH /api/api/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/

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

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

casestudies > layers > delete

DELETE /api/api/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/

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

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

casestudies > layers > tupload

PUT /api/api/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/

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

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

casestudies > layers > upload

PUT /api/api/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/

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

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

casestudyruns > list

GET /api/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/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)

casestudyruns > partial_update

PATCH /api/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

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/

# Interact with the API endpoint
$ coreapi action api casestudyruns partial_update -p id=... -p label=... -p description=... -p domain_area=... -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 = ["api", "casestudyruns &gt; partial_update"]
var params = {
    id: ...,
    label: ...,
    description: ...,
    domain_area: ...,
    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/")

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

codedlabels > list

GET /api/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/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)

contexts > list

GET /api/api/contexts/

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

# Interact with the API endpoint
$ coreapi action api contexts 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", "contexts &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", "contexts &gt; list"]
result = client.action(schema, action)

contexts > read

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

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

# Interact with the API endpoint
$ coreapi action api contexts 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", "contexts &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", "contexts &gt; read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

domainareas > list

GET /api/api/domainareas/

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

# Interact with the API endpoint
$ coreapi action api 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 = ["api", "domainareas &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", "domainareas &gt; list"]
result = client.action(schema, action)

domainareas > read

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

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

# Interact with the API endpoint
$ coreapi action api 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 = ["api", "domainareas &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", "domainareas &gt; read"]
params = {
    "id": ...,
}
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 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 = ["casestudyruns", "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 = ["casestudyruns", "list"]
result = client.action(schema, action)

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 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 = ["casestudyruns", "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 = ["casestudyruns", "read"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

partial_update

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

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/

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

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

v2

auth > createuser > create

POST /api/v2/auth/createuser/

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

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

# Interact with the API endpoint
action = ["v2", "auth &gt; 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/

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
action = ["v2", "casestudies &gt; 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)

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

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

# Interact with the API endpoint
action = ["v2", "casestudies &gt; 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)

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
$ coreapi action v2 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 = ["v2", "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 = ["v2", "casestudies &gt; clone"]
params = {
    "id": ...,
}
result = client.action(schema, action, params=params)

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

# Interact with the API endpoint
$ coreapi action v2 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 = ["v2", "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 = ["v2", "casestudies &gt; cloneupdate"]
params = {
    "id": ...,
    "label": ...,
    "description": ...,
    "tag": ...,
}
result = client.action(schema, action, params=params)

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

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

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

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

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

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

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

# Interact with the API endpoint
$ coreapi action v2 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 = ["v2", "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 = ["v2", "casestudies &gt; inputs &gt; list"]
params = {
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
$ coreapi action v2 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 = ["v2", "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 = ["v2", "casestudies &gt; layers &gt; list"]
params = {
    "parent_lookup_casestudy__id": ...,
}
result = client.action(schema, action, params=params)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
action = ["v2", "casestudies &gt; 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/

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
action = ["v2", "casestudyruns &gt; 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/

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

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

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

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

# Interact with the API endpoint
action = ["v2", "codedlabels &gt; 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/

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

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

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

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

# Interact with the API endpoint
action = ["v2", "contexts &gt; 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/

# Interact with the API endpoint
$ coreapi action v2 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 = ["v2", "domainareas &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 = ["v2", "domainareas &gt; list"]
result = client.action(schema, action)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
action = ["v2", "pressureweights &gt; 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/

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

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

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

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

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

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

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

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

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

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

# Interact with the API endpoint
action = ["v2", "sensitivities &gt; 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)

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

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

# Interact with the API endpoint
action = ["v2", "sensitivities &gt; 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)