get_record Flags

Flags are optional parameters that specify what data about an entity, record, features, or relationships to retrieve. Each function’s relevant flags are detailed here. If no flag parameter is given then the default flags are used.

get_record

These are the control flags applicable to:

  • Python: get_record
  • Java: getRecord
  • sz_command: getRecord
  • C/C++: Sz_getRecord

The default composite flag is SZ_RECORD_DEFAULT_FLAGS.

The parameter values (from our truthset) used to generate the response messages are:

SZ_RECORD_DEFAULT_FLAGS

The output of SZ_RECORD_DEFAULT_FLAGS is equivalent to:

  • SZ_ENTITY_INCLUDE_RECORD_JSON_DATA.
Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

Click to expand response JSON