Column

Last updated 4 months ago

get
Column List

{{ base_url }}
/tables/column/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": 7,
"count": 1,
"next": null,
"previous": null,
"add_permission": true,
"results": [
{
"sid": "xxx",
"name": "xxx",
"description": "xxx",
"data_type": "Text",
"default_value": null,
"is_required": true,
"is_hidden": false,
"is_archived": true,
"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
Column List

{{ base_url }}
/tables/column/list/{level}/{sid}/{serializer}/
Request
Response
Path Parameters
level
required
string
sid
required
string
serializer
required
string
Headers
token
required
string
Form Data Parameters
name
required
string
description
optional
string
data_type
optional
string
default_value
optional
string
is_required
optional
boolean
is_hidded
optional
boolean
is_archived
optional
boolean
201: Created
{
"sid": "xxx",
"name": "xxx",
"name_system": null,
"description": "xxx",
"data_type": "Text",
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"is_archived": true,
"date_created": "2017-11-25T01:30:57.392398Z"
}
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
Column Detail

{{ base_url }}
/tables/column/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
200: OK
{
"sid": "xxx",
"name": "xxx",
"name_system": null,
"description": "xxx",
"data_type": "Text",
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"is_archived": true,
"date_created": "2017-11-25T01:30:57.392398Z"
}
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
Column Detail

{{ base_url }}
/tables/column/detail/{sid}/
Request
Response
Path Parameters
sid
required
string
Headers
token
required
string
Form Data Parameters
name
optional
string
description
optional
string
date_type
optional
string
default_value
optional
string
is_required
optional
boolean
is_hidden
optional
boolean
is_archived
optional
boolean
200: OK
{
"sid": "xxx",
"name": "xxx",
"name_system": null,
"description": "xxx",
"data_type": "Text",
"default_value": null,
"order": 1,
"is_required": true,
"is_hidden": false,
"is_archived": true,
"date_created": "2017-11-25T01:30:57.392398Z"
}
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