bomImportSheets

Requires permission biddesk:assembly:manage.

The sheets of an uploaded bill-of-materials file with headers and suggested mappings. Requires Bid Desk, the engineered-product feature and permission to manage assemblies.

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 BomImportSheets($fileKey: String!) {
  bomImportSheets(fileKey: $fileKey) {
    name
    headers
    rowCount
    suggestedStructure
    suggestedMapping {
      field
      header
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BomImportSheets($fileKey: String!) {\n  bomImportSheets(fileKey: $fileKey) {\n    name\n    headers\n    rowCount\n    suggestedStructure\n    suggestedMapping {\n      field\n      header\n    }\n  }\n}",
  "variables": {
    "fileKey": "string"
  }
}
EOF

Variables:

{
  "fileKey": "string"
}

Response:

{
  "data": {
    "bomImportSheets": [
      {
        "name": "string",
        "headers": [
          "string"
        ],
        "rowCount": 0,
        "suggestedStructure": "LEVEL",
        "suggestedMapping": [
          {
            "field": "string",
            "header": "string"
          }
        ]
      }
    ]
  }
}

bomImportSheets(
  fileKey: String!
): [BomImportSheet!]!

Arguments

bomImportSheets.fileKey ● String! non-null scalar

The key the upload link returned.

Type

BomImportSheet object

One sheet of an uploaded BOM file.