Schemas
Integration ID
df2c0597-13d9-4159-bb6d-00b3f54235dcID of the database
df2c0597-13d9-4159-bb6d-00b3f54235dcTitle of the schema
Sample SchemaList of schemas.
Bad request.
Internal server error.
The ID of the schema to retrieve or update.
df2c0597-13d9-4159-bb6d-00b3f54235dcSuccessful response
Unique identifier for the schema.
The timestamp when the schema was created in Secoda.
The timestamp when the schema was last updated in Secoda.
The type of the schema.
The native type of the schema as it's referred to in the integration.
An optional icon for the schema.
The title of the schema.
The full title of the schema, including its ancestry.
The title of the schema in title case format.
Description of the schema.
The markdown documentation of the schema.
Version number of the schema documentation.
List of users interacting collaboratively on the schema [Not currently in use].
The last user to modify the schema [Not currently in use].
Timestamp of the last modification [Not currently in use].
List of User IDs associated with the schema.
List of Group IDs associated with the schema.
List of Collection IDs to which the schema belongs.
List of Tag IDs associated with the schema.
Workspace identifier in which the schema resides.
Flag indicating whether the schema is published and visible to Viewers.
Flag indicating whether the schema is archived.
Timestamp when the schema was archived.
Flag indicating if the schema contains personally identifiable information.
Flag indicating whether the schema has been verified.
URL to access the schema on the web.
Parent ID of the schema.
Number of child entities associated with this schema.
List of User IDs who have bookmarked the schema.
Identifier for integration from which the schema was extracted.
The last update timestamp of the schema in the source.
Number of times the schema has been viewed within Secoda.
List of users who have interacted with the schema in Secoda.
List of users who have interacted with the schema in the source.
Number of times the schema has been viewed or queried in the Source.
Unique identifier for the schema.
A set of properties used for indexing in search.
Data sources that augment the schema, such as dbt.
List of users subscribed to updates on the schema.
Teams IDs associated with the schema.
Flag indicating if the schema is considered stale.
Timestamp indicating when the schema was last marked as stale.
Flag indicating if the stale status of the schema was removed by a user action.
Permissions of the current user on the schema.
The number of rows present in the schema.
The size of the data used by the dashboard in bytes.
Display-specific metadata for rendering the schema in Secoda.
Status of the question [Not currently in use for Catalog resources].
Priority level of the question [Not currently in use for Catalog resources].
User ID of the person who answered the question [Not currently in use for Catalog resources].
User ID of the person to whom the question is assigned [Not currently in use for Catalog resources].
Schema not found.
Internal server error.
The ID of the schema to retrieve or update.
df2c0597-13d9-4159-bb6d-00b3f54235dcA 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 motusIndicates whether the resource contains personally identifiable information (PII). Values can be - True False
falseIndicates whether the table has been set as verified. Values can be - True False
trueIndicates if the resource is visible to viewers or not. Values can be - True False
trueA 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"]Schema updated successfully
The unique identifier of the resource.
d935a76c-2125-4c30-9389-ef42fa7e23bbThe timestamp when the resource was created in Secoda in UTC format.
2023-08-16T23:12:53.245493ZThe timestamp when the resource was last updated in Secoda in UTC format.
2023-08-16T23:12:53.245507ZThe type of resource in Secoda.
tableThe native type of the resource as it is referred to in the integration.
DatasetList of member IDs that have bookmarked the resource.
["d935a76c-2125-4c30-9389-ef42fa7e23bb","33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]The icon associated with the resource.
icon-url.pngThe title of the resource.
Sample TableThe full title of the resource, including its ancestry.
Sample Database.Sample Schema.Sample TableThe title in a cased format.
sampleTableA description of the resource.
This is a description for a sample table.The documentation of the resource, written in Mark Down format.
The version of the resource's documentation.
1List of members who have opened or worked with the resource recently.
["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]The last member who modified this resource.
429693a2-a5e7-4525-b413-ece5e96bc5b3The timestamp when the multiplayer was last modified in UTC format.
2023-08-16T23:12:53.245507ZList of owner IDs for the resource.
["429693a2-a5e7-4525-b413-ece5e96bc5b3","f71585fa-251c-4102-8d81-c97c57c8d435"]List of owner group IDs for the resource.
["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]List of IDs representing the collection(s) that the resource has been added to.
["e8ac09ed-e51e-4e61-8eaf-59942c98c260"]List of tag IDs added to the resource.
["f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2","a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"]The ID of the workspace.
f71585fa-251c-4102-8d81-c97c57c8d435The total usage count for the resource.
483Indicates if the resource is published and can be seen by Viewers.
falseIndicates if the resource is deleted.
falseIndicates if the resource contains Personally Identifiable Information (PII). Values can be - True False
trueIndicates if the resource is verified. Values can be - True False
falseThe URL associated with the resource.
https://example.com/sample-tableThe parent resource's ID.
df2c0597-13d9-4159-bb6d-00b3f54235dcThe count of children entities of the resource.
2The integration ID associated with the resource.
ca529385-fbc9-4934-afae-e372affe795bThe timestamp of the last update for the resource in the source.
2023-08-16T23:12:53.245507ZThe internal usage count for the resource.
3List of internal user IDs for the resource.
["04654d61-4f64-4f08-b697-3915b5137c49"]List of external user IDs for the resource extracted from the integration.
["33733f42-8ff7-460b-9e20-50a2133d3bb0"]The external usage count for the resource extracted from the source source. This is what is used to calculate Popularity of a resource.
38The databuilder ID associated with the resource. This is a generated field.
b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2Metadata related to indexing the resource for optimizing search.
{"cluster":"glue","database":"awsdatacatalog","schema":"secoda-glue","type":"table"}List of other integrations associated with the resource. For example, if a description is pulled in from DBT for a Snowflake table, this field will reference DBT.
["8a3af948-026c-45d6-983d-3873f6156f86"]List of User IDs who subscribe to the resource.
["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]List of team IDs associated with the resource.
["8680f886-97d2-4f4e-92c8-c80b46a3017d"]Indicates if the resource is stale. This means this resource no longer exists in the source, as of the last extraction.
falseBad request.
Schema not found.
Internal server error.
Last updated
Was this helpful?