bidRequirementCoverage

Requires permission biddesk:bid:read.

How many of a bid's requirements are answered, how many deviate and how many wait on a question. 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 BidRequirementCoverage($bidId: ID!) {
  bidRequirementCoverage(bidId: $bidId) {
    bidId
    covered
    deviations
    openQuestions
    total
    uncovered
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidRequirementCoverage($bidId: ID!) {\n  bidRequirementCoverage(bidId: $bidId) {\n    bidId\n    covered\n    deviations\n    openQuestions\n    total\n    uncovered\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidRequirementCoverage": {
      "bidId": "id",
      "covered": 0,
      "deviations": 0,
      "openQuestions": 0,
      "total": 0,
      "uncovered": 0
    }
  }
}

bidRequirementCoverage(
  bidId: ID!
): BidRequirementCoverage!

Arguments

bidRequirementCoverage.bidId ● ID! non-null scalar

The bid.

Type

BidRequirementCoverage object

How many of a bid's requirements are answered.