Configuring synoptic labels

Configure synoptic labels for your solution. Each synoptic label is specific to an asset type. When rules are applied to a synoptic label's asset type, any assets of that type that satisfy the rules are considered to be of strategic importance. If an asset is of strategic importance, measurement readings are retrieved for the asset. The measurements to be retrieved are defined for the synoptic label.

Method

POST.

Resource URL

https://web_server_hostname/ibm/water/api/synopticlabel/SOLUTION_ID/  
    model/MODEL_ID/labelconfig

For example,

https://web-server.cn.example.com/ibm/water/api/synopticlabel/Sunshine/   
    model/SunshineWaterGroup/labelconfig

Path parameters

Table 1. Path parameters
Name	Type	Description
SOLUTION_ID	String	The ID of the solution application.
MODEL_ID	String	The model ID.

Request properties

Table 2. Request properties
Name	Type	Description
ID	String	The string ID for the synoptic label.
NAME	String	The name of the synoptic label.
ASSETTYPE	String	The ID of the asset type that is associated with the synoptic label.
TENANT_ID	String	The ID of the tenant that the synoptic label is associated with.

Sample request content

{
    "ID":"label1",
    "NAME":"name1",
    "ASSETTYPE":"WPM",
    "TENANT_ID":"SUPER_TENANT"
}

HTTP return codes

The HTTP POST method returns one of the following status codes:

Table 3. Return codes
Code	Description
204	No content. Indicates success
401	Unauthorized
500	Internal server error