requestBomImportUpload

Requires permission biddesk:assembly:manage.

A private upload link for a bill-of-materials file (.csv,.xlsx or.xls, up to 20 MB). 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

mutation RequestBomImportUpload($fileName: String!) {
  requestBomImportUpload(fileName: $fileName) {
    fileKey
    uploadUrl
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RequestBomImportUpload($fileName: String!) {\n  requestBomImportUpload(fileName: $fileName) {\n    fileKey\n    uploadUrl\n  }\n}",
  "variables": {
    "fileName": "string"
  }
}
EOF

Variables:

{
  "fileName": "string"
}

Response:

{
  "data": {
    "requestBomImportUpload": {
      "fileKey": "string",
      "uploadUrl": "string"
    }
  }
}

requestBomImportUpload(
  fileName: String!
): BomImportUpload!

Arguments

requestBomImportUpload.fileName ● String! non-null scalar

The file's name; its extension must be.csv,.xlsx or.xls.

Type

BomImportUpload object

A private upload link for a BOM file.