Query metadata V2 endpoints (Public Preview)

Metadata V2 endpoints are now available in public preview. While the original metadata endpoints remain supported, upgrading to the new V2 endpoints offers improved performance and resolves potential tree navigation errors.

Both versions of the endpoints now include additional properties to better describe nodes and the relationships between them:

  • node_type - Indicates the type of node (one-to-one, one-to-many, or summary field).
  • node_path - Provides the full path from each query field back to the root of the Available Fields tree.

Current route

New route

GET /querytypes/{query_type_id}/availablefields

GET /v2/querytypes/{query_type_id}/availablefields

GET /querytypes/{query_type_id}/nodes/{node_id}/availablefields

GET /v2/querytypes/{query_type_id}/nodes/{node_id}/availablefields

POST /querytypes/{query_type_id}/nodes/availablefields

POST /v2/querytypes/{query_type_id}/nodes/availablefields

GET /summaryfields/{summary_field_id}/availablefields

GET /v2/summaryfields/{summary_field_id}/availablefields

GET /summaryfields/{summary_field_id}/nodes/{node_id}/availablefields

GET /v2/summaryfields/{summary_field_id}/nodes/{node_id}/availablefields

GET /querytypes/{query_type_id}/availablefields/search

GET /v2/querytypes/{query_type_id}/availablefields/search

For details on available operations, see the Query API endpoint reference.

Categories