Attach a document

Attaching a document requires three requests:

request an upload URL;
send the file to this URL;
attach the file to a Bonx record.

The document then appears in the Files tab of the record.

1. Request an upload URL

Send the file name and MIME type to generatePresignedUrlUpload.

mutation Upload($fileName: String!, $contentType: String) {
  generatePresignedUrlUpload(fileName: $fileName, contentType: $contentType) {
    uploadUrl
    fileName
    contentType
  }
}

Variables

{ "fileName": "receiving-note-REC-0412.pdf", "contentType": "application/pdf" }

The response contains:

uploadUrl, the URL where you must send the file. It expires after 10 minutes;
fileName, the storage name created by Bonx. Keep this value for step 3.

2. Send the file

Send the file content with a PUT request to uploadUrl. Use the same Content-Type header as in step 1.

curl -X PUT "$UPLOAD_URL" \
  -H "Content-Type: application/pdf" \
  --data-binary "@receiving-note-REC-0412.pdf"

Do not add the Bonx token to this request. The upload URL already contains a temporary authorization.

Storage rejects the file if the Content-Type is different from the value used in step 1.

3. Attach the file to the record

Use insertFilesOne to create the link between the file and the record.

mutation AttachFile(
  $fileId: String!
  $name: String!
  $contentType: String
  $size: Int!
  $recordId: Int!
  $recordType: String!
) {
  insertFilesOne(
    object: {
      fileId: $fileId
      name: $name
      contentType: $contentType
      size: $size
      recordId: $recordId
      recordType: $recordType
    }
  ) {
    id
  }
}

Variables

{
  "fileId": "9f2c…-receiving-note-rec-0412.pdf",
  "name": "Receiving note REC-0412.pdf",
  "contentType": "application/pdf",
  "size": 284119,
  "recordId": 412,
  "recordType": "receivings"
}

Set the variables as follows:

fileId: use the fileName received in step 1;
name: enter the name displayed in Bonx;
size: enter the file size in bytes;
recordId: enter the internal record ID;
recordType: enter the technical record type.

Available record types

recordType contains the plural technical name of the entity.

Record	`recordType`
Receiving	`receivings`
Shipment	`shipments`
Sales order	`salesOrders`
Purchase order	`purchaseOrders`
Manufacturing order	`manufacturingOrders`
Article	`articles`
Lot	`lots`
Defect	`defects`

Find a record ID

A document usually contains the visible record number, such as REC-0412. Use this number to get the internal id.

query FindReceiving($reference: String!) {
  receivings(where: { name: { _eq: $reference } }) {
    id
    name
  }
}

Stop the process if the query returns no result. In this case, the document number does not match a receiving.

See the complete JavaScript example to automate these three requests.

​1. Request an upload URL

​2. Send the file

​3. Attach the file to the record

​Available record types

​Find a record ID

1. Request an upload URL

2. Send the file

3. Attach the file to the record

Available record types

Find a record ID