Search
K
MarketConnect-OrderEntry

Subscriber

object
* Additional properties are NOT allowed.
triggersarray[string]

NamedItem identifiers of the form fields whose value change fires this subscriber.

conditionsarray

Optional conditions that must hold for the subscriber to execute. Omitted when not used.

actionsarray[object]

Actions executed when any of the triggers fire. Each action declares an HTTP call plus one or more response handlers.

Example:{"type":"http","verb":"get","url":"/market-connect/order-entry/v1/transaction/1064727","token":"OEToken","payload":{"type":"none"},"responseHandlers":[{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}]}

* Additional properties are NOT allowed.
Show Child Parameters
Example

SubscriberAction

object
* Additional properties are NOT allowed.
typestring

The action transport. Currently always “http”.

verbstring

HTTP verb to use (e.g., “get”, “post”).

urlstring

Relative URL of the OE endpoint to call when the trigger fires. Three shapes are emitted: ‘/market-connect/order-entry/v1/dataset’ (dataset refresh); ‘/market-connect/order-entry/v1/transaction/{transactionId}/{stepName}’ (multi-step blueprint refresh); ‘/market-connect/order-entry/v1/transaction/{transactionId}’ (single/enhanced blueprint refresh).

tokenstring

Bearer-token alias forwarded by the UI on the call. Always “OEToken” today.

payloadobject

Request payload envelope. Use type “none” when no body is required.

Example:{"type":"basic","payload":{"transactionId":"1125715","stepName":"MCDPS","fieldId":"531783"}}

* Additional properties are NOT allowed.
Show Child Parameters
responseHandlersarray[object]

One or more handlers that apply the upstream response back to the form.

Example:{"type":"blueprint-modification","action":"replace-whole","value":{"type":"response-query","kind":"json-path","value":"$.data"}}

* Additional properties are NOT allowed.
Show Child Parameters
Example

SubscriberActionPayload

object
* Additional properties are NOT allowed.
typestring

Payload kind. “basic” includes a key/value map in the “payload” field; “none” omits the body.

payloadobject

Inner payload key/value map. Omitted from the JSON envelope when type is “none”.

Example

SubscriberResponseHandler

object
* Additional properties are NOT allowed.
typestring

Handler kind. “context-modification” updates a context namespace; “blueprint-modification” applies the response to the rendered blueprint.

actionstring

Action to perform within the chosen handler kind. Examples: “update-namespace”, “replace-whole”.

namespacestring

Namespace to update for context-modification handlers. Omitted for handler types that do not use a namespace.

valueobject

How to extract the value to apply from the upstream response.

Example:{"type":"response-query","kind":"json-path","value":"$.data"}

* Additional properties are NOT allowed.
Show Child Parameters
Example

SubscriberResponseValue

object
* Additional properties are NOT allowed.
typestring

Value source kind. “response-query” extracts via a query expression on the response body.

kindstring

Query language used to evaluate the value expression. Currently always “json-path”.

valuestring

The query expression itself (e.g., “$.data” to grab the response’s data branch).

Example