Skip to content
Documentation

TSM Custom Flags Configuration

Custom flags offer the opportunity to further distinguish and prioritize values by defining flags with a name, a value and a priority.

HAKOM:TSM:Flags
Flags
└─ CustomFlags
└─ CustomFlag
└─ {Name}
├─ Name (must repeat {Name})
├─ Value
└─ Priority
<HAKOM>
<TSM>
<Flags>
<CustomFlags>
<CustomFlag Name="MyCustomFlag">
<Value>42</Value>
<Priority>199</Priority>
</CustomFlag>
<!-- insert more here -->
</CustomFlags>
</Flags>
</TSM>
</HAKOM>

Custom flags require the same properties that existing flags offer.

Path: HAKOM:TSM:Flags:CustomFlags:CustomFlag:{Name}

Element Type Default Required Description
Name string — ✓ Name of the custom flag. Must repeat the {Name} key; in XML the Name attribute of <CustomFlag> supplies both.
Value int — ✓ Value of the custom flag.
Priority int — ✓ Priority of the custom flag.

The configured custom flags are returned together with the built-in flags by the flags endpoint. The response below is shortened.

Request

GET /flags

Response

[
{
"value": 0,
"priority": 0,
"name": "Ignore"
},
{
"value": 42,
"priority": 199,
"name": "MyCustomFlag"
}
]
© 2026 Volue.Version v0.6.38017 November 2026