Labii ELN & LIMS
Labii ELN & LIMS
Home
Free Trial
Schedule a demo
Blog
Introduction
Quick Start
ELN & LIMS
Add Record
List View
Detail View
Search
Import and Export
Settings
Accounts
Support
Widgets
Summary
Column Widgets
Office
Productivity
Regulation
Biology
Chemistry
Reference Manager
Report
Combination
API
Overview
Methods
Authentication
Organization
Personnel
Team
Organization Widget
Statement
Backup
Project
Project Member
Table
Column
Filter
Row
Cell
Section
Workflow
Step
Version
Activity
Widget
Advanced Usage
Document Management
Track sample consumption
Goal management
Reference Manager
Powered by GitBook

Organization

API for Organization object

get
Organization List

/organizations/organization/list/{level}/{sid}/{serializer}/
Get a list of organizations.
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
200: OK
Cake successfully retrieved.
{
    "page_size": 10,
    "page_number": 1,
    "page_count": 1,
    "count": 1,
    "next": null,
    "previous": null,
    "days_available": 182,
    "add_permission": false,
    "change_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "xxx",
            "username": "xxx",
            "description": "xxx",
            "logo_icon": "xxx",
            "logo_wordmark": "xxx",
            "is_academic": false,
            "is_subscription": true,
            "available_till": "2019-01-01",
            "payment": {
                "payment_option": "Subscription",
                "seats": 5,
                "available_till": "2019-01-01",
                "days_available": 180,
                "is_academic": "False",
                "credits": "$499.25"
            },
            "table_set": [
                {
                    "sid": "xxx",
                    "icon": "assignment",
                    "name_singular": "experiment",
                    "name_plural": "experiments",
                    "name_system": null,
                    "description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
                    "unique_code": "EP",
                    "table_type": "Document",
                    "order": 1
                },
                ...
            ],
            "project_set": [
                {
                    "name": "xxx",
                    "sid": "xxx"
                },
                ...
            ],
            "widget_set": [
                {
                    "sid": "xxx",
                    "icon": "format_color_text",
                    "name": "Rich Text",
                    "subscription_price": "Free",
                    "PPU_price": "Free",
                    "notes": "Add Text with WYSIWYG Text Editor",
                    "component___status___WidgetActive": true,
                    "description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
                    "instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
                    "usecase": "",
                    "related_to": "",
                    "apply_to": "Substance,Document,File",
                    "allow_multiple": true,
                    "is_readonly": false,
                    "is_archived": false,
                    "is_public": true,
                    "date_updated": "2018-07-22T20:25:22.214763Z",
                    "date_created": "2018-01-03T05:31:33.477489Z"
                },
                ...
            ],
        },
        ...
    ]
}
406: Not Acceptable
Could not find a cake matching this query.
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable

post
Organization List

/organizations/organization/list/{level}/{sid}/{serializer}/
Add a new organization.
Request
Response
Path Parameters
level
required
string
​
sid
required
string
​
serializer
required
string
​
Form Data Parameters
name
required
string
​
username
required
string
​
description
optional
string
​
seats
optional
number
How many people is going to use?
201: Created
{
    "sid": "xxx",
    "name": "xxx",
    "username": "xxx",
    "description": "xxx",
    "logo_icon": "xxx",
    "logo_wordmark": "xxx",
    "is_academic": false,
    "is_subscription": true,
    "available_till": "2019-01-01",
    "payment": {
        "payment_option": "Subscription",
        "seats": 5,
        "available_till": "2019-01-01",
        "days_available": 180,
        "is_academic": "False",
        "credits": "$499.25"
    },
    "table_set": [
        {
            "sid": "xxx",
            "icon": "assignment",
            "name_singular": "experiment",
            "name_plural": "experiments",
            "name_system": null,
            "description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
            "unique_code": "EP",
            "table_type": "Document",
            "order": 1
        },
        ...
    ],
    "project_set": [
        {
            "name": "xxx",
            "sid": "xxx"
        },
        ...
    ],
    "widget_set": [
        {
            "sid": "xxx",
            "icon": "format_color_text",
            "name": "Rich Text",
            "subscription_price": "Free",
            "PPU_price": "Free",
            "notes": "Add Text with WYSIWYG Text Editor",
            "component___status___WidgetActive": true,
            "description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
            "instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
            "usecase": "",
            "related_to": "",
            "apply_to": "Substance,Document,File",
            "allow_multiple": true,
            "is_readonly": false,
            "is_archived": false,
            "is_public": true,
            "date_updated": "2018-07-22T20:25:22.214763Z",
            "date_created": "2018-01-03T05:31:33.477489Z"
        },
        ...
    ],
}
406: Not Acceptable
Wrong id - The provided sid is not correct
Wrong id: xxx. The sid does not match to user! - The sid does not match to token information
Wrong level: xxx. Acceptable levels is user. - Wrong level provided

get
Organization Detail

/organization/detail/{sid}/
Get a organization object.
Request
Response
Path Parameters
sid
required
string
​
200: OK
{
    "sid": "xxx",
    "name": "xxx",
    "username": "xxx",
    "description": "xxx",
    "logo_icon": "xxx",
    "logo_wordmark": "xxx",
    "is_academic": false,
    "is_subscription": true,
    "available_till": "2019-01-01",
    "payment": {
        "payment_option": "Subscription",
        "seats": 5,
        "available_till": "2019-01-01",
        "days_available": 180,
        "is_academic": "False",
        "credits": "$499.25"
    },
    "table_set": [
        {
            "sid": "xxx",
            "icon": "assignment",
            "name_singular": "experiment",
            "name_plural": "experiments",
            "name_system": null,
            "description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
            "unique_code": "EP",
            "table_type": "Document",
            "order": 1
        },
        ...
    ],
    "project_set": [
        {
            "name": "xxx",
            "sid": "xxx"
        },
        ...
    ],
    "widget_set": [
        {
            "sid": "xxx",
            "icon": "format_color_text",
            "name": "Rich Text",
            "subscription_price": "Free",
            "PPU_price": "Free",
            "notes": "Add Text with WYSIWYG Text Editor",
            "component___status___WidgetActive": true,
            "description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
            "instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
            "usecase": "",
            "related_to": "",
            "apply_to": "Substance,Document,File",
            "allow_multiple": true,
            "is_readonly": false,
            "is_archived": false,
            "is_public": true,
            "date_updated": "2018-07-22T20:25:22.214763Z",
            "date_created": "2018-01-03T05:31:33.477489Z"
        },
        ...
    ],
}
406: Not Acceptable
Wrong id - The provided sid is not correct

patch
Organization Detail

/organization/detail/{sid}/
Update the organization information
Request
Response
Path Parameters
sid
required
string
​
Form Data Parameters
name
optional
string
​
description
optional
string
​
logo_icon
optional
object
​
logo_wordmark
optional
object
​
200: OK
{
    "sid": "xxx",
    "name": "xxx",
    "username": "xxx",
    "description": "xxx",
    "logo_icon": "xxx",
    "logo_wordmark": "xxx",
    "is_academic": false,
    "is_subscription": true,
    "available_till": "2019-01-01",
    "payment": {
        "payment_option": "Subscription",
        "seats": 5,
        "available_till": "2019-01-01",
        "days_available": 180,
        "is_academic": "False",
        "credits": "$499.25"
    },
    "table_set": [
        {
            "sid": "xxx",
            "icon": "assignment",
            "name_singular": "experiment",
            "name_plural": "experiments",
            "name_system": null,
            "description": "An experiment is the lab note to document procedures carried out to support, refute, or validate a hypothesis.",
            "unique_code": "EP",
            "table_type": "Document",
            "order": 1
        },
        ...
    ],
    "project_set": [
        {
            "name": "xxx",
            "sid": "xxx"
        },
        ...
    ],
    "widget_set": [
        {
            "sid": "xxx",
            "icon": "format_color_text",
            "name": "Rich Text",
            "subscription_price": "Free",
            "PPU_price": "Free",
            "notes": "Add Text with WYSIWYG Text Editor",
            "component___status___WidgetActive": true,
            "description": "Use this widget to add text from a WYSIWYG Text Editor. Other records can also be inserted via Mention(@).",
            "instruction": "* To insert a link of other item, use <b>mention (@[Search Term])</b>. <br />- Type \"@\" to trigger suggestions. Click a list or press Enter to insert. Use \"__\" in search term to separate multiple keywords. For example, to find a experiment did by John, the mention term is <i>@ep__john</i><br />\r\n* To insert a consumption, use <b>mention (@[Amount]__[Unit]__of__[Search Term])</b>. For example, to insert the consumption of 10 ug of sample DNA: <i>@10__ug__of__sample__dna</i> <br />\r\n- The mentioned item can be a <i>Location</i>, consumption for all <i>Substance</i> in the location will be created. For example, to insert the consumption of 50 ul of all 96 miRNAs in a 96-well plate: <i>@50__ul__of__mirna__96__well__plate</i>",
            "usecase": "",
            "related_to": "",
            "apply_to": "Substance,Document,File",
            "allow_multiple": true,
            "is_readonly": false,
            "is_archived": false,
            "is_public": true,
            "date_updated": "2018-07-22T20:25:22.214763Z",
            "date_created": "2018-01-03T05:31:33.477489Z"
        },
        ...
    ],
}
406: Not Acceptable
Wrong id - The provided sid is not correct

​

​

​

Previous
Authentication
Next
Personnel
Last updated 4 months ago
Contents
get
Organization List
post
Organization List
get
Organization Detail
patch
Organization Detail