Section

Last updated 4 months ago

get
Section List

{{ base_url }}
/tables/section/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
sid
required
string
serializer
required
string
Headers
token
required
string
200: OK
{
"page_size": 10,
"page_number": 1,
"page_count": 5,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "Double Signature",
"widget___widget__sid": "xxx",
"description": "",
"is_archived": false,
"order": 1,
"change_permission": true
},
...
]
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable

post
Section List

{{ base_url }}
/tables/section/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
sid
required
string
serializer
required
string
Headers
token
required
string
Query Parameters
row__sid
optional
string
Form Data Parameters
widget__sid
required
string
name
required
string
description
optional
string
201: Created
{
"sid": "xxx",
"table__name_plural": "experiments",
"row__sid": "xxx",
"widget__sid": "xxx",
"name": "Double Signature",
"description": "",
"order": 1,
"widget_set": {
"sid": "xxx",
"icon": "gesture",
"name": "Double Signatures",
"subscription_price": "Free",
"PPU_price": "$0.2",
"notes": "dd",
"component___status___WidgetActive": false,
"description": "xxx",
"instruction": "xxx",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": false,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:27:40.367371Z",
"date_created": "2018-02-24T02:55:10.448466Z"
},
"data": null,
"section_data": {
...
},
"is_archived": false,
"date_updated": "2018-07-27T03:56:42.747213Z",
"date_created": "2018-07-27T03:56:42.646170Z"
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct
Wrong level - the provided level is not acceptable

get
Section Detail

{{ base_url }}
/tables/section/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"table__name_plural": "experiments",
"row__sid": "xxx",
"widget__sid": "xxx",
"name": "Double Signature",
"description": "",
"order": 1,
"widget_set": {
"sid": "xxx",
"icon": "gesture",
"name": "Double Signatures",
"subscription_price": "Free",
"PPU_price": "$0.2",
"notes": "dd",
"component___status___WidgetActive": false,
"description": "xxx",
"instruction": "xxx",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": false,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:27:40.367371Z",
"date_created": "2018-02-24T02:55:10.448466Z"
},
"data": null,
"section_data": {
...
},
"is_archived": false,
"date_updated": "2018-07-27T03:56:42.747213Z",
"date_created": "2018-07-27T03:56:42.646170Z"
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct

patch
Section Patch

{{ base_url }}
/tables/section/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
Form Data Parameters
name
optional
string
description
optional
string
order
optional
number
data
optional
object
is_archived
optional
boolean
200: OK
{
"sid": "xxx",
"table__name_plural": "experiments",
"row__sid": "xxx",
"widget__sid": "xxx",
"name": "Double Signature",
"description": "",
"order": 1,
"widget_set": {
"sid": "xxx",
"icon": "gesture",
"name": "Double Signatures",
"subscription_price": "Free",
"PPU_price": "$0.2",
"notes": "dd",
"component___status___WidgetActive": false,
"description": "xxx",
"instruction": "xxx",
"usecase": "",
"related_to": "",
"apply_to": "Substance,Document,File",
"allow_multiple": false,
"is_readonly": false,
"is_archived": false,
"is_public": true,
"date_updated": "2018-07-22T20:27:40.367371Z",
"date_created": "2018-02-24T02:55:10.448466Z"
},
"data": null,
"section_data": {
...
},
"is_archived": false,
"date_updated": "2018-07-27T03:56:42.747213Z",
"date_created": "2018-07-27T03:56:42.646170Z"
}
401: Unauthorized
Authentication credentials were not provided.
403: Forbidden
You do not have permission to perform this action.
406: Not Acceptable
Wrong id - the provided sid is not correct