Asset

Upload file chunks

IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.

The request target is the Location response header returned by Upload file initialization. Carry the relevant header information across calls as shown below. After the last chunk is uploaded, the file is automatically finalized.

The Location Header Value URL is a placeholder for the Location header from the previous call.

patch
{Location Header Value}/

Headers

tus-resumablestringrequired

Default:1.0.0

upload-offsetstringrequired

The combined length of the previously uploaded chunks. This value can be taken from the Upload-Offset response header of each preceding chunk request.

content-typestringrequired

Default:application/offset+octet-stream

fileidstringrequired
filenamestringrequired
reasonstringrequired

Body

application/offset+octet-stream
string(binary)

Response

Chunk accepted.

patch/

Body

No file selected
 
Invalid URL value 'Location Header Value/'
- missing protocol

Upload file initialization

IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.

This step actually starts uploading the file. Send this request to the signed uploadUrl returned by Create upload url. This initializes a resumable (tus) upload. Any file namings have to be base64 encoded/decoded.
The response headers - in particular the Location header - are required for the next call, Upload file chunks.

The {uploadUrl} path parameter is a placeholder for the signed URL from the previous step.

post
{uploadUrl}/

Headers

tus-resumablestringrequired

Default:1.0.0

upload-lengthstringrequired

Total size of the file to upload, in bytes.

upload-metadatastringrequired

Comma-separated key <base64-value> pairs, e.g. filename ZXhhbXBsZS5wbmc=.

fileidstringrequired
filenamestringrequired
authorizationstringrequired
content-lengthstringrequired

Response

Upload initialized. Use the returned Location header for the chunk uploads.

post/
 
Invalid URL value 'uploadUrl/'
- missing protocol

Publish

IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.

Once the file is fully enriched and ready it can be published. Depending on the profile permissions of the user, the asset will go directly to the asset bank (upload assets) or to the waiting room (upload assets with mandatory approval)

post
https://{your-bynder-domain}/api/1/asset/assets/{assetId}/publish

Path Parameters

assetIdstringrequired

Body

application/json

Optional publish options. If omitted, the asset is published with default settings (forcePublish = false).

PublishAssetInput

forcePublishboolean

When true, forces publication of the asset even if non-blocking validation warnings are present. Defaults to false.

Default:false

Response

application/json

Asset

activeVersionobject
Show Child Parameters
advancedRightsobject
Show Child Parameters
assetIdstring
assetStatusstring
copyrightstring
descriptionstring
embargosarray[object]
Show Child Parameters
moduleCodestring

Allowed values:BGBSIBWF

namestring
originstring
portalIdstring
timeStampCreatedstring(date-time)
timeStampModifiedstring(date-time)
timeStampPublishedstring(date-time)
userCreatedIdstring
userModifiedIdstring
post/api/1/asset/assets/{assetId}/publish

Body

{}
 
application/json

Asset enrichment

Add or update metadata, metaproperties, tags, autotags, embargoes, advanced rights, and relations on an asset before (or after) publishing.

Edit asset

IMPORTANT NOTE
These APIs do not replace the existing v4 APIs yet, and currently only applies to newly uploaded assets still in Draft state (before publishing). Cannot be yet used for Assets that are in Asset Bank and Waiting room.

Edit the core properties of an asset. Each property can individually be updated, without needing to send the rest.

patch
https://{your-bynder-domain}/api/1/asset/assets/{assetId}

Path Parameters

assetIdstringrequired

Body

application/json

EditAssetInput

copyrightstring
descriptionstring
namestring
timeStampPublishedstring

Response

application/json

Asset

activeVersionobject
Show Child Parameters
advancedRightsobject
Show Child Parameters
assetIdstring
assetStatusstring
copyrightstring
descriptionstring
embargosarray[object]
Show Child Parameters
moduleCodestring

Allowed values:BGBSIBWF

namestring
originstring
portalIdstring
timeStampCreatedstring(date-time)
timeStampModifiedstring(date-time)
timeStampPublishedstring(date-time)
userCreatedIdstring
userModifiedIdstring
patch/api/1/asset/assets/{assetId}

Body

{}
 
application/json