ConnectApi.InsLookupErrorCodeRepresentation

Output representation that contains the looked-up error code description, optional cause, resolution instructions, and any request-level errors.

Property NameTypeDescriptionAvailable Version
errorCauseStringDetailed explanation of the underlying business logic or validation rule that triggered this error. This property is omitted if a cause is unavailable or null.68.0
errorCodeStringError code that’s looked up.68.0
errorDescriptionStringHuman-readable description of the error. For known error codes, this is the registered description. It shows an informative “not found” message if the error code is unrecognized.68.0
errorsList<ConnectApi.InsDesignAdvisor​Error​Response​Representation>List of request-level validation or processing errors encountered before executing business logic. Present when the request fails basic validation (such as a missing or blank errorCode). Empty or null on a successful lookup.68.0
instructionsStringStep-by-step troubleshooting guidance to resolve the error. For known codes with an instructions section, this is the localized instruction text. For unknown codes, this property provides format guidance.68.0