Skip to content
Structured Products

Get Structured Product Display Elements

Returns the display elements (labels and values) that the service configures for a structured product in a given display scene. Render the items in order. Pass the product counter_id as target_id. Known scenes:

  • product_details - Product elements section of the product detail page
  • product_details_view_more - “View more” information page of the product detail
  • product_position_basic_information - Basic information page of a held product

For elements whose link_type is pdf, open link as a PDF. Elements whose key is underlying_name can link to the security detail. Do not display elements whose key is underlying_counter_id. Code 2100005 means no elements are configured for the product in this scene; tell the Client the information is not available.

GEThttps://api.lbkrs.com/v1/wms/target/detail

Parameters

scenestringqueryRequired

Display scene. See the operation description for values

target_idstringqueryRequired

Target ID. Pass the structured product counter_id

idea_idstringquery

Product idea ID from the product list

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get Structured Product Display Elements” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
scenestring

Display scene of this response

target_idstring

Target ID

keywordsarray<object>

Display elements in display order

Child attributes
keystring

Element key that identifies the element type. underlying_name is the underlying name and can link to the security detail. underlying_counter_id is for association only and is not displayed

titlestring

Element label

contentstring

Element display value

linkstring

Link associated with the element. May be empty

link_typestring

Link type:

  • pdf - Open link as a PDF file
  • direct - Open link directly
HTTP 400The service rejected the request because a business rule or input validation failed. Review the business codes and correct the request before retrying.
codeintegerrequired

Business status code, 0 indicates success

messagestringrequired

Human-readable result or error message.

Whale Docs