bidApprovalPreview

Requires permission biddesk:bid:read.

What would happen if a bid step were submitted now: which enforced rules match and which approval stages each would need. Runs the rules without raising, counting or writing anything, and returns no condition value. Steps: proposal.release, proposal.revise, costing.submit, bid.go and deviation.accept (any other is refused); null when the step has no document on the bid now. 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 BidApprovalPreview($bidId: ID!, $checkpoint: String!) {
  bidApprovalPreview(bidId: $bidId, checkpoint: $checkpoint) {
    checkpoint
    documentId
    documentType
    outcome
    rules {
      title
      controlId
      message
      outcome
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidApprovalPreview($bidId: ID!, $checkpoint: String!) {\n  bidApprovalPreview(bidId: $bidId, checkpoint: $checkpoint) {\n    checkpoint\n    documentId\n    documentType\n    outcome\n    rules {\n      title\n      controlId\n      message\n      outcome\n    }\n  }\n}",
  "variables": {
    "bidId": "id",
    "checkpoint": "string"
  }
}
EOF

Variables:

{
  "bidId": "id",
  "checkpoint": "string"
}

Response:

{
  "data": {
    "bidApprovalPreview": {
      "checkpoint": "string",
      "documentId": "id",
      "documentType": "string",
      "outcome": "string",
      "rules": [
        {
          "title": "string",
          "controlId": "id",
          "message": "string",
          "outcome": "string"
        }
      ]
    }
  }
}

bidApprovalPreview(
  bidId: ID!
  checkpoint: String!
): BidApprovalPreview

Arguments

bidApprovalPreview.bidId ● ID! non-null scalar

The bid.

bidApprovalPreview.checkpoint ● String! non-null scalar

The step to preview, e.g. proposal.release.

Type

BidApprovalPreview object

What would happen if a bid step were submitted now. Nothing is raised or written; no condition value is returned.