Version 1
Connector Overview: This page documents all 129 endpoints for the Bynderconnector v1.0
POST
Access rights: Create metaproperty access
These API calls allow you to set up visibility restrictions on metaproperties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Access rights: Delete metaproperty access
These API calls allow you to set up visibility restrictions on metaproperties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Access rights: Retrieve metaproperty access
These API calls allow you to set up visibility restrictions on metaproperties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Account: Retrieve account information
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Account: Retrieve derivatives
A derivative is a file that is based on another source, for example, a low-resolution representation of a print-quality photo. During the upload process, Bynder can automatically create pre-defined image derivatives with different dimensions, quality, and format. Bynder can either maintain the original aspect ratio of an image, or crop or pad an image to fit the specified dimensions. We can create smaller versions of your original image asset in both a JPG and PNG file extension. However, the resolution of derivatives can't be larger than the original file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Analytics: Asset Activity
This endpoint will allow you to retrieve all the events performed in a given asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve events performed in a given asset ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Activity CSV
This endpoint will allow you to retrieve all the events performed in a given asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve events performed in a given asset ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Archive
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve archive events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Archive CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve archive events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Create
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve create events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Create CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve create events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Download
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve download events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Download CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve download events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Remove
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve remove events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset Remove CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve remove events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset View
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve view events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Asset View CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve view events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Search Keyword
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve keyword events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: Search Keyword CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve keyword events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: User Activity
This endpoint will allow you to retrieve all the events triggered by a given user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User id. |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve events triggered by a user ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: User Activity CSV
This endpoint will allow you to retrieve all the events triggered by a given user
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
User id. |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve events triggered by a user ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: User Login
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve login events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
GET
Analytics: User Login CSV
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. |
|
|
The position in the dataset for the first event retrieved. To be used for pagination purposes. |
|
|
Retrieve login events ocurred after this date. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
Set a date range together with the "fromDateTime" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. |
|
|
N/A |
POST
Asset usage: Create asset usage
These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.
Warning: Requires the STATISTICS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Asset usage: Delete asset usage
These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.
Warning: Requires the STATISTICS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Integration id. |
|
|
Asset id. |
|
|
Asset location. |
|
|
N/A |
GET
Asset usage: Retrieve asset usage
These calls allow you to keep track of assets being exported from Bynder and imported into a third party application.
In order to get started or find an existing integration id you should check out this Bynder support article.
If you want to register a new third party application please contact us at support@bynder.com.
Warning: Requires the STATISTICS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
Integration id. |
|
|
URI. |
|
|
N/A |
POST
Asset usage: Sync asset usage
This alternative API call allows you to sync all your usage from a single integration.
Warning: Requires the STATISTICS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Assets: Add metaproperty options
These calls allow you to change the metaproperty options attached to an asset.
Warning:Requires VIEW and EDIT access to the asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Assets: Delete asset
Warning: Requires the MEDIAREMOVE security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Assets: Delete metaproperty options
These calls allow you to change the metaproperty options attached to an asset.
Warning:Requires VIEW and EDIT access to the asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Assets: Modify asset
Warning: Requires the MEDIAEDIT security role. Requires the MARKPUBLIC security role in order to change a asset's isPublic state.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Assets: Retrieve assets
Note: original is only returned for assets marked as public and requires the account to have the seoBaseUrl setting configured.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Brand id, can be retrieved using the Retrieve brands and subbrands call. |
|
|
Sub-brand id, can be retrieved using the Retrieve brands and subbrands call. |
|
|
Category id, can be retrieved using the Retrieve categories call. |
|
|
Collection id, can be retrieved using the Retrieve collections call. |
|
|
Asset id, will return the asset for that id. |
|
|
Comma-separated list of asset ids. Will return a asset for each existing id. |
|
|
Comma-separated list of (metaproperty) option ids, can be retrieved using the Retrieve metaproperties call. This parameter searches for assets that contain at least one of the metaproperty options passed in the list. |
|
|
Comma-separated list of tags, can be retrieved using the Retrieve tags call. |
|
|
Comma-separated list of asset types. |
|
|
Comma-separated list of asset orientation. |
|
|
Metaproperty option name.OR Comma-separated list ids of metaproperty options for that metaproperty.Note: NAME should be replaced by the Metaproperty name. |
|
|
Indicates whether or not the response should only contain assets marked as "limited usage". When 0, no filtering happens. |
|
|
Indicates whether or not the response should only contain archived assets. When 0, no filtering happens. |
|
|
Indicates whether or not the response should only contain assets marked as public. |
|
|
Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents. The default order of results is relevance, but can be overriden with the order parameter. |
|
|
Retrieve assets created after this date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Set a date range together with the "dateCreated" parameter.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Retrieve assets created on this specific date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Retrieve assets modified after this date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Set a date range together with the "dateModified" parameter.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Retrieve assets modified on this specific date.ISO8601 format: yyyy-mm-ddThh:mm:ssZ. |
|
|
Order of the returned list of assets. |
|
|
Maximum number of results.Maximum: 1000. |
|
|
Offset page for results: return the N-th set of limit-results. |
|
|
Indicating whether or not the response should include count results. This parameter when passed as 1 overrides the total parameter. |
|
|
Indicating whether or not the response should include the total count of results. |
|
|
Indicating whether or not the response should include all the different media items (derivatives) available for each asset. |
|
|
Indicating whether or not the response should include the active version number. |
|
|
cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.Note: This parameter can only be used if solr-cursor account feature is enabled. |
|
|
N/A |
GET
Assets: Retrieve specific asset
Warning: Requires the STATISTICS security role in order to retrieve views and downloads statistics data in the response, using the stats parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
Include information about the different asset media items including versions. |
|
|
Include information about views and downloads. |
|
|
N/A |
GET
Brands: Retrieve brands
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Brandstore: Modify order
Warning: Requires the brandstore.orderadmin.edit security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Order id. |
|
|
N/A |
PATCH
Brandstore: Modify orderline
Warning: Requires the brandstore.orderadmin.edit security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Orderline id. |
|
|
N/A |
GET
Brandstore: Retrieve orders
Warning: Requires the brandstore.orderadmin.view security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10. |
|
|
N/A |
GET
Brandstore: Retrieve specific order by id
Warning: Requires the brandstore.orderadmin.edit security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Order id. |
|
|
N/A |
GET
Brandstore: Retrieve specific order by number
Warning: Requires the brandstore.orderadmin.edit security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The order number without the country code (NA13334). |
|
|
N/A |
GET
Brandstore: Retrieve specific order info
Warning: Requires the brandstore.orderadmin.view security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Order id. |
|
|
N/A |
GET
Brandstore: Retrieve specific orderline
Warning: Requires the brandstore.orderadmin.view security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Orderline id. |
|
|
N/A |
POST
Collections: Add assets to a collection
Warning: Requires the COLLECTIONS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
N/A |
|
|
N/A |
POST
Collections: Create collection
Warning: To retrieve public collections the collection.public.view security role is required.
Warning: To retrieve collections other users shared/received the INBOXPUBLIC or OUTBOXPUBLIC security role is required.
Warning: To retrieve collections other users created the PUBLICCOLLECTIONS security role is required.Warning: Requires the COLLECTIONS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Collections: Delete collection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id to be deleted. |
|
|
N/A |
|
|
N/A |
POST
Collections: Modify collection
Warning: Requires the COLLECTIONS security role. Requires the PUBLISHCOLLECTIONS security role in order to change a collection's isPublic state.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
N/A |
DELETE
Collections: Remove assets from a collection
Warning: Requires the COLLECTIONS security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
Comma-separated asset ids to remove from the collection. |
|
|
N/A |
GET
Collections: Retrieve collections
Warning: To retrieve public collections the collection.public.view security role is required.
Warning: To retrieve collections other users shared/received the INBOXPUBLIC or OUTBOXPUBLIC security role is required.
Warning: To retrieve collections other users created the PUBLICCOLLECTIONS security role is required.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of results.Maximum: 1000. |
|
|
Offset page for results: return the N-th set of limit-results. |
|
|
Desired order of returned collection set. |
|
|
Comma-separated list of collection ids. Will return the collection for each existing collection. |
|
|
Indicates whether or not the response should include count results. |
|
|
Search on matching names. |
|
|
Indicates whether or not the return should only contain collections marked as public. When left unspecified, no filtering happens. |
|
|
Minimum amount of assets that the returned collections should have. |
|
|
N/A |
GET
Collections: Retrieve specific collection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
N/A |
GET
Collections: Retrieve the assets of a specific collection
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
N/A |
|
|
N/A |
POST
Collections: Share collection
Warning: Requires the SHARECOLLECTION or SHARING security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Collection id. |
|
|
N/A |
GET
Download: Retrieve asset download location
Warning: Requires the MEDIAHIGHRES security role.
Warning: Requires the ARCHIVEDOWNLOAD security role if the asset in question is archived.
Warning: Requires the DOWNLOADWATERMARK security role if the asset in question is watermarked.
Warning: Requires the KEYVISUALSDOWNLOAD security role if the asset in question is marked as limited usage.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
Type of files to download. Note that when multiple additional files are available only the download url of the latest one will be returned. |
|
|
N/A |
GET
Download: Retrieve asset version download location
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id. |
|
|
Asset version to download. |
|
|
N/A |
GET
Download: Retrieve specific asset item download location
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the asset you’d like to download a item of. |
|
|
The id of the specific asset item you’d like to download. |
|
|
Indicates whether or not to treat the itemId as a hashed item id. |
|
|
N/A |
GET
Dynamic Asset Transformations: Generate dynamic asset transformation
Generate a derivative on the fly with a transformation (such as cropping, scaling, filling) applied to it.
More information about this feature can be found in our Knowledge Base item.
Image operations can be passed as io parameters in the form of transform:{operation},{param1}:{value1},{param2}:{value2},....
It's possible to specify several operations: ?io={operation1}&io={operation2}&.... The operations will be applied in the same order they are passed in the url.
These are the possible image operations and their parameters:
| Operation | Parameter | Possible values |
| --------- | ----------- | --------------- |
|background| color | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) |
|crop | width | integer |
| | height | integer |
| | x | integer |
| | y | integer |
| | gravity | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright |
| | shape | circle / square |
| | blur | integer |
| | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) |
|extend| width | integer |
| | height | integer |
| | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) |
|fill | width | integer |
| | height | integer |
| | gravity | topleft / top / topright / left / center / right / bottomleft / bottom / bottomright |
| | aspectratio | {integer}x{integer} |
|fit | width | integer |
| | height | integer |
|flip | (no parameters) | |
|mirror| (no parameters) | |
|rotate| angle | integer between 0 and 360 |
| | background | color name (yellow, black, etc.) or hexadecimal (rgb, rrggbb) |
|scale | width | integer |
| | height | integer |
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The operation(s) performed on the image before it's served to the client. It's possible to specify this parameter several times to have several operations applied. |
|
|
Focus point as a x,y coordinate (with values between 0 - 1). This will serve as the center point for the image operations. |
|
|
Format of the served image. This can either be jpg or png and it will overwrite the default webP. |
|
|
Image quality, ranging from 1 - 100 (has no effect when format is set to 'png'). |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Groups: Retrieve groups
Warning: Requires the GROUPMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Search on matching group names. |
|
|
What page of results to return. |
|
|
Maximum results to return. If limit is not provided the first 20 resulsts will be returned. |
|
|
Order of the returned list of groups. |
|
|
N/A |
POST
Metaproperties: Create dependency
Warning: Specific metaproperty dependency operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty to which you’d like to add a dependency. |
|
|
Id of the (Metaproperty) option you'd like to become a dependency. |
|
|
N/A |
|
|
N/A |
POST
Metaproperties: Create metaproperty
Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Metaproperties: Create metaproperty option
Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty to which you’d like to add a option. |
|
|
N/A |
DELETE
Metaproperties: Delete dependency
Warning: Specific metaproperty dependency operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty from which you’d like to delete a dependency. |
|
|
Id of the (Metaproperty) option you'd like to no longer be a dependency. |
|
|
N/A |
DELETE
Metaproperties: Delete metaproperty
Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Metaproperties: Delete metaproperty option
Warning: Specific metaproperty option operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option which you’d like to delete. |
|
|
N/A |
POST
Metaproperties: Modify metaproperty
Warning: Requires the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Metaproperties: Modify metaproperty option
Warning: Specific metaproperty option operations require the METAPROPERTYMANAGEMENT or METAMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option which you’d like to modify. |
|
|
N/A |
GET
Metaproperties: Retrieve metaproperties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Indicates whether or not the response should include asset count results for metaproperty-options. |
|
|
Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1. |
|
|
Indicates whether or not the response should include the metaproperty options of each metaproperty. |
|
|
Comma-separated list of metaproperty ids. Will return a metaproperty for each existing id. |
|
|
N/A |
GET
Metaproperties: Retrieve metaproperty dependencies
When a metaproperty has dependencies, the metaproperty won't be visble until a linked option is selected in the upload/bulk edit.
This call returns a list of depending meteproperty option ids.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
N/A |
GET
Metaproperties: Retrieve metaproperty options
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty option name. |
|
|
Maximum number of results.Maximum: 1000. |
|
|
Offset page for results: return the N-th set of limit-results. |
|
|
N/A |
|
|
N/A |
GET
Metaproperties: Retrieve metaproperty options by ids
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Comma-separated list of metaproperty-option ids. |
|
|
N/A |
GET
Metaproperties: Retrieve specific metaproperty
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
Indicates whether or not the response should include asset count results for metaproperty-options. |
|
|
Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1. |
|
|
Indicates whether or not the response should include the metaproperty options of the metaproperty. |
|
|
N/A |
|
|
N/A |
POST
Metaproperty option dependencies: Add a dependency
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the option belongs to. |
|
|
The id of the (metaproperty) option to which you’d like to add a dependency. |
|
|
The id of the (metaproperty) option you’d like to become a dependency. |
|
|
N/A |
POST
Metaproperty option dependencies: Add a dependency option to a group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option the dependency group belongs to. |
|
|
The id of the dependency group you’d like to add a dependency to. |
|
|
The id of the dependency (metaproperty option) you’d like to add to the dependency group. |
|
|
N/A |
|
|
N/A |
POST
Metaproperty option dependencies: Create dependency group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option for which you’d like to create a dependency group. |
|
|
N/A |
DELETE
Metaproperty option dependencies: Delete a dependency
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the option belongs to. |
|
|
The id of the (metaproperty) option from which you’d like to delete a dependency. |
|
|
The id of the (metaproperty) option you’d like to delete. |
|
|
N/A |
DELETE
Metaproperty option dependencies: Delete dependency group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option the dependency group belongs to. |
|
|
The id of the dependency group you’d like to delete. |
|
|
N/A |
POST
Metaproperty option dependencies: Modify dependency group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option the dependency group belongs to. |
|
|
The id of the dependency group you’d like to modify. |
|
|
N/A |
DELETE
Metaproperty option dependencies: Remove a dependency option from a group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the metaproperty the (metaproperty) option belongs to. |
|
|
The id of the (metaproperty) option the dependency group belongs to. |
|
|
The id of the dependency group you’d like to remove a dependency from. |
|
|
The id of the dependency (metaproperty option) you’d like to remove from the dependency group. |
|
|
N/A |
GET
Metaproperty option dependencies: Retrieve global option dependencies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Metaproperty option dependencies: Retrieve metaproperty option dependencies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
N/A |
GET
Metaproperty option dependencies: Retrieve specific metaproperty option dependencies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
Metaproperty option id. |
|
|
Use grouped results like other option dependency calls. |
|
|
N/A |
GET
OAuth 1.0a: Authorise & Authenticate
During this step the user has to authorise & authenticate the request token pair. This request should be executed in a webview or browser where the user has to login to the Bynder portal. No authorization header is needed for this request.
Warning: Make sure you understand that the permissions of the temporary access token pair that will be created afterwards, will be bound to the user that was used to login.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The value of the request token provided by the 1st step. |
|
|
A callback URL to be redirected to once the external portal login has been completed. If this parameter is missing then the auth_token is returned. |
|
|
N/A |
POST
OAuth 1.0a: Exchange the request token pair for an access token pair
In the final step, you exchange the request token pair for a temporary access token pair. This requires a fully signed OAuth request.
You use the oauth_token and oauth_token_secret with the values provided by the response of the 1st request. If successful the request token pair is immediately expired.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
OAuth 1.0a: Obtain a Request token pair
The first step is obtaining a request token pair. A request token pair is only valid for 10 minutes and it will be used in the last step for obtaining the temporary access token pair.
This requires a valid signed OAuth request with only the Consumer Key and Secret.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
OAuth 2.0: Authorize application
When using the Authorization Code grant, redirect the user to the Authorize application endpoint. After the user
is authenticated and approves the authorization request, Bynder will redirect the user back with an
authorization code which can then be passed to the Token endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The client ID provided for the OAuth application. |
|
|
Scopes to request authorization for. These must be separated by a space. Include offline to get a Refresh Token. |
|
|
The URL for the authorize response redirect. This must exactly match one of the "Authorization redirect URIs" values specified for the OAuth application. |
|
|
Determines the grant being used. Only code is supported for the Authorization Code grant. |
|
|
A random string used to maintain state between the request and callback. This value must is used to prevent CSRF attacks. |
|
|
N/A |
|
|
N/A |
GET
OAuth 2.0: Retrieve scopes
The scopes endpoint provides a JSON formatted overview of the existing
scopes within Bynder and what user permissions are required in order
for the OAuth2 service to grant a scope to a user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
OAuth 2.0: Using an authorization code
Use the token endpoint to retrieve a access token which can be used to authorize API
requests. Depending on the type of grant, different fields are required which are
outlined per request.
_The token endpoint requires authorization either in the body or by
sending the Authorization header._
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT
Product layer metaproperties: Modify metaproperty option
Warning: Currently you can only edit the children of a metaproperty option.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty option id. |
|
|
N/A |
GET
Product layer metaproperties: Retrieve metaproperties
Warning: Requires the metaproperty.view security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Product layer metaproperties: Retrieve metaproperty options
Retrieves a paginated list of options for the given metaproperty id and these options' sub options.Warning: Requires the METAPROPERTYMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
Order of the options, based on the option z-index and option name. |
|
|
Index to load a specific set of metaproperty options. |
|
|
Amount of options that are retrieved per page. |
|
|
N/A |
GET
Product layer metaproperties: Retrieve specific metaproperty
Retrieve the metaproperty details and it's metaproperty options.Warning: Requires the METAPROPERTYMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Metaproperty id. |
|
|
N/A |
GET
Security roles: Retrieve security profiles
To determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the Retrieve specific user or Retrieve current user call.
It’s the API’s responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.Warning: Requires the PERMISSIONMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Security roles: Retrieve specific security profile
This call allows you to retrieve your own security profile without requiring the PERMISSIONMANAGEMENT security role.
In order to get your own security profile use your user profile id retrieved by executing the Specific User or Current User call.Warning: Requires the PERMISSIONMANAGEMENT security role if not retrieving your own security profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Security profile id. |
|
|
N/A |
GET
Smartfilters: Retrieve smartfilters
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Tags: Add tag to assets
Warning: Tag operations on assets require the MEDIAEDIT or MEDIAAUDIT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Tag id. |
|
|
N/A |
|
|
N/A |
DELETE
Tags: Remove tag from assets
Warning: Tag operations on assets require the MEDIAEDIT or MEDIAAUDIT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Tag id. |
|
|
Comma-separated asset ids from which to remove the tag. |
|
|
N/A |
GET
Tags: Retrieve tags
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of results.Maximum: 1000. |
|
|
Offset page for results: return the N-th set of limit-results. |
|
|
Order of the returned list of tags. |
|
|
Search on matching names. |
|
|
Minimum media count that the returned tags should have. |
|
|
N/A |
GET
Trash: Retrieve recently removed assets
Warning: You can only retrieve the removed assets from the last 30 days.
Warning: Requires the trash.assets security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Maximum number of results. |
|
|
Offset page for results: return the N-th set of limit-results. |
|
|
Retrieve assets removed after this date.Format: yyyy-mm-dd hh:mm:ss |
|
|
Field to sort on the returned list of assets. |
|
|
Sort order of returned list of assets. Sorts the list of assets by the field parameter defined, if the field parameter was not defined the results will be sorted by media.name. |
|
|
N/A |
POST
Upload assets: Finalise a completely uploaded file and save as a new asset additional
Warning: This call should only be used if you are uploading an additional file for an asset, if you are not go to step 5.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id to which to save the new additional. |
|
|
The upload id of the file. |
|
|
N/A |
GET
Upload assets: Get closest AmazonS3 upload endpoint
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Upload assets: Initialise upload
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST
Upload assets: Register uploaded chunk
Uploading a file consists of:
-
Breaking down your file in parts/chunks. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.
For more information, about how amazon handles parts/chunks, visit: Amazon's website.
-
Sending the chunks over to Amazon and then registering them to Bynder. You can repeat those calls up until your file has been uploaded completely.
1. Upload a chunk
Make a POST request to the Amazon upload endpoint you received from calling Get closest AmazonS3 upload endpoint.
Use a multipart/form-data to send all of the parameters that the multipart_params of the previous request included; plus the following additional parameters:
| Name | Value | Type |
| -------- | -------- | -------- |
|Content-Type| Content type extracted from the multipart_params's Content-Type of the response of the initialise upload request.| string |
|Policy| Policy extracted from the multipart_params's Policy of the response of the initialise upload request.| string |
|X-Amz-Signature| Signature extracted from the multipart_params's X-Amz-Signature of the response of the initialise upload request.| string |
|acl| Access control list extracted from the multipart_params's acl of the response of the initialise upload request.| string |
|key| Key extracted from the multipart_params's key of the response of the initialise upload request followed by p{Chunk index number}. Example: "pluploads/12345/image.png/p1". | string |
|success_action_status| Success action status extracted from the multipart_params's success_action_status of the response of the initialise upload request.| string |
|x-amz-algorithm| Algorithm extracted from the multipart_params's x-amz-algorithm of the response of the initialise upload request.| string |
|x-amz-credential| Credential extracted from the multipart_params's x-amz-credential of the response of the initialise upload request.| string |
|x-amz-date| Date extracted from the multipart_params's x-amz-date of the response of the initialise upload request.| string |
|name| Filename that was passed as attribute in the initialise upload request.| string |
|chunk| Chunk index number (indexing starts from 1).| number |
|chunks| Total number of chunks.| number |
|Filename| The value of the key from the multipart_params of the response of the initise upload request followed by p{Chunk index number}. Example: "pluploads/12345/image.png/p1". ATTENTION: Filename must start with capital F.| string |
|file| File or chunk of the file to be uploaded. | byte array |
2. Register uploaded chunk
After uploading a chunk, you must register it's completion to Bynder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Upload id for the uploaded file. |
|
|
N/A |
GET
Upload assets: Retrieve poll state
Warning: This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the items parameter.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Comma-separated import id's of a finalised file, as returned by the finalise call. |
|
|
N/A |
POST
Upload assets: Save as a new asset
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Import id of a finalised and processed upload to be saved. |
|
|
N/A |
POST
Upload assets: Save as a new asset version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Asset id for which to save the new version. |
|
|
Import id of a finalised and processed upload to be saved. |
|
|
N/A |
|
|
N/A |
POST
Users: Create user
Warning: User operations require the USERMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Users: Delete user
Warning: Specific user operations require the USERMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id or username of the user you’d like to delete. |
|
|
N/A |
POST
Users: Modify user
Warning: Specific user operations require the USERMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of the user you’d like to modify. |
|
|
N/A |
GET
Users: Retrieve current user
Retrieve the current user information. Unlike Retrieve specific user this call doesn't require you to know your user id in order to retrieve your current user information.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Users: Retrieve specific user
Warning: Specific user operations require the USERMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id or username of the user you’d like to retrieve. |
|
|
N/A |
GET
Users: Retrieve users
Warning: User operations require the USERMANAGEMENT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Whether to include inactive users in the list of results. |
|
|
Maximum results to return. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers. |
|
|
What page of results to return. |
|
|
N/A |
POST
Workflow campaigns: Create campaign
Warning: Requires the CAMPAIGNADD security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Workflow campaigns: Delete campaign
Warning: Requires the CAMPAIGNREMOVE security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Campaign. |
|
|
N/A |
PUT
Workflow campaigns: Modify campaign
Warning: Requires the CAMPAIGNEDIT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Campaign. |
|
|
N/A |
GET
Workflow campaigns: Retrieve campaigns
Warning: Requires the CAMPAIGNOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Workflow campaigns: Retrieve specific campaign
Warning: Requires the CAMPAIGNOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Campaign. |
|
|
N/A |
POST
Workflow groups: Create group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Workflow groups: Delete group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Workflow group. |
|
|
N/A |
|
|
N/A |
PUT
Workflow groups: Modify group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Workflow group. |
|
|
N/A |
GET
Workflow groups: Retrieve groups
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Workflow groups: Retrieve specific group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Workflow group. |
|
|
N/A |
POST
Workflow jobs: Create job
Warning: Requires the JOBADD security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE
Workflow jobs: Delete job
Warning: Requires the JOBREMOVE security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Job. |
|
|
N/A |
PUT
Workflow jobs: Modify job
Warning: Requires the JOBEDIT security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Job. |
|
|
N/A |
GET
Workflow jobs: Retrieve jobs
Warning: Requires the JOBOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Only return jobs which have a dateCreated on or after this datetime. |
|
|
Only return jobs which have a dateCreated before or on this datetime. |
|
|
Only return jobs which have a dateModified on or after this datetime. |
|
|
Only return jobs which have a dateModified before or on this datetime. |
|
|
Only return jobs which have a deadline on or after this datetime. |
|
|
Only return jobs which have a deadline before or on this datetime. |
|
|
Comma-separated list of workflow user IDs or workflow user group IDs. |
|
|
Comma-separated list of workflow user IDs. |
|
|
Comma-separated list of job status. |
|
|
Field to order results by |
|
|
Maximum results to return, maximum: 1000. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers. |
|
|
What page of results to return. |
|
|
N/A |
GET
Workflow jobs: Retrieve media of specific job
Warning: Requires the JOBOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Job. |
|
|
N/A |
GET
Workflow jobs: Retrieve specific job
Warning: Requires the JOBOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Job. |
|
|
N/A |
GET
Workflow jobs: Retrieve specific job preset
Warning: Requires the PRESETOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Job Preset. |
|
|
N/A |
GET
Workflow jobs: Retrieve the jobs of a specific campaign
Warning: Requires the CAMPAIGNOVERVIEW security role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a Campaign. |
|
|
Only return jobs which have a dateCreated on or after this datetime. |
|
|
Only return jobs which have a dateCreated before or on this datetime. |
|
|
Only return jobs which have a dateModified on or after this datetime. |
|
|
Only return jobs which have a dateModified before or on this datetime. |
|
|
Only return jobs which have a deadline on or after this datetime. |
|
|
Only return jobs which have a deadline before or on this datetime. |
|
|
Comma-separated list of workflow user IDs or workflow user group IDs. |
|
|
Comma-separated list of workflow user IDs. |
|
|
Comma-separated list of job status. |
|
|
Field to order results by |
|
|
Maximum results to return, maximum: 1000. If limit is not provided, all results are returned. Note: When using pagination, pagination information is returned as response headers. |
|
|
What page of results to return. |
|
|
N/A |
GET
Workflow metaproperties: Retrieve metaproperties
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET
Workflow metaproperties: Retrieve specific metaproperty
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The id of a metaproperty. |
|
|
N/A |
GET
Workflow users: Retrieve users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |