Update a File

post/bdmanager.update/{typedId}

Updates file's metadata (e.g., a file name).

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

typedId of the document whose attachment's metadata you want to update.

Request Body schema: application/json
object
version
required
integer
typedId
required
string
fileName
string
contentType
string
length
integer
createdByName
string
latestUploadStatusId
integer
sentViaEmail
boolean
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
Responses
200

OK

Response Schema: application/json
object
node
string
Array of objects
Array
version
integer
typedId
string
embeddedOwner
string or null
fileName
string
contentType
string
length
integer
userGroupEdit
string or null
userGroupViewDetails
string or null
createdByName
string
lastUpdateByName
string
latestUploadStatusId
integer
sentViaEmail
boolean
sender
string or null
recipients
string or null
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
status
integer
Request samples
application/json
{
  • "data": {
    • "version": 1,
    • "typedId": "1146.BD",
    • "fileName": "updatedName.png",
    • "contentType": "image/png",
    • "length": 10278,
    • "createdByName": "admin",
    • "latestUploadStatusId": 4302,
    • "sentViaEmail": false,
    • "createDate": "2022-10-26T11:37:05",
    • "createdBy": 2147490696,
    • "lastUpdateDate": "2022-10-26T11:37:05",
    • "lastUpdateBy": 2147490696
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-54d5b6957c-vfplx",
    • "data": [
      • {
        • "version": 2,
        • "typedId": "1146.BD",
        • "embeddedOwner": null,
        • "fileName": "updatedName.png",
        • "contentType": "image/png",
        • "length": 10278,
        • "userGroupEdit": null,
        • "userGroupViewDetails": null,
        • "createdByName": "admin",
        • "lastUpdateByName": "admin",
        • "latestUploadStatusId": 4302,
        • "sentViaEmail": false,
        • "sender": null,
        • "recipients": null,
        • "createDate": "2022-10-26T11:37:05",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2022-10-26T15:09:44",
        • "lastUpdateBy": 2147490696
        }
      ],
    • "status": 0
    }
}