Create a table in a collection.

Beta

POST

https://api-prod.scoutos.com/v2/collections/:collection_id/tables

POST

/v2/collections/:collection_id/tables

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.tables.create(
7     collection_id="collection_id",
8 )

Try it

200Successful

1 {
2   "data": {
3     "table_config": {
4       "table_display_name": "Untitled",
5       "table_img_url": "table_img_url",
6       "table_description": "table_description",
7       "schema": [
8         {
9           "column_id": "column_id",
10           "column_display_name": "column_display_name",
11           "column_type": "checkbox",
12           "data_type": "boolean",
13           "hidden": false,
14           "default": false
15         }
16       ]
17     },
18     "created_at": "created_at",
19     "last_updated_at": "last_updated_at",
20     "created_by": {
21       "type": "user",
22       "details": {
23         "user_id": "user_id",
24         "org_id": "org_id",
25         "scout_organization_id": "scout_organization_id",
26         "email": {}
27       }
28     },
29     "last_updated_by": {
30       "type": "user",
31       "details": {
32         "user_id": "user_id",
33         "org_id": "org_id",
34         "scout_organization_id": "scout_organization_id",
35         "email": {}
36       }
37     },
38     "revision_id": "revision_id",
39     "table_id": "table_id",
40     "index_id": "index_id"
41   }
42 }

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.

table_display_namestringOptionalDefaults to Untitled

table_img_urlstring or nullOptional

table_descriptionstring or nullOptional

schemalist of objects or nullOptional

Response

Successful Response

dataobject or null

Create a table in a collection.

Path parameters

Headers

Request

Response

Errors