bidProposalDocumentHtml

Requires permission biddesk:bid:read.

A proposal revision rendered as the customer's technical or commercial document (HTML), from the proposal@1 contract and the organization's template for it (its default, else the built-in). Holds no cost, margin or approval record. 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 BidProposalDocumentHtml($kind: BidProposalDocumentKind!, $revisionId: ID!) {
  bidProposalDocumentHtml(kind: $kind, revisionId: $revisionId)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidProposalDocumentHtml($kind: BidProposalDocumentKind!, $revisionId: ID!) {\n  bidProposalDocumentHtml(kind: $kind, revisionId: $revisionId)\n}",
  "variables": {
    "kind": "COMMERCIAL",
    "revisionId": "id"
  }
}
EOF

Variables:

{
  "kind": "COMMERCIAL",
  "revisionId": "id"
}

Response:

{
  "data": {
    "bidProposalDocumentHtml": "string"
  }
}

bidProposalDocumentHtml(
  kind: BidProposalDocumentKind!
  revisionId: ID!
): String!

Arguments

bidProposalDocumentHtml.kind ● BidProposalDocumentKind! non-null enum

Which document: technical or commercial.

bidProposalDocumentHtml.revisionId ● ID! non-null scalar

The proposal revision to print.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.