Watson Marketing Insights Configuration API Service

Beta

Watson Marketing Insights Configuration API Service

+ Day(s) remaining in the trial

Overview

Use the configuration API parameters to set values for a the general WMI application parameters. Tasks may include:

  • Get a list of configuration parameters in the system
  • Get the details about a configuration parameter
  • Update a configuration parameter value

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Documentation

Watson Marketing Insights Configuration API Service:

Config

Config
Get all configuration parameters.
Retrieves a list of all configuration parameters.

GET   /config

			https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config
		
Keys
Request code
								
HttpResponse<String> response = Unirest.get("https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config") .header("accept", "application/json") .header("authorization", "APIKey yourapikeyvalue") .asString();
Response model

200

A list of all configuration parameters was returned successfully.

Body

paramName

STRING , required

Response example

200

A list of all configuration parameters was returned successfully.

								{
  "paramName" : string
}
							
Get a specific configuration parameter
Retrives name/value pairs of a configuration parameter

GET   /config/{configParamName}

			https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/{configParamName}
		
Keys
Path and Query parameters

configParamName

URL , required

Request code
								
HttpResponse<String> response = Unirest.get("https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/{configParamName_string}") .header("accept", "application/json") .header("authorization", "APIKey yourapikeyvalue") .asString();
Response model

200

Configuration parameter

Body

paramName

STRING , required

Response example

200

Configuration parameter

								{
  "paramName" : string
}
							
Update a configuration parameter.
Modifies a specific configuration parameter.

PATCH   /config/{configParamName}

			https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/{configParamName}
		
Keys
Path and Query parameters

configParamName

URL , required

Request code
								
HttpResponse<String> response = Unirest.patch("https://wmi-rest-api-r1.watsonmarketinginsights.ibm.com/api/v1/config/{configParamName_string}") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "APIKey yourapikeyvalue") .asString();
Request model

value

STRING , optional

Response model

200

The config parameter was modified successfully

Body

validationExpression

STRING , required

description

STRING , required

name

STRING , required

validationType

STRING , required

value

STRING , required

defaultValue

STRING , required

Response example

200

The config parameter was modified successfully

								{
  "validationExpression" : string,
  "description" : string,
  "name" : string,
  "validationType" : string,
  "value" : string,
  "defaultValue" : string
}
							

Loading content...