Data models
List elements in a data model
This endpoint retrieves details of all elements in a data model, which helps you understand and interact with the individual components that make up the data model, such as tables or controls.
Usage notes
- Retrieve the dataModelId by calling the /v2/dataModels endpoint.
- To retrieve elements from version-tagged data models, pass the tagName in the query parameters with the tag name. Retrieve the tag name by calling the /v2/dataModels/{dataModelId}/tags endpoint and using the tags.name included in the response for a given data model.
Usage scenarios
- Detailed analysis: Developers and users can retrieve specific elements for detailed data analysis or further manipulation.
- Interface customization: Allows for dynamic interface construction where users can choose which elements to display or interact with.
Best practices
- Use pagination to handle large numbers of elements efficiently, reducing load times and improving user experience.
get/v2/dataModels/{dataModelId}/elements
Request
- Base URLhttps://api.sigmacomputing.com
- AuthHTTP bearer
Path parameters
dataModelIdstring required
Unique identifier of the data model.
Query parameters
pagestring
Use to specify further pages using the string returned in the nextPage portion of the response.
limitnumber double
Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.
tagNamestring
Response
The response body.
Changes
No recorded changes to this operation across all 1 revision of this API.