2. Upload a File

post/bdmanager.upload/{typedId}/{slotId}

Uploads a file.

To upload a file you need to retrieve the slot ID using the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
typedId
required
string

typedId of the document you want to attach the file to.

slotId
required
string

The ID of the slot you want to use for the upload. retrieve the slot ID using the /uploadmanager.newuploadslot (Create an Upload Slot) endpoint.

Request Body schema: multipart/form-data
file
string <binary>

A base64 encoded file data.

Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects (BinaryData)
Array
lastUpdateByName
string or null <= 255 characters
createdByName
string <= 255 characters
fileName
string <= 255 characters
typedId
string
lastUpdateDate
string or null <date-time>
length
integer
latestUploadStatusId
integer
version
integer
sender
string or null <= 255 characters
createdBy
integer
recipients
string or null <= 255 characters
sentViaEmail
boolean
userGroupEdit
string or null <= 255 characters
userGroupViewDetails
string or null <= 255 characters
contentType
string <= 255 characters
embeddedOwner
string or null <= 255 characters
createDate
string <date-time>
lastUpdateBy
integer
status
integer
Request samples
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-8dbb5b975-rvc75",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "1139.BD",
        • "embeddedOwner": null,
        • "fileName": "DataExport-1649934421115.xlsx",
        • "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
        • "length": 55021,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "createdByName": "admin",
        • "lastUpdateByName": null,
        • "latestUploadStatusId": 4296,
        • "sentViaEmail": false,
        • "sender": null,
        • "recipients": null,
        • "createDate": "2022-10-05T09:57:05",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2022-10-05T09:57:06",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "status": 0
    }
}