Field Mapping

servicerequest

relationship - required

The service request that the field mapping belongs to.

sequence

integer - required

Order in which the field mappings associated with the service request will execute. Note that this does not control the order of fields in the body of the external request — field ordering is arbitrary.

field

string - required

The name of the field in the request body of the service request. Supports lazy-instantiation of intermediate fields. For example, if request body has the shape:

{
    "person": {
        "address": {
            "street": "123 main street",
            "city": "Boston"
        }
    }
}

You can specify the streetfield using person.address.street directly.

value

expression - required

The value to associate with a field. Can be a literal value, a reference to value defined elsewhere in the integration, or a code expression. If the expression does not evaluate to a value, the retvalue variable must be used.

value_type

string - required

Typecast to perform on non-null values. If the value is an expression, the typecast is performed on the result of the expression. Options are:

• str — String

• int — Integer

• float — Floating point number

• dict — Dictionary (also known as "Object")

Incompatible typecasting (e.g. dict('5.0')) will raise an error at runtime.

valuemappingset

relationship - optional

The valuemappingset to apply to the value.

include_if

expression - optional

An expression to run to determine whether the field mapping should be included in the request. Must return a boolean. Defaults to Trueif left empty.

include_for_each

iterable - optional

Specifies an iterable. Will produce a new field mapping entry on the request for each entry in the iterable. Use fitem and fidx to refer to values in the iterable to differentiate the field mappings.

Resolves before the include_if block.

nullable

boolean - required

Indicator for whether the value can be be null at runtime. If set to falseand a null value is encountered, the integration will stop execution with an error.

message_substitution_name

string - optional

Replaces the sritem with specified string.

Documentation Fields

• target_record_type

• target_field_name

• source_record_type

• source_field_name

• notes