Resources
Was this helpful?
Was this helpful?
The resource endpoint can be used to query resources in Secoda, such as Databases, Schemas, Tables, Columns, Jobs, Events, Dashboards, and Charts.
This endpoint will provide the details of an individual resource.
The ID of the resource to retrieve.
d31e59c7-cd52-4398-9d6e-da313a7b7775This endpoint allows you to delete a resource by its unique identifier (resource_id).
The unique identifier of the resource to delete
61ce0a34-ce90-4f1a-a135-f122dcbed242No content
This endpoint allows you to edit the metadata of a resource by its unique identifier (resource_id).
The unique identifier of the resource to edit
61ce0a34-ce90-4f1a-a135-f122dcbed24A 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"]Use this endpoint to update multiple entities in a single request.
For performance reasons, this endpoint can only handle a maximum of 100 entities at a time.
An array of entities to update.
The Secoda entity ID to update.
2d6e7503-8f05-4812-a5da-11863617bc62Only include the fields you would like to update.
Use this endpoint to list all catalog resources. The resources can be sorted or filtered by most of the fields in the response, using the Sort and Filter JSON objects respectively. More details about the sort and filter query parameters can be found below. The default sort is by external usage in descending order.
Please refer to our product documentation for assistance with the filter param. We have exposed a filter generator in https://app.secoda.co/settings/api to make creating these requests easier, and have also created a python script that will help you create filters programmatically.
Important Limitations:
This endpoint has a maximum limit of 10,000 resources that can be returned across all pages
For large datasets exceeding 10,000 resources, consider using more specific filter to narrow your results
The page number for paginated results.
2The ID of the team the resources should filter by.
550e8400-e29b-41d4-a716-446655440000A serialized and URL encoded JSON object to define filters on the catalog resources. See Catalog Filter for the definition of this JSON object.
%7B%22operator%22%3A%20%22and%22%2C%20%22operands%22%3A%20%5B%7B%22operator%22%3A%20%22contains%22%2C%20%22field%22%3A%20%22title%22%2C%20%22value%22%3A%20%22customers%22%7D%2C%20%7B%22operator%22%3A%20%22in%22%2C%20%22field%22%3A%20%22native_type%22%2C%20%22value%22%3A%20%5B%22table%22%2C%20%22view%22%5D%7D%2C%20%7B%22operator%22%3A%20%22in%22%2C%20%22field%22%3A%20%22integration_id%22%2C%20%22value%22%3A%20%5B%220b0d4419-841f-4413-8510-ee068487adec%22%5D%7D%2C%20%7B%22operator%22%3A%20%22in%22%2C%20%22field%22%3A%20%22parent_id%22%2C%20%22value%22%3A%20%5B%22c8878ff2-67e4-460c-a5b5-ce1ee0209d49%22%5D%7D%5D%7D%0AA serialized and URL encoded JSON object to define the sort pattern on the catalog resources. See Catalog Sort for the definition of this JSON object.
%7B%22field%22%3A%22native_type%22%2C%22order%22%3A%22asc%22%2C%22tie_breaker%22%3A%7B%22field%22%3A%22external_usage%22%2C%22order%22%3A%22asc%22%7D%7DThis endpoint allows you to create a new resource with the specified data. The title will map to the resource name, and the definition can be added to the definition field.