Search Item object representation

The searchitem object representation and fields are described below.

searchitem was introduced in API version V1

searchitem has not been marked for deprecation

Description

A search result item

Fields

NameTypeDescriptionConstraints
urnString representation of a Unique Resource Name. Typically a UUID with 36 characters.The URN of the result item
urlURL represented as a stringThe URL of the search item
sortOrderSigned int32The sort ordering value used internally to rank results.
typeString literalThe type of the item

Allowed values:

  • ENTITY
  • ENTITY_LIST
  • GROUP
  • IDENTITY
  • PROJECT
  • TASK

nameString literalThe search item name (if applicable). The name may be included for convenience however the representation should be accessed using it's URL for it's content.