Skip to main content

Create or update concepts

PUT 
/platform/v1/:project-id/concepts

Creates new concepts (i.e., categories, attributes, and text values) or updates existing ones.

The request body consists of concepts and their related data and update options.

The update option syncMode determines how existing concepts are affected by the new request. If set to FULL, all concepts that are currently present in the Data Platform, but are not part of the latest request, will be deleted. In this case, it is important that the latest request represents the full ontology.

If you do not want to remove any concepts, you can set the syncMode parameter to INCREMENTAL. With this mode, new concepts can be created and existing concepts can be enriched with additional extraction rules or synonyms. No concepts will be removed.

The writeMode parameter allows you to determine whether the request should OVERWRITE existing concept data or MERGE the latest concept data with the existing concept data.

ignoreModified determines whether concepts that were adjusted manually in the Data Platform should be affected by the update. If set to true, concepts that have been modified by a user will be "ignored" during the ontology update, ensuring manual changes are preserved when automated sync processes run. In other words, if a concept was tweaked by a human in the UI, setting ignoreModified to true tells the system: "don’t touch it."

Note for multilocale setups: If your concepts have translations in multiple languages, you can define a language-dependent name as well as language-dependent synonyms and extractionRules. Extraction rules define which input data should be matched in order for a concept to be extracted and a corresponding fact created(link to documentation extraction rules).

If no extraction rules are sent, Data Platform automatically derives a MATCH extraction rule from the name. You can see the automatically-generated extraction rules in the response. The response reflects the concepts as they are stored in the Data Platform.

Request​

Responses​