Skip to main content

Gets dealScenario via a single related deal

GET/jsonapi/deals/{id}/dealScenario

Where id is the identifier of the deal

Access

Bearer authentication. Confirm your scopes, data access and required adviser context.

Request parameters

id path required

idinteger

format: int32

include query

Comma-separated relationship paths for the response representation. Use dots for nested relationships.

includearray
Array itemstring

fields query

Select response attributes and relationships by resource type, including included resources. Each value is a comma-separated list of public field names, for example fields[articles]=title,body. Does not affect which request fields are written.

fieldsobject
Additional propertystring

Example request

Use your supplied API base URL and replace path placeholders such as {id}. These examples run in your backend or terminal, where your credentials are kept.

curl --globoff --request GET "${API_BASE_URL}/jsonapi/deals/{id}/dealScenario" \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "UserId: $ADVISER_CONTACT_ID" \
--header 'Accept: application/vnd.api+json'

Responses

200 response

application/vnd.api+json

Example response body

Generated from the OpenAPI Specification with illustrative values. Shows primary data and attributes where defined; optional links, relationships and included resources are omitted. Actual values and returned fields depend on your request and access.

{
"data": {
"type": "deal-scenario",
"id": "1001",
"attributes": {}
}
}
200 responseobjectDealScenarioDocument ↗
metaobjectread only
jsonApiobjectread only
linksall ofread only
dataobjectrequiredDealScenario ↗
includedarray · nullableread only

For guidance beyond this operation's schema, see troubleshooting and JSON:API explained.