commitBidHistoryImport

Requires permission biddesk:settings:manage.

Imports the previewed bids and their lines into the Memory. A bid reference that was imported before is skipped. Requires Bid Desk and permission to manage Bid Desk settings.

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

mutation CommitBidHistoryImport($input: BidHistoryImportInput!, $previewHash: String!) {
  commitBidHistoryImport(input: $input, previewHash: $previewHash) {
    importBatchId
    importedBids
    importedLines
    skippedExisting
    skippedInvalid
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CommitBidHistoryImport($input: BidHistoryImportInput!, $previewHash: String!) {\n  commitBidHistoryImport(input: $input, previewHash: $previewHash) {\n    importBatchId\n    importedBids\n    importedLines\n    skippedExisting\n    skippedInvalid\n  }\n}",
  "variables": {
    "input": {
      "bidMapping": [
        {
          "field": "string",
          "header": "string"
        }
      ],
      "bidsSheet": "string",
      "fileKey": "string",
      "lineMapping": [
        {
          "field": "string",
          "header": "string"
        }
      ]
    },
    "previewHash": "string"
  }
}
EOF

Variables:

{
  "input": {
    "bidMapping": [
      {
        "field": "string",
        "header": "string"
      }
    ],
    "bidsSheet": "string",
    "fileKey": "string",
    "lineMapping": [
      {
        "field": "string",
        "header": "string"
      }
    ]
  },
  "previewHash": "string"
}

Response:

{
  "data": {
    "commitBidHistoryImport": {
      "importBatchId": "string",
      "importedBids": 0,
      "importedLines": 0,
      "skippedExisting": 0,
      "skippedInvalid": 0
    }
  }
}

commitBidHistoryImport(
  input: BidHistoryImportInput!
  previewHash: String!
): BidHistoryImportResult!

Arguments

commitBidHistoryImport.input ● BidHistoryImportInput! non-null input

The sheets and column mappings that were previewed.

commitBidHistoryImport.previewHash ● String! non-null scalar

The hash the preview returned.

Type

BidHistoryImportResult object

The result of a committed history import.