Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

GetPolicy(policyId, connectDynamicParameters)

Get details of an insurance policy. Pass additional context or metadata to customize the information that's fetched.

API Version

63.0

Requires Chatter

Signature

public static ConnectApi.GetPolicyOutputRepresentation GetPolicy(String policyId, Map<String,String> connectDynamicParameters)

1ConnectApi.InsurancePolicyAdminFamily, GetPolicy, [String, Map<String,String>], ConnectApi.GetPolicyOutputRepresentation

Parameters

policyId: Type: String; ID of the policy for which the details are to be fetched.
connectDynamicParameters: Type: Map<String,String>; Map of connect dynamic parameters to fetch the policy details.

Return Value

Type: ConnectApi.GetPolicyOutputRepresentation

Usage

Use this API to fetch the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.

When the contextOnly parameter is true, the API returns a context ID along with the insurance policy details.
When you send a request with additional fields with the operator $in, it returns a list of field-set IDs. When the operator is $eq, the request returns a single field-set ID.

For examples, see Get Policy.

Insurance Developer Guide