bidApprovals

Requires permission biddesk:bid:read.

Lists the approval requests on a bid's own documents (the bid, its cost sheets, proposal revisions and deviations), newest first; a request you may not read in the approvals inbox is left out, and a bid you may not see lists nothing. 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 BidApprovals($bidId: ID!) {
  bidApprovals(bidId: $bidId) {
    documentId
    documentLabel
    documentType
    request {
      id
      documentNumber
      appliedByName
      onBehalfOfName
      requesterName
      resolvedByName
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidApprovals($bidId: ID!) {\n  bidApprovals(bidId: $bidId) {\n    documentId\n    documentLabel\n    documentType\n    request {\n      id\n      documentNumber\n      appliedByName\n      onBehalfOfName\n      requesterName\n      resolvedByName\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidApprovals": [
      {
        "documentId": "id",
        "documentLabel": "string",
        "documentType": "string",
        "request": {
          "id": "id",
          "documentNumber": "string",
          "appliedByName": "string",
          "onBehalfOfName": "string",
          "requesterName": "string",
          "resolvedByName": "string"
        }
      }
    ]
  }
}

bidApprovals(
  bidId: ID!
  take: Int = 50
): [BidApprovalEntry!]!

Arguments

bidApprovals.bidId ● ID! non-null scalar

The bid.

bidApprovals.take ● Int scalar

How many requests to return, at most 100.

Type

BidApprovalEntry object

One approval request on one of a bid's own documents.