bidApprovalDocument

Requires permission biddesk:bid:read.

The bid an approval request's document belongs to, for a link from the request; null for a document that is not a bid's own, an unknown one, or one on a bid you may not see. 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 BidApprovalDocument($documentId: ID!, $documentType: String!) {
  bidApprovalDocument(documentId: $documentId, documentType: $documentType) {
    bidNumber
    bidId
    tab
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidApprovalDocument($documentId: ID!, $documentType: String!) {\n  bidApprovalDocument(documentId: $documentId, documentType: $documentType) {\n    bidNumber\n    bidId\n    tab\n  }\n}",
  "variables": {
    "documentId": "id",
    "documentType": "string"
  }
}
EOF

Variables:

{
  "documentId": "id",
  "documentType": "string"
}

Response:

{
  "data": {
    "bidApprovalDocument": {
      "bidNumber": "string",
      "bidId": "id",
      "tab": "string"
    }
  }
}

bidApprovalDocument(
  documentId: ID!
  documentType: String!
): BidApprovalDocumentRef

Arguments

bidApprovalDocument.documentId ● ID! non-null scalar

The request's document ID.

bidApprovalDocument.documentType ● String! non-null scalar

The request's document type, e.g. BidProposalRevision.

Type

BidApprovalDocumentRef object

The bid an approval request's document belongs to.