| Method | HTTP request | Description |
|---|---|---|
| getByPath | GET /enumerationvalues | Retrieve an enumeration value by path. |
| get | GET /enumerationvalues/{webId} | Retrieve an enumeration value mapping |
| updateEnumerationValue | PATCH /enumerationvalues/{webId} | Update an enumeration value by replacing items in its definition. |
| deleteEnumerationValue | DELETE /enumerationvalues/{webId} | Delete an enumeration value from an enumeration set. |
getByPath(String path, String selectedFields, String webIdType)
Retrieve an enumeration value by path.
| Name | Type | Description | Notes |
|---|---|---|---|
| path | String | The path to the target enumeration value.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | 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".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
get(String webId, String selectedFields, String webIdType)
Retrieve an enumeration value mapping
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the enumeration value.. | [required] |
| selectedFields | String | List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned.. | [optional] |
| webIdType | String | 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".. | [optional] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
updateEnumerationValue(String webId, PIEnumerationValue enumerationValue)
Update an enumeration value by replacing items in its definition.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the enumeration value to update.. | [required] |
| enumerationValue | PIEnumerationValue | A partial enumeration value containing the desired changes.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]
deleteEnumerationValue(String webId)
Delete an enumeration value from an enumeration set.
| Name | Type | Description | Notes |
|---|---|---|---|
| webId | String | The ID of the enumeration value.. | [required] |
[Back to top] [Back to API list] [Back to Model list] [Back to DOCUMENTATION]