Step

Step API

Method & Permission

API	GET	POST	PUT	PATCH	DELETE
Step List	Admin, Member	Admin	-	-	-
Step Detail	Admin, Member	-	-	Admin	Admin

Step List

GET /tables/step/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Query Parameters

Name	Type	Description
widget__sid	string

Headers

Name	Type	Description
token	string

200

# serializer = name
{
    "page_size": 1,
    "page_number": 1,
    "page_count": 5,
    "count": 5,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "Create an experiment note"
        }
    ]
}
# serializer = list
{
    "page_size": 1,
    "page_number": 1,
    "page_count": 5,
    "count": 5,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "name": "Create an experiment note",
            "parent": null,
            "redirect_to": null,
            "color": "Grey",
            "workflow": {
                "sid": "xxx",
                "name": "Plan an experiment",
                "description": "This workflow describes what you need to do before start an experiment."
            },
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "change_permission": true
        }
    ]
}
# serializer = detail
{
    "page_size": 1,
    "page_number": 1,
    "page_count": 5,
    "count": 5,
    "next": "xxx",
    "previous": null,
    "add_permission": true,
    "results": [
        {
            "sid": "xxx",
            "table": {
                "sid": "xxx",
                "name": "experiments"
            },
            "workflow": {
                "sid": "xxx",
                "name": "Plan an experiment",
                "description": "This workflow describes what you need to do before start an experiment."
            },
            "parent": null,
            "name": "Create an experiment note",
            "description": "Learn more at <a href='https://docs.labii.com/eln-and-lims/add-record' target='_blank'>here</a>",
            "condition": null,
            "protocol": null,
            "redirect_to": null,
            "color": "Grey",
            "is_archived": false,
            "updated_by": "xxx",
            "date_updated": "2020-02-10T03:02:27.174030Z",
            "date_created": "2020-02-10T03:02:27.172914Z",
            "change_permission": true
        }
    ]
}

Step List

POST /tables/step/list/{level}/{sid}/{serializer}/

Path Parameters

Name	Type	Description
level	string	organization
sid	string	organization sid
serializer	string

Query Parameters

Name	Type	Description
widget__sid	string

Headers

Name	Type	Description
token	string

201

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "workflow": {
        "sid": "xxx",
        "name": "Plan an experiment",
        "description": "This workflow describes what you need to do before start an experiment."
    },
    "parent": null,
    "name": "Create an experiment note",
    "description": "Learn more at <a href='https://docs.labii.com/eln-and-lims/add-record' target='_blank'>here</a>",
    "condition": null,
    "protocol": null,
    "redirect_to": null,
    "color": "Grey",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:27.174030Z",
    "date_created": "2020-02-10T03:02:27.172914Z",
    "change_permission": true
}

406

Missing workflow__sid in get parameters
Wrong workflow sid - the provided workflow sid is not correct

Step Detail

GET /tables/step/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

200

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "workflow": {
        "sid": "xxx",
        "name": "Plan an experiment",
        "description": "This workflow describes what you need to do before start an experiment."
    },
    "parent": null,
    "name": "Create an experiment note",
    "description": "Learn more at <a href='https://docs.labii.com/eln-and-lims/add-record' target='_blank'>here</a>",
    "condition": null,
    "protocol": null,
    "redirect_to": null,
    "color": "Grey",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:27.174030Z",
    "date_created": "2020-02-10T03:02:27.172914Z",
    "change_permission": true
}

Step Detail

PATCH /tables/step/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

200

{
    "sid": "xxx",
    "table": {
        "sid": "xxx",
        "name": "experiments"
    },
    "workflow": {
        "sid": "xxx",
        "name": "Plan an experiment",
        "description": "This workflow describes what you need to do before start an experiment."
    },
    "parent": null,
    "name": "Create an experiment note",
    "description": "Learn more at <a href='https://docs.labii.com/eln-and-lims/add-record' target='_blank'>here</a>",
    "condition": null,
    "protocol": null,
    "redirect_to": null,
    "color": "Grey",
    "is_archived": false,
    "updated_by": "xxx",
    "date_updated": "2020-02-10T03:02:27.174030Z",
    "date_created": "2020-02-10T03:02:27.172914Z",
    "change_permission": true
}

Step Detail

DELETE /tables/step/detail/{sid}/

Path Parameters

Name	Type	Description
sid	string

Headers

Name	Type	Description
token	string

204

{}