Class FeatureFlagSettingValuesUsingSdkKeyApi
- java.lang.Object
-
- com.configcat.publicapi.java.client.api.FeatureFlagSettingValuesUsingSdkKeyApi
-
public class FeatureFlagSettingValuesUsingSdkKeyApi extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description FeatureFlagSettingValuesUsingSdkKeyApi()FeatureFlagSettingValuesUsingSdkKeyApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApiClientgetApiClient()java.lang.StringgetCustomBaseUrl()intgetHostIndex()SettingValueModelgetSettingValueBySdkkey(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.CallgetSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _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.CallgetSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback)Build call for getSettingValueBySdkkeyApiResponse<SettingValueModel>getSettingValueBySdkkeyWithHttpInfo(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.SettingValueModelreplaceSettingValueBySdkkey(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY)Replace value This endpoint replaces 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.CallreplaceSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _callback)Replace value (asynchronously) This endpoint replaces 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.CallreplaceSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback)Build call for replaceSettingValueBySdkkeyApiResponse<SettingValueModel>replaceSettingValueBySdkkeyWithHttpInfo(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY)Replace value This endpoint replaces 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.voidsetApiClient(ApiClient apiClient)voidsetCustomBaseUrl(java.lang.String customBaseUrl)voidsetHostIndex(int hostIndex)SettingValueModelupdateSettingValueBySdkkey(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 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.CallupdateSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _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 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.CallupdateSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback)Build call for updateSettingValueBySdkkeyApiResponse<SettingValueModel>updateSettingValueBySdkkeyWithHttpInfo(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 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.
-
-
-
Constructor Detail
-
FeatureFlagSettingValuesUsingSdkKeyApi
public FeatureFlagSettingValuesUsingSdkKeyApi()
-
FeatureFlagSettingValuesUsingSdkKeyApi
public FeatureFlagSettingValuesUsingSdkKeyApi(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)
-
getSettingValueBySdkkeyCall
public okhttp3.Call getSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) throws ApiExceptionBuild call for getSettingValueBySdkkey- 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. -
-
getSettingValueBySdkkey
public SettingValueModel getSettingValueBySdkkey(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 attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules 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/).- Parameters:
settingKeyOrId- The key or id of the Setting. (required)X_CONFIGCAT_SDKKEY- The ConfigCat SDK Key. (https://app.configcat.com/sdkkey) (optional)- Returns:
- SettingValueModel
- 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. -
-
getSettingValueBySdkkeyWithHttpInfo
public ApiResponse<SettingValueModel> getSettingValueBySdkkeyWithHttpInfo(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 attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules 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/).- 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<SettingValueModel>
- 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. -
-
getSettingValueBySdkkeyAsync
public okhttp3.Call getSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _callback) throws ApiExceptionGet 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 attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules 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/).- 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. -
-
replaceSettingValueBySdkkeyCall
public okhttp3.Call replaceSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) throws ApiExceptionBuild call for replaceSettingValueBySdkkey- Parameters:
settingKeyOrId- The key or id of the Setting. (required)updateSettingValueModel- (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. -
-
replaceSettingValueBySdkkey
public SettingValueModel replaceSettingValueBySdkkey(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) throws ApiException
Replace value This endpoint replaces 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. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ```- Parameters:
settingKeyOrId- The key or id of the Setting. (required)updateSettingValueModel- (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:
- SettingValueModel
- 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. -
-
replaceSettingValueBySdkkeyWithHttpInfo
public ApiResponse<SettingValueModel> replaceSettingValueBySdkkeyWithHttpInfo(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY) throws ApiException
Replace value This endpoint replaces 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. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ```- Parameters:
settingKeyOrId- The key or id of the Setting. (required)updateSettingValueModel- (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<SettingValueModel>
- 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. -
-
replaceSettingValueBySdkkeyAsync
public okhttp3.Call replaceSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, UpdateSettingValueModel updateSettingValueModel, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _callback) throws ApiExceptionReplace value (asynchronously) This endpoint replaces 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. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send a replace request body as below: ```json { \"value\": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ```json { \"rolloutPercentageItems\": [], \"rolloutRules\": [], \"value\": true } ```- Parameters:
settingKeyOrId- The key or id of the Setting. (required)updateSettingValueModel- (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. -
-
updateSettingValueBySdkkeyCall
public okhttp3.Call updateSettingValueBySdkkeyCall(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback _callback) throws ApiExceptionBuild call for updateSettingValueBySdkkey- 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. -
-
updateSettingValueBySdkkey
public SettingValueModel updateSettingValueBySdkkey(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 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 `value`, `rolloutRules` and `percentageRules` attributes 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default served value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ```- 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:
- SettingValueModel
- 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. -
-
updateSettingValueBySdkkeyWithHttpInfo
public ApiResponse<SettingValueModel> updateSettingValueBySdkkeyWithHttpInfo(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 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 `value`, `rolloutRules` and `percentageRules` attributes 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default served value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ```- 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<SettingValueModel>
- 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. -
-
updateSettingValueBySdkkeyAsync
public okhttp3.Call updateSettingValueBySdkkeyAsync(java.lang.String settingKeyOrId, java.util.List<JsonPatchOperation> jsonPatchOperation, java.lang.String reason, java.lang.String X_CONFIGCAT_SDKKEY, ApiCallback<SettingValueModel> _callback) throws ApiExceptionUpdate 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 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 `value`, `rolloutRules` and `percentageRules` attributes 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. ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": false } ``` If we send an update request body as below: ```json [ { \"op\": \"replace\", \"path\": \"/value\", \"value\": true } ] ``` Only the default served value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ```json { \"rolloutPercentageItems\": [ { \"percentage\": 30, \"value\": true }, { \"percentage\": 70, \"value\": false } ], \"rolloutRules\": [], \"value\": true } ```- 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. -
-
-