TaxonomyTermsResult

Field Type Description

termLongId

String

Term identifier and all its ancestors, as recorded in the document

displayValue

String

Display value of the term and all its ancestors, as recorded in the document

finalTermLongId

String

  • If warning field has the value STRUCTURE_CHANGED, this field gives the new ID of the term (and its ancestors) from the source taxonomy.
  • If the term has not changed, or has been deleted, the value of finalTermLongId will be the same as termLongId.

finalDisplayValue

String

  • If the warning field has the value STRUCTURE_CHANGED, this field gives the new display value of the term (and its ancestors) from the source taxonomy.
  • If the term has not changed, or has been deleted, the value of finalDisplayValue will be the same as displayValue.

key

String

Key name of the term

warning

String

Indicates if the source taxonomy for this term changed.

Note:

Possible values are:

  • NONE: indicates no changes for the term
  • STRUCTURE_CHANGED: indicates that the term has moved to a different location in the hierarchy of the source taxonomy
  • TERM_DELETED: indicates that the term no longer exists in the source taxonomy