bidUsuallyIncluded

Requires permission biddesk:bid:read.

Items comparable past configurations of the same assembly usually had that this bid's configuration lacks, each with how many had it and the bids behind it. Counts only bids the caller may see and imported history. Requires Bid Desk and permission to read bids.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidUsuallyIncluded($bidId: ID!) {
  bidUsuallyIncluded(bidId: $bidId) {
    productName
    confidenceBp
    present
    productId
    support
    refs {
      id
      kind
      reference
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidUsuallyIncluded($bidId: ID!) {\n  bidUsuallyIncluded(bidId: $bidId) {\n    productName\n    confidenceBp\n    present\n    productId\n    support\n    refs {\n      id\n      kind\n      reference\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidUsuallyIncluded": [
      {
        "productName": "string",
        "confidenceBp": 0,
        "present": 0,
        "productId": "id",
        "support": 0,
        "refs": [
          {
            "id": "id",
            "kind": "BID",
            "reference": "string"
          }
        ]
      }
    ]
  }
}

bidUsuallyIncluded(
  bidId: ID!
  configurationId: ID
): [BidUsuallyIncludedItem!]!

Arguments

bidUsuallyIncluded.bidId ● ID! non-null scalar

The bid.

bidUsuallyIncluded.configurationId ● ID scalar

The configuration; the bid's latest (frozen first) by default.

Type

BidUsuallyIncludedItem object

An item comparable past configurations of the same assembly usually had and this one lacks. Carries no amount.