Insurance Policy Details (GET)

Get the context ID and the insurance policy details. This includes related assets, participants, and coverages. Use query parameters to request additional information.

Resource

{policyId}, {fieldSetIds}, and {fieldSetId} are placeholders.

/connect/insurance/policies/{policyId}?_qs=contextOnly=true
/connect/insurance/policies/{policyId}?_qs=expand[attributes]=true
/connect/insurance/policies/{policyId}?_qs=expand[attributes]=true&expand[surcharges]=true
/connect/insurance/policies/{policyId}?_qs=expand[additionalFields][fieldSet][$in]={fieldSetIds}
/connect/insurance/policies/{policyId}?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId}
/connect/insurance/policies/{policyId}?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};contextOnly=true
/connect/insurance/policies/{policyId}?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};expand[attributes]=true
/connect/insurance/policies/{policyId}?_qs=expand[additionalFields][fieldSet][$eq]={fieldSetId};expand[attributes]=true&expand[surcharges]=true

Resource Example

Replace {yourInstance} with the My Domain name of your Salesforce org.

https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[attributes]=true
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA?_qs=expand[attributes]=true&expand[surcharges]=true
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=contextOnly=true
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;contextOnly=true
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTSG000000233R4AQ?_qs=expand[additionalFields][fieldSet][$in]=0IXSG000001ADt34AG,0IXSG000001AUp34AG;expand[attributes]=true
https://{yourInstance}.salesforce.com/services/data/v68.0/connect/insurance/policies/0YTxx0000000001GAA?_qs=expand[surcharges]=true

Available Version

63.0

HTTP Methods

GET

Request Parameters for GET

Parameter Name Type Description Required or Optional Available Version
connectDynamicParameters Map<String,String> Map of connect dynamic parameters. Optional 63.0

Response Body for GET