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
TransactionResponse
objectThe unique identifier for the created transaction
>= 1 characters
The case identifier returned by the product service
Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).
The blueprint containing section and field definitions
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"}
Show Child Parameters
UpdateTransactionRequest
objectTransaction update request. The data property matches TransactionResponse.data (field id → array of QuestionData rows, with index for collection rows). A field value may also be a single QuestionData object when prefilled (see prefilled on QuestionData).
Dictionary keyed by question id or composite collection field id; values are arrays of QuestionData (includes index for collection rows).
ValidationCondition
objectSingle validation condition inside a FieldValidationRule. The shape varies by type: matchesRegexCondition uses regex; numberComparisonCondition uses value + operator; characterCountInBetween uses value: { minLength, maxLength }.
The kind of validation this condition performs.
Allowed values:matchesRegexConditionnumberComparisonConditioncharacterCountInBetween
Example:matchesRegexCondition
The answer node identifier this condition evaluates.
Example:Transaction.Beneficiaries[0].EmailAddresses["Home"].Address
Regex pattern. Only used when type is matchesRegexCondition.
Example:^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
Comparison operator. Only used when type is numberComparisonCondition.
Allowed values:lessThanlessThanOrEqualgreaterThangreaterThanOrEqualequalnotEqual
Example:lessThan
Any OfCondition-specific value. Number for numberComparisonCondition; object { minLength, maxLength } for characterCountInBetween. Absent for matchesRegexCondition.
Example:9999999999