com.configcat.publicapi.java.client.api

Class FeatureFlagSettingValuesUsingSdkKeyV2Api

java.lang.Object

com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesUsingSdkKeyV2Api

public class FeatureFlagSettingValuesUsingSdkKeyV2Api
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FeatureFlagSettingValuesUsingSdkKeyV2Api()
FeatureFlagSettingValuesUsingSdkKeyV2Api(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
SettingFormulaModel	getSettingValueBySdkkeyV2(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY) Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
okhttp3.Call	getSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingFormulaModel> _callback) Get value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
okhttp3.Call	getSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) Build call for getSettingValueBySdkkeyV2
ApiResponse<SettingFormulaModel>	getSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY) Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
SettingFormulaModel	replaceSettingValueBySdkkeyV2(java.lang.String settingKeyOrId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
okhttp3.Call	replaceSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingFormulaModel> _callback) Replace value (asynchronously) This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
okhttp3.Call	replaceSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) Build call for replaceSettingValueBySdkkeyV2
ApiResponse<SettingFormulaModel>	replaceSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId, UpdateEvaluationFormulaModel updateEvaluationFormulaModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)
SettingFormulaModel	updateSettingValueBySdkkeyV2(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
okhttp3.Call	updateSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingFormulaModel> _callback) Update value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.
okhttp3.Call	updateSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) Build call for updateSettingValueBySdkkeyV2
ApiResponse<SettingFormulaModel>	updateSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FeatureFlagSettingValuesUsingSdkKeyV2Api

public FeatureFlagSettingValuesUsingSdkKeyV2Api()

FeatureFlagSettingValuesUsingSdkKeyV2Api

public FeatureFlagSettingValuesUsingSdkKeyV2Api(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

getSettingValueBySdkkeyV2Call

public okhttp3.Call getSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId,
                                                  java.lang.String X_CONFIGCAT_SDKKEY,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for getSettingValueBySdkkeyV2

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingValueBySdkkeyV2

public SettingFormulaModel getSettingValueBySdkkeyV2(java.lang.String settingKeyOrId,
                                                     java.lang.String X_CONFIGCAT_SDKKEY)
                                              throws ApiException

Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting.

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

SettingFormulaModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingValueBySdkkeyV2WithHttpInfo

public ApiResponse<SettingFormulaModel> getSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId,
                                                                              java.lang.String X_CONFIGCAT_SDKKEY)
                                                                       throws ApiException

Get value This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting.

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

ApiResponse<SettingFormulaModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

getSettingValueBySdkkeyV2Async

public okhttp3.Call getSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId,
                                                   java.lang.String X_CONFIGCAT_SDKKEY,
                                                   ApiCallback<SettingFormulaModel> _callback)
                                            throws ApiException

Get value (asynchronously) This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important fields in the response are the `defaultValue`, `targetingRules`. The `defaultValue` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting Rules, or when there are no additional rules to evaluate. The `targetingRules` represents the current Targeting Rule configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/targeting/targeting-overview/). The `percentageEvaluationAttribute` represents the custom [User Object](https://configcat.com/docs/targeting/user-object/) attribute that must be used at the [percentage evaluation](https://configcat.com/docs/advanced/targeting/#anatomy-of-the-percentage-based-targeting) of the Feature Flag or Setting.

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingValueBySdkkeyV2Call

public okhttp3.Call replaceSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId,
                                                      UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                      java.lang.String reason,
                                                      java.lang.String X_CONFIGCAT_SDKKEY,
                                                      ApiCallback _callback)
                                               throws ApiException

Build call for replaceSettingValueBySdkkeyV2

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

updateEvaluationFormulaModel - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingValueBySdkkeyV2

public SettingFormulaModel replaceSettingValueBySdkkeyV2(java.lang.String settingKeyOrId,
                                                         UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                         java.lang.String reason,
                                                         java.lang.String X_CONFIGCAT_SDKKEY)
                                                  throws ApiException

Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

updateEvaluationFormulaModel - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

SettingFormulaModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingValueBySdkkeyV2WithHttpInfo

public ApiResponse<SettingFormulaModel> replaceSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId,
                                                                                  UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                                                  java.lang.String reason,
                                                                                  java.lang.String X_CONFIGCAT_SDKKEY)
                                                                           throws ApiException

Replace value This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

updateEvaluationFormulaModel - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

ApiResponse<SettingFormulaModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

replaceSettingValueBySdkkeyV2Async

public okhttp3.Call replaceSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId,
                                                       UpdateEvaluationFormulaModel updateEvaluationFormulaModel,
                                                       java.lang.String reason,
                                                       java.lang.String X_CONFIGCAT_SDKKEY,
                                                       ApiCallback<SettingFormulaModel> _callback)
                                                throws ApiException

Replace value (asynchronously) This endpoint replaces the value and the Targeting Rules of a Feature Flag or Setting in a specified Environment identified by the <a target=\"_blank\" rel=\"noopener noreferrer\" href=\"https://app.configcat.com/sdkkey\">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other field that you don't want to change to its original state. Not listing one means it will reset. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send a replace request body as below: ```json { \"defaultValue\": { \"boolValue\": true } } ``` Then besides that the default served value is set to `true`, all the Targeting Rules are deleted. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": true }, \"targetingRules\": [] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

updateEvaluationFormulaModel - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingValueBySdkkeyV2Call

public okhttp3.Call updateSettingValueBySdkkeyV2Call(java.lang.String settingKeyOrId,
                                                     java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                     java.lang.String reason,
                                                     java.lang.String X_CONFIGCAT_SDKKEY,
                                                     ApiCallback _callback)
                                              throws ApiException

Build call for updateSettingValueBySdkkeyV2

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

jsonPatchOperation - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
204	When no change applied on the resource.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingValueBySdkkeyV2

public SettingFormulaModel updateSettingValueBySdkkeyV2(java.lang.String settingKeyOrId,
                                                        java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                        java.lang.String reason,
                                                        java.lang.String X_CONFIGCAT_SDKKEY)
                                                 throws ApiException

Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

jsonPatchOperation - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

SettingFormulaModel

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
204	When no change applied on the resource.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingValueBySdkkeyV2WithHttpInfo

public ApiResponse<SettingFormulaModel> updateSettingValueBySdkkeyV2WithHttpInfo(java.lang.String settingKeyOrId,
                                                                                 java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                                                 java.lang.String reason,
                                                                                 java.lang.String X_CONFIGCAT_SDKKEY)
                                                                          throws ApiException

Update value This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

jsonPatchOperation - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

Returns:

ApiResponse<SettingFormulaModel>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details

Status Code	Description	Response Headers
200		-
204	When no change applied on the resource.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-

updateSettingValueBySdkkeyV2Async

public okhttp3.Call updateSettingValueBySdkkeyV2Async(java.lang.String settingKeyOrId,
                                                      java.util.List<JsonPatchOperation> jsonPatchOperation,
                                                      java.lang.String reason,
                                                      java.lang.String X_CONFIGCAT_SDKKEY,
                                                      ApiCallback<SettingFormulaModel> _callback)
                                               throws ApiException

Update value (asynchronously) This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](https://jsonpatch.com) operations in a specified Environment. Only the `defaultValue`, `targetingRules`, and `percentageEvaluationAttribute` fields are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource of a Feature Flag. ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": true } } ] } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/targetingRules/0/value/boolValue\", \"value\": true } ] ``` Only the first Targeting Rule's `value` is going to be set to `false` and all the other fields are remaining unchanged. So we get a response like this: ```json { \"defaultValue\": { \"boolValue\": false }, \"targetingRules\": [ { \"conditions\": [ { \"userCondition\": { \"comparisonAttribute\": \"Email\", \"comparator\": \"sensitiveTextEquals\", \"comparisonValue\": { \"stringValue\": \"test@example.com\" } } } ], \"percentageOptions\": [], \"value\": { \"boolValue\": false } } ] } ```

Parameters:

settingKeyOrId - The key or id of the Setting. (required)

jsonPatchOperation - (required)

reason - The reason note for the Audit Log if the Product's \"Config changes require a reason\" preference is turned on. (optional)

X_CONFIGCAT_SDKKEY - The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details

Status Code	Description	Response Headers
200		-
204	When no change applied on the resource.	-
400	Bad request.	-
404	Not found.	-
429	Too many requests. In case of the request rate exceeds the rate limits.	-