EmbeddedDataFlowElement

Embedded data flow element.

Typestring

Type of embedded data flow element.

Possible values: [EmbeddedData]

FlowIDFlow Id (string)

Unique identifier. Should be of form FL_1

Possible values: Value must match regular expression ^FL_[1-9][0-9]*$

EmbeddedData object[]

Embedded data.

Array [

Descriptionstringrequired

A user-provided description of the embedded data.

Possible values: <= 100 characters

Typestringrequired

The type of embedded data.

Possible values: [Recipient, Custom, EmbeddedData]

Fieldstringrequired

Field for embedded data.

Possible values: <= 100 characters

VariableTypestring

Variable type.

Possible values: [Nominal, MultiValueNominal, Ordinal, Scale, String, Date, FilterOnly, Filter Only]

DataVisibility object

Visibility of data.

Privateboolean

If true, data is private.

Hiddenboolean

If true, data is hidden.

AnalyzeTextboolean

If true, analyze embedded data text.

Valuestring

An attribute associated with key.

Possible values: <= 100 characters

property name*any

]

property name*any

Embedded data flow element.

EmbeddedDataFlowElement

{
  "Type": "EmbeddedData",
  "FlowID": "string",
  "EmbeddedData": [
    {
      "Description": "string",
      "Type": "Recipient",
      "Field": "string",
      "VariableType": "Nominal",
      "DataVisibility": {
        "Private": true,
        "Hidden": true
      },
      "AnalyzeText": true,
      "Value": "string"
    }
  ]
}