Package com.cumulocity.sdk.client.option
Interface SystemOptionApi
-
- All Known Implementing Classes:
SystemOptionApiImpl
public interface SystemOptionApi
API for retrieving system options from the platform.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description OptionRepresentation
getOption(OptionPK optionPK)
Gets an option by id Requires role ROLE_OPTION_MANAGEMENT_READ
-
-
-
Method Detail
-
getOption
OptionRepresentation getOption(OptionPK optionPK) throws SDKException
Gets an option by id Requires role ROLE_OPTION_MANAGEMENT_READ- Parameters:
optionPK
- id of the option to search for- Returns:
- the system option with the given id
- Throws:
SDKException
- if the option is not found or if the query failed
-
-