How to fetch system defined term template with REST API

Question

Hi,

it seems that using this endpoint GET {endpoint}/datamap/api/atlas/v2/types/typedefs?api-version=2023-09-01&includeTermTemplate={includeTermTemplate} we can fetch only custom term templates, can we somehow to get also system defined term template with its fields.

And if one wants to import terms using Purview Portal, there is an option to load the csv file with templates. Is there any similar option for creating/updating terms with REST API?

Answer 1

@Alina Smahliuk

Thanks for reaching out to Microsoft Q&A.

To fetch system-defined term templates using the REST API, you might encounter limitations with the endpoint you mentioned, which primarily retrieves custom term templates. Unfortunately, as of now, there isn’t a direct API endpoint documented for fetching system-defined term templates alongside their fields.

Possible Workarounds:

1. Check Documentation: Sometimes, API capabilities are updated. It’s worth checking the latest Azure Purview REST API documentation for any new endpoints or parameters that might allow fetching system-defined templates.
2. Use GraphQL: If available, consider using GraphQL queries, which can sometimes provide more flexibility in fetching specific data types, including system-defined templates.

Importing Terms:

Regarding importing terms via the Purview Portal, while you can upload CSV files for templates, the REST API does not currently support bulk creation or updates of terms directly through CSV uploads. You would typically need to create or update terms one at a time using the appropriate POST or PATCH requests.

Hope this helps. Do let us know if you any further queries.