EnumerationValue Get
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
EnumerationValue Get
Retrieve an enumeration value mapping
Request
GET enumerationvalues/{webId}
URL Parameters
-
webId The ID of the enumeration value. See WebID for more information.
-
selectedFields List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.
-
webIdType Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.
Status Codes
200: The specified enumeration value mapping
Sample Response Body
{
"WebId": "I1MVRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQlIYqmOlvs0ygEQnSeGSe7w",
"Id": "982a8694-6fe9-4cb3-a011-09d278649eef",
"Name": "CarBrand|Model3",
"Description": "Model Number of CarBrand",
"Value": 2005,
"Path": "\\\\MyAssetServer\\MyDatabase\\EnumerationSets[Model Number]\\CarBrand|Model3",
"Parent": "CarBrand",
"Links": {
"Self": "https://localhost.osisoft.int/piwebapi/enumerationvalues/I1MVRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQlIYqmOlvs0ygEQnSeGSe7w"
}
}