SubscriberResponseHandler
objectHandler kind. “context-modification” updates a context namespace; “blueprint-modification” applies the response to the rendered blueprint.
Action to perform within the chosen handler kind. Examples: “update-namespace”, “replace-whole”.
Namespace to update for context-modification handlers. Omitted for handler types that do not use a namespace.
How to extract the value to apply from the upstream response.
Example:{"type":"response-query","kind":"json-path","value":"$.data"}
Show Child Parameters
SubscriberResponseValue
objectValue source kind. “response-query” extracts via a query expression on the response body.
Query language used to evaluate the value expression. Currently always “json-path”.
The query expression itself (e.g., “$.data” to grab the response’s data branch).
SubsectionBlueprint
objectThe unique identifier for the subsection
>= 1 characters
The part name for the subsection
>= 1 characters
Text content for the subsection
Show Child Parameters
The title of the subsection
Show Child Parameters
Indicates if this is a custom subsection
Array of field groups within this subsection
Show Child Parameters
Array of nested subsections within this subsection
Show Child Parameters
Indicates if this subsection should be shown in navigation
Role identifier controlling copy behavior. Use ‘none’ to disable copying, or a role name (e.g., ‘owner’, ‘annuitant’, ‘insured’, ‘payor’). Multiple roles may be comma-separated.
Visibility conditions for the subsection. When present, the subsection is only visible when all conditions are met. Example: { “booleanOperator”: “AND”, “conditions”: [ { “type”: “equality”, “isEqual”: true, “value”: “NY”, “targetNodeId”: “SolicitationStateCode” } ] }
Example:{"booleanOperator":"AND","conditions":[{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"},{"type":"equality","isEqual":true,"value":"Yes","targetNodeId":"Transaction.SolicitationState"}]}
Show Child Parameters
Repeat-instance metadata when the wizard subsection or custom control declares IsRepeated.
Show Child Parameters
TransactionDataQuestionRowsMap
objectAnswers keyed by blueprint question id or composite collection field id. Named properties below are representative examples (same keys as the default example); any other field id is valid and uses the same value shape (see additionalProperties → QuestionDataRows → QuestionData). Each array entry is one row; use index for repeatable collection instances.
One row of captured or echoed answer data. Must include id, type, and value (the JSON property value must be present on each row; use JSON null for an empty optional answer when applicable). On PUT, id must match the enclosing data field key (or the leaf key inside a collection item’s data). type must be a QuestionData storage type (see QuestionDataStorageTypes); collection value rows use collectionItem on each CollectionItem.
Show Child Parameters
TransactionResponse
objectThe unique identifier for the created transaction
>= 1 characters
The case identifier returned by the product service
Answers keyed by blueprint question id or composite collection field id. Named properties below are representative examples (same keys as the default example); any other field id is valid and uses the same value shape (see additionalProperties → QuestionDataRows → QuestionData). Each array entry is one row; use index for repeatable collection instances.
Example:{"259726":[{"id":"259726","type":"dropdown","questionText":"Account designation","questionSubText":"Account designation","displayValue":"Owner","value":"Owner","index":0}],"486958":[{"id":"486958","type":"date","questionText":"Date of birth","questionSubText":"","displayValue":"1989-10-13","value":"1989-10-13","index":0}],"488043":[{"id":"488043","type":"radio","questionText":"Gender","questionSubText":"","displayValue":"Male","value":"Male","index":0}],"489353_FirstName_Main":[{"id":"489353_FirstName_Main","type":"text","questionText":"First Name","questionSubText":"","displayValue":"John","value":"John","index":0}],"489353_LastName_Main":[{"id":"489353_LastName_Main","type":"text","questionText":"Last Name","questionSubText":"","displayValue":"Doe","value":"Doe","index":0}]}
Show Child Parameters
Show Child Parameters
Reactive subscriber definitions consumed by the UI. Each subscriber declares trigger fields, an HTTP action to run on change, and a response handler. Two flavors are emitted: dataset-dependency (context-modification) and blueprint-modification (replace-whole).
Example:{"triggers":["FirstName"],"actions":[{"type":"http","verb":"get","url":"/market-connect/order-entry/v1/transaction/1125715/MCDPS","token":"OEToken","payload":{"type":"none"},"responseHandlers":[{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}]}]}
Show Child Parameters
Collection of errors if the operation failed
Example:{"code":"VALIDATION_ERROR","description":"Input validation failed","details":"One or more input fields are invalid","timestamp":"2024-01-15T10:30:00.000Z"}
Show Child Parameters
One validation message in API shape. Optional properties are omitted in JSON when null (e.g. fieldId is missing or 0).
Example:{"fieldId":"BeneficiaryAddress","answerNodeId":"Transaction.PrimaryOwner.PersonName.Prefix","message":"First name is required","sectionName":"EntityOwners"}