Section
API for Section object
Method & Permission
API | GET | POST | PUT | PATCH | DELETE |
Section List | Admin, Project Admin, Project Edit, Project View | Project Admin*, Project Edit* | - | - | - |
Section Detail | Admin, Project Admin, Project Edit, Project View | - | - | Project Admin*, Project Edit* | Admin** |
*Section can not be posted/modified if row.is_locked=True
, unless the widget can be added at the read-only
*Section can not be posted/modified if row.is_archived=True
**Only the section table can be deleted
Section List
GET
{{ base_url }} /tables/section/list/{level}/{sid}/{serializer}/
Need table__sid or row__sid.
Path Parameters
Name | Type | Description |
---|---|---|
level | string | organization |
sid | string | organization sid |
serializer | string | one of [name, list, detail] |
Query Parameters
Name | Type | Description |
---|---|---|
row__sid | string | |
table__sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Section List
POST
{{ base_url }} /tables/section/list/{level}/{sid}/{serializer}/
Path Parameters
Name | Type | Description |
---|---|---|
level | string | organization |
sid | string | organization sid |
serializer | string | one of [name, list, detail] |
Query Parameters
Name | Type | Description |
---|---|---|
row__sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
widget | object | |
name | string | |
description | string |
Section Detail
GET
{{ base_url }} /tables/section/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Section Patch
PATCH
{{ base_url }} /tables/section/detail/{sid}/
Path Parameters
Name | Type | Description |
---|---|---|
sid | string |
Headers
Name | Type | Description |
---|---|---|
token | string |
Request Body
Name | Type | Description |
---|---|---|
name | string | |
description | string | |
order | number | |
data | object | |
is_archived | boolean |
Last updated