File Information Metadata
to get file metadata
Last updated
Was this helpful?
to get file metadata
Last updated
Was this helpful?
POST
<base_url>/port/api/v1/commerce/fileMetadata
Please replace <base_url>
as explained . Please note that file information metadata is different from SRR metadata.
commerce-api-key*
string
Commerce API Key
issuer-address*
string
Contract Address of API Key owner
payload*
array
Array of the request. Each element of the array corresponds to a file.
payload[*].filename*
string
Name of the file. Should contain file extensions (.jpg, .png, .pdf, etc).
Should not contain space. Use a unique name for each file.
If the filename is already used by the client, then it will fail when uploading. (unique for each LUW, but can be same for different LUW).
This is to avoid modification of files that are already used in SRR.
If the client needs to delete an existing file, please contact Startbahn.
payload[*].category*
string
Use non_attachment_file
to upload thumbnails and contract terms.
The API responds with 200 if the check to the storage provider success. Bear in mind that client’s back end needs to check the results[*].message
if there is a problem with each file.
payload
Array of the results. The order of the array is same as the request.
array
payload[*].filename
The value will be same as parameter sent in request.
string
payload[*].hash
The value of calculated hash. If the hash still in calculation, file is not ready yet. If the file size is above 20 GB, you need to contact to Startbahn to calculate hash manually.
string
payload[*].cid
The value of IPFS CID v1. Like the hash
, ones for very large files need to be contacted to Startbahn.
string
payload[*].size
The size in bytes.
number
payload[*].message
Exist if there is problem describing it.
string
Please refer to to understand the difference among the categories.
Check the .
Check .