Example - usage information

crossTerm instances typically have a data category at term level, which represents information on usage (standardization: should this term be used or not?). It is a picklist data category, the values of which are defined by special "Usage" flags. These flags are Recommended (term is preferred) and DoNotUse (term should not be used).

Example:

The query for api/v1/Instances(key)/DataCategories will contain the description of this data category, among others.

"odata.type":"Across.Services.CrossTerm.Model.PicklistDataCategory","Id":21,"Type":"Picklist","Name":"Usage","AllowMultipleValues":false,"Scope":"Term","InstanceId":1,"Values":[{"ValueId":"8d7c76c5-9f0c-49e3-a59a-ac28db986212","TextLong":"Standard","TextShort":"Standard","Usage":"Recommended","IsDefault":false},{"ValueId":"2e087bdc-579f-4a56-b573-a549480cb628","TextLong":"Synonym","TextShort":"Syn","Usage":"Normal","IsDefault":false},{"ValueId":"9cfd8dc8-8d9e-408e-a264-8aedc00e90be","TextLong":"Unwort","TextShort":"Unwort","Usage":"DoNotUse","IsDefault":false}]

This information shows which properties of terms should be interpreted if the application is interested in Usage information: It is the data category Usage.

Tip

Theoretically, more than one picklist at term level may have values with the flags Recommended and/or DoNotUse. However, in practice, there is usually only one such picklist, and all values of all other picklists have Usage: Normal.

The query for api/v1/Terms(key)/Properties will contain all properties of the term with this key. These are instantiations of data categories, for example of the "Usage" data category. In the following result example, we see that also at this level, the Usage flag is represented for each property.

Example request

http://localhost/Across/CrossTerm/api/v1/Terms(7487)/Properties

Example result

{"odata.metadata":"http://localhost/Across/CrossTerm/api/v1/$metadata#Properties","value":[{"odata.type":"Across.Services.CrossTerm.Model.PicklistProperty","Id":3079,"Name":"Wortklasse","DataCategoryId":2,"Values":[{"ValueId":"1128aafc-085b-4bb8-b25e-38a89baeef93","TextLong":"Substantiv","TextShort":"n","Usage":"Normal","IsDefault":true}]},{"odata.type":"Across.Services.CrossTerm.Model.PicklistProperty","Id":3080,"Name":"Verwendung","DataCategoryId":21,"Values":[{"ValueId":"8d7c76c5-9f0c-49e3-a59a-ac28db986212","TextLong":"Standard","TextShort":"Standard","Usage":"Recommended","IsDefault":false}]}]}

So, in this example, the usage of the term with key 7487 is recommended.