BidSearchHit

One search hit: something the caller can open, and the console path that opens it.

type BidSearchHit {
  bidId: ID
  bidNumber: String
  id: ID!
  kind: BidSearchKind!
  path: String!
  snippet: String
  title: String!
}

Fields

BidSearchHit.bidId ● ID scalar

The bid the hit belongs to; null for a knowledge note whose source bid the caller cannot see.

BidSearchHit.bidNumber ● String scalar

The number of the bid the hit belongs to; null when bidId is.

BidSearchHit.id ● ID! non-null scalar

The id of the hit: the bid, requirement, cost line, thread or knowledge note.

BidSearchHit.kind ● BidSearchKind! non-null enum

What kind of thing the hit is.

BidSearchHit.path ● String! non-null scalar

The console path that opens the exact item.

BidSearchHit.snippet ● String scalar

The matched text around the match, at most 160 characters.

BidSearchHit.title ● String! non-null scalar

The line that names the hit.

Member Of

BidSearchResult object