Are there generic options available for all API update calls?

Question

What are the options that are available for POST update API calls such as:

POST {TenantURL}/entities

POST {TenantURL}/entities/_update

POST {TenantURL}/entities/_cleanse?type={shortUriOfCleanseConfig}

POST {TenantURL}/_byUris

 

Answer

options

 

This is a comma-separated list of different options

Available options
sendHidden - disabled by default, entity's JSON will contain hidden attributes if this option is enabled.

searchByOv - disabled by default, to search by all attributes with ov only

ovOnly - return only attribute values that have ov=true flag.

 nonOvOnly - return only attribute values that have ov=false flag. If we have nested or reference attribute value which has ov=true, but at the same time it has sub-attributes with ov=false then these subattributes will not appear in the response.

activeness  

Available options

active - Default value. This option allow search among active entities

all - This option allow search among all (active/expired) entities

not_active - This option allow search among expired entities

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.