Tables
Tables or similar data elements from an integration.
Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with
filter={"operator":"exact","field":"type","value":"table"}
.
Integration ID
df2c0597-13d9-4159-bb6d-00b3f54235dc
ID of the schema
df2c0597-13d9-4159-bb6d-00b3f54235dc
Title of the table
Sample Table
GET /api/v1/table/tables HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
"links": {
"next": "https://api.secoda.co/resource/all/?page=2",
"previous": "None"
},
"meta": {
"page": 1,
"previous_page": "None",
"next_page": 2
},
"count": 315,
"total_pages": 7,
"results": [
{
"id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
"created_at": "2023-08-16T23:12:53.245493Z",
"updated_at": "2023-08-16T23:12:53.245507Z",
"entity_type": "table",
"native_type": "Dataset",
"bookmarked_by": [
"d935a76c-2125-4c30-9389-ef42fa7e23bb",
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"icon": "icon-url.png",
"title": "Sample Table",
"title_full": "Sample Database.Sample Schema.Sample Table",
"title_cased": "sampleTable",
"description": "This is a description for a sample table.",
"definition": "text",
"definition_version": 1,
"multiplayers": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
"multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
"owners": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"owners_groups": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"collections": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260"
],
"tags": [
"f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
"a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
],
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"total_usage": 483,
"published": false,
"archived": false,
"pii": true,
"verified": false,
"url": "https://example.com/sample-table",
"parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
"children_count": 2,
"integration": "ca529385-fbc9-4934-afae-e372affe795b",
"external_updated_at": "2023-08-16T23:12:53.245507Z",
"internal_usage": 3,
"internal_users": [
"04654d61-4f64-4f08-b697-3915b5137c49"
],
"external_users": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0"
],
"external_usage": 38,
"databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
"search_metadata": {
"cluster": "glue",
"database": "awsdatacatalog",
"schema": "secoda-glue",
"type": "table"
},
"sources": [
"8a3af948-026c-45d6-983d-3873f6156f86"
],
"subscribers": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"teams": [
"8680f886-97d2-4f4e-92c8-c80b46a3017d"
],
"stale": false,
"current_user_permissions": {
"read": true,
"write": true,
"execute": false
},
"database": "awsdatacatalog",
"schema": "secoda-glue",
"cluster": "text",
"creation_query": "select * from customers where country=='CAN'"
}
]
}
Create a new table with a schema as a parent. The table must be associated with an integration.
The native type of the table.
Dataset
The name of the database the table belongs to.
Sample Database
The name of the schema the table belongs to.
Sample Schema
POST /api/v1/table/tables HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 847
{
"native_type": "Dataset",
"database": "Sample Database",
"schema": "Sample Schema",
"title": "Sample Title",
"integration": "ca529385-fbc9-4934-afae-e372affe795b",
"description": "This is a description for a sample table.",
"entity_type": "glossary",
"definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
"parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
"pii": false,
"verified": true,
"published": true,
"teams": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260",
"cca810f1-11c1-4117-bc23-20ae8020897f"
],
"owners": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"owners_groups": [
"f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da"
],
"collections": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"tags": [
"04654d61-4f64-4f08-b697-3915b5137c49",
"429693a2-a5e7-4525-b413-ece5e96bc5b3"
],
"subscribers": [
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
]
}
{
"id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
"created_at": "2023-08-16T23:12:53.245493Z",
"updated_at": "2023-08-16T23:12:53.245507Z",
"entity_type": "table",
"native_type": "Dataset",
"bookmarked_by": [
"d935a76c-2125-4c30-9389-ef42fa7e23bb",
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"icon": "icon-url.png",
"title": "Sample Table",
"title_full": "Sample Database.Sample Schema.Sample Table",
"title_cased": "sampleTable",
"description": "This is a description for a sample table.",
"definition": "text",
"definition_version": 1,
"multiplayers": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
"multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
"owners": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"owners_groups": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"collections": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260"
],
"tags": [
"f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
"a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
],
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"total_usage": 483,
"published": false,
"archived": false,
"pii": true,
"verified": false,
"url": "https://example.com/sample-table",
"parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
"children_count": 2,
"integration": "ca529385-fbc9-4934-afae-e372affe795b",
"external_updated_at": "2023-08-16T23:12:53.245507Z",
"internal_usage": 3,
"internal_users": [
"04654d61-4f64-4f08-b697-3915b5137c49"
],
"external_users": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0"
],
"external_usage": 38,
"databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
"search_metadata": {
"cluster": "glue",
"database": "awsdatacatalog",
"schema": "secoda-glue",
"type": "table"
},
"sources": [
"8a3af948-026c-45d6-983d-3873f6156f86"
],
"subscribers": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"teams": [
"8680f886-97d2-4f4e-92c8-c80b46a3017d"
],
"stale": false,
"current_user_permissions": {
"read": true,
"write": true,
"execute": false
},
"database": "awsdatacatalog",
"schema": "secoda-glue",
"cluster": "text",
"creation_query": "select * from customers where country=='CAN'"
}
Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with
filter={"operator":"exact","field":"id","value":"your-table-id"}
.
ID of the table to retrieve
d935a76c-2125-4c30-9389-ef42fa7e23bb
GET /api/v1/table/tables/{table_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
{
"id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
"created_at": "2023-08-16T23:12:53.245493Z",
"updated_at": "2023-08-16T23:12:53.245507Z",
"entity_type": "table",
"native_type": "Dataset",
"bookmarked_by": [
"d935a76c-2125-4c30-9389-ef42fa7e23bb",
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"icon": "icon-url.png",
"title": "Sample Table",
"title_full": "Sample Database.Sample Schema.Sample Table",
"title_cased": "sampleTable",
"description": "This is a description for a sample table.",
"definition": "text",
"definition_version": 1,
"multiplayers": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
"multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
"owners": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"owners_groups": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"collections": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260"
],
"tags": [
"f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
"a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
],
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"total_usage": 483,
"published": false,
"archived": false,
"pii": true,
"verified": false,
"url": "https://example.com/sample-table",
"parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
"children_count": 2,
"integration": "ca529385-fbc9-4934-afae-e372affe795b",
"external_updated_at": "2023-08-16T23:12:53.245507Z",
"internal_usage": 3,
"internal_users": [
"04654d61-4f64-4f08-b697-3915b5137c49"
],
"external_users": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0"
],
"external_usage": 38,
"databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
"search_metadata": {
"cluster": "glue",
"database": "awsdatacatalog",
"schema": "secoda-glue",
"type": "table"
},
"sources": [
"8a3af948-026c-45d6-983d-3873f6156f86"
],
"subscribers": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"teams": [
"8680f886-97d2-4f4e-92c8-c80b46a3017d"
],
"stale": false,
"current_user_permissions": {
"read": true,
"write": true,
"execute": false
},
"database": "awsdatacatalog",
"schema": "secoda-glue",
"cluster": "text",
"creation_query": "select * from customers where country=='CAN'"
}
This endpoint deletes a specific table by its ID.
ID of the table to delete
e7691426-2c2a-46b4-98e7-d09d0b82b2b1
DELETE /api/v1/table/tables/{table_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*
No content
Use this endpoint to update table metadata.
ID of the table to update
d935a76c-2125-4c30-9389-ef42fa7e23bb
A description of the resource.
This is a description for a sample table.
Mark down documentation to be added to the resource.
\n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus
Indicates whether the resource contains personally identifiable information (PII). Values can be - True False
false
Indicates whether the table has been set as verified. Values can be - True False
true
Indicates if the resource is visible to viewers or not. Values can be - True False
true
A list of team IDs that the resource belongs to.
["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]
A list of owner user IDs for the resource.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
A list of collection IDs the resource belongs to.
["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]
A list of tag IDs associated with the resources.
["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]
A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.
["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]
PATCH /api/v1/table/tables/{table_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 563
{
"description": "This is a description for a sample table.",
"definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
"pii": false,
"verified": true,
"published": true,
"teams": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260",
"cca810f1-11c1-4117-bc23-20ae8020897f"
],
"owners": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"collections": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"tags": [
"04654d61-4f64-4f08-b697-3915b5137c49",
"429693a2-a5e7-4525-b413-ece5e96bc5b3"
],
"subscribers": [
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
]
}
{
"id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
"created_at": "2023-08-16T23:12:53.245493Z",
"updated_at": "2023-08-16T23:12:53.245507Z",
"entity_type": "table",
"native_type": "Dataset",
"bookmarked_by": [
"d935a76c-2125-4c30-9389-ef42fa7e23bb",
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"icon": "icon-url.png",
"title": "Sample Table",
"title_full": "Sample Database.Sample Schema.Sample Table",
"title_cased": "sampleTable",
"description": "This is a description for a sample table.",
"definition": "text",
"definition_version": 1,
"multiplayers": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
"multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
"owners": [
"429693a2-a5e7-4525-b413-ece5e96bc5b3",
"f71585fa-251c-4102-8d81-c97c57c8d435"
],
"owners_groups": [
"3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
],
"collections": [
"e8ac09ed-e51e-4e61-8eaf-59942c98c260"
],
"tags": [
"f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
"a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
],
"workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
"total_usage": 483,
"published": false,
"archived": false,
"pii": true,
"verified": false,
"url": "https://example.com/sample-table",
"parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
"children_count": 2,
"integration": "ca529385-fbc9-4934-afae-e372affe795b",
"external_updated_at": "2023-08-16T23:12:53.245507Z",
"internal_usage": 3,
"internal_users": [
"04654d61-4f64-4f08-b697-3915b5137c49"
],
"external_users": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0"
],
"external_usage": 38,
"databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
"search_metadata": {
"cluster": "glue",
"database": "awsdatacatalog",
"schema": "secoda-glue",
"type": "table"
},
"sources": [
"8a3af948-026c-45d6-983d-3873f6156f86"
],
"subscribers": [
"33733f42-8ff7-460b-9e20-50a2133d3bb0",
"c90dedee-40ee-47ec-9c27-96dc3b2ec363"
],
"teams": [
"8680f886-97d2-4f4e-92c8-c80b46a3017d"
],
"stale": false,
"current_user_permissions": {
"read": true,
"write": true,
"execute": false
},
"database": "awsdatacatalog",
"schema": "secoda-glue",
"cluster": "text",
"creation_query": "select * from customers where country=='CAN'"
}
Was this helpful?