openapi

ESP API v3.4.0.0.20241018114208

            Full list of generally available query filters:

            uuid (UUID) - Search for a single UUID
            uuids (List[UUID]) - Search for a list of UUIDs
            uuid.not (UUID) - Filter out resource with specific UUID
            name (String) - Search for an exact resource name search
            name.like (String) - Double-ended case-insensitive wildcard search. E.g. a name.like query for "ron" will find items named "Boron" and "Ronald".
            names (List[String]) - Search for a list of resource names (exact match).
            desc (String) - Search for content in the resource description/note (case-sensitive wildcard, but wildcard insertion is an exercise for the caller).
            desc.like (String) - Double-ended case-insensitive wildcard search. E.g. a desc.like query for "ron" will find items with either "Boron" or "Ronald" in the description/note.
            owner (String): Search for resources where the owner's email or username exactly matches the value.
            owner.like (String): Search for resources where the owner's email or username matches the value using a double-ended case-insensitive wildcard search. E.g. an owner.like search for "carl" would find resources with a username of "Carl" or "Scarlett" or email addresses "the.carl@email.com" or "scarlett@email.com".
            created_after (Date): created date is >= the specified date.
            created_before (Date): created date is <= the specified date.
            updated_after (Date): updated date is >= the specified date.
            updated_before (Date): updated date is <= the specified date.
            tags (List[String]): Search for resources with one or more tags in the specified list.
            alltags (List[String]): Search for resources with all specified tags.
            in_containers (Boolean): Search for resources in containers.
            state (String): Search for resources by state.
            states (List[String]): Search for resources by a list of states.
            limit (Integer): Limit the number of results returned.
            offset (Integer): Specify the offset of the first result returned.
            schedulability (String): Search for resources by schedulability.
            is_scheduled (Boolean) - Search for resources that are scheduled.
            barcodes (List[String]) - Search for a list of barcodes (exact match).
            barcode.like (String) - Double-ended case-insensitive wildcard search. E.g. a barcode.like query for "123" will find items with either "1234" or "1123" in the barcode.
            cls (String) - Search for resources by class.
            clses (List[String]) - Search for resources by a list of classes.

Apps

Get an ESP App

Responses

Status	Meaning	Description	Schema
200	OK	Success	ResourceResponse
400	Bad Request	Bad Request	Response400
5XX	Unknown	Server Error	DefaultError

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	The App UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/apps/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/apps/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string"
}

Delete an ESP App

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline
400	Bad Request	Bad Request	Response400
5XX	Unknown	Server Error	DefaultError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	The App UUID

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/apps/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/apps/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "id": "string"
}

Create ESP App

Body parameter

{
  "name": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	ResourceResponse
400	Bad Request	Bad Request	Response400
5XX	Unknown	Server Error	DefaultError

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» name	body	string	true	app name

Request

const inputBody = '{
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/apps',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/apps', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string"
}

Availability_Schedules

Get Availability Schedule Containers

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/availability_schedules',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/availability_schedules', headers = headers)

print(r.json())

Response

json

null

Create Availability Schedule Container

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/availability_schedules',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/availability_schedules', headers = headers)

print(r.json())

Response

json

null

Get Availability Schedule Container

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/availability_schedules/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/availability_schedules/{uuid}', headers = headers)

print(r.json())

Response

json

null

Update Availability Schedule Container

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/availability_schedules/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/availability_schedules/{uuid}', headers = headers)

print(r.json())

Response

json

null

Delete Availability Schedule Container

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/availability_schedules/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/availability_schedules/{uuid}', headers = headers)

print(r.json())

Response

json

null

Bundle_Review

Plan Bundle Review - create SignatureFlowInstance for requested Bundle.

POST /api/hub/bundle_review/plan-bundle-review

Args: package_id (str): Bundle uuid. signature_flow_def_uuid (str): SignatureFlowDefinition uuid. signature_flow_name (str): Name of SignatureFlowInstance that’ll be created. signature_flow_desc (str, optional): Description of SignatureFlowInstance that’ll be created. due_date(str, optional): Timestamp of SignatureFlowInstance valid due date. location_id (int, optional): The hub’s location id. Defaults to 0.

Returns: Response: HTTPStatus.CREATED if successful.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/plan-bundle-review',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/bundle_review/plan-bundle-review', headers = headers)

print(r.json())

Response

json

null

Update Bundle Review - revise existing Bundle Review Plan.

POST /api/hub/bundle_review/revise-bundle-review

Returns: Response: HTTPStatus.CREATED if successful.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/revise-bundle-review',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/bundle_review/revise-bundle-review', headers = headers)

print(r.json())

Response

json

null

Update Bundle Review - delete existing Bundle Review Plan.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/delete-bundle-review',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/bundle_review/delete-bundle-review', headers = headers)

print(r.json())

Response

json

null

Get Bundle Review Plan - get SignatureFlowInstance for requested Bundle.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
packages_ids	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/{packages_ids}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/bundle_review/{packages_ids}', headers = headers)

print(r.json())

Response

json

null

Execute Bundle Review - perform sign of SignatureFlowInstance stage.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/execute-bundle-review',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/bundle_review/execute-bundle-review', headers = headers)

print(r.json())

Response

json

null

Retract Bundle Review - perform retraction of previously approved bundle

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/retract-bundle-review',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/bundle_review/retract-bundle-review', headers = headers)

print(r.json())

Response

json

null

View function to get remote user for a retracted bundle.

GET /api/hub/bundle_review/get-remote-user/{location_id}/{user_uuid}

At the time of this writing, a bundle review’s retraction status only has the UUID of the user who retracted it. This view function is specifically for retrieving the user information from a remote hub for the purposes of converting that UUID into a username (and potentially other information).

Args: location_id (int): The remote hub to query, given by the defined location id. user_uuid (str): The remote user’s UUID.

Returns: Response: HTTPStatus.OK if successful, with a User model’s as_dict().

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
location_id	path	integer	true	none
user_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/bundle_review/get-remote-user/{location_id}/{user_uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/bundle_review/get-remote-user/{location_id}/{user_uuid}', headers = headers)

print(r.json())

Response

json

null

Collections

Get Collections

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/collections', headers = headers)

print(r.json())

Response

json

null

Create Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/collections', headers = headers)

print(r.json())

Response

json

null

Get Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/collections/{uuid}', headers = headers)

print(r.json())

Response

json

null

Archive Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/hub/collections/{uuid}', headers = headers)

print(r.json())

Response

json

null

Updates a collection or multiple collections (given by the UUID) with the provided list of supplies.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuids	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{uuids}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/hub/collections/{uuids}', headers = headers)

print(r.json())

Response

json

null

Get Collection Definition

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/definitions/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/collections/definitions/{uuid}', headers = headers)

print(r.json())

Response

json

null

Pin Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
collection_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/pin/{collection_uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/collections/pin/{collection_uuid}', headers = headers)

print(r.json())

Response

json

null

Exports a collection with the most recent state of the listed resources

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
collection_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{collection_uuid}/export',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/collections/{collection_uuid}/export', headers = headers)

print(r.json())

Response

json

null

Remove Supplies From Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
collection_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{collection_uuid}/supplies',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/hub/collections/{collection_uuid}/supplies', headers = headers)

print(r.json())

Response

json

null

Exports a pinned collection that contains resources in the state they were

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
collection_definition_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{collection_definition_uuid}/export/pinned',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/collections/{collection_definition_uuid}/export/pinned', headers = headers)

print(r.json())

Response

json

null

Remove Supply From Collection

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
collection_uuid	path	string	true	none
supply_uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/collections/{collection_uuid}/supplies/{supply_uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/hub/collections/{collection_uuid}/supplies/{supply_uuid}', headers = headers)

print(r.json())

Response

json

null

Configuration

List All Configs

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/configuration', headers = headers)

print(r.json())

Response

json

null

Retrieve Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
app	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/{app}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/configuration/{app}', headers = headers)

print(r.json())

Response

json

null

Update Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
app	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/{app}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/configuration/{app}', headers = headers)

print(r.json())

Response

json

null

Revert Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
app	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/{app}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/configuration/{app}', headers = headers)

print(r.json())

Response

json

null

Delete Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
app	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/{app}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/configuration/{app}', headers = headers)

print(r.json())

Response

json

null

Endpoint to return data that is needed for setup when a user is not yet logged in

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/public',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/configuration/public', headers = headers)

print(r.json())

Response

json

null

Create Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
app	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/configuration/create/{app}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/configuration/create/{app}', headers = headers)

print(r.json())

Response

json

null

Content

Handles retrieval of local and/or remote package overviews.

GET /api/hub/content

This endpoint returns a cached value via the @HUB_CACHE.cache_on_arguments decorator if the particular location/status combinations of arguments (which forms the particular key in the cache) has a value. If no key is found for the arguments, the function proceeds and the final return value is stored in the cache.

NOTE: A cached key-value can be manually purged from the HUB by hitting the hub’s “refresh button”, which calls the refresh_cache function above.

Args: location_ids (list[int], optional): The location to fetch packages from. Defaults to [0]. location_id (int, optional): The location to fetch packages from. Defaults to 0. (Parameter for backwards compatibility with ESP<3.3.0 after location_id was changed to location_ids) status (list[str], optional): [‘AVAILABLE’], [‘INSTALLED’] or [‘AVAILABLE’, ‘INSTALLED’]. Defaults to None. bundles_stacking_location (int, optional): If passed, points to the location on which the stacking process should occur. In such case bundles with the same fixed_id are stacked together. Defaults to None. extra_params (str, optional): Contains additional params. { dependencies (bool): Indicate whether fetch package dependencies or not. packages_ids (list[str]): packages ids to filter by. If this list is supplied along with bundles_stacking_location not being None, fixed_ids are read from these packages and only bundles with such fixed_ids are taken into account. omit_cache (Union[bool, dict[str, bool]]): Indicate whether cache can be used or not. Defined per location { “0”: true, “1”: false, … } or with a single boolean for all locations. If not provided, all locations default to OMIT_CACHE_DEFAULT. return_properties (list[str]): Name of parameters that should be returned. If empty - return all. return_categories (list[str]): Name of categories that should be returned. If empty - return all. } Raises: InternalServerError: General exception when something goes wrong during package retrieval.

Returns: Response: The PackageOverview list of package overviews with added location_id key and possibly stacked bundles

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/content', headers = headers)

print(r.json())

Response

json

null

Endpoint responsible for installing content into the local ESP environment, whether installing a bundle from the

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/content', headers = headers)

print(r.json())

Response

json

null

Uploads or installs a bundle to an ESP

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/hub/content', headers = headers)

print(r.json())

Response

json

null

Handles retrieval of local or remote package YAML export.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/export',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/content/export', headers = headers)

print(r.json())

Response

json

null

Endpoint responsible for refreshing the local cache of the specified hub.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/refresh_cache',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/content/refresh_cache', headers = headers)

print(r.json())

Response

json

null

Uploads (writes to disk) a bundle to the L7|HUB ‘available’ directory.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/upload-bundle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/content/upload-bundle', headers = headers)

print(r.json())

Response

json

null

Build a bundle from selected location of requested content.

POST /api/hub/content/generate-bundle

Args: packages_ids (str): The ids of the packages to create Bundle from description (str): Bundle description created_version (str): ESP version that the Bundle is created on tested_versions (list): list of ESPs’ versions that Bundle content was tested on review_plan (dict): Review Plan data to add for created Bundle. Of the form: { “signature_flow_def_uuid”: , “signature_flow_name”: , “signature_flow_desc”: , “due_date”: } files (list[dict]): List of additional files to add to created Bundle. Of the form: [ { “filename”: , “type”: thumbnail/doc, “file_base64_string”: },] location_id (int): Location to perform action on. Indicates location to take packages from name (str): Name for the Bundle fixed_id: Bundle fixed id. Used e.g. to stack Bundles tags (list): List of Bundle tags action (str | int): Action to perform. Possible values: - “download” / “install” - Download or install created Bundle - location id (int) of where to upload created Bundle is_async (bool): Indicates whether Bundle generation should be done asynchronously using Celery. Defaults to False, as we need support requests from ESP of version < 3.3 (not able to send request with additional is_async parameter)

Returns: - Response with Bundle bytes if performed synchronously - Response with Celery job id and task status if performed asynchronously

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/generate-bundle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/content/generate-bundle', headers = headers)

print(r.json())

Response

json

null

Get Packages Bundle

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
packages_ids	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/{packages_ids}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/content/{packages_ids}', headers = headers)

print(r.json())

Response

json

null

Gets the resource’s relevant resource information from an ESP database

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
package_id	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/resource/{package_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/content/resource/{package_id}', headers = headers)

print(r.json())

Response

json

null

Handles retrieval of local or remote package.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
category	path	string	true	none
package_id	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/content/{category}/{package_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/content/{category}/{package_id}', headers = headers)

print(r.json())

Response

json

null

Content_Legacy

Handles retrieval of local and/or remote package overviews.

GET /api/store/content

NOTE: A cached key-value can be manually purged from the HUB by hitting the hub’s “refresh button”, which calls the refresh_cache function above.

Returns: Response: The PackageOverview list of package overviews with added location_id key and possibly stacked bundles

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/content', headers = headers)

print(r.json())

Response

json

null

Endpoint responsible for installing content into the local ESP environment, whether installing a bundle from the

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/store/content', headers = headers)

print(r.json())

Response

json

null

Uploads or installs a bundle to an ESP

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/store/content', headers = headers)

print(r.json())

Response

json

null

Handles retrieval of local or remote package YAML export.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/export',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/store/content/export', headers = headers)

print(r.json())

Response

json

null

Endpoint responsible for refreshing the local cache of the specified hub.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/refresh_cache',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/content/refresh_cache', headers = headers)

print(r.json())

Response

json

null

Uploads (writes to disk) a bundle to the L7|HUB ‘available’ directory.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/upload-bundle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/store/content/upload-bundle', headers = headers)

print(r.json())

Response

json

null

Build a bundle from selected location of requested content.

POST /api/store/content/generate-bundle

Returns: - Response with Bundle bytes if performed synchronously - Response with Celery job id and task status if performed asynchronously

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/generate-bundle',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/store/content/generate-bundle', headers = headers)

print(r.json())

Response

json

null

Get Packages Bundle

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
packages_ids	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/{packages_ids}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/content/{packages_ids}', headers = headers)

print(r.json())

Response

json

null

Gets the resource’s relevant resource information from an ESP database

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
package_id	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/resource/{package_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/content/resource/{package_id}', headers = headers)

print(r.json())

Response

json

null

Handles retrieval of local or remote package.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
category	path	string	true	none
package_id	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/content/{category}/{package_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/content/{category}/{package_id}', headers = headers)

print(r.json())

Response

json

null

Controllers

Control ESP processes:

POST /api/controllers/{command}/{service}

To retrieve status for all services, the user needs to send a GET request on /controllers/status. To retrieve status for a specified service, the user needs to send a GET request on /controllers/status/

To control services, the user needs to send a POST request on /controllers/, where command is start, stop, or restart. To control a specific service, the user needs to send a POST request on /controllers//, where command is start, stop, or restart.

.. :quickref: command_runner method; Control an ESP process

Exceptions:

None unless there is a coding error, which will return a 500.

Example Request A :

.. sourcecode:: http

GET /controllers/status Host: (host)[:port number] Accept: application/json

Example Request B :

.. sourcecode:: http

GET /controllers/status/http Host: (host)[:port number] Accept: application/json

Example Request C :

.. sourcecode:: http

POST /controllers/restart/http Host: (host)[:port number] Accept: application/json

Returns:

Returns a JSON response. If 200, ‘status’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response B:

Upon a 200 response code, returns a JSON dict.

Example Response C:

Upon a 200 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “haproxy”: “Running (pid 43470)”, “l7-esp database”: “Available”, “l7-esp.broker”: “Running (pid 43335)”, “l7-esp.executor”: “Running (pid 43425)”, “l7-esp.http.0”: “Running (pid 4320)”, “l7-esp.logger”: “Running (pid 43380)”, “l7-esp.pipeline”: “Running (pid 43242)”, “status”: “Success in status command” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Example Response B ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “l7-esp.http.0”: “Running (pid 4320)”, “status”: “Success in status command” }

:resheader 400: application/json, text/javascript, /; q=0.01; :status 400: OK

Example Response C ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “status”: “Success in restart command” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
command	path	string	true	none
service	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/controllers/{command}/{service}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/controllers/{command}/{service}', headers = headers)

print(r.json())

Response

json

null

Emails

Receive Email Request

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/notification/email',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/notification/email', headers = headers)

print(r.json())

Response

json

null

Esp_Resources

Get Locations For Scheduling

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resources/location',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resources/location', headers = headers)

print(r.json())

Response

json

null

Get Equipment For Scheduling

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resources/equipment',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resources/equipment', headers = headers)

print(r.json())

Response

json

null

Expression

Expression Handler; Evaluate a Lab7 expression

Body parameter

{
  "expression": "1 + x",
  "context": {
    "x": 5
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns an evaluated result if the expression succeded with a response code 200.	ExpressionResponse
400	Bad Request	Returns an error if something goes wrong. A common source of error is an invalid format of the expression.	Response400
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
default	Default	Default error	DefaultError

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» expression	body	string	true	A single Lab7 expression.
» context	body	object	false	A dictionary used to resolve variable names used in the Lab7 expression.

Request

const inputBody = '{
  "expression": "1 + x",
  "context": {
    "x": 5
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/expressions/eval',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/expressions/eval', headers = headers)

print(r.json())

Response

json

Extensions

Get all transition strategies

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of transition chain dicts	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	false	none	none
» desc	string	false	none	none
» virtual	boolean	false	none	none
» parameters	[ExtensionParameterSchema]	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
»» default	any	false	none	Can be any value.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	number	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	[any]	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» help	string	false	none	none
»» required	boolean	false	none	none
»» label	string	false	none	none
»» validation_rules	object¦null	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/transition_strategies',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/transition_strategies', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "resubmit",
    "desc": "Workflow chain sample transition strategy",
    "virtual": true,
    "parameters": []
  },
  {
    "name": "createsample",
    "desc": "Workflow chain sample transition strategy",
    "virtual": true,
    "parameters": [
      {
        "name": "sample_type_uuid",
        "type": "sample_type",
        "default": null,
        "help": "Entity Type type to create",
        "required": true,
        "label": "Sample Type",
        "validation_rules": null
      }
    ]
  }
]

Get all transition invokables

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of invokables	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	false	none	none
» desc	string¦null	false	none	none
» uses_session	boolean	false	none	none
» handles_files	boolean	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/invokables',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/invokables', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "bundle_hello_world2",
    "desc": "hello world",
    "uses_session": false,
    "handles_files": false
  },
  {
    "name": "hl7_hello_world",
    "desc": null,
    "uses_session": false,
    "handles_files": false
  }
]

Get all preprocessors

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of preprocessors	ProcessorResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/preprocessors',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/preprocessors', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "add_row_number",
    "desc": "example desc",
    "parameters": []
  }
]

Get all postprocessors

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of postprocessors	ProcessorResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/postprocessors',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/postprocessors', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "add_row_number",
    "desc": "example desc",
    "parameters": []
  }
]

Get extension load statuses

Responses

Status	Meaning	Description	Schema
200	OK	Returns load statuses	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/loadstatus',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/loadstatus', headers = headers)

print(r.json())

Response

json

{
  "bundle_test = bundle_test": "Succeeded",
  "hl7 = hl7": "Succeeded"
}

Reload extensions

Responses

Status	Meaning	Description	Schema
200	OK	Extensions reloaded	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/reload',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/v3/extensions/reload', headers = headers)

print(r.json())

Response

json

{
  "bundle_test = bundle_test": "Succeeded",
  "hl7 = hl7": "Succeeded"
}

Get ESP expressions

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary of expressions	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	string	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/expressions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/expressions', headers = headers)

print(r.json())

Response

json

{
  "Q_": "Construct a Quantity",
  "basename": "wrapper for os.path.basename"
}

Get API callbacks

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary of api callbacks	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/api_callbacks',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/api_callbacks', headers = headers)

print(r.json())

Response

json

{
  "before": [],
  "after": []
}

Get protocol actions

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of protocol actions	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	false	none	none
» desc	string	false	none	none
» translatedName	string	false	none	none
» translatedDesc	string	false	none	none
» parameters	[ExtensionParameterSchema]	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
»» default	any	false	none	Can be any value.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	number	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	[any]	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» help	string	false	none	none
»» required	boolean	false	none	none
»» label	string	false	none	none
»» validation_rules	object¦null	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/protocol_actions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/protocol_actions', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "Archive Objects",
    "desc": "archive desc",
    "translatedName": "Archive Objects",
    "translatedDesc": "archive desc",
    "parameters": [
      {
        "name": "expression",
        "type": "expressionstring",
        "default": null,
        "help": "expression help",
        "required": false,
        "label": "Expression",
        "validation_rules": null
      }
    ]
  }
]

Get protocol action conditions

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of protocol action conditions	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» name	string	false	none	none
» desc	string	false	none	none
» translatedName	string	false	none	none
» translatedDesc	string	false	none	none
» parameters	[ExtensionParameterSchema]	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
»» default	any	false	none	Can be any value.

anyOf

Name	Type	Required	Restrictions	Description
»»» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	number	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	[any]	false	none	none

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
»» help	string	false	none	none
»» required	boolean	false	none	none
»» label	string	false	none	none
»» validation_rules	object¦null	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/v3/extensions/action_conditions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v3/extensions/action_conditions', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "All rows match an expression",
    "desc": "archive desc",
    "translatedName": "All rows match an expression",
    "translatedDesc": "archive desc",
    "parameters": [
      {
        "name": "expression",
        "type": "expressionstring",
        "default": null,
        "help": "An ESP expression to evaluate",
        "required": true,
        "label": "expression",
        "validation_rules": null
      }
    ]
  }
]

Invoke a function by name with arguments

POST /api/invoke/{name}

Invokable functions are contributed by via the l7.esp.invokables entry point.

Arguments: - args (list): Passed to the invokable as *args. - kwargs (dict): Passed to the invokable as **kwargs.

The POST method assumes the arguments are provided as part of the request body as does NOT perform string -> object interpolation.

The return value and return content type depend on the invokable. The typical case is a JSON representation of the return value of the invokable, but invokables may override the returned content type. In these cases, the invokable is responsible for ensuring the returned value conforms to the expected reponse header parameters.

Body parameter

{}

Responses

Status	Meaning	Description	Schema
200	OK	The return value and return content type depend on the invokable	None
400	Bad Request	Returns an error if something goes wrong.	Response400
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
name	path	string	true	none
body	body	object	false	none

Request

const inputBody = '{}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/invoke/{name}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/invoke/{name}', headers = headers)

print(r.json())

Response

json

{
  "error": "invokable1 not registered for invocation",
  "request_id": 0,
  "session": ""
}

json

{
  "error": "A user with those credentials was not found."
}

I18N

Import Resource I18N

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/import',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/i18n/import', headers = headers)

print(r.json())

Response

json

null

Retrieve Languages

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/languages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/languages', headers = headers)

print(r.json())

Response

json

null

Export I18N

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/system/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/system/export', headers = headers)

print(r.json())

Response

json

null

Retrieve All Resources By Type

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
r_type	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/resource/{r_type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/resource/{r_type}', headers = headers)

print(r.json())

Response

json

null

Bulk Export Resource I18N

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
cls_name	path	string	true	none
language	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/export/{cls_name}/{language}/bulk',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/export/{cls_name}/{language}/bulk', headers = headers)

print(r.json())

Response

json

null

Export Resource I18N

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
cls_name	path	string	true	none
language	path	string	true	none
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/export/{cls_name}/{language}/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/export/{cls_name}/{language}/{uuid}', headers = headers)

print(r.json())

Response

json

null

Validate Language Pack

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
user_requested_lang	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/{user_requested_lang}/validate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/{user_requested_lang}/validate', headers = headers)

print(r.json())

Response

json

null

Retrieve Translation Files

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
requested_lang	path	string	true	none
requested_locale	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/i18n/{requested_lang}/{requested_locale}/dictionary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/i18n/{requested_lang}/{requested_locale}/dictionary', headers = headers)

print(r.json())

Response

json

null

Iam

Do Authentication

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/internal/iam/authenticate',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/internal/iam/authenticate', headers = headers)

print(r.json())

Response

json

null

Locations

retrieve L7|Hub locations

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/locations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/locations', headers = headers)

print(r.json())

Response

json

null

retrieve location by id

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
location_id	path	integer	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/locations/{location_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/locations/{location_id}', headers = headers)

print(r.json())

Response

json

null

Locations_Legacy

retrieve L7|Hub locations

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/locations',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/locations', headers = headers)

print(r.json())

Response

json

null

retrieve location by id

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
location_id	path	integer	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/store/locations/{location_id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/store/locations/{location_id}', headers = headers)

print(r.json())

Response

json

null

Main

Get the OpenAPI spec

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
500	Internal Server Error	Server Error	BasicErrorModel

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
format	query	string	true	Format type for export

Enumerated Values

Parameter	Value
format	json
format	yaml
format	dict

Request

const headers = {
  'Accept':'text/x-yaml'
};

fetch('/api/openapi?format=json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'text/x-yaml'
}

r = requests.get('/api/openapi', params={
  'format': 'json'
}, headers = headers)

print(r.json())

Get the OpenAPI spec for a given server

Responses

Status	Meaning	Description	Schema
200	OK	Success	string
400	Bad Request	Invalid parameter	BasicErrorModel
500	Internal Server Error	Server Error	BasicErrorModel

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
server	path	string	true	Get openapi spec for a specific server. rapid7 is currently the only server supported.
format	query	string	true	Format type for export

Detailed descriptions

server: Get openapi spec for a specific server. rapid7 is currently the only server supported.

Enumerated Values

Parameter	Value
format	json
format	yaml
format	dict

Request

const headers = {
  'Accept':'text/x-yaml'
};

fetch('/api/openapi/{server}?format=json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'text/x-yaml'
}

r = requests.get('/api/openapi/{server}', params={
  'format': 'json'
}, headers = headers)

print(r.json())

Metrics

Retrieve server metrics:

GET /metrics/

To retrieve metrics, the user needs to send a GET request on /metrics.

.. :quickref: get_metrics method; Retrieve server metrics

Exceptions:

None unless there is a coding error, which will return a 500.

Returns:

Returns a text response. If 200, text is returned.

Example Response A:

Upon a 200 response code, returns text

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

esp_database_sessions 5 esp_user_sessions 0 esp_available_memory 5490827264 esp_cpu_usage_percent 40.7 esp_avail_disk_space 883905421312 esp_load_avg 2.51318359375 esp_service_broker 1 esp_service_logger 1 esp_service_pipeline 1 esp_service_executor 1 esp_service_haproxy 1 esp_service_http_0 1 esp_service_database 1

:resheader 200: text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/metrics/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/metrics/', headers = headers)

print(r.json())

Response

json

null

Multitenant

Retrieve Environments

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/multitenant/environment', headers = headers)

print(r.json())

Response

json

null

Create Environment

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/create',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/multitenant/environment/create', headers = headers)

print(r.json())

Response

json

null

Retrieve Environment Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
tenant	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/{tenant}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/multitenant/environment/{tenant}', headers = headers)

print(r.json())

Response

json

null

Update Tenant

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
tenant	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/{tenant}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/multitenant/environment/{tenant}', headers = headers)

print(r.json())

Response

json

null

Archive Environment

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
tenant	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/{tenant}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/multitenant/environment/{tenant}', headers = headers)

print(r.json())

Response

json

null

Retrieve Default Environment Config

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/defaultConfig',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/multitenant/environment/defaultConfig', headers = headers)

print(r.json())

Response

json

null

Wipe Tenant

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
tenant	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/multitenant/environment/wipe/{tenant}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/multitenant/environment/wipe/{tenant}', headers = headers)

print(r.json())

Response

json

null

Notary

Get Enabled Notaries

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/notary', headers = headers)

print(r.json())

Response

json

null

Gets the status and contents of documents that have been processed in DocuSign. If no UUID is

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/notary/adobesign/{uuid}', headers = headers)

print(r.json())

Response

json

null

Takes information about a document and its signers, configures an envelope, and sends it to docusign

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none
fragment	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/{uuid}/{fragment}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/notary/adobesign/{uuid}/{fragment}', headers = headers)

print(r.json())

Response

json

null

Docusign Webhook Get

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/docusign/webhook',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/notary/docusign/webhook', headers = headers)

print(r.json())

Response

json

null

Docusign Webhook Post

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/docusign/webhook',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/notary/docusign/webhook', headers = headers)

print(r.json())

Response

json

null

Gets the new access/refresh tokens for a user in DocuSign and saves them to the database.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/redirect',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/notary/adobesign/redirect', headers = headers)

print(r.json())

Response

json

null

Adobesign Webhook Post

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
tenant	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/{tenant}/webhook',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/notary/adobesign/{tenant}/webhook', headers = headers)

print(r.json())

Response

json

null

This method will fetch a new access token using the refresh token provided by DocuSign’s

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/refresh/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/notary/adobesign/refresh/{uuid}', headers = headers)

print(r.json())

Response

json

null

Gets the updated content of documents in DocuSign, identified by the envelope_id. The

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
document_id	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/notary/adobesign/signatures/{document_id}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/notary/adobesign/signatures/{document_id}', headers = headers)

print(r.json())

Response

json

null

Notification

Retrieves the list of Notifications, each being represented as JSON:

GET /notification

To retrieve notifications, the user needs to send a GET request on /notification.

.. :quickref: retrieve_notifications method; Retrieves notifications

Exceptions:

None unless there is a coding error, which will return a 500.

JSON:

username (optional): Type: String

User we want to retrieve message for. If not present, logged in user used.

timeframe (optional): Type: String

How far back in time we want to retrieve messages for. Can be in minutes (ex: 4M), hours (ex: 2H), or days (ex: 1D).

acknowledged (optional): Type: String

Y/N. Signifies that we want already acknowledged notifications returned. Defaults to N.

target (optional): Type: String

Signifies the specific ESP site the notification was targeted for.

Example Request A :

.. sourcecode:: http

GET /notification Host: (host)[:port number] Accept: application/json

Returns:

Returns a JSON response. If 200, ‘results’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “results”: [ { “acknowledged”: false, “msg”: { “text”: “Message #1” }, “msg_type”: “system”, “seq_num”: 126, “origin”: “ESP A”, “other_seq_num”: -1, “severity”: “info”, “target”: “ESP A”, “username”: “admin@localhost” }, { “acknowledged”: false, “msg”: { “text”: “Message #2” }, “msg_type”: “system”, “seq_num”: 127, “origin”: “ESP A”, “other_seq_num”: -1, “severity”: “info”, “target”: “ESP A”, “username”: “admin@localhost” }] }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/notification',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/notification', headers = headers)

print(r.json())

Response

json

null

Create and Send a Notification:

POST /notification

To create a new notification, the user needs to send a POST request on /notification.

.. :quickref: accept_notification method; Create a new notification

Exceptions:

None unless there is a coding error, which will return a 500.

JSON:

msg: Type: JSON

Free form JSON format for however you want to store your message

msg_type: Type: String

The type of message you are sending. No validation is done, so it’s up to your application that is using this to determine what it should be.

severity: Type: String

The severity of the message. No validation is done, so it’s up to your application that is using this to determine what it should be.

role (optional): Type: String

If given, we look for all users for the role and send them the notification.

user (optional): Type: String

User who this notification is for. If role is present, it will supersede user. If neither role or user is present, the logged in user is used.

workgroup (optional): Type: String

If given, we look for all users for the workgroup and send them the notification. If either role or user is present, it will supersede workgroup.

target (optional): Type: String

ESP target site to send this message via Kafka

seq_num (optional): Type: Int

Notification number if this notification came from this site. Only present when receiving a notification from Kafka, which will be negative. UI and User generated notifs won’t have this.

other_seq_num (optional): Type: Int

Notification number if this notification came from anpther site. Only present when receiving a notification from Kafka. UI and User generated notifs won’t have this.

origin (optional): Type: Int

ESP site that initially created this notification. Only present when message received from Kafka. UI and User generated notifs won’t have this.

Example Request A :

.. sourcecode:: http

POST /notification Host: (host)[:port number] JSON: { “msg”: { “title”: { “image”: “img0.png”, “text”: “Notification title” }, “body”: { “image”: “img1.png”, “text”: “Notification body” }, “link”: { “url”: “http://example.org”, “text”: “Example link” } }, “msg_type”: “system”, “severity”: “info”, “target”: “ESP B” } Accept: application/json

Example Request B :

.. sourcecode:: http

POST /notification Host: (host)[:port number] JSON: { “msg”: { “text”: “This is a notification.”, “link”: “http://google.com” }, “msg_type”: “system” } Accept: application/json

Returns:

Returns a JSON response. If 200, ‘status’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response B:

Upon a 400 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “status”: “Notification sent” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Example Response B ;

.. sourcecode:: http

HTTP/1.1 400 OK Content-Type: application/json

{ “error”: “Severity not provided” }

:resheader 400: application/json, text/javascript, /; q=0.01; :status 400: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/notification',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/notification', headers = headers)

print(r.json())

Response

json

null

Acknowledges a received Notification:

PUT /notification

To acknowledge a notification, the user needs to send a PUT request on /notification.

.. :quickref: acknowledge_notification method; Acknowledge a notification

Exceptions:

None unless there is a coding error, which will return a 500.

JSON:

target: Type: String

ESP target site. Can be the current site or an outside site.

seq_num (optional): Type: Int

Present if acknowledging a notification generated from this server

other_seq_num (optional): Type: Int

Present if acknowledging a notification generated from an outside server, so we know to forward on the acknowledgement to that site.

user (optional): Type: String

User who this notification is for. If user is not present, the logged in user is used.

Example Request A :

.. sourcecode:: http

PUT /notification Host: (host)[:port number] JSON: { “seq_num”: 15, “target”: “ESP A”, “user”: “admin@localhost” } Accept: application/json

Example Request B :

.. sourcecode:: http

PUT /notification Host: (host)[:port number] JSON: { “seq_num”: 15, “user”: “admin@localhost” } Accept: application/json

Returns:

Returns a JSON response. If 200, ‘status’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response B:

Upon a 400 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “status”: “Acknowledge sent” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Example Response B ;

.. sourcecode:: http

HTTP/1.1 400 OK Content-Type: application/json

{ “error”: “Target not provided” }

:resheader 400: application/json, text/javascript, /; q=0.01; :status 400: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/notification',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/notification', headers = headers)

print(r.json())

Response

json

null

PDFgen

post__api_pdfgen_notebook_entry

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/notebook_entry',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/notebook_entry')

print(r.json())

post__api_pdfgen_notebook_template

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/notebook_template',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/notebook_template')

print(r.json())

post__api_pdfgen_flex_view

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/flex_view',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/flex_view')

print(r.json())

post__api_pdfgen_report

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/report',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/report')

print(r.json())

post__api_pdfgen_html

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/html',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/html')

print(r.json())

post__api_pdfgen_url

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/url',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/url')

print(r.json())

Merge PDFs into one.

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error.	None

This operation does not require authentication

Request

fetch('/api/pdfgen/merge',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/pdfgen/merge')

print(r.json())

Params

Undelete a Param Group by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Success	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/param_groups/{uuid}/undelete',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/param_groups/{uuid}/undelete', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Get Param Groups

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of param groups objects	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	false	Search for a single UUID
uuids	query	array[string]	false	Search for a list of UUIDs
uuid.not	query	string(uuid)	false	Filter out resource with specific UUID
name	query	string	false	Search for an exact resource name
name.like	query	string	false	Double-ended case-insensitive wildcard search for resource names
names	query	array[string]	false	Search for a list of resource names (exact match)
desc	query	string	false	Search for content in the resource description/note (case-sensitive wildcard)
desc.like	query	string	false	Double-ended case-insensitive wildcard search for resource description/note
barcode	query	string	false	Search for a single barcode
barcodes	query	array[string]	false	Search for a list of barcodes
barcode.like	query	string	false	Double-ended case-insensitive wildcard search for barcode
limit	query	integer	false	Limit the number of results returned
offset	query	integer	false	Specify the offset of the first result returned
alltags	query	array[string]	false	Search for resources with all specified tags
owner	query	string	false	Search for resources where the owner’s email or username exactly matches the value
owner.like	query	string	false	Search for resources where the owner’s email or username matches the value using a double-ended case-insensitive wildcard search
created_after	query	string(date)	false	Search for resources created after a specified date
created_before	query	string(date)	false	Search for resources created before a specified date
updated_after	query	string(date)	false	Search for resources updated after a specified date
updated_before	query	string(date)	false	Search for resources updated before a specified date
tags	query	array[string]	false	Search for resources with one or more tags in the specified list

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» params	object	true	none	parameter key value pairs
»»» additionalProperties	string	false	none	none

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/param_groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/param_groups', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "params": {
      "property1": "string",
      "property2": "string"
    }
  }
]

Create a new Param Group

POST /api/param_groups

To create a new Param Group, send a Param Group Handler POST request.

The user has the ability to create a Param Group with name, desc, params, and tags.

When creating a Param Group, the fields can be passed via request body or query args.

Example Request: Creating an example Param Group used to dictate what animals are currently in the lab.

Common Errors:
- Response Code 400
  - Occurs when either:
    POST request was improperly structured with the params or tags.
    Single quotes were (improperly) used instead of double quotes.

Example Response Upon a 200 response code, a JSON Param Group object is returned with the associated data installed by the the user in the POST request.

Body parameter

{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	If successful, the server returns a response code 200 and a Param Group object in a JSON format.	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Occurs when either the POST request was improperly structured with the params or tags or single quotes were (improperly) used instead of double quotes.	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	ParamPostBody	true	none
» name	body	string	true	Name of the designated Param Group
» desc	body	string	false	Description of the Param Group
» params	body	object	false	A designated key-value pair that can be referenced at any point in ESP.
»» additionalProperties	body	string	false	none
» tags	body	[string]	false	List of designated tags (Strings) to be associated with the Param Group

Request

const inputBody = '{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/param_groups',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/param_groups', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Create a new Param Group by importing data

POST /api/param_groups/import

To create a new Param Group, send a Param Group Handler POST request.

The user has the ability to create a Param Group with name, desc, params, and tags.

Request Body:

Example Request: Creating an example Param Group used to dictate what animals are currently in the lab.

Common Errors:
- Response Code 400
  - Occurs when either:
    POST request was improperly structured with the params or tags.
    Single quotes were (improperly) used instead of double quotes.

Example Response Upon a 200 response code, a JSON Param Group object is returned with the associated data installed by the the user in the POST request.

Body parameter

{
  "import_data": {
    "param_groups": [
      {}
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	If successful, the server returns a response code 200 and a JSON object containing the new Param Groups	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» import_data	body	object	false	none
»» param_groups	body	[ParamPostBody]	false	none
»»» name	body	string	true	Name of the designated Param Group
»»» desc	body	string	false	Description of the Param Group
»»» params	body	object	false	A designated key-value pair that can be referenced at any point in ESP.
»»»» additionalProperties	body	string	false	none
»»» tags	body	[string]	false	List of designated tags (Strings) to be associated with the Param Group

Request

const inputBody = '{
  "import_data": {
    "param_groups": [
      {}
    ]
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/param_groups/import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/param_groups/import', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Get Param Group by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of param groups objects	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/param_groups/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/param_groups/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Delete a Param Group

Responses

Status	Meaning	Description	Schema
200	OK	If successful, the server returns a response code 200 and a Param Group object in a JSON format.	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Occurs when either the POST request was improperly structured with the params or tags or single quotes were (improperly) used instead of double quotes.	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/param_groups/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/param_groups/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Update a Param Group

Body parameter

{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ],
  "augment": true,
  "barcode": "barcode123",
  "barcode_type": "1D",
  "fixed_id": "param_fixed_id"
}

Responses

Status	Meaning	Description	Schema
200	OK	If successful, the server returns a response code 200 and a Param Group object in a JSON format.	ParamResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Occurs when either the POST request was improperly structured with the params or tags or single quotes were (improperly) used instead of double quotes.	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
body	body	ParamPutBody	false	none

Request

const inputBody = '{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ],
  "augment": true,
  "barcode": "barcode123",
  "barcode_type": "1D",
  "fixed_id": "param_fixed_id"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/param_groups/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/param_groups/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

Get Param Group Action, Key, or Export

GET /api/param_groups/{uuid}/{fragment}

The user has the ability to get actions from or export the designated Param Group, and also to retrieve a specific key-value pair contained within that Param Group.

Path Parameters:

Example Request A: Retrieve the actions performed on a Param Group in ESP based on it’s unique ID.

Example Request B: Export the Param Group object in a .lab7 extension file.

Example Request C: Retrieve a single key-value pair in a designed Param Group based on it’s unique ID.

Common Errors:
- Response Code 400
  - Occurs when either:
    Param Group unique ID did not exist for get_actions, export, or calling for a specific key.
    A key in a designated Param Group did not exist when trying to retrieve it.

Example Response A: Upon a 200 response code, the JSON Param Group object is returned of the actions performed on the Param Group designated by it’s unique ID.

Example Response B: Upon a 200 response code, a JSON Param Group object is returned of the Group to be exported in a .lab7 extension file format automatically downloaded to the user.

Example Response C: Upon a 200 response code, a JSON Param Group object is returned of the specified key in the designated Param Group.

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of param groups objects	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
fragment	path	string	true	- get_actions

Detailed descriptions

fragment: - get_actions - Type: String - Actions performed on the Param Group - Example: Changing the value in key-value pair: {“key” : “kittens”} -> {“key”, “cat”} - export - Type: String - Exports the Param Group into a .lab7-formatted extension file. - key - Type: String - Key parameter in a key-value pair of a designated Param Group

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/param_groups/{uuid}/{fragment}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/param_groups/{uuid}/{fragment}', headers = headers)

print(r.json())

Planned_Action_Chains

Get Planned Action Chains

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_action_chains', headers = headers)

print(r.json())

Response

json

null

Create Planned Action Chain

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/planned_action_chains', headers = headers)

print(r.json())

Response

json

null

Get Planned Action Chain

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_action_chains/{uuid}', headers = headers)

print(r.json())

Response

json

null

Update Planned Action Chain

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/planned_action_chains/{uuid}', headers = headers)

print(r.json())

Response

json

null

Delete Planned Action Chain

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/planned_action_chains/{uuid}', headers = headers)

print(r.json())

Response

json

null

Schedule Planned Action Chain

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_chains/{uuid}/schedule',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/planned_action_chains/{uuid}/schedule', headers = headers)

print(r.json())

Response

json

null

Queue

Get

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/work_queue/job', headers = headers)

print(r.json())

Response

json

null

Post

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/status',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/work_queue/status', headers = headers)

print(r.json())

Response

json

null

Purge

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/work_queue/job', headers = headers)

print(r.json())

Response

json

null

Status

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/status/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/work_queue/status/{uuid}', headers = headers)

print(r.json())

Response

json

null

Get Status For All Jobs

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job/latest',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/work_queue/job/latest', headers = headers)

print(r.json())

Response

json

null

Get Items For Job

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
jobid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job/{jobid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/work_queue/job/{jobid}', headers = headers)

print(r.json())

Response

json

null

Delete

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
jobid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job/{jobid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/work_queue/job/{jobid}', headers = headers)

print(r.json())

Response

json

null

Get Status For Job

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
jobid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/work_queue/job/{jobid}/latest',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/work_queue/job/{jobid}/latest', headers = headers)

print(r.json())

Response

json

null

Relay

Relay Handler - Get the respected page or data with the correct authorization.

Body parameter

{
  "url": "http://localhost:8080/api/samples",
  "method": "GET",
  "auth": {
    "mode": "basic",
    "username": "user1",
    "password": "pass1"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful request.	AnyValue
400	Bad Request	Returns an error if something goes wrong.	Response400
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
default	Default	Default error	DefaultError

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	object	true	none
» url	body	string	true	URL of the remote endpoint, including the protocol component (“http://” or “https://”). The URL query component MAY be ommitted and passed using the “args” argument instead.
» method	body	string	false	HTTP method for connecting to the remote endpoint
» auth	body	object	false	HTTP authentication information, if any, for the remote
» content_type	body	string	false	HTTP “Content-Type” header for the remote request;
» headers	body	object	false	Any additional headers to include with the remote
» args	body	string	false	Remote requests arguments as a {“arg. name”: }
» timeout	body	integer	false	Number of seconds to wait before timing out the request; defaults to 10 seconds.
» validate_cert	body	boolean	false	If true and making a remote HTTPS request, require the remote server provide a valid certificate. (Defaults to false).

Detailed descriptions

» auth: HTTP authentication information, if any, for the remote endpoint. If provided, it MUST be a dictionary (JSON object) with the following key-value pairs:

“mode”: if provided, its value MUST be “basic”
“username”: username for HTTP basic authentication
“password”: password for HTTP basic authentication

» content_type: HTTP “Content-Type” header for the remote request; MAY be omitted. Defaults to None (null) for “GET”, “OPTIONS”, and “HEAD” requests, and “application/x-www-form-urlencoded” for “POST” and “PUT” requests.

» headers: Any additional headers to include with the remote request, supplied as a {“header name”: “header value”} dictionary.

NOTE: if provided, the value of “Content-Type” provided in “headers” takes precedence over any value provided by the “content_type” argument.

» args: Remote requests arguments as a {“arg. name”: } dictionary. How this dictionary is formatted for the remote request is determined by the “Content-Type” header.

Enumerated Values

Parameter	Value
» method	GET
» method	POST
» method	PUT
» method	OPTIONS
» method	HEAD

Request

const inputBody = '{
  "url": "http://localhost:8080/api/samples",
  "method": "GET",
  "auth": {
    "mode": "basic",
    "username": "user1",
    "password": "pass1"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'*/*'
};

fetch('/api/relay',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*'
}

r = requests.post('/api/relay', headers = headers)

print(r.json())

Reload

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/reload',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/reload', headers = headers)

print(r.json())

Response

json

null

Resource_Assignments

Get Resource Assignments

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments', headers = headers)

print(r.json())

Response

json

null

Get Assignments Status

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/status', headers = headers)

print(r.json())

Response

json

null

Get Resource Assignments Outside Of Schedule

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/pending',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/pending', headers = headers)

print(r.json())

Response

json

null

Update Pending Resource Assignments

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/pending',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.patch('/api/schedules/resource_assignments/pending', headers = headers)

print(r.json())

Response

json

null

Get Capacity

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/capacity',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/capacity', headers = headers)

print(r.json())

Response

json

null

Get Suggested Times

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/suggested_times',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/suggested_times', headers = headers)

print(r.json())

Response

json

null

Get Shared Availability

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/shared_availability',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/shared_availability', headers = headers)

print(r.json())

Response

json

null

Get Recurrence Problems

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/recurrence_problems',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/resource_assignments/recurrence_problems', headers = headers)

print(r.json())

Response

json

null

Delete Future Assignments

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_assignments/delete_future_assignments',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/resource_assignments/delete_future_assignments', headers = headers)

print(r.json())

Response

json

null

Resource_Disable_Period

Create Resource Disable Period

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_disable_period',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/resource_disable_period', headers = headers)

print(r.json())

Response

json

null

Update Resource Disable Period

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/resource_disable_period',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/resource_disable_period', headers = headers)

print(r.json())

Response

json

null

SSH

Get User logins

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/api/profile/logins',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.get('/api/profile/logins')

print(r.json())

Create User login

Request

fetch('/api/profile/logins',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/profile/logins')

print(r.json())

Delete User login

Request

fetch('/api/profile/logins',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.delete('/api/profile/logins')

print(r.json())

Get SSH logins for User

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
user	path	string(uuid)	true	User agent UUID

Request

fetch('/api/users/{user}/logins',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.get('/api/users/{user}/logins')

print(r.json())

Post SSH login for User

Parameters

Name	In	Type	Required	Description
user	path	string(uuid)	true	User agent UUID

Request

fetch('/api/users/{user}/logins',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/users/{user}/logins')

print(r.json())

Delete SSH login for User

Parameters

Name	In	Type	Required	Description
user	path	string(uuid)	true	User agent UUID

Request

fetch('/api/users/{user}/logins',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.delete('/api/users/{user}/logins')

print(r.json())

Sample

Import Sample(s)

Body parameter

{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "name": "Sample Name",
  "desc": "Description of the sample",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "SampleType1",
  "barcode": "1234567890",
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "names": [
    "Name1",
    "Name2"
  ],
  "descs": [
    "Desc1",
    "Desc2"
  ],
  "count": 5,
  "sequence": "lab7_sample_auto_id_seq",
  "children": [
    {}
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
body	body	SampleImportPostBody	true	none
» uuid	body	string(uuid)	false	UUID of the sample
» name	body	string	false	Name of the sample
» desc	body	string	false	Description of the sample
» tags	body	[string]	false	Tags associated with the sample
» type	body	string	false	SampleType name
» barcode	body	string	false	Barcode of the sample
» variables	body	object	false	Variables associated with the sample
»» additionalProperties	body	string	false	none
» names	body	[string]	false	List of names. Used for bulk sample creation.
» descs	body	[string]	false	List of descriptions. Used for bulk sample creation.
» count	body	integer	false	Number of samples to create. Used for bulk sample creation.
» sequence	body	string	false	Sample sequence
» children	body	[object]	false	List of children samples

Response Schema

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const inputBody = '{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "name": "Sample Name",
  "desc": "Description of the sample",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "SampleType1",
  "barcode": "1234567890",
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "names": [
    "Name1",
    "Name2"
  ],
  "descs": [
    "Desc1",
    "Desc2"
  ],
  "count": 5,
  "sequence": "lab7_sample_auto_id_seq",
  "children": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/samples/import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/samples/import', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

Export Sample

Responses

Status	Meaning	Description	Schema
200	OK	Success	SampleExportDictResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
format	query	string	true	Format type for export

Enumerated Values

Parameter	Value
format	json
format	yaml
format	dict

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}/export?format=json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/{uuid}/export', params={
  'format': 'json'
}, headers = headers)

print(r.json())

Get Sample Hierarchy

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
depth	query	integer	false	ancestor depth

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» description	string	false	none	none
» name	string	false	none	none
» params	object	false	none	none
»» depth	integer	false	none	none
» path	string	false	none	none
» processing_time_seconds	number(float)	false	none	none
» results	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	BasicResourceResponse	false	none	basic resource response
»»»» uuid	string(uuid)	true	none	resource uuid
»»»» url	string	true	none	resource url
»»»» cls	string	true	none	resource class
»»»» name	string	true	none	resource name
»»»» desc	string	true	none	resource description
»»»» barcode	string	true	none	resource barcode
»»»» created_at	string	true	none	resource created timestamp
»»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	resource response
»»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»»» fixed_id	string	true	none	resource fixed id
»»»» deleted	boolean	true	none	is resource archived?
»»»» tags	[string]	true	none	resource tags
»»»» owner	object	true	none	resource owner
»»»»» name	string	false	none	none
»»»»» uuid	string(uuid)	false	none	none
»»»» meta	object	true	none	resource metadata
»»»» view_template	string	true	none	resource view template
»»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	none
»»» child_resource_id	integer	true	none	Child Resource ID
»»» cycle	boolean	true	none	Is Cycle?
»»» deleted	boolean	true	none	Is Deleted?
»»» generation	integer	true	none	Generation relative to origin sample
»»» in_workflow_instance	boolean	true	none	Is in Workflow Instance?
»»» meta	object	true	none	Meta
»»» owner	string	true	none	Owner
»»» owner_resource_id	integer	true	none	Owner Resource ID
»»» parentage	[integer]	true	none	Parentage
»»» plural_name	string	true	none	Plural Name
»»» primary_uuid	string(uuid)	true	none	Primary UUID
»»» resource_id	integer	true	none	Resource ID
»»» resource_vals	object	true	none	Resource Values
»»»» additionalProperties	string	false	none	none
»»» sample_type	string(uuid)	true	none	Sample Type
»»» sample_type_name	string	true	none	Sample Type Name
»»» sample_type_uuid	string(uuid)	true	none	Sample Type UUID

continued

Name	Type	Required	Restrictions	Description
» roles	[string]	false	none	none

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}/parentage',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/{uuid}/parentage', headers = headers)

print(r.json())

Response

json

{
  "description": "Displays sample relationships in tree form",
  "name": "Sample Parentage",
  "params": {
    "depth": 1
  },
  "path": "/api/samples/[uuid]/parentage",
  "processing_time_seconds": 0.042237281799316406,
  "results": {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": false,
    "tags": [
      "string"
    ],
    "owner": "system admin (admin@localhost)",
    "meta": [],
    "view_template": "string",
    "state": "string",
    "child_resource_id": 593,
    "cycle": false,
    "generation": 0,
    "in_workflow_instance": false,
    "owner_resource_id": 11,
    "parentage": [
      77
    ],
    "plural_name": "Samples",
    "primary_uuid": "9415a68a-c0a8-4076-aae5-a1ac892ea185",
    "resource_id": 77,
    "resource_vals": {
      "custom_field1": "textaaa",
      "custom_field2": 12345
    },
    "sample_type": "77777777-7777-4014-b700-053300000000",
    "sample_type_name": "Generic sample",
    "sample_type_uuid": "77777777-7777-4014-b700-053300000000"
  },
  "roles": []
}

Get Sample Data

Responses

Status	Meaning	Description	Schema
200	OK	Returns Sample experiment data	SampleUUIDDataResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}/data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/{uuid}/data', headers = headers)

print(r.json())

Response

json

{
  "results": {
    "property1": "string",
    "property2": "string"
  },
  "params": {
    "uuid": "6e39f573-d036-4592-ab6f-af211d13788e"
  },
  "processing_time_seconds": 0.03594684600830078
}

Undelete a Sample by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Success	SampleResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}/undelete',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/samples/{uuid}/undelete', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

Get Sample Sequences

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SampleSequenceResponse]	false	none	none
» name	string	true	none	Name
» format	string	true	none	Sequence format
» sequence	string	true	none	Sequence name

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/id_sequences',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/id_sequences', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "ESP SEQUENCE",
    "format": "ESP{sample_number:06}",
    "sequence": "lab7_sample_auto_id_seq"
  }
]

Get Samples

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of Sample dictionaries	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
name	query	string	false	Search for an exact resource name
name.like	query	string	false	Double-ended case-insensitive wildcard search for resource names
barcode.like	query	string	false	Double-ended case-insensitive wildcard search for barcode
clses	query	array[string]	false	Search for a list of classes
limit	query	integer	false	Limit the number of results returned
offset	query	integer	false	Specify the offset of the first result returned
tags	query	array[string]	false	Search for resources with one or more tags in the specified list
owner.like	query	string	false	Search for resources where the owner’s email or username matches the value using a double-ended case-insensitive wildcard search
created_after	query	string(date)	false	Search for resources created after a specified date
created_before	query	string(date)	false	Search for resources created before a specified date
workflowable_resource_class_uuid	query	string(uuid)	false	The UUID of the workflowable resource class
sample_type.like	query	string	false	Double-ended case-insensitive wildcard search for Sample Type
in_workflow_instance	query	boolean	false	Indicates if the item is in a workflow instance

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SampleOptResponse]	false	none	[Optimized Sample response]
» name	string	false	none	resource name
» uuid	string(uuid)	false	none	resource uuid
» meta	object	false	none	resource metadata
» desc	string	false	none	resource description
» barcode	string	false	none	resource barcode
» barcode_type	string	false	none	resource barcode type
» created_at	string	false	none	resource created timestamp
» updated_at	string	false	none	resource updated timestamp
» sample_type_uuid	string(uuid)	false	none	UUID of the sample type
» sample_type_name	string	false	none	Name of the sample type
» url	string	false	none	resource url
» in_workflow_instance	boolean	false	none	whether the sample is in a workflow instance
» owner	object	false	none	resource owner
»» name	string	false	none	none
»» uuid	string(uuid)	false	none	none
» resource_vals	[object]	false	none	resource values
» tags	[string]	false	none	resource tags

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples_opt',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples_opt', headers = headers)

print(r.json())

Response

json

[
  {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "meta": {},
    "desc": "string",
    "barcode": "string",
    "barcode_type": "string",
    "created_at": "string",
    "updated_at": "string",
    "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
    "sample_type_name": "string",
    "url": "string",
    "in_workflow_instance": true,
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "resource_vals": [
      {}
    ],
    "tags": [
      "string"
    ]
  }
]

Create Sample(s)

POST /api/samples

Handles create (POST) Sample

The user may create one or multiple Samples with meta data, name, description, tags, and the Sample Type definition uuid. For more information on the Sample Type uuid, refer to the Sample Type Handler definition section.

The user may also import files that contain Sample data into ESP by either importing through a text file (formatted with a .Lab7 extension) or via the Sample ingest Pipelines. Note that the user should consult with Lab7 when Sample ingesting from vendors.

Parameters:

Example Request

Example response If successful, the server returns a response code 200 and created Sample(s) in JSON format. If only one Sample is created, one JSON Dict is returned.

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ],
  "lab7_id_sequence": "string",
  "autogen_name": true,
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
      "parents": [],
      "children": [],
      "resource_vals": [],
      "lab7_id_sequence": "string",
      "autogen_name": true
    }
  ],
  "metadata": {
    "sample_tags": [
      "string"
    ],
    "format": "text",
    "pipeline_uuid": "03afed02-78e2-41e3-b5b0-ddd069f5f552",
    "property1": "string",
    "property2": "string"
  },
  "autogen_names": true
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the created Sample.	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
body	body	SamplePostBody	true	none

Response Schema

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ],
  "lab7_id_sequence": "string",
  "autogen_name": true,
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
      "parents": [],
      "children": [],
      "resource_vals": [],
      "lab7_id_sequence": "string",
      "autogen_name": true
    }
  ],
  "metadata": {
    "sample_tags": [
      "string"
    ],
    "format": "text",
    "pipeline_uuid": "03afed02-78e2-41e3-b5b0-ddd069f5f552",
    "property1": "string",
    "property2": "string"
  },
  "autogen_names": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/samples',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/samples', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

Update Samples

Body parameter

{
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "resource_vals": {}
    }
  ],
  "migrate_type_def": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the updated Sample.	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
body	body	SamplePutBody	true	none
» samples	body	[allOf]	false	A list of dictionaries containing the sample UUIDs to migrate
»» anonymous	body	BasicResourcePostSchema	false	none
»»» name	body	string	false	Name
»»» desc	body	string¦null	false	Description
»»» tags	body	[string]	false	Tags
»»» meta	body	object	false	Meta
»»» augment	body	object¦null	false	Augment
»»»» additionalProperties	body	string	false	none
»»» barcode	body	string¦null	false	Barcode
»»» barcode_type	body	string¦null	false	Barcode Type
»» anonymous	body	object	false	none
»»» uuid	body	string(uuid)	false	none
»»» resource_vals	body	object	false	none
» migrate_type_def	body	any	false	The new sample type definition to migrate the samples to

Enumerated Values

Parameter	Value
»»» barcode_type	QR
»»» barcode_type	1D
»»» barcode_type	mini data matrix

Response Schema

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const inputBody = '{
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "resource_vals": {}
    }
  ],
  "migrate_type_def": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/samples',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/samples', headers = headers)

print(r.json())

Get Sample by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns a Sample dictionary	SampleResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

Delete Sample by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns the archived Sample’s UUID	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string(uuid)	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/samples/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update Sample

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the updated Sample.	SampleResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
body	body	SamplePutUUIDBody	true	none

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/samples/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

Get Sample relations

Responses

Status	Meaning	Description	Schema
200	OK	Returns one of:

Retrieves a Sample’s parents
Retrieves a Sample’s children
Retrieves the protocol_instances that a Sample belongs to
Retrieves the workflow_instances that a Sample belongs to
Retrieves the ingest_instances that a Sample belongs to|Inline| |401|Unauthorized|Authentication failed|Response401| |500|Internal Server Error|Server error|Response500| |4XX|Unknown|Client Error|Response400|

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
fragment	path	string	true	- parents

Detailed descriptions

fragment: - parents - Type: String - Retrieves a Sample’s parents, provided its uuid

children
- Type: String
- Retrieves a Sample’s children, provided its uuid
protocol_instances
- Type: String
- Retrieves the protocol_instances that a Sample belongs to, provided its uuid
workflow_instances
- Type: String
- Retrieves the workflow_instances that a Sample belongs to, provided its uuid
ingests
- Type: String
- Retrieves the ingest_instances that a Sample belongs to, provided its uuid

Response Schema

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/samples/{uuid}/{fragment}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/samples/{uuid}/{fragment}', headers = headers)

print(r.json())

Get Samples for a Sample Point Resource Val

Responses

Status	Meaning	Description	Schema
200	OK	Returns list Sample Point dictionaries	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
resource_val	query	string(uuid)	true	Resource Val UUID

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SamplePointResponse]	false	none	[Sample Point response]
» parent_resource_id	string(uuid)¦null	false	none	parent resource uuid
» parent_resource_name	string¦null	false	none	Name of the parent resource
» resource_id	string(uuid)	false	none	Resource UUID
» created_at	string(date-time)	false	none	Date and time of creation
» deleted	boolean	false	none	Indicates if the resource is deleted
» desc	string¦null	false	none	Description of the resource
» meta	object	false	none	Additional metadata for the resource
» name	string	false	none	Name of the resource
» barcode	string	false	none	Barcode of the resource
» barcode_type	string	false	none	Type of barcode
» updated_at	string(date-time)	false	none	Date and time of last update
» url	string¦null	false	none	URL of the resource
» uuid	string(uuid)	false	none	UUID of the resource
» in_workflow_instance	boolean	false	none	Indicates if the resource is in a workflow instance
» sample_type	string	false	none	Sample type
» sample_type_uuid	string(uuid)	false	none	UUID of the sample type

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample-point?resource_val=497f6eca-6276-4993-bfeb-53cbbbba6f08',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample-point', params={
  'resource_val': '497f6eca-6276-4993-bfeb-53cbbbba6f08'
}, headers = headers)

print(r.json())

Response

json

[
  {
    "parent_resource_id": "e34b2239-0c28-4b0b-9612-6793cd110465",
    "parent_resource_name": "Parent Resource",
    "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
    "created_at": "2024-03-01 16:45:48.228656",
    "deleted": true,
    "desc": "Description of the resource",
    "meta": [],
    "name": "ESP000001",
    "barcode": "e34b2239-0c28-4b0b-9612-6793cd110465",
    "barcode_type": "QR",
    "updated_at": "2024-03-05 21:50:11.586942",
    "url": null,
    "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
    "in_workflow_instance": true,
    "sample_type": "Generic sample",
    "sample_type_uuid": "77777777-7777-4014-b700-053300000000"
  }
]

Create samples for a sample point

Body parameter

{
  "sample_specs": [
    {
      "name": "Sample Spec Name",
      "resource_vals": []
    }
  ],
  "general_sample_specs": {
    "lab7_id_sequence": "ESP SEQUENCE",
    "sample_type_uuid": "33b92cd0-6bf3-4fbc-bbfe-52c4623dabe8",
    "sample_type_definition_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
    "tags": []
  },
  "parent": {
    "resource_var_uuid": "51bc8fad-c6f6-49ba-937e-2c82e848029e",
    "resource_val_uuid": "bf12a574-03cc-47cc-9795-4ea5b6bfc89b"
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the created Sample.	SamplePointPostResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	SamplePointPostBody	true	none
» sample_specs	body	[object]	false	List of Sample specification dicts
»» name	body	string	false	none
»» resource_vals	body	[object]	false	none
»»» name	body	string	false	none
»»» value	body	string	false	none
»»» uuid	body	string(uuid)	false	none
» general_sample_specs	body	object	false	Dictionary containing the SampleType UUID, SampleTypeDefinition UUID, and lab7_id_sequence for the samples to be created.
»» lab7_id_sequence	body	string	false	none
»» sample_type_uuid	body	string(uuid)	false	none
»» sample_type_definition_uuid	body	string(uuid)	false	none
»» tags	body	[string]	false	none
» parent	body	object	false	none
»» resource_var_uuid	body	string(uuid)	false	sample point resource val uuid or pipe-delimited resource val uuid in case of groups
»» resource_val_uuid	body	string(uuid)	false	resource var uuid of sample point column

Request

const inputBody = '{
  "sample_specs": [
    {
      "name": "Sample Spec Name",
      "resource_vals": []
    }
  ],
  "general_sample_specs": {
    "lab7_id_sequence": "ESP SEQUENCE",
    "sample_type_uuid": "33b92cd0-6bf3-4fbc-bbfe-52c4623dabe8",
    "sample_type_definition_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
    "tags": []
  },
  "parent": {
    "resource_var_uuid": "51bc8fad-c6f6-49ba-937e-2c82e848029e",
    "resource_val_uuid": "bf12a574-03cc-47cc-9795-4ea5b6bfc89b"
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/sample-point',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/sample-point', headers = headers)

print(r.json())

Response

json

{
  "new_registered_children": [
    "485e6eba-5256-4215-8122-7a42b3b058b5",
    "b526c1d9-0528-4b5b-9c75-552e7376dfed"
  ],
  "all_sample_point_children": [
    "485e6eba-5256-4215-8122-7a42b3b058b5",
    "b526c1d9-0528-4b5b-9c75-552e7376dfed"
  ],
  "metadata": []
}

Import Sample Type(s)

Body parameter

{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "def_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
  "name": "qatype",
  "fixed_id": "qatype",
  "desc": "SampleType Description",
  "cls": "SampleTypeClass",
  "tags": [
    "tag1",
    "tag2"
  ],
  "sequences": [
    "Sequence1",
    "Sequence2"
  ],
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "view_template": "",
  "workflowable_resource_class": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "create": [],
  "augment": []
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	SampleTypeResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	SampleTypeImportPostBody	true	none
» uuid	body	string(uuid)	false	UUID
» def_uuid	body	string(uuid)	false	Definition UUID
» name	body	string	false	Name
» fixed_id	body	string	false	Fixed ID
» desc	body	string	false	Description
» cls	body	string	false	Class
» tags	body	[string]	false	Tags
» sequences	body	[string]	false	Sequences
» variables	body	[object]	false	Custom fields
»» additionalProperties	body	string	false	none
» view_template	body	string	false	View template HTML
» workflowable_resource_class	body	string(uuid)	false	Workflowable resource class UUID
» workflowable_resource_class_name	body	string	false	Name of workflowable resource class
» workflowable_resource_class_barcode	body	string	false	Barcode of workflowable resource class
» create	body	[SampleImportPostBody]	false	Samples to create with the new sample type
»» uuid	body	string(uuid)	false	UUID of the sample
»» name	body	string	false	Name of the sample
»» desc	body	string	false	Description of the sample
»» tags	body	[string]	false	Tags associated with the sample
»» type	body	string	false	SampleType name
»» barcode	body	string	false	Barcode of the sample
»» variables	body	object	false	Variables associated with the sample
»»» additionalProperties	body	string	false	none
»» names	body	[string]	false	List of names. Used for bulk sample creation.
»» descs	body	[string]	false	List of descriptions. Used for bulk sample creation.
»» count	body	integer	false	Number of samples to create. Used for bulk sample creation.
»» sequence	body	string	false	Sample sequence
»» children	body	[object]	false	List of children samples
» augment	body	object¦null	false	Augment
»» additionalProperties	body	string	false	none

Request

const inputBody = '{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "def_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
  "name": "qatype",
  "fixed_id": "qatype",
  "desc": "SampleType Description",
  "cls": "SampleTypeClass",
  "tags": [
    "tag1",
    "tag2"
  ],
  "sequences": [
    "Sequence1",
    "Sequence2"
  ],
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "view_template": "",
  "workflowable_resource_class": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "create": [],
  "augment": []
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/sample_types/import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/sample_types/import', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

Get Sample Export

Responses

Status	Meaning	Description	Schema
200	OK	Success	SampleTypeExportResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
format	query	string	true	Format type for export

Enumerated Values

Parameter	Value
format	json
format	yaml
format	dict

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_types/{uuid}/export?format=json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample_types/{uuid}/export', params={
  'format': 'json'
}, headers = headers)

print(r.json())

Undelete a Sample Type by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Success	SampleTypeResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_types/{uuid}/undelete',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/sample_types/{uuid}/undelete', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

Get Sample Types

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of Sample Type dictionaries	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	false	Search for a single UUID
uuids	query	array[string]	false	Search for a list of UUIDs
uuid.not	query	string(uuid)	false	Filter out resource with specific UUID
name	query	string	false	Search for an exact resource name
name.like	query	string	false	Double-ended case-insensitive wildcard search for resource names
names	query	array[string]	false	Search for a list of resource names (exact match)
desc	query	string	false	Search for content in the resource description/note (case-sensitive wildcard)
desc.like	query	string	false	Double-ended case-insensitive wildcard search for resource description/note
barcode	query	string	false	Search for a single barcode
barcodes	query	array[string]	false	Search for a list of barcodes
barcode.like	query	string	false	Double-ended case-insensitive wildcard search for barcode
limit	query	integer	false	Limit the number of results returned
offset	query	integer	false	Specify the offset of the first result returned
alltags	query	array[string]	false	Search for resources with all specified tags
owner	query	string	false	Search for resources where the owner’s email or username exactly matches the value
owner.like	query	string	false	Search for resources where the owner’s email or username matches the value using a double-ended case-insensitive wildcard search
created_after	query	string(date)	false	Search for resources created after a specified date
created_before	query	string(date)	false	Search for resources created before a specified date
updated_after	query	string(date)	false	Search for resources updated after a specified date
updated_before	query	string(date)	false	Search for resources updated before a specified date
tags	query	array[string]	false	Search for resources with one or more tags in the specified list
workflowable_resource_class	query	string	false	The name of the workflowable resource class
workflowable_resource_class.like	query	string	false	Double-ended case-insensitive wildcard search for workflowable resource class name
workflowable_resource_class_uuid	query	string(uuid)	false	The UUID of the workflowable resource class
workflowable_resource_class.barcode	query	string	false	The barcode of the workflowable resource class

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» resource_vars	[allOf]	true	none	resource variables

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» var_type	string	true	none	Variable Type
»»»» default_val	string	true	none	Default Value
»»»» source	string	true	none	Source
»»»» dropdown	[string]	true	none	Dropdown
»»»» dropdown_expr	string¦null	true	none	Dropdown Expression
»»»» in_sample_sheet	boolean	true	none	Is in Sample Sheet?
»»»» in_sample_sheet_expr	string¦null	true	none	In Sample Sheet Expression
»»»» units	string¦null	true	none	Units
»»»» required	boolean	true	none	Is Required?
»»»» required_expr	string¦null	true	none	Required Expression
»»»» read_only	boolean	true	none	Is Read-Only?
»»»» read_only_expr	string¦null	true	none	Read-Only Expression
»»»» expected	string¦null	true	none	Expected
»»»» pipeline_param	boolean	true	none	Is Pipeline Parameter?
»»»» var_group	string¦null	true	none	Variable Group
»»»» resource_link_type	string¦null	true	none	Resource Link Type
»»»» ontology_path	string¦null	true	none	Ontology Path
»»»» shared	boolean	true	none	Is Shared?
»»»» instructions	string	true	none	Instructions
»»»» reportable	boolean	true	none	Is Reportable?
»»»» reportable_key	string	true	none	Reportable Key
»»»» reportable_display	string	true	none	Reportable Display

continued

Name	Type	Required	Restrictions	Description
»» def_uuid	string(uuid)	true	none	Definition UUID
»» sample_type_id	string(uuid)	true	none	Sample Type ID
»» workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class
»» workflowable_resource_class_name	string	true	none	Workflowable Resource Class Name
»» workflowable_resource_class_barcode	string	true	none	Workflowable Resource Class Barcode
»» id_sequences	[string]	true	none	ID Sequences
»» is_head	boolean	true	none	Is Head?
»» group_meta	object	true	none	Group Meta
»»» schedulability	string	false	none	Schedulability
»» type_deleted	boolean	true	none	Is Type Deleted?
»» icon_svg	string¦null	true	none	Icon SVG

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_types',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample_types', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "resource_vars": [
      {}
    ],
    "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "workflowable_resource_class_name": "qaclass",
    "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "id_sequences": [
      "ESP SEQUENCE"
    ],
    "is_head": true,
    "group_meta": {
      "schedulability": "off"
    },
    "type_deleted": false,
    "icon_svg": null
  }
]

Create Sample Type

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "fixed_id": "Generic sample",
  "resource_vars": [],
  "group_meta": {
    "schedulability": false,
    "hub_dependencies": []
  },
  "view_template": "",
  "workflowable_resource_class": "77777777-7777-4014-b700-053400000000",
  "icon_svg": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the created Sample Type.	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
body	body	SampleTypePostBody	true	none

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» resource_vars	[allOf]	true	none	resource variables

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» var_type	string	true	none	Variable Type
»»»» default_val	string	true	none	Default Value
»»»» source	string	true	none	Source
»»»» dropdown	[string]	true	none	Dropdown
»»»» dropdown_expr	string¦null	true	none	Dropdown Expression
»»»» in_sample_sheet	boolean	true	none	Is in Sample Sheet?
»»»» in_sample_sheet_expr	string¦null	true	none	In Sample Sheet Expression
»»»» units	string¦null	true	none	Units
»»»» required	boolean	true	none	Is Required?
»»»» required_expr	string¦null	true	none	Required Expression
»»»» read_only	boolean	true	none	Is Read-Only?
»»»» read_only_expr	string¦null	true	none	Read-Only Expression
»»»» expected	string¦null	true	none	Expected
»»»» pipeline_param	boolean	true	none	Is Pipeline Parameter?
»»»» var_group	string¦null	true	none	Variable Group
»»»» resource_link_type	string¦null	true	none	Resource Link Type
»»»» ontology_path	string¦null	true	none	Ontology Path
»»»» shared	boolean	true	none	Is Shared?
»»»» instructions	string	true	none	Instructions
»»»» reportable	boolean	true	none	Is Reportable?
»»»» reportable_key	string	true	none	Reportable Key
»»»» reportable_display	string	true	none	Reportable Display

continued

Name	Type	Required	Restrictions	Description
»» def_uuid	string(uuid)	true	none	Definition UUID
»» sample_type_id	string(uuid)	true	none	Sample Type ID
»» workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class
»» workflowable_resource_class_name	string	true	none	Workflowable Resource Class Name
»» workflowable_resource_class_barcode	string	true	none	Workflowable Resource Class Barcode
»» id_sequences	[string]	true	none	ID Sequences
»» is_head	boolean	true	none	Is Head?
»» group_meta	object	true	none	Group Meta
»»» schedulability	string	false	none	Schedulability
»» type_deleted	boolean	true	none	Is Type Deleted?
»» icon_svg	string¦null	true	none	Icon SVG

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "fixed_id": "Generic sample",
  "resource_vars": [],
  "group_meta": {
    "schedulability": false,
    "hub_dependencies": []
  },
  "view_template": "",
  "workflowable_resource_class": "77777777-7777-4014-b700-053400000000",
  "icon_svg": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/sample_types',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/sample_types', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "resource_vars": [
      {}
    ],
    "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "workflowable_resource_class_name": "qaclass",
    "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "id_sequences": [
      "ESP SEQUENCE"
    ],
    "is_head": true,
    "group_meta": {
      "schedulability": "off"
    },
    "type_deleted": false,
    "icon_svg": null
  }
]

Get Sample Type by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns a Sample Type dictionary	SampleTypeResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_types/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample_types/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

Delete Sample Type by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns the archived Sample Type UUID	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string(uuid)	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_types/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/sample_types/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update Sample Type

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "fixed_id": "Generic sample",
  "resource_vars": [],
  "group_meta": {
    "schedulability": false,
    "hub_dependencies": []
  },
  "view_template": "",
  "workflowable_resource_class": "77777777-7777-4014-b700-053400000000",
  "icon_svg": null
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns a dictionary for the updated Sample Type.	SampleTypeResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
body	body	SampleTypePostBody	true	none

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "fixed_id": "Generic sample",
  "resource_vars": [],
  "group_meta": {
    "schedulability": false,
    "hub_dependencies": []
  },
  "view_template": "",
  "workflowable_resource_class": "77777777-7777-4014-b700-053400000000",
  "icon_svg": null
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/sample_types/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/sample_types/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

Get Sample Types for menu

Parameters

Name	In	Type	Required	Description
clses	query	array[string]	false	resource classes

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SampleTypeMenuResponse]	false	none	none
» uuid	string(uuid)	true	none	UUID
» name	string	true	none	Name
» def_uuid	string(uuid)	true	none	Definition UUID
» cls	string	true	none	Class
» workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class UUID

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/app/master/sample_type_menu',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/app/master/sample_type_menu', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "77777777-7777-4014-b700-053200000000",
    "name": "Generic sample",
    "def_uuid": "77777777-7777-4014-b700-053300000000",
    "cls": "SampleType",
    "workflowable_resource_class": "77777777-7777-4014-b700-053700000000"
  }
]

Get Sample Type Definitions

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of Sample Type objects	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	query	string(uuid)	false	Search for a single UUID
uuids	query	array[string]	false	Search for a list of UUIDs
uuid.not	query	string(uuid)	false	Filter out resource with specific UUID
name	query	string	false	Search for an exact resource name
name.like	query	string	false	Double-ended case-insensitive wildcard search for resource names
names	query	array[string]	false	Search for a list of resource names (exact match)
desc	query	string	false	Search for content in the resource description/note (case-sensitive wildcard)
desc.like	query	string	false	Double-ended case-insensitive wildcard search for resource description/note
barcode	query	string	false	Search for a single barcode
barcodes	query	array[string]	false	Search for a list of barcodes
barcode.like	query	string	false	Double-ended case-insensitive wildcard search for barcode
limit	query	integer	false	Limit the number of results returned
offset	query	integer	false	Specify the offset of the first result returned
alltags	query	array[string]	false	Search for resources with all specified tags
owner	query	string	false	Search for resources where the owner’s email or username exactly matches the value
owner.like	query	string	false	Search for resources where the owner’s email or username matches the value using a double-ended case-insensitive wildcard search
created_after	query	string(date)	false	Search for resources created after a specified date
created_before	query	string(date)	false	Search for resources created before a specified date
updated_after	query	string(date)	false	Search for resources updated after a specified date
updated_before	query	string(date)	false	Search for resources updated before a specified date
tags	query	array[string]	false	Search for resources with one or more tags in the specified list

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» resource_vars	[allOf]	true	none	resource variables

allOf

Name	Type	Required	Restrictions	Description
»»» anonymous	any	false	none	none

and

Name	Type	Required	Restrictions	Description
»»» anonymous	object	false	none	none
»»»» var_type	string	true	none	Variable Type
»»»» default_val	string	true	none	Default Value
»»»» source	string	true	none	Source
»»»» dropdown	[string]	true	none	Dropdown
»»»» dropdown_expr	string¦null	true	none	Dropdown Expression
»»»» in_sample_sheet	boolean	true	none	Is in Sample Sheet?
»»»» in_sample_sheet_expr	string¦null	true	none	In Sample Sheet Expression
»»»» units	string¦null	true	none	Units
»»»» required	boolean	true	none	Is Required?
»»»» required_expr	string¦null	true	none	Required Expression
»»»» read_only	boolean	true	none	Is Read-Only?
»»»» read_only_expr	string¦null	true	none	Read-Only Expression
»»»» expected	string¦null	true	none	Expected
»»»» pipeline_param	boolean	true	none	Is Pipeline Parameter?
»»»» var_group	string¦null	true	none	Variable Group
»»»» resource_link_type	string¦null	true	none	Resource Link Type
»»»» ontology_path	string¦null	true	none	Ontology Path
»»»» shared	boolean	true	none	Is Shared?
»»»» instructions	string	true	none	Instructions
»»»» reportable	boolean	true	none	Is Reportable?
»»»» reportable_key	string	true	none	Reportable Key
»»»» reportable_display	string	true	none	Reportable Display

continued

Name	Type	Required	Restrictions	Description
»» def_uuid	string(uuid)	true	none	Definition UUID
»» sample_type_id	string(uuid)	true	none	Sample Type ID
»» workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class
»» workflowable_resource_class_name	string	true	none	Workflowable Resource Class Name
»» workflowable_resource_class_barcode	string	true	none	Workflowable Resource Class Barcode
»» id_sequences	[string]	true	none	ID Sequences
»» is_head	boolean	true	none	Is Head?
»» group_meta	object	true	none	Group Meta
»»» schedulability	string	false	none	Schedulability
»» type_deleted	boolean	true	none	Is Type Deleted?
»» icon_svg	string¦null	true	none	Icon SVG

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_type_definitions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample_type_definitions', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "resource_vars": [
      {}
    ],
    "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
    "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "workflowable_resource_class_name": "qaclass",
    "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
    "id_sequences": [
      "ESP SEQUENCE"
    ],
    "is_head": true,
    "group_meta": {
      "schedulability": "off"
    },
    "type_deleted": false,
    "icon_svg": null
  }
]

Get Sample Type Definition

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of Sample Type objects	SampleTypeResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sample_type_definitions/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sample_type_definitions/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

Get Workflowable Resource Classes

Responses

Status	Meaning	Description	Schema
200	OK	Returns a list of Workflowable Resource Class dictionaries	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
plural_name	query	string	false	workflowable resource class plural name
uuid	query	string(uuid)	false	Search for a single UUID
uuids	query	array[string]	false	Search for a list of UUIDs
uuid.not	query	string(uuid)	false	Filter out resource with specific UUID
name	query	string	false	Search for an exact resource name
name.like	query	string	false	Double-ended case-insensitive wildcard search for resource names
names	query	array[string]	false	Search for a list of resource names (exact match)
desc	query	string	false	Search for content in the resource description/note (case-sensitive wildcard)
desc.like	query	string	false	Double-ended case-insensitive wildcard search for resource description/note
barcode	query	string	false	Search for a single barcode
barcodes	query	array[string]	false	Search for a list of barcodes
barcode.like	query	string	false	Double-ended case-insensitive wildcard search for barcode
limit	query	integer	false	Limit the number of results returned
offset	query	integer	false	Specify the offset of the first result returned
alltags	query	array[string]	false	Search for resources with all specified tags
owner	query	string	false	Search for resources where the owner’s email or username exactly matches the value
owner.like	query	string	false	Search for resources where the owner’s email or username matches the value using a double-ended case-insensitive wildcard search
created_after	query	string(date)	false	Search for resources created after a specified date
created_before	query	string(date)	false	Search for resources created before a specified date
updated_after	query	string(date)	false	Search for resources updated after a specified date
updated_before	query	string(date)	false	Search for resources updated before a specified date
tags	query	array[string]	false	Search for resources with one or more tags in the specified list

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» resource_vars	[object]	true	none	resource variables
»» plural_name	string	true	none	plural resource name
»» list_view_template	string	true	none	list view template
»» detail_panel_template	string	true	none	detail panel template
»» icon_svg	string	true	none	icon svg
»» contains	[string]	true	none	list of contained resources
»» source	string	true	none	resource source

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/workflowable_resource_classes', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "resource_vars": [
      {}
    ],
    "plural_name": "string",
    "list_view_template": "string",
    "detail_panel_template": "string",
    "icon_svg": "string",
    "contains": [
      "string"
    ],
    "source": "string"
  }
]

Create a Workflowable Resource Class

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "plural_name": "Resources",
  "list_view_template": null,
  "detail_panel_template": null,
  "view_template": null,
  "icon_svg": null,
  "contains": [
    "Sample"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns the Workflowable Resource Class dictionary	WorkflowableResourceClassResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	WorkflowableResourceClassPostBody	true	none

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "plural_name": "Resources",
  "list_view_template": null,
  "detail_panel_template": null,
  "view_template": null,
  "icon_svg": null,
  "contains": [
    "Sample"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/workflowable_resource_classes', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {}
  ],
  "plural_name": "string",
  "list_view_template": "string",
  "detail_panel_template": "string",
  "icon_svg": "string",
  "contains": [
    "string"
  ],
  "source": "string"
}

Get Workflowable Resource Class by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns the Workflowable Resource Class dictionary	WorkflowableResourceClassResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/workflowable_resource_classes/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {}
  ],
  "plural_name": "string",
  "list_view_template": "string",
  "detail_panel_template": "string",
  "icon_svg": "string",
  "contains": [
    "string"
  ],
  "source": "string"
}

Delete Workflowable Resource Class by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Returns the Workflowable Resource Class dictionary	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» id	string(uuid)	false	none	none

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/workflowable_resource_classes/{uuid}', headers = headers)

print(r.json())

Response

json

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Update Workflowable Resource Class

Body parameter

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "plural_name": "Resources",
  "list_view_template": null,
  "detail_panel_template": null,
  "view_template": null,
  "icon_svg": null,
  "contains": [
    "Sample"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Returns the new Workflowable Resource Class dictionary	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
body	body	WorkflowableResourceClassPostBody	true	none

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[allOf]	false	none	none

allOf

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

allOf

Name	Type	Required	Restrictions	Description
»» anonymous	BasicResourceResponse	false	none	basic resource response
»»» uuid	string(uuid)	true	none	resource uuid
»»» url	string	true	none	resource url
»»» cls	string	true	none	resource class
»»» name	string	true	none	resource name
»»» desc	string	true	none	resource description
»»» barcode	string	true	none	resource barcode
»»» created_at	string	true	none	resource created timestamp
»»» updated_at	string	true	none	resource updated timestamp

and

Name	Type	Required	Restrictions	Description
»» anonymous	object	false	none	resource response
»»» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
»»» fixed_id	string	true	none	resource fixed id
»»» deleted	boolean	true	none	is resource archived?
»»» tags	[string]	true	none	resource tags
»»» owner	object	true	none	resource owner
»»»» name	string	false	none	none
»»»» uuid	string(uuid)	false	none	none
»»» meta	object	true	none	resource metadata
»»» view_template	string	true	none	resource view template
»»» state	string	true	none	resource state

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» resource_vars	[object]	true	none	resource variables
»» plural_name	string	true	none	plural resource name
»» list_view_template	string	true	none	list view template
»» detail_panel_template	string	true	none	detail panel template
»» icon_svg	string	true	none	icon svg
»» contains	[string]	true	none	list of contained resources
»» source	string	true	none	resource source

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

This operation does not require authentication

Request

const inputBody = '{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "plural_name": "Resources",
  "list_view_template": null,
  "detail_panel_template": null,
  "view_template": null,
  "icon_svg": null,
  "contains": [
    "Sample"
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/workflowable_resource_classes/{uuid}', headers = headers)

print(r.json())

Response

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "url": "string",
    "cls": "string",
    "name": "string",
    "desc": "string",
    "barcode": "string",
    "created_at": "string",
    "updated_at": "string",
    "barcode_type": "QR",
    "fixed_id": "string",
    "deleted": true,
    "tags": [
      "string"
    ],
    "owner": {
      "name": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
    },
    "meta": {},
    "view_template": "string",
    "state": "string",
    "resource_vars": [
      {}
    ],
    "plural_name": "string",
    "list_view_template": "string",
    "detail_panel_template": "string",
    "icon_svg": "string",
    "contains": [
      "string"
    ],
    "source": "string"
  }
]

Import Workflowable Resource Class

Body parameter

{
  "uuid": "77777777-7777-4014-b700-053600000000",
  "name": "Library",
  "plural_name": "Libraries",
  "desc": "Resource Description",
  "cls": "WorkflowableResourceClass",
  "view_template": "",
  "list_view_template": "",
  "detail_panel_template": "",
  "icon_svg": ""
}

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowableResourceClassResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
body	body	WorkflowableResourceClassImportBody	true	none
» uuid	body	string(uuid)	false	UUID
» name	body	string	false	Name
» plural_name	body	string	false	Plural Name
» desc	body	string	false	Description
» cls	body	string	false	Class
» view_template	body	string	false	View template HTML
» list_view_template	body	string	false	List view template HTML
» detail_panel_template	body	string	false	Detail panel template HTML
» icon_svg	body	string	false	Icon SVG

Request

const inputBody = '{
  "uuid": "77777777-7777-4014-b700-053600000000",
  "name": "Library",
  "plural_name": "Libraries",
  "desc": "Resource Description",
  "cls": "WorkflowableResourceClass",
  "view_template": "",
  "list_view_template": "",
  "detail_panel_template": "",
  "icon_svg": ""
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes/import',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/workflowable_resource_classes/import', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {}
  ],
  "plural_name": "string",
  "list_view_template": "string",
  "detail_panel_template": "string",
  "icon_svg": "string",
  "contains": [
    "string"
  ],
  "source": "string"
}

Export Workflowable Resource Class

Responses

Status	Meaning	Description	Schema
200	OK	Success	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
format	query	string	true	Format type for export

Enumerated Values

Parameter	Value
format	json
format	yaml
format	dict

Request

const headers = {
  'Accept':'application/yaml'
};

fetch('/api/workflowable_resource_classes/{uuid}/export?format=json',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/yaml'
}

r = requests.get('/api/workflowable_resource_classes/{uuid}/export', params={
  'format': 'json'
}, headers = headers)

print(r.json())

Undelete a WorkflowableResourceClass by UUID

Responses

Status	Meaning	Description	Schema
200	OK	Success	WorkflowableResourceClassResponse
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/workflowable_resource_classes/{uuid}/undelete',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/workflowable_resource_classes/{uuid}/undelete', headers = headers)

print(r.json())

Response

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {}
  ],
  "plural_name": "string",
  "list_view_template": "string",
  "detail_panel_template": "string",
  "icon_svg": "string",
  "contains": [
    "string"
  ],
  "source": "string"
}

Get sample experiment data

Responses

Status	Meaning	Description	Schema
200	OK	If successful, the server returns a list of Sample dictionaries	Inline
401	Unauthorized	Authentication failed	Response401
500	Internal Server Error	Server error	Response500
4XX	Unknown	Client Error	Response400

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» samples	[SampleDataResponse]	false	none	none
»» sample_name	string	false	none	The name of the sample
»» sample_type_uuid	string(uuid)	false	none	The UUID of the sample type
»» sample_uuid	string(uuid)	false	none	The UUID of the sample
»» data	object	false	none	The data associated with the sample
»» protocol_name	string¦null	false	none	The name of the protocol associated with the sample
»» protocol_complete	string¦null	false	none	Whether the protocol associated with the sample is complete
»» report_elements	[object]¦null	false	none	The elements of the report associated with the sample

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/data/samples',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/data/samples', headers = headers)

print(r.json())

Response

json

{
  "samples": [
    {
      "sample_name": "sample unlimited",
      "sample_type_uuid": "77777777-7777-4014-b700-053300000000",
      "sample_uuid": "95e94665-ce36-4c6f-b59f-d5d952e6064a",
      "data": [],
      "protocol_name": "branch A",
      "protocol_complete": "true",
      "report_elements": null
    }
  ]
}

Scheduling_History

Get Calendar History

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/history',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/history', headers = headers)

print(r.json())

Response

json

null

Scheduling_Import

Import Calendar From File

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/import/calendar',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/import/calendar', headers = headers)

print(r.json())

Response

json

null

Check Conflicts

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/import/conflicts',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/import/conflicts', headers = headers)

print(r.json())

Response

json

null

Sequences

Retrieve All Sequences

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sequences',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sequences', headers = headers)

print(r.json())

Response

json

null

Create Sequences

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sequences',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/sequences', headers = headers)

print(r.json())

Response

json

null

Retrieve Sequence

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
seq_name	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/sequences/{seq_name}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/sequences/{seq_name}', headers = headers)

print(r.json())

Response

json

null

SignatureFlow

Pin SignatureFlow Definition

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID
name	path	string	true	pinned version name

Request

fetch('/api/signature_flow_definitions{uuid}/pin/{name}',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/signature_flow_definitions{uuid}/pin/{name}')

print(r.json())

Sign SignatureFlow Instance

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

fetch('/api/signature_flow_instances/{uuid}/sign',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/signature_flow_instances/{uuid}/sign')

print(r.json())

Nominate user for SignatureFlow Instance

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

fetch('/api/signature_flow_instances/{uuid}/nominate',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/signature_flow_instances/{uuid}/nominate')

print(r.json())

Sites

Retrieves a list of sites from ESP:

GET /sites

To list ESP sites, the user needs to send a GET request on /sites.

.. :quickref: get_sites method; Retrieves a list of sites

Exceptions:

None unless there is a coding error, which will return a 500.

Example Request A :

.. sourcecode:: http

GET /sites Host: (host)[:port number] Accept: application/json

Returns:

Returns a JSON response. If 200, ‘results’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “results”: [ { “location”: “Austin, Texas, USA”, “name”: “ESP A” }, { “location”: “Austin, Texas, USA”, “name”: “ESP B” }] }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/sites',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/sites', headers = headers)

print(r.json())

Response

json

null

Adds a site to ESP:

POST /sites

To add a site to ESP, the user needs to send a POST request on /sites.

.. :quickref: add_site method; Adds a site to ESP

Exceptions:

None unless there is a coding error, which will return a 500.

JSON:

name: Type: String

ESP Site name to be added

location: Type: String

Location of the site, just for informational purposes

Example Request A :

.. sourcecode:: http

POST /sites Host: (host)[:port number] JSON: { “name”: “ESP B”, “location”: “Dallas, TX, USA” } Accept: application/json

Returns:

Returns a JSON response. If 200, ‘status’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “status”: “Site Added” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/sites',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/sites', headers = headers)

print(r.json())

Response

json

null

Removes a site from ESP:

DELETE /sites

To remove a site to ESP, the user needs to send a DELETE request on /sites.

.. :quickref: remove_site method; Removes a site from ESP

Exceptions:

None unless there is a coding error, which will return a 500.

JSON:

name: Type: String

ESP Site name to be removed

Example Request A :

.. sourcecode:: http

DELETE /sites Host: (host)[:port number] JSON: { “name”: “ESP B” } Accept: application/json

Returns:

Returns a JSON response. If 200, ‘status’ is returned in the JSON. If non-200, then ‘error’ is returned in the JSON.

Example Response A:

Upon a 200 response code, returns a JSON dict.

Example Response A ;

.. sourcecode:: http

HTTP/1.1 200 OK Content-Type: application/json

{ “status”: “Site removed” }

:resheader 200: application/json, text/javascript, /; q=0.01; :status 200: OK

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/sites',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/sites', headers = headers)

print(r.json())

Response

json

null

Supplies

Create Supply

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/supplies',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/hub/supplies', headers = headers)

print(r.json())

Response

json

null

Get Supply

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/hub/supplies/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/hub/supplies/{uuid}', headers = headers)

print(r.json())

Response

json

null

Task_Types

Get Planned Action Types

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_types',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_action_types', headers = headers)

print(r.json())

Response

json

null

Create Planned Action Type

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_types',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/planned_action_types', headers = headers)

print(r.json())

Response

json

null

Update Planned Action Type

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_types',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/planned_action_types', headers = headers)

print(r.json())

Response

json

null

Get Planned Action Type

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_types/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_action_types/{uuid}', headers = headers)

print(r.json())

Response

json

null

Delete Planned Action Type

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_action_types/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/planned_action_types/{uuid}', headers = headers)

print(r.json())

Response

json

null

Tasks

Get Planned Actions

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_actions', headers = headers)

print(r.json())

Response

json

null

Create Planned Actions

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/planned_actions', headers = headers)

print(r.json())

Response

json

null

Update Planned Actions

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/planned_actions', headers = headers)

print(r.json())

Response

json

null

Get Planned Action Stats

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/stats',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_actions/stats', headers = headers)

print(r.json())

Response

json

null

Get Planned Actions Min Max Start

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/range',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_actions/range', headers = headers)

print(r.json())

Response

json

null

Get Planned Action

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/schedules/planned_actions/{uuid}', headers = headers)

print(r.json())

Response

json

null

Updates a Planned Action, optionally updating all future recurrences.

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/schedules/planned_actions/{uuid}', headers = headers)

print(r.json())

Response

json

null

Delete Planned Action

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/planned_actions/{uuid}', headers = headers)

print(r.json())

Response

json

null

Delete Planned Action Occurrences

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/{uuid}/all',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/schedules/planned_actions/{uuid}/all', headers = headers)

print(r.json())

Response

json

null

Schedule Planned Action

Responses

Status	Meaning	Description	Schema
200	OK	Successful response	Inline
404	Not Found	Not found	HTTPError

Parameters

Name	In	Type	Required	Description
uuid	path	string	true	none

Response Schema

This operation does not require authentication

Request

const headers = {
  'Accept':'application/json'
};

fetch('/api/schedules/planned_actions/{uuid}/schedule',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('/api/schedules/planned_actions/{uuid}/schedule', headers = headers)

print(r.json())

Response

json

null

User

Create User API key

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/user/api-keys',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/user/api-keys')

print(r.json())

Delete User API key

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/user/api-keys',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.delete('/user/api-keys')

print(r.json())

Expire User Session

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/api/user/session',
{
  method: 'DELETE'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.delete('/api/user/session')

print(r.json())

get_api_users{user_uuid}_activity

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Parameters

Name	In	Type	Required	Description
user_uuid	path	string(uuid)	true	User UUID

Request

fetch('/api/users/{user_uuid}/activity',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.get('/api/users/{user_uuid}/activity')

print(r.json())

Get user breadcrumb

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

fetch('/api/users/{uuid}/breadcrumb',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.get('/api/users/{uuid}/breadcrumb')

print(r.json())

Add user breadcrumb

Parameters

Name	In	Type	Required	Description
uuid	path	string(uuid)	true	Resource UUID

Request

fetch('/api/users/{uuid}/breadcrumb',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/users/{uuid}/breadcrumb')

print(r.json())

Add resources to a workgroup.

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/api/labs/associateresources',
{
  method: 'POST'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.post('/api/labs/associateresources')

print(r.json())

Get Permissions and Licensed Apps

Responses

Status	Meaning	Description	Schema
2XX	Unknown	Success	None
4XX	Unknown	Client Error	None
5XX	Unknown	Server Error	None

This operation does not require authentication

Request

fetch('/app/user/admin',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Request

import requests

r = requests.get('/app/user/admin')

print(r.json())

Schemas

BasicErrorModel

basic error

Properties

Name	Type	Required	Restrictions	Description
error	string	true	none	Error message

json

{
  "error": "string"
}

DefaultError

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicErrorModel	false	none	basic error

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Default error
» request_id	integer	true	none	request ID
» session_id	string	true	none	session ID

json

{
  "error": "string",
  "request_id": 0,
  "session_id": "string"
}

Response400

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	DefaultError	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Bad Request

json

{
  "error": "string",
  "request_id": 0,
  "session_id": "string"
}

Response401

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicErrorModel	false	none	basic error

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Unauthorized

json

{
  "error": "A user with those credentials was not found."
}

Response500

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	DefaultError	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Server Error

json

{
  "error": "string",
  "request_id": 0,
  "session_id": "string"
}

AnyValue

Can be any value.

Properties

anyOf

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
anonymous	number	false	none	none

Name	Type	Required	Restrictions	Description
anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
anonymous	[any]	false	none	none

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

json

"string"

BasicResourceResponse

basic resource response

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	resource uuid
url	string	true	none	resource url
cls	string	true	none	resource class
name	string	true	none	resource name
desc	string	true	none	resource description
barcode	string	true	none	resource barcode
created_at	string	true	none	resource created timestamp
updated_at	string	true	none	resource updated timestamp

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string"
}

ResourceResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourceResponse	false	none	basic resource response

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	resource response
» barcode_type	string	true	none	barcode type (QR, 1D, mini data matrix)
» fixed_id	string	true	none	resource fixed id
» deleted	boolean	true	none	is resource archived?
» tags	[string]	true	none	resource tags
» owner	object	true	none	resource owner
»» name	string	false	none	none
»» uuid	string(uuid)	false	none	none
» meta	object	true	none	resource metadata
» view_template	string	true	none	resource view template
» state	string	true	none	resource state

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string"
}

ItemResponse

Item response

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» resource_vals	[ResourceValResponse]	false	none	resource values
» in_workflow_instance	boolean	false	none	Indicates if the item is part of a workflow instance
» sample_type	string(uuid)	false	none	UUID of the sample type
» sample_type_name	string	false	none	Name of the sample type
» sample_type_description	string	false	none	Description of the sample type
» sample_type_uuid	string(uuid)	false	none	UUID of the sample type
» sample_type_barcode	string	false	none	Barcode of the sample type
» workflowable_resource_class_name	string	false	none	Name of the workflowable resource class
» workflowable_resource_class_barcode	string	false	none	Barcode of the workflowable resource class
» sample_type_group_uuid	string(uuid)	false	none	UUID of the sample type group
» item_type	string(uuid)	false	none	Type of the item
» lot_id	string¦null	false	none	Lot ID of the item
» serial_id	string¦null	false	none	Serial ID of the item
» status	string¦null	false	none	Status of the item
» initial_qty	integer	false	none	Initial quantity of the item
» qty	integer	false	none	Current quantity of the item
» expiration_timestamp	string¦null	false	none	Expiration timestamp of the item
» bound_to_container	boolean	false	none	Is the item bound to a container

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": false,
  "sample_type": "542934b9-b364-41cf-86fa-b51a4ab79efb",
  "sample_type_name": "it1",
  "sample_type_description": "",
  "sample_type_uuid": "542934b9-b364-41cf-86fa-b51a4ab79efb",
  "sample_type_barcode": "542934b9-b364-41cf-86fa-b51a4ab79efb",
  "workflowable_resource_class_name": "Item",
  "workflowable_resource_class_barcode": "77777777-7777-4014-b700-053600000000",
  "sample_type_group_uuid": "7a1b36fd-18c4-4c48-9453-4b9920c544af",
  "item_type": "7a1b36fd-18c4-4c48-9453-4b9920c544af",
  "lot_id": null,
  "serial_id": null,
  "status": null,
  "initial_qty": 2,
  "qty": 2,
  "expiration_timestamp": null,
  "bound_to_container": false
}

SamplePointResponse

Sample Point response

Properties

Name	Type	Required	Restrictions	Description
parent_resource_id	string(uuid)¦null	false	none	parent resource uuid
parent_resource_name	string¦null	false	none	Name of the parent resource
resource_id	string(uuid)	false	none	Resource UUID
created_at	string(date-time)	false	none	Date and time of creation
deleted	boolean	false	none	Indicates if the resource is deleted
desc	string¦null	false	none	Description of the resource
meta	object	false	none	Additional metadata for the resource
name	string	false	none	Name of the resource
barcode	string	false	none	Barcode of the resource
barcode_type	string	false	none	Type of barcode
updated_at	string(date-time)	false	none	Date and time of last update
url	string¦null	false	none	URL of the resource
uuid	string(uuid)	false	none	UUID of the resource
in_workflow_instance	boolean	false	none	Indicates if the resource is in a workflow instance
sample_type	string	false	none	Sample type
sample_type_uuid	string(uuid)	false	none	UUID of the sample type

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

json

{
  "parent_resource_id": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "parent_resource_name": "Parent Resource",
  "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
  "created_at": "2024-03-01 16:45:48.228656",
  "deleted": true,
  "desc": "Description of the resource",
  "meta": [],
  "name": "ESP000001",
  "barcode": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "barcode_type": "QR",
  "updated_at": "2024-03-05 21:50:11.586942",
  "url": null,
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "in_workflow_instance": true,
  "sample_type": "Generic sample",
  "sample_type_uuid": "77777777-7777-4014-b700-053300000000"
}

ContainerTypeResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	Container response
» resource_vals	[ResourceValResponse]	false	none	resource values
» def_uuid	string(uuid)	false	none	Container Type Definition UUID
» sample_type_id	string(uuid)	false	none	Sample type UUID
» workflowable_resource_class	string(uuid)	false	none	Workflowable resource class UUID
» workflowable_resource_class_name	string	false	none	Workflowable resource class name
» workflowable_resource_class_barcode	string	false	none	Workflowable resource class barcode
» id_sequences	[string]	false	none	ID sequences
» is_head	boolean	false	none	Indicates if it is the head
» group_meta	object	false	none	Group metadata
» type_deleted	boolean	false	none	Indicates if the type is deleted
» icon_svg	string	false	none	Icon SVG
» contains	[string]	false	none	List of models the container type can contain
» contained_type_params	[ContainedTypeParamsSchema]	false	none	Contained type parameters

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [],
  "def_uuid": "83f20975-9dc5-4f1d-9218-eadb75df53ce",
  "sample_type_id": "83f20975-9dc5-4f1d-9218-eadb75df53ce",
  "workflowable_resource_class": "77777777-7777-4014-b700-053500000000",
  "workflowable_resource_class_name": "Container",
  "workflowable_resource_class_barcode": "77777777-7777-4014-b700-053500000000",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": [],
  "type_deleted": false,
  "icon_svg": null,
  "contains": [
    "Sample"
  ],
  "contained_type_params": [
    {
      "workflowable_resource_type": {},
      "min_contained": null,
      "max_contained": null,
      "transfer_item_qty": false
    }
  ]
}

SampleResponse

Sample response

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» resource_vals	[ResourceValResponse]	true	none	resource values
» in_workflow_instance	boolean	true	none	whether the sample is in a workflow instance
» sample_type	string(uuid)	true	none	UUID of the sample type
» sample_type_name	string	true	none	name of the sample type
» sample_type_description	string	true	none	description of the sample type
» sample_type_uuid	string(uuid)	true	none	UUID of the sample type
» sample_type_barcode	string	true	none	barcode of the sample type
» workflowable_resource_class_name	string	true	none	name of the workflowable resource class
» workflowable_resource_class_barcode	string	true	none	barcode of the workflowable resource class
» sample_type_group_uuid	string(uuid)	true	none	UUID of the sample type group

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vals": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "value": "textbbb",
      "not_applicable": false,
      "expression": null,
      "dropdown": [],
      "var_type": "text",
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "error_msg": null,
      "dropdown_error_msg": null,
      "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
      "overrides": [],
      "exception_assessment": null
    }
  ],
  "in_workflow_instance": true,
  "sample_type": "2bdfbe6a-7408-4746-947c-c29c351c97c2",
  "sample_type_name": "string",
  "sample_type_description": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_barcode": "string",
  "workflowable_resource_class_name": "string",
  "workflowable_resource_class_barcode": "string",
  "sample_type_group_uuid": "fee10780-c6ea-494b-9c20-78ca69fa6101"
}

SampleUUIDDataResponse

Sample experiment values

Properties

Name	Type	Required	Restrictions	Description
results	object	false	none	Experiment Data
» additionalProperties	string	false	none	none
params	object	false	none	Request parameters
» uuid	string(uuid)	false	none	Sample UUID
processing_time_seconds	number	false	none	Response time

json

{
  "results": {
    "property1": "string",
    "property2": "string"
  },
  "params": {
    "uuid": "6e39f573-d036-4592-ab6f-af211d13788e"
  },
  "processing_time_seconds": 0.03594684600830078
}

SampleOptResponse

Optimized Sample response

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	resource name
uuid	string(uuid)	false	none	resource uuid
meta	object	false	none	resource metadata
desc	string	false	none	resource description
barcode	string	false	none	resource barcode
barcode_type	string	false	none	resource barcode type
created_at	string	false	none	resource created timestamp
updated_at	string	false	none	resource updated timestamp
sample_type_uuid	string(uuid)	false	none	UUID of the sample type
sample_type_name	string	false	none	Name of the sample type
url	string	false	none	resource url
in_workflow_instance	boolean	false	none	whether the sample is in a workflow instance
owner	object	false	none	resource owner
» name	string	false	none	none
» uuid	string(uuid)	false	none	none
resource_vals	[object]	false	none	resource values
tags	[string]	false	none	resource tags

json

{
  "name": "string",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "meta": {},
  "desc": "string",
  "barcode": "string",
  "barcode_type": "string",
  "created_at": "string",
  "updated_at": "string",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "sample_type_name": "string",
  "url": "string",
  "in_workflow_instance": true,
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "resource_vals": [
    {}
  ],
  "tags": [
    "string"
  ]
}

SampleParentsResponse

The Samples’s UUID and a list of the sample’s parents is returned

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	Sample UUID
parents	object	true	none	none
» parents	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»» anonymous	[SampleResponse]	false	none	[Sample response]

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "parents": {
    "parents": [
      "string"
    ]
  }
}

SampleChildrenResponse

The Samples’s UUID and a list of the sample’s children is returned

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	Sample UUID
children	object	true	none	none
» children	[oneOf]	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
»» anonymous	[SampleResponse]	false	none	[Sample response]

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "children": {
    "children": [
      "string"
    ]
  }
}

SampleProtocolInstanceResponse

The Samples’s UUID and a list of protocol instances is returned

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	Sample UUID
protocol_instances	[object]	true	none	none
» cls	string	false	none	Class
» uuid	string(uuid)	false	none	Protocol Instance UUID
» name	string	false	none	Protocol Instance name
» desc	string¦null	false	none	Protocol Instance description
» created_timestamp	string	false	none	Timestamp for creation date
» protocol_name	string	false	none	Protocol name
» protocol_uuid	string(uuid)	false	none	Protocol UUID

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "protocol_instances": [
    {
      "cls": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "desc": "string",
      "created_timestamp": "string",
      "protocol_name": "string",
      "protocol_uuid": "e69ce6ae-1b46-44af-bb53-548306db3e66"
    }
  ]
}

SampleWorkflowInstanceResponse

The Samples’s UUID and a list of workflow instances is returned

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	Sample UUID
workflow_instances	[object]	true	none	none
» cls	string	false	none	Class
» uuid	string(uuid)	false	none	Workflow Instance UUID
» name	string	false	none	Workflow Instance name
» desc	string¦null	false	none	Workflow Instance description
» created_timestamp	string	false	none	Timestamp for creation date
» workflow_name	string	false	none	Workflow name
» workflow_uuid	string(uuid)	false	none	Workflow UUID

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "workflow_instances": [
    {
      "cls": "string",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "name": "string",
      "desc": "string",
      "created_timestamp": "string",
      "workflow_name": "string",
      "workflow_uuid": "5f472623-08f6-4789-89f2-effc00ed9ea8"
    }
  ]
}

SampleIngestResponse

A list of the sample’s ingests is returned

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	false	none	Ingest Instance UUID
name	string	false	none	Ingest Instance name
created_at	string	false	none	Ingest creation datetime
updated_at	string	false	none	Ingest last updated datetime
values	[object]	false	none	Ingest values

json

[
  {
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "name": "string",
    "created_at": "string",
    "updated_at": "string",
    "values": [
      {}
    ]
  }
]

SampleTypeResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» resource_vars	[ResourceVarResponse]	true	none	resource variables
» def_uuid	string(uuid)	true	none	Definition UUID
» sample_type_id	string(uuid)	true	none	Sample Type ID
» workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class
» workflowable_resource_class_name	string	true	none	Workflowable Resource Class Name
» workflowable_resource_class_barcode	string	true	none	Workflowable Resource Class Barcode
» id_sequences	[string]	true	none	ID Sequences
» is_head	boolean	true	none	Is Head?
» group_meta	object	true	none	Group Meta
»» schedulability	string	false	none	Schedulability
» type_deleted	boolean	true	none	Is Type Deleted?
» icon_svg	string¦null	true	none	Icon SVG

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "def_uuid": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "sample_type_id": "92e395cc-ca05-46e2-b4e0-dff0fe04cea8",
  "workflowable_resource_class": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "c80d6eec-4d22-4f03-a243-e52ed26966ee",
  "id_sequences": [
    "ESP SEQUENCE"
  ],
  "is_head": true,
  "group_meta": {
    "schedulability": "off"
  },
  "type_deleted": false,
  "icon_svg": null
}

ResourceVarResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» var_type	string	true	none	Variable Type
» default_val	string	true	none	Default Value
» source	string	true	none	Source
» dropdown	[string]	true	none	Dropdown
» dropdown_expr	string¦null	true	none	Dropdown Expression
» in_sample_sheet	boolean	true	none	Is in Sample Sheet?
» in_sample_sheet_expr	string¦null	true	none	In Sample Sheet Expression
» units	string¦null	true	none	Units
» required	boolean	true	none	Is Required?
» required_expr	string¦null	true	none	Required Expression
» read_only	boolean	true	none	Is Read-Only?
» read_only_expr	string¦null	true	none	Read-Only Expression
» expected	string¦null	true	none	Expected
» pipeline_param	boolean	true	none	Is Pipeline Parameter?
» var_group	string¦null	true	none	Variable Group
» resource_link_type	string¦null	true	none	Resource Link Type
» ontology_path	string¦null	true	none	Ontology Path
» shared	boolean	true	none	Is Shared?
» instructions	string	true	none	Instructions
» reportable	boolean	true	none	Is Reportable?
» reportable_key	string	true	none	Reportable Key
» reportable_display	string	true	none	Reportable Display

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "var_type": "text",
  "default_val": "text",
  "source": "user",
  "dropdown": [],
  "dropdown_expr": null,
  "in_sample_sheet": true,
  "in_sample_sheet_expr": null,
  "units": null,
  "required": false,
  "required_expr": null,
  "read_only": false,
  "read_only_expr": null,
  "expected": null,
  "pipeline_param": false,
  "var_group": null,
  "resource_link_type": null,
  "ontology_path": null,
  "shared": false,
  "instructions": "",
  "reportable": false,
  "reportable_key": "",
  "reportable_display": ""
}

AncestorTreeResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» child_resource_id	integer	true	none	Child Resource ID
» cycle	boolean	true	none	Is Cycle?
» deleted	boolean	true	none	Is Deleted?
» generation	integer	true	none	Generation relative to origin sample
» in_workflow_instance	boolean	true	none	Is in Workflow Instance?
» meta	object	true	none	Meta
» owner	string	true	none	Owner
» owner_resource_id	integer	true	none	Owner Resource ID
» parentage	[integer]	true	none	Parentage
» plural_name	string	true	none	Plural Name
» primary_uuid	string(uuid)	true	none	Primary UUID
» resource_id	integer	true	none	Resource ID
» resource_vals	object	true	none	Resource Values
»» additionalProperties	string	false	none	none
» sample_type	string(uuid)	true	none	Sample Type
» sample_type_name	string	true	none	Sample Type Name
» sample_type_uuid	string(uuid)	true	none	Sample Type UUID

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": false,
  "tags": [
    "string"
  ],
  "owner": "system admin (admin@localhost)",
  "meta": [],
  "view_template": "string",
  "state": "string",
  "child_resource_id": 593,
  "cycle": false,
  "generation": 0,
  "in_workflow_instance": false,
  "owner_resource_id": 11,
  "parentage": [
    77
  ],
  "plural_name": "Samples",
  "primary_uuid": "9415a68a-c0a8-4076-aae5-a1ac892ea185",
  "resource_id": 77,
  "resource_vals": {
    "custom_field1": "textaaa",
    "custom_field2": 12345
  },
  "sample_type": "77777777-7777-4014-b700-053300000000",
  "sample_type_name": "Generic sample",
  "sample_type_uuid": "77777777-7777-4014-b700-053300000000"
}

ResourceValResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» value	string	true	none	Resource Value
» not_applicable	boolean	true	none	Is Resource Value Not Applicable?
» expression	string¦null	false	none	Resource Value Expression
» dropdown	[string]	true	none	Resource Value Dropdown
» var_type	string	true	none	Resource Value Type
» required	boolean	true	none	Is Resource Value Required?
» required_expr	string¦null	true	none	Resource Value Required Expression
» read_only	boolean	false	none	Is Resource Value Read-Only?
» read_only_expr	string¦null	true	none	Resource Value Read-Only Expression
» in_sample_sheet	boolean	true	none	Is Resource Value in Sample Sheet?
» in_sample_sheet_expr	string¦null	true	none	Resource Value in Sample Sheet Expression
» error_msg	string¦null	true	none	Resource Value Error Message
» dropdown_error_msg	string¦null	true	none	Resource Value Dropdown Error Message
» resource_var	string(uuid)	true	none	Resource Variable
» overrides	object	true	none	Resource Value Overrides
» exception_assessment	object¦null	true	none	Resource Value Exception Assessment

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "value": "textbbb",
  "not_applicable": false,
  "expression": null,
  "dropdown": [],
  "var_type": "text",
  "required": false,
  "required_expr": null,
  "read_only": false,
  "read_only_expr": null,
  "in_sample_sheet": true,
  "in_sample_sheet_expr": null,
  "error_msg": null,
  "dropdown_error_msg": null,
  "resource_var": "a0dd1f97-30f2-4c24-a775-b2ed97419828",
  "overrides": [],
  "exception_assessment": null
}

WorkflowableResourceClassResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» resource_vars	[object]	true	none	resource variables
» plural_name	string	true	none	plural resource name
» list_view_template	string	true	none	list view template
» detail_panel_template	string	true	none	detail panel template
» icon_svg	string	true	none	icon svg
» contains	[string]	true	none	list of contained resources
» source	string	true	none	resource source

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "resource_vars": [
    {}
  ],
  "plural_name": "string",
  "list_view_template": "string",
  "detail_panel_template": "string",
  "icon_svg": "string",
  "contains": [
    "string"
  ],
  "source": "string"
}

WorkflowableResourceClassExportResponse

Properties

Name	Type	Required	Restrictions	Description
augment	object¦null	false	none	Augment
» additionalProperties	string	false	none	none
cls	string	false	none	Class
created_timestamp	string(date-time)	false	none	Timestamp of creation
desc	string	false	none	Description
detail_panel_template	string	false	none	Detail panel template HTML
icon_svg	string	false	none	Icon SVG
list_view_template	string	false	none	List view template HTML
meta	object	false	none	Metadata
» additionalProperties	string	false	none	none
name	string	false	none	Name
plural_name	string	false	none	Plural Name
tags	[string]	false	none	Tags
updated_timestamp	string(date-time)	false	none	Timestamp of last update
uuid	string(uuid)	false	none	UUID
view_template	string	false	none	View template HTML

json

{
  "augment": [],
  "cls": "WorkflowableResourceClass",
  "created_timestamp": "2024-02-29 16:59:00.713239",
  "desc": "core resource class for item management and processing",
  "detail_panel_template": "",
  "icon_svg": "",
  "list_view_template": "",
  "meta": {
    "contains_cls": [
      901
    ],
    "schedulability": "off",
    "source": "system"
  },
  "name": "Item",
  "plural_name": "Items",
  "tags": [],
  "updated_timestamp": "2024-02-29 16:59:00.713239",
  "uuid": "77777777-7777-4014-b700-053600000000",
  "view_template": ""
}

ParamResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ResourceResponse	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» params	object	true	none	parameter key value pairs
»» additionalProperties	string	false	none	none

json

{
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "url": "string",
  "cls": "string",
  "name": "string",
  "desc": "string",
  "barcode": "string",
  "created_at": "string",
  "updated_at": "string",
  "barcode_type": "QR",
  "fixed_id": "string",
  "deleted": true,
  "tags": [
    "string"
  ],
  "owner": {
    "name": "string",
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
  },
  "meta": {},
  "view_template": "string",
  "state": "string",
  "params": {
    "property1": "string",
    "property2": "string"
  }
}

ResourceActionResponse

resource action

Properties

Name	Type	Required	Restrictions	Description
agent	string	true	none	user agent
timestamp	string	true	none	resource action time
resource	string(uuid)	true	none	resource action uuid
desc	string	true	none	resource action description
agent_name	string	true	none	user agent name

json

{
  "agent": "string",
  "timestamp": "string",
  "resource": "d008879e-b5d9-47da-af4e-3c8f40b7c9ee",
  "desc": "string",
  "agent_name": "string"
}

ProcessorResponse

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
desc	string	false	none	none
parameters	[object]	false	none	none

json

[
  {
    "name": "add_row_number",
    "desc": "example desc",
    "parameters": []
  }
]

ExtensionParameterSchema

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
type	string	false	none	none
default	AnyValue	false	none	Can be any value.
help	string	false	none	none
required	boolean	false	none	none
label	string	false	none	none
validation_rules	object¦null	false	none	none

json

[
  {
    "name": "string",
    "type": "string",
    "default": "string",
    "help": "string",
    "required": true,
    "label": "string",
    "validation_rules": {}
  }
]

SampleDataResponse

Properties

Name	Type	Required	Restrictions	Description
sample_name	string	false	none	The name of the sample
sample_type_uuid	string(uuid)	false	none	The UUID of the sample type
sample_uuid	string(uuid)	false	none	The UUID of the sample
data	object	false	none	The data associated with the sample
protocol_name	string¦null	false	none	The name of the protocol associated with the sample
protocol_complete	string¦null	false	none	Whether the protocol associated with the sample is complete
report_elements	[object]¦null	false	none	The elements of the report associated with the sample

json

{
  "sample_name": "sample unlimited",
  "sample_type_uuid": "77777777-7777-4014-b700-053300000000",
  "sample_uuid": "95e94665-ce36-4c6f-b59f-d5d952e6064a",
  "data": [],
  "protocol_name": "branch A",
  "protocol_complete": "true",
  "report_elements": null
}

SampleTypeMenuResponse

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	true	none	UUID
name	string	true	none	Name
def_uuid	string(uuid)	true	none	Definition UUID
cls	string	true	none	Class
workflowable_resource_class	string(uuid)	true	none	Workflowable Resource Class UUID

json

{
  "uuid": "77777777-7777-4014-b700-053200000000",
  "name": "Generic sample",
  "def_uuid": "77777777-7777-4014-b700-053300000000",
  "cls": "SampleType",
  "workflowable_resource_class": "77777777-7777-4014-b700-053700000000"
}

SampleSequenceResponse

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Name
format	string	true	none	Sequence format
sequence	string	true	none	Sequence name

json

{
  "name": "ESP SEQUENCE",
  "format": "ESP{sample_number:06}",
  "sequence": "lab7_sample_auto_id_seq"
}

SamplePointPostResponse

Properties

Name	Type	Required	Restrictions	Description
new_registered_children	[string]	false	none	none
all_sample_point_children	[string]	false	none	none
metadata	object	false	none	none

json

{
  "new_registered_children": [
    "485e6eba-5256-4215-8122-7a42b3b058b5",
    "b526c1d9-0528-4b5b-9c75-552e7376dfed"
  ],
  "all_sample_point_children": [
    "485e6eba-5256-4215-8122-7a42b3b058b5",
    "b526c1d9-0528-4b5b-9c75-552e7376dfed"
  ],
  "metadata": []
}

SampleExportJSONResponse

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
barcode	string	false	none	none
variables	object	false	none	none

json

{
  "name": "ESP000001",
  "barcode": "485e6eba-5256-4215-8122-7a42b3b058b5",
  "variables": []
}

SampleExportDictResponse

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» desc	string¦null	false	none	none
» tags	[string]	false	none	none

json

{
  "name": "Resource",
  "desc": "sample description",
  "tags": [
    "tag1",
    "tag2"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D"
}

SampleTypeExportResponse

Properties

Name	Type	Required	Restrictions	Description
augment	object¦null	false	none	Augment
» additionalProperties	string	false	none	none
cls	string	false	none	ESP class
created_timestamp	string(date-time)	false	none	Timestamp of creation
def_created_timestamp	string(date-time)	false	none	Definition created timestamp
def_updated_timestamp	string(date-time)	false	none	Definition updated timestamp
def_uuid	string(uuid)	false	none	Definition UUID
desc	string	false	none	Description
fixed_id	string	false	none	Fixed ID
group_meta	object	false	none	Group metadata
name	string	false	none	Name
sequences	[string]	false	none	List of sequences
tags	[string]	false	none	Tags
updated_timestamp	string(date-time)	false	none	Timestamp of last update
uuid	string(uuid)	false	none	UUID
variables	[ResourceVarResponse]	false	none	Variables
view_template	string	false	none	View template HTML
workflowable_resource_class	string(uuid)	false	none	Workflowable resource class UUID
workflowable_resource_class_barcode	string	false	none	Barcode of workflowable resource class
workflowable_resource_class_name	string	false	none	Name of workflowable resource class

json

{
  "augment": [],
  "cls": "SampleType",
  "created_timestamp": "2024-03-01 20:17:51.407374",
  "def_created_timestamp": "2024-03-01 20:17:51.407374",
  "def_updated_timestamp": "2024-03-01 20:17:51.407374",
  "def_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
  "desc": "",
  "fixed_id": "qatype",
  "group_meta": {
    "schedulability": "off"
  },
  "name": "qatype",
  "sequences": [
    "ESP SEQUENCE"
  ],
  "tags": [],
  "updated_timestamp": "2024-03-01 20:17:51.407374",
  "uuid": "33b92cd0-6bf3-4fbc-bbfe-52c4623dabe8",
  "variables": [
    {
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "url": "string",
      "cls": "string",
      "name": "string",
      "desc": "string",
      "barcode": "string",
      "created_at": "string",
      "updated_at": "string",
      "barcode_type": "QR",
      "fixed_id": "string",
      "deleted": true,
      "tags": [],
      "owner": {},
      "meta": {},
      "view_template": "string",
      "state": "string",
      "var_type": "text",
      "default_val": "text",
      "source": "user",
      "dropdown": [],
      "dropdown_expr": null,
      "in_sample_sheet": true,
      "in_sample_sheet_expr": null,
      "units": null,
      "required": false,
      "required_expr": null,
      "read_only": false,
      "read_only_expr": null,
      "expected": null,
      "pipeline_param": false,
      "var_group": null,
      "resource_link_type": null,
      "ontology_path": null,
      "shared": false,
      "instructions": "",
      "reportable": false,
      "reportable_key": "",
      "reportable_display": ""
    }
  ],
  "view_template": "",
  "workflowable_resource_class": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "workflowable_resource_class_barcode": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "workflowable_resource_class_name": "qaclass"
}

ContainedTypeParamsSchema

Association table for ContainerTypeDefinitions and WorkflowableResourceTypes with many-to-many semantics

Properties

Name	Type	Required	Restrictions	Description
workflowable_resource_type	object	false	none	Workflowable resource type details
» name	string	false	none	Name of the resource type
» uuid	string(uuid)	false	none	UUID of the resource type
min_contained	any	false	none	Minimum containment value
max_contained	number¦null	false	none	Maximum containment value
transfer_item_qty	boolean	false	none	Choose between moving whole Items into Containers or transfering held quantity from the Item to an Item bound to the Container

json

{
  "workflowable_resource_type": {
    "name": "Generic sample",
    "uuid": "77777777-7777-4014-b700-053200000000"
  },
  "min_contained": null,
  "max_contained": null,
  "transfer_item_qty": false
}

SamplePostSchema

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» uuid	string(uuid)	false	none	The sample UUID
» sample_type_uuid	string(uuid)	true	none	The Sample Type UUID
» parents	[object]	false	none	none
» children	[object]	false	none	none
» resource_vals	[object]	false	none	none
» lab7_id_sequence	string	false	none	The Sample name with a user-designated specific prefix
» autogen_name	boolean	false	none	Refers to how the Sample will be registered to ESP in the database (Used for bulk creation)

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ],
  "lab7_id_sequence": "string",
  "autogen_name": true
}

SamplePutBody

Properties

Name	Type	Required	Restrictions	Description
samples	[allOf]	false	none	A list of dictionaries containing the sample UUIDs to migrate

allOf

Name	Type	Required	Restrictions	Description
» anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none
»» uuid	string(uuid)	false	none	none
»» resource_vals	object	false	none	none

continued

Name	Type	Required	Restrictions	Description
migrate_type_def	any	false	none	The new sample type definition to migrate the samples to

json

{
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "resource_vals": {}
    }
  ],
  "migrate_type_def": null
}

ContainerTypePostBody

Container Type post body

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the Container Type
desc	string	false	none	The description of the Container Type
tags	[string]	false	none	Tags associated with the Container
contains	[string]	false	none	Workflowable Resource Classes allowed in the Container
group_meta	object	false	none	Additional metadata associated with the Container Type
fixed_id	string	false	none	Fixed ID of the Container Type
barcode	string	false	none	Barcode associated with the Container Type
barcode_type	string	false	none	Type of barcode
view_template	string	false	none	Template for viewing the Container Type
augment	object	false	none	Augmentation information
resource_vars	[ResourceVarResponse]	false	none	resource variables
contained_type_params	[ContainedTypeParamsSchema]	false	none	Contained type parameters
meta	object	false	none	Additional metadata
» axis_names	[string]	false	none	Names for the axes
» format	string	false	none	Format of axis labels
» location_holds	string	false	none	Determines whether a Container slot can contain one or unlimited elements.
» dims	[string]	false	none	A list of the dimensions associated with the Container Type definition
» axis_labels	[array]	false	none	A list of labels associated with the axes of the Container Type

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

json

{
  "name": "Fridge",
  "desc": "This fridge belongs to Laboratory A.",
  "tags": [
    "tag1",
    "tag2"
  ],
  "contains": [
    "Samples",
    "Containers"
  ],
  "group_meta": {
    "key": "value"
  },
  "fixed_id": "12345",
  "barcode": "ABC123",
  "barcode_type": "QR",
  "view_template": "",
  "augment": [],
  "resource_vars": [],
  "contained_type_params": [
    {
      "workflowable_resource_type": {},
      "min_contained": null,
      "max_contained": null,
      "transfer_item_qty": false
    }
  ],
  "meta": {
    "axis_names": [
      "X",
      "Y"
    ],
    "format": "%s",
    "location_holds": "unlimited",
    "dims": [
      "9",
      "5"
    ],
    "axis_labels": [
      [],
      [],
      [],
      [],
      [],
      []
    ]
  }
}

SamplePutUUIDBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» parents	[object]	false	none	none
» children	[object]	false	none	none
» resource_vals	[object]	false	none	none

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ]
}

BasicResourcePostSchema

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	Name
desc	string¦null	false	none	Description
tags	[string]	false	none	Tags
meta	object	false	none	Meta
augment	object¦null	false	none	Augment
» additionalProperties	string	false	none	none
barcode	string¦null	false	none	Barcode
barcode_type	string¦null	false	none	Barcode Type

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D"
}

ItemPutBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» view_template	string	false	none	The view template HTML for the item
» vendor	string	false	none	The vendor of the item
» lot_id	string	false	none	The Lot ID of the item
» serial_id	string	false	none	The Serial ID of the item
» status	string	false	none	The status of the item
» expiration_timestamp	string	false	none	The expiration timestamp of the item
» qty_note	string	false	none	Notes related to quantity
» add_qty	number	false	none	Quantity to add
» remove_qty	number	false	none	Quantity to remove
» transfer_qty	number	false	none	Quantity to transfer
» resource_vals	[object]	false	none	Resource values associated with the item

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "view_template": "",
  "vendor": "Vendor X",
  "lot_id": "LOT123",
  "serial_id": "SERIAL456",
  "status": "Active",
  "expiration_timestamp": 1643678400,
  "qty_note": "Additional notes here",
  "add_qty": 10,
  "remove_qty": 5,
  "transfer_qty": 3,
  "resource_vals": [
    {}
  ]
}

ItemPostBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ItemPostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» items	[ItemBulkPostSchema]	false	none	list of dictionaries defining the items to create
» autogen_names	boolean	false	none	Refers to how the Sample will be registered to ESP in the database (Used for bulk creation)
» lab7_id_sequence	string	false	none	Resource sequence to generate item name

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "item_type_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": "223e4567-e89b-12d3-a456-426614174000",
  "lot_id": "LOT123",
  "serial_id": "SERIAL456",
  "status": "Active",
  "initial_qty": 100,
  "expiration_timestamp": 1643678400,
  "items": [
    {
      "item_type_def_uuid": "74c2b0db-a20b-4fea-9e6c-7baa9dbf1af6",
      "vendor": "223e4567-e89b-12d3-a456-426614174000",
      "lot_id": "LOT123",
      "serial_id": "SERIAL456",
      "status": "Active",
      "initial_qty": 100,
      "expiration_timestamp": 1643678400
    }
  ],
  "autogen_names": true,
  "lab7_id_sequence": "ESP SEQUENCE"
}

ItemBulkPostSchema

Properties

Name	Type	Required	Restrictions	Description
item_type_def_uuid	string(uuid)	false	none	Item Type Definition UUID
vendor	string(uuid)	false	none	The vendor UUID
lot_id	string	false	none	The Lot ID of the item
serial_id	string	false	none	The Serial ID of the item
status	string	false	none	The status of the item
initial_qty	number	false	none	The initial quantity of the item
expiration_timestamp	string	false	none	The timestamp for when the item expires

json

{
  "item_type_def_uuid": "74c2b0db-a20b-4fea-9e6c-7baa9dbf1af6",
  "vendor": "223e4567-e89b-12d3-a456-426614174000",
  "lot_id": "LOT123",
  "serial_id": "SERIAL456",
  "status": "Active",
  "initial_qty": 100,
  "expiration_timestamp": 1643678400
}

ItemPostSchema

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» item_type_uuid	string(uuid)	true	none	The Item Type UUID
» vendor	string(uuid)	false	none	The vendor UUID
» lot_id	string	false	none	The Lot ID of the item
» serial_id	string	false	none	The Serial ID of the item
» status	string	false	none	The status of the item
» initial_qty	number	false	none	The initial quantity of the item
» expiration_timestamp	string	false	none	The timestamp for when the item expires

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "item_type_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "vendor": "223e4567-e89b-12d3-a456-426614174000",
  "lot_id": "LOT123",
  "serial_id": "SERIAL456",
  "status": "Active",
  "initial_qty": 100,
  "expiration_timestamp": 1643678400
}

SamplePostBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	SamplePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» samples	[SamplePostSchema]	false	none	list of dictionaries defining the samples to create
» metadata	object	false	none	The headers of an import file
»» additionalProperties	string	false	none	none
»» sample_tags	[string]	false	none	A list of tags to apply to the imported samples
»» format	string	false	none	text is for importing with a sample pipeline and json is for
»» pipeline_uuid	string(uuid)	false	none	The pipeline UUID
» autogen_names	boolean	false	none	Refers to how the Sample will be registered to ESP in the database (Used for bulk creation)

Enumerated Values

Property	Value
format	text
format	json

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
  "parents": [
    {}
  ],
  "children": [
    {}
  ],
  "resource_vals": [
    {}
  ],
  "lab7_id_sequence": "string",
  "autogen_name": true,
  "samples": [
    {
      "name": "Resource",
      "desc": "A Human Patient",
      "tags": [],
      "meta": [],
      "augment": [],
      "barcode": null,
      "barcode_type": "1D",
      "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
      "sample_type_uuid": "84de9253-26a2-43de-a273-4ad2dab652a3",
      "parents": [],
      "children": [],
      "resource_vals": [],
      "lab7_id_sequence": "string",
      "autogen_name": true
    }
  ],
  "metadata": {
    "sample_tags": [
      "string"
    ],
    "format": "text",
    "pipeline_uuid": "03afed02-78e2-41e3-b5b0-ddd069f5f552",
    "property1": "string",
    "property2": "string"
  },
  "autogen_names": true
}

SampleTypeImportPostBody

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	false	none	UUID
def_uuid	string(uuid)	false	none	Definition UUID
name	string	false	none	Name
fixed_id	string	false	none	Fixed ID
desc	string	false	none	Description
cls	string	false	none	Class
tags	[string]	false	none	Tags
sequences	[string]	false	none	Sequences
variables	[object]	false	none	Custom fields
» additionalProperties	string	false	none	none
view_template	string	false	none	View template HTML
workflowable_resource_class	string(uuid)	false	none	Workflowable resource class UUID
workflowable_resource_class_name	string	false	none	Name of workflowable resource class
workflowable_resource_class_barcode	string	false	none	Barcode of workflowable resource class
create	[SampleImportPostBody]	false	none	Samples to create with the new sample type
augment	object¦null	false	none	Augment
» additionalProperties	string	false	none	none

json

{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "def_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
  "name": "qatype",
  "fixed_id": "qatype",
  "desc": "SampleType Description",
  "cls": "SampleTypeClass",
  "tags": [
    "tag1",
    "tag2"
  ],
  "sequences": [
    "Sequence1",
    "Sequence2"
  ],
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "view_template": "",
  "workflowable_resource_class": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "workflowable_resource_class_name": "qaclass",
  "workflowable_resource_class_barcode": "05d30518-9b8a-46e2-a7a8-70e850b6b017",
  "create": [],
  "augment": []
}

SampleImportPostBody

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	false	none	UUID of the sample
name	string	false	none	Name of the sample
desc	string	false	none	Description of the sample
tags	[string]	false	none	Tags associated with the sample
type	string	false	none	SampleType name
barcode	string	false	none	Barcode of the sample
variables	object	false	none	Variables associated with the sample
» additionalProperties	string	false	none	none
names	[string]	false	none	List of names. Used for bulk sample creation.
descs	[string]	false	none	List of descriptions. Used for bulk sample creation.
count	integer	false	none	Number of samples to create. Used for bulk sample creation.
sequence	string	false	none	Sample sequence
children	[object]	false	none	List of children samples

json

{
  "uuid": "e34b2239-0c28-4b0b-9612-6793cd110465",
  "name": "Sample Name",
  "desc": "Description of the sample",
  "tags": [
    "tag1",
    "tag2"
  ],
  "type": "SampleType1",
  "barcode": "1234567890",
  "variables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "names": [
    "Name1",
    "Name2"
  ],
  "descs": [
    "Desc1",
    "Desc2"
  ],
  "count": 5,
  "sequence": "lab7_sample_auto_id_seq",
  "children": [
    {}
  ]
}

WorkflowableResourceClassPostBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» plural_name	string	true	none	Plural Name
» list_view_template	string¦null	false	none	List View Template HTML
» detail_panel_template	string¦null	false	none	Detail Panel Template HTML
» view_template	string¦null	false	none	View Template HTML
» icon_svg	string¦null	false	none	Icon SVG
» contains	[string]	false	none	Contains

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "plural_name": "Resources",
  "list_view_template": null,
  "detail_panel_template": null,
  "view_template": null,
  "icon_svg": null,
  "contains": [
    "Sample"
  ]
}

WorkflowableResourceClassImportBody

Properties

Name	Type	Required	Restrictions	Description
uuid	string(uuid)	false	none	UUID
name	string	false	none	Name
plural_name	string	false	none	Plural Name
desc	string	false	none	Description
cls	string	false	none	Class
view_template	string	false	none	View template HTML
list_view_template	string	false	none	List view template HTML
detail_panel_template	string	false	none	Detail panel template HTML
icon_svg	string	false	none	Icon SVG

json

{
  "uuid": "77777777-7777-4014-b700-053600000000",
  "name": "Library",
  "plural_name": "Libraries",
  "desc": "Resource Description",
  "cls": "WorkflowableResourceClass",
  "view_template": "",
  "list_view_template": "",
  "detail_panel_template": "",
  "icon_svg": ""
}

ParamPostBody

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Name of the designated Param Group
desc	string	false	none	Description of the Param Group
params	object	false	none	A designated key-value pair that can be referenced at any point in ESP.
» additionalProperties	string	false	none	none
tags	[string]	false	none	List of designated tags (Strings) to be associated with the Param Group

json

{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ]
}

ParamPutBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ParamPostBody	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» augment	boolean	false	none	none
» barcode	string	false	none	Barcode of the Param Group
» barcode_type	string	false	none	Barcode Type of the Param Group
» fixed_id	string	false	none	Fixed ID of the Param Group

Enumerated Values

Property	Value
barcode_type	QR
barcode_type	1D
barcode_type	mini data matrix

json

{
  "name": "Animal Parameters",
  "desc": "List of animals used in the lab",
  "params": {
    "Animals": [
      "Cat",
      "Dog",
      "Rat"
    ]
  },
  "tags": [
    "Cat",
    "Dog",
    "Rat"
  ],
  "augment": true,
  "barcode": "barcode123",
  "barcode_type": "1D",
  "fixed_id": "param_fixed_id"
}

SampleTypePostBody

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BasicResourcePostSchema	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» fixed_id	string	false	none	Whether the resource has a fixed ID
» resource_vars	[ResourceVarResponse]	false	none	resource variables
» group_meta	object¦null	false	none	A version control handler for Container Types and Sample Types
» view_template	string	false	none	The HTML template used to render the view
» workflowable_resource_class	string	false	none	The name of the workflowable resource class
» icon_svg	string¦null	false	none	The SVG icon used for the resource

json

{
  "name": "Resource",
  "desc": "A Human Patient",
  "tags": [
    "Patient"
  ],
  "meta": [],
  "augment": [],
  "barcode": null,
  "barcode_type": "1D",
  "fixed_id": "Generic sample",
  "resource_vars": [],
  "group_meta": {
    "schedulability": false,
    "hub_dependencies": []
  },
  "view_template": "",
  "workflowable_resource_class": "77777777-7777-4014-b700-053400000000",
  "icon_svg": null
}

SamplePointPostBody

Properties

Name	Type	Required	Restrictions	Description
sample_specs	[object]	false	none	List of Sample specification dicts
» name	string	false	none	none
» resource_vals	[object]	false	none	none
»» name	string	false	none	none
»» value	string	false	none	none
»» uuid	string(uuid)	false	none	none
general_sample_specs	object	false	none	Dictionary containing the SampleType UUID, SampleTypeDefinition UUID, and lab7_id_sequence for the samples to be created.
» lab7_id_sequence	string	false	none	none
» sample_type_uuid	string(uuid)	false	none	none
» sample_type_definition_uuid	string(uuid)	false	none	none
» tags	[string]	false	none	none
parent	object	false	none	none
» resource_var_uuid	string(uuid)	false	none	sample point resource val uuid or pipe-delimited resource val uuid in case of groups
» resource_val_uuid	string(uuid)	false	none	resource var uuid of sample point column

json

{
  "sample_specs": [
    {
      "name": "Sample Spec Name",
      "resource_vals": []
    }
  ],
  "general_sample_specs": {
    "lab7_id_sequence": "ESP SEQUENCE",
    "sample_type_uuid": "33b92cd0-6bf3-4fbc-bbfe-52c4623dabe8",
    "sample_type_definition_uuid": "7365c60a-c2e3-4c2f-8124-1a370952faae",
    "tags": []
  },
  "parent": {
    "resource_var_uuid": "51bc8fad-c6f6-49ba-937e-2c82e848029e",
    "resource_val_uuid": "bf12a574-03cc-47cc-9795-4ea5b6bfc89b"
  }
}

ExpressionResponse

Expression results

Properties

Name	Type	Required	Restrictions	Description
result	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

xor

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

json

HTTPError

Properties

Name	Type	Required	Restrictions	Description
detail	object	false	none	none
message	string	false	none	none

json

{
  "detail": {},
  "message": "string"
}