{"info":{"_postman_id":"09cbeb08-240d-4650-acad-ae127896c96a","name":"Brandworkz API (v1.6)","description":"

The Brandworkz API allows you to interact with the data stored within your Brandworkz system. It is intended for developers who are writing standalone applications or integrations that incorporate content from Brandworkz.

Prerequisites

Before getting started, a consumer ID and secret are required to be able to perform requests to the API.

\n
If you do not have these access details yet, please contact your primary Brandworkz point of contact.
\n

The easiest way to get started with the API is to click the Run in Postman button present at the top of the documentation page and use the Postman App to send requests. Note that you need to have a Postman account and be logged in for the button to be present.

Overview

The
\n
authentication
\n
consists of calling an initial /getAPIURL endpoint, followed by requesting an access token.
\n
Such access token is then used for subsequent calls.
\n
The Brandworkz API will only respond to secured communications done over HTTPS. HTTP requests will send a 301 redirect to the corresponding HTTPS resources.
\n
The response to every request is sent in JSON format by default. Some endpoints have the option for an HTML response, too. This is specified by sending the format query parameter or the Accept header.
\n
In case an API request results in an error, it will return a code and a description about what happened. See the
\n
Error Handling
\n
section.
\n

Authentication

The Brandworkz API uses OAuth 2.0 + JSON Web Tokens. Please follow the below steps to successfully authenticate within the system.

Step 1: Get API details

Before authenticating, you will need to obtain your client_id, api_url and api_version from the https://api.brandworkz.com/getAPIURL endpoint. This is needed to request access tokens and call subsequent API endpoints.

Note that /getAPIURL is a global endpoint which should always be called on https://api.brandworkz.com/getAPIURL regardless of whether you are developing against a production or qa site and regardless of which geographical hosting location your site is in. However, for ALL subsequent endpoints you should call the domain and intial path returned from this call which may or may not be the same as the above domain.

To use this endpoint, you will need to pass the URL of your Brandworkz 'staging' or 'live' site via the clientURL parameter.

For example, https://api.brandworkz.com/getAPIURL?clientURL=mycompanyname.brandworkz.com
and below is an example of the JSON response:

{\n    \"result\": {\n        \"message\": \"Success\",\n        \"code\": 0\n    },\n    \"data\": {\n        \"api_url\": \"https://us-api.brandworkz.com\",\n        \"client_id\": \"brandworkz_mycompanyname\",\n        \"version\": \"1.6\"\n    }\n}\n\n

api_url: The base URL that needs to be used for all subsequent endpoint API calls.

client_id: This is an identifier, specific for each client.

api_version: The current API version.

\n
Important: These three values must always be set dynamically using the getAPIURL call and never be hard-coded. If you hardcode any of these then either subsequent calls won't work at all or they will stop working at some point in the future when we retire the current API version.
\n

These three variables should be used at the beginning of every call as follows:
{{api_url}}/v{{api_version}}/{{client_id}}/endpoint

\n
Tip: For ease of use inside Postman, you should store the above as environment variables. Then always run the /getAPIURL followed by the /oauth/token call before making any other API calls. More info on setting up Postman variables can be found here.
\n

Step 2: Get a token

Once you have the API details, you can either request a token directly (2a below), or you can use the authentication code flow to get a code and request a token at a later time (2b below).
If your Brandworkz instance has SAML SSO users then you must use code flow.

Note that the below /oauth/... authorisation endpoints are different from the functional endpoints as they do not have the api_version and client_id specified in the path. They are unversioned and should have the client_id passed in through the client DB parameter as per below. However you should still use the API domain from /getAPIURL

2a: Request an access token directly

Once you have the above API details and your consumer ID and secret as mentioned in the prerequisites section, you will be able to request an access token as follows:

\n
Please bear in mind that this endpoint call is a POST and can't be pasted in a browser, so this is a cURL command that can be executed in a console.
\n

curl \\\\\n    -u {{consumer_id}}:{{consumer_secret}} \\\\\n    -X POST \"{{api_url}}/oauth/token\" \\\\\n    -H \"Accept: application/json;charset=UTF-8\" \\\\\n    -H \"Content-Type: application/x-www-form-urlencoded\" \\\\\n    -d \"grant_type=password&client_db={{client_id}}&username={{user_login}}&password={{user_password}}\"\n\n

For example:

curl \\\\\n    -u mybrandsite-live:j9dueY5RReqa95dMq \\\\\n    -X POST \"https://us-api.brandworkz.com/oauth/token\" \\\\\n    -H \"Accept: application/json;charset=UTF-8\" \\\\\n    -H \"Content-Type: application/x-www-form-urlencoded\" \\\\\n    -d \"grant_type=password&client_db=brandworkz_mycompanyname&username=bobbySmith&password=dl_8MrTjja\"\n\n

user_login and user_password must be an existing user on your site.

An access token will be returned as part of the response:

{\n  \"access_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjZGIiOiJicmFuZHdvcmt6X215YnJhbmRzaXRlIi...\",\n  \"token_type\": \"bearer\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjZGIiOiJicmFuZHdvcmt6X215YnJhbmRzaXRlIi...\",\n  \"expires_in\": 1200,\n  \"scope\": \"read write\",\n  \"cdb\": \"brandworkz_mycompanyname\",\n  \"uid\": 5081,\n  \"sid\": \"b68c2984-7aa7-408f-89e4-3a5fde42ae9a\",\n  \"jti\": \"78c48e66-6d4a-4ea9-a3e5-6cd1dba30b29\"\n}\n\n

2b: Using authentication code flow

Initial Endpoint

In order to get a code, the user's browser should be redirected to an initial endpoint to start the process.

The initial endpoint is: {{api_url}}/oauth/authorize

This endpoint requires a number of parameters, which are:

clientDb - This is the \"client_id\" from getAPIURL
response_type - This should have the value, \"code\" to indicate that you wish to use the authentication code flow process to authenticate.
client_id - Your consumer Id, i.e. NOT the \"client_id\" returned from getAPIURL.
scope - The scope of the authentication, this should be set to, \"read\".
redirect_uri - This is the URI that the code will be sent to once the user has authenticated and approved the request.

Endpoint example:
{{api_url}}/oauth/authorize?clientDb={{client_id}}&response_type=code&client_id={{consumerID}&scope=read&redirect_uri={{Your Redirect URI, to process the Auth code}}

After visiting that endpoint, the user's browser will be redirected to our login form page, where they can enter their Brandworkz login credentials.

Approval

After the user has authenticated, they are redirected to an approval screen, as they will need to approve the use of the integration that initiated the process.

The user will need to select \"Authorize\", in order to proceed and generate a code.

If the user selects \"Deny\" from the approval screen, then they will be redirected to the initial redirect URI, with the following parameters:

[Your Redirect URI]/?error=access_denied&error_description=User denied access

When the user selects \"Authorize\", they will then get redirected to the initial redirect URI, but with the code attached as a parameter, e.g.
[Your Redirect URI]/?code=qRcX8q

Using the code

The code generated in the previous step can then be used to generate a token. For example, using curl:

curl -u \"[Consumer ID]:[Secret]\" -X POST \"[API URL]/oauth/token\" -H \"Accept: application/json;charset=UTF-8\" -H \"Content-Type: application/x-www-form-urlencoded\" -d 'grant_type=authorization_code&client_db=[Client DB]>&code=qRcX8q&redirect_uri=[Your Redirect URI]'

All of the parameters in the call to get the token should match those that were given in the initial endpoint, although note that in the above call client_db should be used as the parameter name as opposed to clientDb in /oauth/authorize

Step 3: Use the access token

In order to make subsequent endpoint calls which require authentication, the only thing you have to do is to specify the access token as the Authorization request header, as follows:

Authorization: Bearer {{access_token}}

Such access token will be valid for the number of seconds specified in expires_in when requesting it. In order to renew it, you just need to use the refresh token changing the grant type. For more information, please check out the official OAuth 2.0 documentation on how to do this.

Search and Browse

If you are doing an integration where the end-user needs to search and/or browse for assets, e.g. to insert images or videos ad-hoc into a 3rd party CMS or eCommerce app, then there are two ways to do it:

The preferred way is to use our out-of-the-box UI for this via the /assetInsert API endpoint
If for any reason, you can't use the previous option, you can construct a search/browse UI \"manually\" via the /simpleSearch endpoint.

Search/Browse UI via /assetInsert

The /assetinsert endpoint will return a complete HTML/React app very similar to the main search in the web-UI, complete with keyword search, search facets, folder browsing, asset detail view, and download options. This app can be embedded in e.g. a pop-up or iframe in the 3rd party app, and have parameters to limit it to show only certain filetypes or files uploaded by the end-user themselves, and allowing either single-file or multi-file selection. When the user has selected one or more assets, the app will do a call-back to the calling 3rd party app with json info on the selected files.

This is by far the preferred option for this use-case as it will be quicker to implement, provides a rich search/browse experience, and will automatically receive feature enhancements from us.

You can see further detail on the endpoint below under the \"UI\" section as well as example code for how to implement it in either jQuery and JECMAScript6+WebPack here: https://github.com/bwkz/assetInsert-integration-examples

Search/Browse UI via /simpleSearch

The /simpleSearch endpoint can of course as the name implies be used for creating a simple Google-style search feature, but it can - and should - also be used for manually constructing a folder-hierarchy browse feature if you need this, and can't use /assetInsert as described above.

Search UI via /simpleSearch

You will need to create your own text input box which on submit performs a GET like so with XXXX being the phrase the end-user types in

/simpleSearch?searchterm=XXXX\n\n

The result will be something like this:

{\n\"result\":{\n\"message\":\"Success\",\n\"code\":0\n},\n\"searchResult\":{\n\"total\":2,\n\"hits\":[\n{\n\"_source\":{\n\"extendedKeywords\":\"\",\n\"serialNumber\":2001,\n\"description\":\"\",\n\"version\":1,\n\"thumbnailUrlCdn\":\"https://cdn.domain.com/assetThumbnails/0020/2001_1_thumbnail_320x320_page1_157792.jpg\",\n\"title\":\"Brandworkz-Logo-Landscape-RGB-darkText\",\n\"objectURL\":\"/BMS/asset/views/?artwork_ID=2001&category=96\"\n},\n\"_type\":\"asset\",\n\"_id\":\"d76e2bc0-7933-4cc2-b4b0-3b8183279758\",\n\"_score\":13.55542\n},\n{\n\"_source\":{\n\"extendedKeywords\":\"\",\n\"serialNumber\":3697,\n\"description\":\"\",\n\"version\":1,\n\"thumbnailUrlCdn\":\"https://cdn.domain.com/assetThumbnails/0036/3697_1_thumbnail_320x320_page1_144462.jpg\",\n\"title\":\"Brandworkz Logo Landscape RGB Neg\",\n\"objectURL\":\"/BMS/asset/views/?artwork_ID=3697&category=95\"\n},\n\"_type\":\"asset\",\n\"_id\":\"1d91d44f-9f10-44d0-bcb5-8d2bad4816dc\",\n\"_score\":8.396609\n}\n],\n\"max_score\":null\n}\n}\n\n

Note the following in relation to the response structure above:

searchResult.total is of course the total number of total hits from a particular search query and the searchResult.hits array are the actual hits. However, the hits array is limited to only show a max number of hits so may not match the total. See the guidance on the from and size parameters further down for implementing paging.
for each entry in the searchResult.hits array:
_id is the guid for the result. You should if possible always use the GUID even though for certain types like assets, a sequential serialnumber/ID is also returned. There are some older API calls which will expect the sequential ID but these are likely to be retired in the future as we move towards using only GUIDs everywhere.
files.GUID._source contains all other information for a result. See info on the sourceFields parameter further down to return additional metadata if you need it.
extendedKeywords : This is a synthesized read-only field useful for outputting a simplified keywords list. It consists of a concatenation of:
Content of field with a \"keywords\" systemref if there is one
Values from all multiple-choice fields (select, tick, radio, multi, hierarchical)
Text from any single-line text fields if they haven't got a systemref of \"description\"
description : Will show the content of any field with a systemref of 'description'
thumbnailUrlCdn : Link to a small thumbnail sized to a 320x320 bounding box.
objectURL : a link to the asset within the Brandworkz Web-UI

The endpoint is permission-aware so will only return results which the end-user has access to, but by default it will return results from everywhere in the system as well as all asset types so you may want to limit down on these as well:

categoryGUID : If this is passed in then only descendants of that category/folder will be returned. Tip: The sysadmin can see the categoryGUID of a folder in the Brandworkz Web-UI if they browse to the folder and click on Properties.
assetType : By default all of these types/categories are returned: Image, Video, Audio, Document, Folder, Webpage, Editable template (W2P template), User artwork (artwork created from W2P template). If for instance you are creating an integration for a CMS then it's likely that you wouldn't want to show folders, webpages and web-to-publish templates/artworks, but only files and would therefore specify assetType=Image,Video,Audio,Document Note that the options are case sensitive.
fileType : In some circumstances you may need to limit the filetypes down even further than just the asset categories/types above to specific file suffixes. If for instance you were creating a document integration where only PowerPoint files should show up in the results you could specify fileType=pptx,potx,potm,ppsx,ppsm,pptm,ppam,ppt,pot,pps,ppm These options are case-insensitive.

You will most likely also need to use these two parameters:

from : This is for implementing paging if there are more results than will fit on one page. The default number of search results returned for a page is 50 as set in the optional size parameter. If there are more than 50 hits, then for page 2 you need to pass from=50 for page 3 from=100 and so forth (note that this is zero-based). You can check how many hits there are from a query in the searchResult.total node of the response. The maximum value you can set size to is 500, but of course the higher you set this, the slower your UI will be, especially if you are loading thumbnails for the results as well.
sourceFields : This determines how much file information and metadata you will get back for each hit. By default it will return a good base selection of fields such as title, thumbnailUrlCdn, etc. so start there. If you need more information back for an asset, such as custom metadata, pixel sizes, then temporarily set sourceFields=all. This will return all metadata including custom metadata. You can then specify all of the fieldnames you need as a list in sourceFields and these will be returned. Note that it's very important to not use sourceFields=all in production because this will e.g. also return the document fulltext so the response can run to many megabytes.

Note that you can also create more complex search queries via the /search endpoint, for instance if you wanted to return search facets/filtes. This takes native Elastic json query format and executes it against your Elastic search index after applying the end-users permissions. In order to use this you will therefore need to have a good understanding of both the Elastic query syntax as well as the internal structure of your Brandworkz search index.

Browse UI via /simpleSearch

If you need to manually create an OS-style folder-browse UI via /simpleSearch then first go through how to create a search UI with this endpoint above. This will give you a grounding in many of the input parameters you will also need for a browse UI.

Typically you will want to start by outputting all folders and files at the root of the folder hierarchy. In order to only return direct children of a particular folder is to use the parentCategoryGUID input parameter.

In order to get the GUID of the root category use this:

GET /getCategoryInfo?categoryID=0\n\n

...and the guid will be returned in the categoryGuid node.

Then use the returned GUID for the root node like so:

GET /simpleSearch?parentCategoryGUID=1B35C48F-03EA-4DB3-99B2-F7C598979E68&assetType=Folder,Webpage,Image,Video,Audio,Document\n\n

The response structure will be the same as shown further up under \"Search UI via /simpleSearch\" but note that you may get both Folders, WebPages as well as files (image, Video, Audio, Document) in the results.

Folders and WebPages : Both of these will return as _type=folder. This is because conceptually they are the same, i.e. nodes in a hierarchy. A webpage is essentially a folder with a CMS template attached to it. Note that even though Webpages can't directly contain assets they can have sub-folders which may have assets in so when doing a browse-UI you should always include these in assetType.
Image,Video,Audio,Document You may of course want to limit this down to only some of these asset categories.
You will probably want to represent each folder, page and asset type with distinct icons in your UI. If this is the case you should include assetType in the list of sourceFields you specify as you can then pick up on this in the response to show the right icon for each type.
If parentCategoryGUID is specified, then the ranking of the result will be modified from the default internal Elastic \"ranking\" and instead will be returned with folders/webpages first and then assets, both alphabetically.
If you need to limit down to specific file filetypes/suffixes via the fileType parameter then note that folders and webpages will not be returned and in this case you will need to make two calls every time the end-user browses to a folder, one for the folders/pages, and another for the files of the specific type.

The above will return a number of folder/webpage and file hits at the root. When the user clicks on one of these then you will probably want to do the following:

Folders/Webpages : Simply do an identical call to the root folder one above but exchange the parentCategoryGUID with the GUID of the folder as returned in _id
Files : You may have everything you need in the _source sourceFields as returned by the original query, but you don't want to make this too bloated so if you need to show a variety of asset metadata when an asset is clicked then perform another call to /simpleSearch specifying the extra sourceFields you need and entering the asset GUID as returned in _id for the hit into the searchTerm field

Uploading files

When uploading files to Brandworkz via the API you can do this in two ways.

Upload the whole file in one PUT action.
Split the file into parts/chunks, upload each chunk and then assemble the uploaded chunks after uploading.

We recommend that you implement both types depending on the size of the file, with single-file upload for smaller files and multi-part/chunked upload for large files as you will then be covered for all file sizes now and in the future. In the Brandworkz web-UI we start to chunk uploads for files that are larger than 15MB and this is also our recommendation for you.

However, if you know that your integration won't be uploading large files such as HD videos, Photoshop files, large PowerPoints, etc then you can opt to only implement the single-file upload, although note that even if you have a fast internet connection then these uploads may start failing if the files go above 100-200MB, and doing very large PUTs may also be disallowed by a security device on your corporate network. The theoretical limit for a single-file PUT is 5GB, but if you have filesizes like that then you definitely need to implement chunked upload.

Uploading a single file vs multi-part is controlled via the uploadType parameter when calling the initial /createUploadPath API endpoint.

If you don't specify uploadType then you will be returned a single-file upload URL for files smaller than 15MB, and an array of upload links for files larger than this, for uploading each chunk to. The array also specifies how many bytes each chunk should be.
If you specify single-upload then you will get a single upload URL returned to PUT the file to.
If you specify multipart-upload then you will be returned an array of upload links including what the byte size of each chunk should be. Each chunk will be 15MB with the remainder in the last chunk. E.g. a 32MB file will return three upload URLs, the first two for 15MB chunks each and the last one for the remaining 2MB. Note however, that if the file is so large that a 15MB chunk size would result in more than 200 upload links, the chunksize will be increased. Therefore, the part byte sizes are not constants and will need to be read from the response returned by the initial /createUploadPath call - see below.

(Note that if you use Postman for your API development then this will unfortunately not work for the actual file uploads/PUTs as Postman adds additional headers which stops the authentication working with the AWS S3 signed upload url returned)

Upload the whole file in one action

The steps for this are in summary as follows:

Generate an upload link via the /createUploadPath endpoint
Upload the file to the upload link via PUT
Import the file into Brandworkz via the /importAsset endpoint

1. Generate an upload link via the /createUploadPath endpoint for single-file upload

This will return the information needed to upload the file to S3, and also to import it in a later call. At a minimum you need to specify these in the request body:

fileName (string) The name of the file being uploaded incl suffix. e.g. myLogo.png.
fileSize(numeric) The size of that file in bytes - e.g. 33554432 (a 32MB file)
categoryGuid (string) The GUID of the folder that you're going to upload into. The category GUID is returned by other endpoints in the API, e.g. /simpleSearch and /getCategoryInfo
uploadType(enum, optional) Can be either single-upload or multipart-upload As outlined above, this will control if this function returns a single link for uploading the entire file in one PUT, or an array of links for uploading the file in chunks. If this isn't specified then a single upload link will be returned for files of less than 15MB, and an array of upload links for each 15MB (or larger) chunk for files larger than this. In this example single-upload should be specified.

You can optionally also specify these:

assetGuid (string, optional) If you would like to upload a new file/version to an existing asset then specify the assetGuid of the asset you would like to upload this new version to. Also, if you are uploading a custom thumbnail to an existing asset then you must specify this.
isCustomThumbnail (boolean, optional) If this is set to true then the path returned will be for uploading a custom thumbnail/preview to an existing asset. This is useful for filetypes where we may not auto-generate a visual preview, e.g. some 3D files. If this is set to true then you must specify a valid assetGuid, and also set the equivalent parameter to true in the subsequent /importAsset endpoint.

An example request body is this:

{\n\"filename\": \"myLogo.png\",\n\"filesize\": 33554432,\n\"categoryGuid\": \"a4428547-14f9-4a0e-bb53-f7c3a06c7a6e\",\n\"uploadType\": \"single-upload\"\n}\n\n

And the response will be similar to this:

{\n\"data\":{\n\"categoryGuid\":\"a4428547-14f9-4a0e-bb53-f7c3a06c7a6e\",\n\"assetId\":10152,\n\"assetVersion\":1,\n\"keyName\":\"originals/0101/myLogo_010152_001.png\",\n\"uploadDetails\":{\n\"type\":\"single-upload\",\n\"url\":\"https://bwkz-bms-euprod-tenant-assets.s3-accelerate.amazonaws.com/clientname/assets/originals/0135/myLogo_010152_001.png?AWSAccessKeyId=ASIAQ2YO7IPIP6YGS57P&Signature=HaZcmoTVI7KYRPVdt...&Expires=1601988910\"\n}\n},\n\"result\":{\n\"message\":\"Success\",\n\"status\":0\n}\n}\n\n

Notes to the above response:

Before going further, first check for success. Do this by checking for result.status=0 or alternatively for a 200 HTTP success code.
If there is an error then the error message will be in the result.message json node.
The upload link is time limited. 15 minutes, or correspondingly longer the larger the file is.
Keep the information returned from this endpoint, as we will need to use it in subsequent calls.

2. Upload the file

Upload the entire file via PUT to URL returned in the data.uploadDetails.url node in the /createUploadPath endpoint above.

As mentioned above, note that you during development can't use Postman for this as it adds headers incompatible with AWS S3 signed URLs.

Check for a 200 OK HTTP response from the PUT to validate that the file uploaded successfully.

3. Import the file into Brandworkz via the /importAsset endpoint

Finally import the uploaded file into Brandworkz by calling the /importAsset endpoint

At a minimum you need to specify these in the request body:

categoryGuid (string) must be the same categoryGuid specified in the /createUploadPath call
keyName (string) As returned from /createUploadPath in the data.keyname value
originalFilename (string) Pass the same value as per fileName in the /createUploadPath call
assetId (string) As returned from /createUploadPath in the data.assetId value
assetVersion (string) As returned from /createUploadPath in the data.assetVersion value
filesize (numeric) The filesize in bytes

Continuing our example from above with the myLogo.png file the request body would look like this:

{\n\"categoryGuid\": \"a4428547-14f9-4a0e-bb53-f7c3a06c7a6e\",\n\"keyName\": \"originals/0101/myLogo_010152_001.png\",\n\"originalFilename\": \"myLogo.png\",\n\"assetId\": 10152,\n\"assetVersion\": 1,\n\"fileSize\": 33554432\n}\n\n

If the file imports correctly, then you will get a response similar to this:

{\n\"result\": {\n\"status\": 0,\n\"message\": \"Success\"\n},\n\"data\": {\n\"binaryIdenticalToGuid\": \"\",\n\"shortcutCreated\": 0,\n\"md5\": \"99a3ceafafd891df92a5847e603d60aa\",\n\"pixelwidth\": 7016,\n\"pixelheight\": 4961,\n\"resolution\": 300,\n\"imageformat\": \"CMYK-32\",\n\"pagecount\": 1,\n\"durationInSeconds\": 0,\n\"disksizeBytes\": 33554432,\n\"assetSerialNumber\": 10152,\n\"assetVersion\": 1,\n\"assetGuid\": \"272c757f-01a6-4d72-9eb1-328d82a7ca59\",\n\"assetVersionGuid\": \"7f449978-b7e4-4537-a208-4eabc7867705\",\n\"assetTitle\": \"myLogo\",\n\"nameClash\": false\n}\n}\n\n

Notes to the above response:

As per earlier calls, check for success. Do this by checking for result.status=0 or alternatively for a 200 HTTP success code. If unsuccessful, the reason for the issue will be in result.message.
Note that files may fail to import as expected behaviour. For instance if you try to upload an .exe file this will not import for security reasons. You may also have file deduplication enabled and the same binary file is already on the system in which case the file will be turned into a shortcut of the original. In most cases result.status = 1 means that there have been an error and result.status = 2 means that the file hasn't important for another reason. In both cases the reason should be returned in result.message.
In order to return a response as soon as possible from this call, only the essential asset information is discovered and returned. Further asynchronous tasks will be performed after the response, for instance adding the asset to the search index, creating thumbnails and previews, extracting document text, discovering colours, etc. Therefore, if you call e.g. /simpleSearch on the returned assetGuid immediately after upload it may not be present or may not be fully populated. The asynchronous data should be fully populated after 30 seconds, although note that documentfulltext from documents and colour extraction from images can take up to 2 minutes. Also note that even though you can query the API and get thumbnail links back after 30 seconds, the actual image files may not be generated until later.
In extension to the above point, note that any embedded metadata in images - e.g. keywords, description, etc - is extracted synchronously before the /importAsset responds. This means that it is safe to immediately call the POST /saveMetadata endpoint after this if you need to assign metadata to the uploaded file.

The data nodes in the above example are guaranteed to be returned regardless of filetype, although some of them may be empty, e.g. if you upload an audio file then the pixelwidth/height will of course be empty. Note the following on these response nodes:

shortcutCreated (bool): If you have file deduplication enabled in the system preferences, and the file you are uploading is already present somewhere else in the system - based on an MD5 checksum match - then this will be true (1).
binaryIdenticalToGuid (string): if shortcutCreated = 1 then this will contain the assetGuid of the file on the system which the uploaded file is identical to.
md5 (string): Note that this will only be returned if asset deduplication is enabled in system preferences. You can use this to verify with absolute certainty that the file uploaded successfully if you calculate the md5 checksum of the original file and then compare it with this value.
disksizeBytes (integer): number of bytes of the file uploaded. Should match the filesize of the original file, i.e. can be used as a quickcheck to ensure that the file uploaded intact.
pixelwidth (integer): pixelwidth for images and videos. Empty if other types
pixelheight (integer): pixelheight for images and videos. Empty if other types
resolution (integer): resolution in dpi for images. Empty if other types
imageformat (string): the colourDepth/system for images. Typical values are \"RGB-24\", \"RGB-48\", \"RGB-96\", \"CMYK-32\", \"CMYK-64\", \"CMYK-128\"
pagecount (integer): The page or slide count for documents and presentations. 1 for all other filetypes.
durationInSeconds (decimal): duration for videos in second-decimal format
assetSerialNumber (integer): The human-friendly Brandworkz serial number. A sequential number which is incremented every time a new file is uploaded. Note that although this is guaranteed to be unique within your system, you should if possible use the assetGuid in preference to this for storing back in your own system or for further actions on the asset.
assetVersion (integer): Will be 1 for new assets, and subsequent numbers if uploading new versions of existing assets.
assetGuid (guid): The main identifier for a Brandworkz asset. In your integration you should store this GUID back in your own system for future reference/API calls on that asset. Note however that this guid is version independent and when used will return the details of the latest version of this asset - which for most use cases is what you would want. However, you may want to store the assetVersion back in your system as well for future reference.
assetVersionGuid (guid): The asset's version-specific Guid. This is mainly used for internal purposes at present but may be used in future public API calls.
assetTitle (string): The title of the asset. Will for new assets initially be based on the filename minus the file suffix. Note that if you upload new versions of existing assets then the assetTitle will remain and not change to the filename of the new file if this is different to the original version. See also 'nameClash' below.
nameClash (bool): If you upload a file to a folder which already have an asset with the same Title as what the new one would get based on it's filename then (2) will be appended to it. For instance if you upload \"myLogo.png\" and there is already an asset in the same folder called \"myLogo\" then the new asset will be named \"myLogo (2)\" and so forth, and this will be returned in the assetTitle above.

Completion

If all of the responses returned successfully, you should now be able to see the file in the system in the folder that you specified!

Typical subsequent API calls after uploading are:

POST /saveMetadata for assigning/changing the asset's metadata.
/simpleSearchfor getting further information back on the asset beyond what's returned in the /importAsset response. See notes on the asynch nature of this further up.

Upload files in separate chunks/parts

The steps for this are in summary as follows:

Generate the upload links via the /createUploadPath endpoint
Split the file into chunks and then upload each one via the upload links returned via PUT
Assemble the chunks back into a file after uploading all chunks
Import the file into Brandworkz via the /importAsset endpoint

1. Generate the upload links via the /createUploadPath endpoint

The input parameters are identical to the ones outlined under the single-file upload above apart from the fact that the uploadType should be multipart-upload - or if uploadType isn't specified and the file is larger than 15MB

The response is somewhat different to the single-file response and looks like this for our imaginary 32MB myLogo.png file:

{\n\"data\":{\n\"categoryGuid\":\"a4428547-14f9-4a0e-bb53-f7c3a06c7a6e\",\n\"assetId\":10152,\n\"assetVersion\":1,\n\"keyName\":\"originals/0101/myLogo_010152_001.png\",\n\"uploadDetails\":{\n\"uploadId\":\"9lI4NQl20DGxnpYreJV6f3EHg7.CaiEGHj4dAOGdk1VAK7lDOgJRzIQ.9N5s35l.l6NQRsqtMeYckhHsoblYW01QKxb3rjnn4bZR48e2pOggj3Cj3y5e2S6VBtvXQbl3ahFXaL.5EAC5wXhCoxacaiCrcME3J5b7RxTrKj62XZI-\",\n\"urls\":[\n\"https://bwkz-bms-qa-tenant-assets.s3-accelerate.amazonaws.com/example_client/assets/originals/0101/myLogo_010152_001.png?uploadId=9lI4NQl20DGxnpYreJV6f3EHg7.CaiEGHj4dAOGdk1VAK7lDOgJRzIQ.9N5s35l.l6NQRsqtMeYckhHsoblYW01QKxb3rjnn4bZR48e2pOggj3Cj3y5e2S6VBtvXQbl3ahFXaL.5EAC5wXhCoxacaiCrcME3J5b7RxTrKj62XZI-&partNumber=1&AWSAccessKeyId=ASIAQ2YO7IPILRUZ3QGH&Signature=9OlMOePJ4L6ZYzzRV7zJ0rQy2Yc=&x-amz-security-token=IQoJb3...&Expires=1601997174\",\n\"https://bwkz-bms-qa-tenant-assets.s3-accelerate.amazonaws.com/example_client/assets/originals/0101/myLogo_010152_001.png?uploadId=9lI4NQl20DGxnpYreJV6f3EHg7.CaiEGHj4dAOGdk1VAK7lDOgJRzIQ.9N5s35l.l6NQRsqtMeYckhHsoblYW01QKxb3rjnn4bZR48e2pOggj3Cj3y5e2S6VBtvXQbl3ahFXaL.5EAC5wXhCoxacaiCrcME3J5b7RxTrKj62XZI-&partNumber=2&AWSAccessKeyId=ASIAQ2YO7IPILRUZ3QGH&Signature=aRu4O3pPg2w2tW+eEeoJhgG0Y7Q=&x-amz-security-token=IQoJb3...&Expires=1601997174\",\n\"https://bwkz-bms-qa-tenant-assets.s3-accelerate.amazonaws.com/example_client/assets/originals/0101/myLogo_010152_001.png?uploadId=9lI4NQl20DGxnpYreJV6f3EHg7.CaiEGHj4dAOGdk1VAK7lDOgJRzIQ.9N5s35l.l6NQRsqtMeYckhHsoblYW01QKxb3rjnn4bZR48e2pOggj3Cj3y5e2S6VBtvXQbl3ahFXaL.5EAC5wXhCoxacaiCrcME3J5b7RxTrKj62XZI-&partNumber=3&AWSAccessKeyId=ASIAQ2YO7IPILRUZ3QGH&Signature=l9M9SVbEJkBEQtF0IbNKdhKG00s=&x-amz-security-token=IQoJb3...&Expires=1601997174\"\n],\n\"mainChunkSize\":15728640,\n\"finalChunkSize\":2097152,\n\"type\":\"multipart-upload\",\n\"chunkNo\":3\n}\n},\n\"result\":{\n\"message\":\"Success\",\n\"status\":0\n}\n}\n\n

Included in this response is the mainChunkSize and the finalChunkSize, these values are in bytes. These relate to the size of the chunks that should be uploaded to each URL. The final URL in the list should have a chunk corresponding to the finalChunkSize.

In the example above, the chunkNo indicates that there should be 3 chunks in total: 2 with a size of 15728640 bytes each, and 1 of 2097152 bytes.

Also note that the three upload URLs returned in the data.uploadDetails.urls array each have a partNumber URL parameter which corresponds to the chunk that should be used against it. The returned array will always be in sequence, i.e. partNumber will always be 1 for the first link and so forth.

You will also need to keep track of the data.uploadId value returned as you need this later to assemble the files.

2. Split the file into chunks and then upload each one via the upload links returned via PUT

Now that we have generated the links to upload to, we now need to actually upload the file chunks.

The chunks need to be sent with a HTTP PUT request.

When uploading chunks, then each chunk should be uploaded to the corresponding URL in the list returned by /createUploadPath as described above.

During development you may want to do the uploads from the command line. On Linux/Apple based systems, you can use the curl command, e.g.

curl -v --upload-file x1.bin \"https://bwkz-bms-qa-tenant-assets.s3-accelerate.amazonaws.com/example_client/assets/originals/0101/myLogo_010152_001.png?uploadId=9lI4NQl20DGxnpYreJV6f3EHg7.CaiEGHj4dAOGdk1VAK7lDOgJRzIQ.9N5s35l.l6NQRsqtMeYckhHsoblYW01QKxb3rjnn4bZR48e2pOggj3Cj3y5e2S6VBtvXQbl3ahFXaL.5EAC5wXhCoxacaiCrcME3J5b7RxTrKj62XZI-&partNumber=1&AWSAccessKeyId=ASIAQ2YO7IPILRUZ3QGH&Signature=9OlMOePJ4L6ZYzzRV7zJ0rQy2Yc=&x-amz-security-token=IQoJb3...&Expires=1601997174\"\n\n

In this example, \"x1.bin\" is the name of the chunk (see the split command reference in Chunking) and the link is the first link in the list of the /createUploadPath response.

Curl is using the -v option here, so that we can see the headers returned by the call. We will need the ETag header returned in the response from every PUT call, as they will be used to assemble the chunks in the next call.

Repeat the curl command for each chunk/URL of the file, and keep a record of all the ETag headers in the responses.

When uploading programmatically you will also need to capture the Etag response from each chunk as you will need those to assemble the parts later.

The method of chunking a file is completely up to you, and can vary from system to system. There is no single way of doing it, and you should pick the most appropriate method for your use case and programming language.

For Linux and Apple based systems, there is the split command, e.g.

split -b 15728640 --numeric-suffixes=1 --suffix-length=1 --additional-suffix=\".bin\" myLogo.png\n\n

This would generate a number of files with the .bin extension of the right sizes. e.g x1.bin.

3. Assemble the chunks back into a file

To do this you call the /assemble endpoint with the following values for the request body:

objectKey: As returned in keyName from the initial /createUploadPath response
uploadId: As returned in data.uploadId from the initial /createUploadPath response
eTag(s): The eTag returned from each PUT upload for the chunks. Note that you will get \"ETag\" returned in the headers, but you need to use \"eTag\" in the json below.

The json body should look like this:

{\n\"objectKey\": \"originals/0101/myLogo_010152_001.png\",\n\"uploadId\": \"KCTf7nos7bjhqk9w6y7wxXmQNsJWU1565Ul5bo.bfSfZM6DuDhhVND_ePmNkdYYQ2YsQZqVajtZQmZCjePeEag3oef08u2e8tvixjJEiWywCygUOOOxOMrGj4EiPgVtd8xeUnIyBDBlrXRfM9VKihdaDmb0g0WbMMDaAnWTmws4-\",\n\"parts\": [{\n\"partNumber\": 1,\n\"eTag\": \"a212be3df3b75034d3134181133961b0\"\n},\n{\n\"partNumber\": 2,\n\"eTag\": \"b1748f980effa301ef39a5b38cb1728e\"\n},\n{\n\"partNumber\": 3,\n\"eTag\": \"0812f72258be829e7c22094f69430e62\"\n}\n]\n}\n\n

The /assemble endpoint will return with a success if it managed to assemble the chunks properly. e.g.

{\n\"result\": {\n\"status\": 0,\n\"message\": \"Success\"\n},\n\"data\": {\n\"uploadId\": \"KCTf7nos7bjhqk9w6y7wxXmQNsJWU1565Ul5bo.bfSfZM6DuDhhVND_ePmNkdYYQ2YsQZqVajtZQmZCjePeEag3oef08u2e8tvixjJEiWywCygUOOOxOMrGj4EiPgVtd8xeUnIyBDBlrXRfM9VKihdaDmb0g0WbMMDaAnWTmws4-\",\n\"asset\": \"example_client/assets/originals/0101/myLogo_010152_001.png\"\n}\n}\n\n

Now that the file has been reconstructed, it's now time to import the asset into the Brandworkz system.

4. Import the assembled file

This is done in an identical manner to the single-file upload so see the corresponding section above for this.

Inserting asset metadata

After having uploaded a new file via the API you may also want to add metadata to that new asset, which is done via the POST /saveMetadata endpoint.
You can use this both for adding/modifying a number of fixed fields, as well as any custom metadata you may have set up in your instance of Brandworkz. This is done by posting json in the body/payload adhering to the following schema, where 'assetGuid' is the only mandatory field:

{\n  \"assetGuid\": \"string\",\n  \"assetPublishDate\": \"string\",\n  \"assetExpiryDate\": \"string\",\n  \"assetStatus\": 0,\n  \"assetTitle\": \"string\",\n  \"assetVersion\": 0,\n  \"languageCode\": \"string\",\n  \"metadata\": {},\n  \"metasetRef\": \"string\"\n}\n\n

Inserting metadata to the fixed fields

These are the fixed fields:

assetGuid The asset's guid. Mandatory
assetPublishDate Set a publish date before which the asset will be unavailable. We recommend posting this in the yyyy\\mm\\dd format to avoid any ambiguity between US/non-US day/month notation.
assetExpiryDate Set an expiry date after which the asset will be unavailable. We recommend posting this in the yyyy\\mm\\dd format to avoid any ambiguity between US/non-US day/month notation.
assetStatus
- 0 - Set the asset to hidden. Only a system administrator can see it.
- 1 - This is the standard status; the asset can be viewed and download by any user with the correct permissions.
- 2 - View only. The asset can only be viewed, and not downloaded.
\n
assetTitle Change the Title. Note that this can not be set to empty. Also note that if you try to set this to a title which is the same as another asset in the same folder you will get a 400 Bad Request response back, and a suggestion as to what you can rename it to in the data.suggestion node which will only be present if there is a name clash. The suggestion will be based on suffixing a number after the title asked for in the failing call.
assetVersion Ignore this. For potential future functionality. Asset metadata is currently not tied to a specific version of an asset but any/all versions.

Inserting metadata to custom fields

To insert custom metadata you will need to use these parameters:

assetGuid The asset's guid
languageCode Only relevant if you have a multi-language system. This is for specifying the language code to insert to, where you need to call the endpoint separately for each of your langCodes. Note that you only need to do this for text entries, for multiple-choice entries only need to be saved in one language as they will then automatically be populated in all languages, assuming you have set up translations for the options.
metasetRef The systemRef for the metaset you are inserting values for. As a sysadmin or metadata admin you can see this by browsing to the relevant metaset in the admin area.
metadata A collection of fields specified by their systemRefs' and the associated values you want to insert.

As an example, lets say we have a MetaSet for some product images which has a systemRef of ASSETPRODUCTIMAGES
This metaset has the following fields in:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Friendly Name	SystemRef	Type	Options
Keywords	KEYWORDS	textarea	N/A
SKU	SKU	Integer	N/A
Shot angle	SHOTANGLE	Selectbox	Front/Left/Right
Shot content	SHOTCONTENT	Checkbox	People/Object/Interior environment/Exterior environment
Colour	COLOUR	Hierarchical	Red, Red->Burgundy, Red->Crimson, Green, Green->Avocado, Green->Lime green

If we then had an asset with the following attributes:

The keywords we want to insert are: boho chic, floral, spring
It's SKU/product code is: 12364
Its a shot from the Front
Its showing people and Exterior environment
It's red and lime coloured

...we would then post this Json in the body to insert that:

{\n   \"assetGuid\":\"2f0637c6-fd92-60c0-085b-154a2e3f263c\",\n   \"metasetRef\":\"ASSETPRODUCTIMAGES\",\n   \"metadata\":{\n      \"SKU\":\"12364\",\n      \"SHOTANGLE\":[\"Front\"],\n      \"THESHOTCONTENT\":[\"People\",\"Exterior environment\"],\n      \"COLOUR2\":[\"Red\",\"Green|Lime green\"\n      ],\n      \"KEYWORDS\":[\"boho chic, floral, spring\"]\n   }\n}\n\n

Note the following on the above:

SKU/Number fields. You should wrap these in double-quotes as is they were text fields
SHOTANGLE/Single-option selectbox or radio button: You can either pass the value as a single-item array as per above, or simply a text value. You must pass an option which exists for that field already, otherwise a 500 error will be returned
Shot Content/multi-value fields : You must pass this as an array of text entries. You must pass options which exist for that field already, otherwise a 500 error will be returned
Colour/hierarchical fields : You can target options at any level in the hierarchy but if the option isn't at the root, then you must pass a pipe-delimited path as per \"Green|Lime green\" above.
Keywords/text and textarea fields: You can either pass these as single-item array entries as per above or just a text value.

Finally, you can insert both fixed and custom metadata in the same call.

Error Handling

The API calls will respond with appropriate HTTP status codes for all requests. When a response is received, the status code is returned and is accompanied by a help text that indicates the possible meaning of the response code. A 200 OK indicates all went well, while 4XX or 5XX response codes indicate an error from the requesting client or our API servers respectively.

The most common errors you can encounter in the Brandworkz API are as follows:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

HTTP Status Code	Response Code	Error Message	Cause
401	1	Full authentication is required to access this resource	You are trying to access the API without authenticating.
502	2	Service not available	You are trying to access a service that isn’t running.
422	3	Argument error	Depending on endpoint. This is caused when parameters don’t pass validation.
500	4	Configuration error	A configuration value could not get retrieved, thus the action could not be completed.

Infrastructure

The approach we are implementing is a micro-services architecture. Unlike a monolithic or standalone API, our system has the ability to scale up as needed. Endpoints are grouped by service and below is a list of the key services relating to DAM:

Albums
Annotations
Assets
Categories
CMS
Integration
Metadata
Navigation
Search
Users

\n
Please contact Brandworkz to find out more about other API services relating to other Brandworkz modules (e.g. Workflow and Web-to-Print).
\n

Responses

The response to every request is sent in JSON format by default. Some endpoints have the option for other formats, such as HTML. This can be specified passing the optional query parameter format or making use of the request header Accept when calling an endpoint. We also return a response message and code for every call to check if the operation was successful, independently of the resulting content, in the following way:

{\n\"result\": {\n// message and status code\n},\n\"data\": {\n// content\n}\n}\n\n

For example:

{\n\"result\": {\n\"status\": 5,\n\"message\": \"Service endpoint call failed\"\n},\n\"data\": {\n\"dateTime\": \"2019-02-11T10:50:56.924\",\n\"rootCause\": \"Can't find a service with serviceId = cms-v1.6\",\n\"endpointName\": \"cms/templates\",\n\"method\": \"post\"\n}\n}\n\n

Endpoint Structure

We work with several environments, so the versions and URLs change as the API evolves. The following three data variables are therefore essential when calling API endpoints:

api_url: The API base URL that needs to be used for all subsequent endpoint calls.

client_id: This is an identifier, specific for each client.

api_version: The current API version.

\n
Important: These values must be always set dynamically using the getAPIURL call and never be hard-coded. We ensure this way consistency and integrity with the API. Hard-coding these values should be considered a bad practice and it is prone to errors.
\n

These data variables are used at the beginning of every endpoint as follows:

{{api_url}}/v{{api_version}}/{{client_id}}/endpoint

\n
Tip: For ease of use inside Postman, you could store the above as environment variables. Then always run the /getAPIURL followed by the /oauth/token call before making any other API calls. More info on setting up Postman variables can be found here.
\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Search and Browse","slug":"search-and-browse"},{"content":"Uploading files","slug":"uploading-files"},{"content":"Inserting asset metadata","slug":"inserting-asset-metadata"},{"content":"Error Handling","slug":"error-handling"},{"content":"Infrastructure","slug":"infrastructure"},{"content":"Responses","slug":"responses"},{"content":"Endpoint Structure","slug":"endpoint-structure"}],"owner":"2016221","collectionId":"09cbeb08-240d-4650-acad-ae127896c96a","publishedId":"2s93RRwtCU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-03-29T08:15:57.000Z"},"item":[{"name":"Albums","item":[{"name":"Add album assets","id":"c02b2dd6-5d0c-413c-8ca8-91289809de5b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/addAlbumAssets?albumID={{albumID}}&assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Adds assets and/or shortcuts to the given album. This function will return an error if the logged in user does not own the album that the assets are trying to be added to.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","addAlbumAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album ID that you wish to add assets to.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

A comma separated list of asset IDs that you wish to add to the album.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

A comma separated list of shortcut IDs that you wish to add to the album.

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"95d7af71-67e7-49ec-9d1a-a7db97cd2178","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"c02b2dd6-5d0c-413c-8ca8-91289809de5b"},{"name":"Create album","id":"38733d97-3db7-4d4c-9b38-6e5e58615d21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/createAlbum?albumClient={{albumClient}}&albumDescription={{albumDescription}}&albumName={{U2hhcmU=}}&albumProject={{albumProject}}&assetIDs={{assetIDs}}&format={{json}}&isHidden={{0}}&shortcutIDs={{shortcutIDs}}&showFullscreen={{1}}&showMetadata={{0}}","description":"

\n
Creates an album in the system for the the currently logged in user. This function will return the album information for the newly created album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","createAlbum"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The Base64 encoded client name that you wish to use.

\n","type":"text/plain"},"key":"albumClient","value":"{{albumClient}}"},{"description":{"content":"

The Base64 encoded album description that you wish to use.

\n","type":"text/plain"},"key":"albumDescription","value":"{{albumDescription}}"},{"description":{"content":"

The Base64 encoded album name that you wish to use. The default value is the Base64 encoding of \"Share\"

\n","type":"text/plain"},"key":"albumName","value":"{{U2hhcmU=}}"},{"description":{"content":"

The Base64 encoded project name that you wish to use.

\n","type":"text/plain"},"key":"albumProject","value":"{{albumProject}}"},{"description":{"content":"

Comma separated list of asset IDs that you want this album to have.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether this album is hidden or not.

\n","type":"text/plain"},"key":"isHidden","value":"{{0}}"},{"description":{"content":"

Comma separated list of shortcut IDs that you want this album to have.

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"},{"description":{"content":"

Whether to allow a full screen view for the assets on this album.

\n","type":"text/plain"},"key":"showFullscreen","value":"{{1}}"},{"description":{"content":"

Whether to allow the user to see metadata for assets when viewing this album.

\n","type":"text/plain"},"key":"showMetadata","value":"{{0}}"}],"variable":[{"id":"ffb3e93f-08c5-440e-b2c3-805f99ab8333","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"38733d97-3db7-4d4c-9b38-6e5e58615d21"},{"name":"Create album short link","id":"c77860fd-4dcb-4e08-8da0-0cb7639846a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/createAlbumShortLink?albumID={{albumID}}&endDate={{endDate}}&format={{json}}&startDate={{startDate}}&transformIDs={{transformIDs}}","description":"

\n
This function returns a URL which can be used to access an album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","createAlbumShortLink"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album ID you wish to create a shortcut link for

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The date when this link will stop working. If left empty/not given, then it will default to a date far in the future

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The date when this link will start working. If left empty/not given, then it will default to the current date

\n","type":"text/plain"},"key":"startDate","value":"{{startDate}}"},{"description":{"content":"

A comma separated list of transform IDs that this album will be shared with

\n","type":"text/plain"},"key":"transformIDs","value":"{{transformIDs}}"}],"variable":[{"id":"416deb66-17f6-4d5b-98e8-f1efccf9b4da","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"c77860fd-4dcb-4e08-8da0-0cb7639846a2"},{"name":"Delete album","id":"36f1e130-1025-4249-ab49-1047e4c493f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/deleteAlbum?albumID={{albumID}}&format={{json}}","description":"

\n
Deletes the given album. The only detail that is returned is a sucess message.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","deleteAlbum"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album that you wish to delete

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"5fd1dc4c-810a-46b0-b856-4ed38bb32da9","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"36f1e130-1025-4249-ab49-1047e4c493f4"},{"name":"Duplicate album","id":"2c599435-a2d6-4d14-89e0-37147cba94fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/duplicateAlbum?albumClient={{albumClient}}&albumDescription={{albumDescription}}&albumID={{albumID}}&albumName={{albumName}}&albumProject={{albumProject}}©Assets={{1}}&format={{json}}","description":"

\n
This will duplicate the given album, and if the other fields are passed in, they will be used for the new album. If the parameters are not specified, then they will be taken from the album that you are duplicating. If you do not wish to have a value for these fields and you do not want to take the values from the given album, then pass in an empty string for that parameter.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","duplicateAlbum"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The Base64 encoded client name that you wish to use.

\n","type":"text/plain"},"key":"albumClient","value":"{{albumClient}}"},{"description":{"content":"

The Base64 encoded album description that you wish to use.

\n","type":"text/plain"},"key":"albumDescription","value":"{{albumDescription}}"},{"description":{"content":"

The ID of the album that you wish to duplicate.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The Base64 encoded album name that you wish to use.

\n","type":"text/plain"},"key":"albumName","value":"{{albumName}}"},{"description":{"content":"

The Base64 encoded project name that you wish to use.

\n","type":"text/plain"},"key":"albumProject","value":"{{albumProject}}"},{"description":{"content":"

If you wish to copy the assets and shortcuts from the given album, the set this value to 1. 0 will just copy the album and leave it empty.

\n","type":"text/plain"},"key":"copyAssets","value":"{{1}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"e5a2ee58-4015-40b9-a81c-6372dd6ea44f","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"2c599435-a2d6-4d14-89e0-37147cba94fd"},{"name":"Get album assets","id":"1e673e09-4106-4008-bccc-949cf4c83dde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumAssets?albumID={{albumID}}&assetTypes={{all}}&fileName={{fileName}}&format={{json}}&integration={{0}}&log={{1}}&numberOfResults={{50}}&sortBy={{sortBy}}&start={{1}}","description":"

\n
Returns the assets for a given album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

ID of the album you wish to get assets for.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

A comma separated list of strings representing the types of assets you wish to bring back. Values are all,audio,document,folder,image,template,video

\n","type":"text/plain"},"key":"assetTypes","value":"{{all}}"},{"description":{"content":"

This is a basic filter that will only bring back assets that have this value in their file name

\n","type":"text/plain"},"key":"fileName","value":"{{fileName}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether this call is being made from an integration

\n","type":"text/plain"},"key":"integration","value":"{{0}}"},{"description":{"content":"

Whether to log this call as a view to an album

\n","type":"text/plain"},"key":"log","value":"{{1}}"},{"description":{"content":"

The number of results that you wish to be returned

\n","type":"text/plain"},"key":"numberOfResults","value":"{{50}}"},{"description":{"content":"

A comma separated list of strings in the format: field:order e.g. alpha:asc,size_disk:asc

\n","type":"text/plain"},"key":"sortBy","value":"{{sortBy}}"},{"description":{"content":"

The result number that you wish to start from (not currently implemented)

\n","type":"text/plain"},"key":"start","value":"{{1}}"}],"variable":[{"id":"82b8c92b-487a-4e0a-b62d-8cb71652c537","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"1e673e09-4106-4008-bccc-949cf4c83dde"},{"name":"Get album deleted assets","id":"143d8a8d-c4aa-4a02-b42e-2c086df1327f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumDeletedAssets?albumID={{albumID}}&format={{json}}","description":"

\n
Returns a list of the assets that have been removed from the given album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumDeletedAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album that you wish to get the deleted assets for.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"11844cca-c937-4a75-8c2a-689589ef4bf2","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"143d8a8d-c4aa-4a02-b42e-2c086df1327f"},{"name":"Get album dependencies","id":"27fcd306-9e07-4d9a-9b4d-450c3577e32f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumDependencies?albumID={{albumID}}&format={{json}}","description":"

\n
Returns information about the dependencies for the given album (e.g. the number of assets in this album, and the number of times it's been shared.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumDependencies"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album that you wish to get the deleted assets for.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"7f354515-8771-4bd2-99a7-1711ac34e88a","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"27fcd306-9e07-4d9a-9b4d-450c3577e32f"},{"name":"Get album global transforms","id":"e6a83c63-163c-4bb5-9409-1dcad8552fd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumGlobalTransforms","description":"

\n
Gets the transforms generally available for albums.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumGlobalTransforms"],"host":["api","brandworkz","com"],"query":[],"variable":[{"id":"6c8498f2-5860-4a96-a8fd-3b9c6df30ed3","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"e6a83c63-163c-4bb5-9409-1dcad8552fd1"},{"name":"Get album history","id":"4a3738bf-5a39-4afb-833a-c8f5d04a3af5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumHistory?albumID={{albumID}}&endDate={{endDate}}&format={{json}}&startDate={{startDate}}","description":"

\n
Returns they history records for the given album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumHistory"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

An album ID to retrieve the history for.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The latest date that you wish to get the history to.

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The earliest date that you wish to get the history from.

\n","type":"text/plain"},"key":"startDate","value":"{{startDate}}"}],"variable":[{"id":"9329ad02-ea7c-447a-a7c3-d2b1fa9f6902","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"4a3738bf-5a39-4afb-833a-c8f5d04a3af5"},{"name":"Get album info","id":"351a2ad5-e7d4-4716-adb0-67aef71bb595","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumInfo?albumID={{albumID}}&format={{json}}","description":"

\n
Returns information about the given album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumInfo"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album that you wish to retrieve information

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"7f879ecc-cc52-4475-b562-dc685fea51b6","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"351a2ad5-e7d4-4716-adb0-67aef71bb595"},{"name":"Get album large previews","id":"d8aa7f57-f9ca-482d-bc1d-faafbf07d944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumLargePreviews?activeID={{0}}&albumID={{albumID}}&assetID={{assetID}}&format={{json}}&isFullScreen={{0}}&post={{post}}&pre={{pre}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Returns large preview code for the parameters passed in,
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumLargePreviews"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The asset ID that is to be shown first

\n","type":"text/plain"},"key":"activeID","value":"{{0}}"},{"description":{"content":"

ID of the album that contains these assets

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

ID of the asset in the middle you wish to get previews for

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether this is a fullscreen request or not (should bring back previews of the larger size. 0 = False, 1= True

\n","type":"text/plain"},"key":"isFullScreen","value":"{{0}}"},{"description":{"content":"

A comma separated list of asset IDs that are to come after the selected asset

\n","type":"text/plain"},"key":"post","value":"{{post}}"},{"description":{"content":"

A comma separated list of asset IDs that are to precede the selected asset

\n","type":"text/plain"},"key":"pre","value":"{{pre}}"},{"description":{"content":"

A comma separated list of shortcut IDs, these are used to match up with the asset IDs passed in when we're looking at a shortcut. These can then be used to distinguish them in any output

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"1fde113b-aebb-46ea-80ae-f39fef62d697","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"d8aa7f57-f9ca-482d-bc1d-faafbf07d944"},{"name":"Get album sent log entry","id":"0c9e6879-ab07-47b5-9683-47b2aca92484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumSentEntry?accessID={{accessID}}&format={{html}}","description":"

\n
Retrieves the given sent entry.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumSentEntry"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The access ID for the record

\n","type":"text/plain"},"key":"accessID","value":"{{accessID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{html}}"}],"variable":[{"id":"6edd0e27-dc0a-4ade-8472-7200ab65d41d","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"0c9e6879-ab07-47b5-9683-47b2aca92484"},{"name":"Get album sent logs","id":"bf1cc67b-4989-4b0e-86eb-cd7fa2845b10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumSentLogs?endDate={{endDate}}&format={{json}}&startDate={{startDate}}","description":"

\n
Returns they history records for the given album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumSentLogs"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The latest date that you wish to get the history to.

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The earliest date that you wish to get the history from.

\n","type":"text/plain"},"key":"startDate","value":"{{startDate}}"}],"variable":[{"id":"37c5796a-2c7d-4767-ae9a-8d0a895c8d29","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"bf1cc67b-4989-4b0e-86eb-cd7fa2845b10"},{"name":"Get album sent logs for month","id":"0b499176-848a-4680-91e9-9ff7a58c6fa8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumSentLogsForMonth?format={{json}}&month={{month}}&year={{year}}","description":"

\n
Gets the album sent logs for the specified month.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumSentLogsForMonth"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The earliest date that you wish to get the history from.

\n","type":"text/plain"},"key":"month","value":"{{month}}"},{"description":{"content":"

The earliest date that you wish to get the history from.

\n","type":"text/plain"},"key":"year","value":"{{year}}"}],"variable":[{"id":"b33be4ee-eade-497d-8159-2c38fc9b1071","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"0b499176-848a-4680-91e9-9ff7a58c6fa8"},{"name":"Get album transforms","id":"5b3a6b46-b0be-4411-982c-6a9582620145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbumTransforms?albumID={{albumID}}&format={{json}}&template={{transforms}}","description":"

\n
Gets the list of transforms available for the specified album.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbumTransforms"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

albumID

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

template

\n","type":"text/plain"},"key":"template","value":"{{transforms}}"}],"variable":[{"id":"1df250fd-67bb-4c77-92d5-1f1190c27d11","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"5b3a6b46-b0be-4411-982c-6a9582620145"},{"name":"Get albums","id":"5dcd3e4c-0412-4163-bd8e-98c1236d745c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAlbums?format={{json}}&listingType={{0,1}}&sortBy={{sortBy}}","description":"

\n
Returns a list of albums which match the specified criteria, for the logged in user.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAlbums"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The type of albums you wish to return. Values are: 0 - Sent albums, 1 - Received albums

\n","type":"text/plain"},"key":"listingType","value":"{{0,1}}"},{"description":{"content":"

The sort string that you wish to return the albums in

\n","type":"text/plain"},"key":"sortBy","value":"{{sortBy}}"}],"variable":[{"id":"c1eab25d-6953-4ead-be3c-50d5dd1d390b","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"5dcd3e4c-0412-4163-bd8e-98c1236d745c"},{"name":"Get latest albums","id":"e55e9800-90f2-4dc9-b742-786a6b660918","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/latestAlbums?format={{json}}&limit={{limit}}&showHidden={{0}}&template={{latestAlbums}}","description":"

\n
Returns the latest created albums for the logged in user.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","latestAlbums"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The maximum number of albums you wish to return.

\n","type":"text/plain"},"key":"limit","value":"{{limit}}"},{"description":{"content":"

Whether to show hidden albums or not.

\n","type":"text/plain"},"key":"showHidden","value":"{{0}}"},{"description":{"content":"

The name of the template you wish to return. Note: Outside of a brandworkz instance, this paramater is unlikely to be anything other than the default.

\n","type":"text/plain"},"key":"template","value":"{{latestAlbums}}"}],"variable":[{"id":"d8aff9dc-97de-4370-89a6-85f139972875","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"e55e9800-90f2-4dc9-b742-786a6b660918"},{"name":"Remove album assets","id":"0d85fee6-cf57-4b63-bf21-62f736b695f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/removeAlbumAssets?albumID={{albumID}}&assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Removes the given assets from the given album. This method does not actually delete the assets from the system. This action is non-reversible.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","removeAlbumAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album ID that you wish to remove the assets from.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

A comma separated list of asset IDs that you wish to remove from the album.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

A comma separated list of shortcut IDs that you wish to remove from the album.

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"11ea8e68-9811-497e-abb3-8b13947f2460","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"0d85fee6-cf57-4b63-bf21-62f736b695f5"},{"name":"Save album","id":"cec32974-489c-4fe9-b598-045eba7c240f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/saveAlbum?albumClient={{albumClient}}&albumDescription={{albumDescription}}&albumID={{albumID}}&albumName={{albumName}}&albumProject={{albumProject}}&assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}&showFullscreen={{1}}&showMetadata={{0}}","description":"

\n
Saves the given details against the given album. This function will return details about the album after the update.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","saveAlbum"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The Base64 encoded client name that you wish to use.

\n","type":"text/plain"},"key":"albumClient","value":"{{albumClient}}"},{"description":{"content":"

The Base64 encoded album description that you wish to use.

\n","type":"text/plain"},"key":"albumDescription","value":"{{albumDescription}}"},{"description":{"content":"

The album ID that you are going to save.

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

The Base64 encoded album name that you wish to use.

\n","type":"text/plain"},"key":"albumName","value":"{{albumName}}"},{"description":{"content":"

The Base64 encoded project name that you wish to use.

\n","type":"text/plain"},"key":"albumProject","value":"{{albumProject}}"},{"description":{"content":"

The comma seprarated list of assets that you wish to save to this album.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The comma seprarated list of shortcuts that you wish to save to this album.

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"},{"description":{"content":"

Whether to allow a full screen view for the assets on this album.

\n","type":"text/plain"},"key":"showFullscreen","value":"{{1}}"},{"description":{"content":"

Whether to allow the user to see metadata for assets when viewing this album.

\n","type":"text/plain"},"key":"showMetadata","value":"{{0}}"}],"variable":[{"id":"80c9e915-2127-4678-9528-7056d31693df","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"cec32974-489c-4fe9-b598-045eba7c240f"},{"name":"Share album","id":"1899b7ea-5113-4e85-944a-23d3a0d7e465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/shareAlbum?albumID={{albumID}}&emailAddresses={{emailAddresses}}&emailMessage={{emailMessage}}&emailSubject={{emailSubject}}&endDate={{endDate}}&format={{json}}&groupIDs={{groupIDs}}&startDate={{startDate}}&transformIDs={{transformIDs}}&userIDs={{userIDs}}","description":"

\n
Shares the given album with the given users and email addresses. This function does not guarantee that the emails will be sent out immediately, but that they will go into a queue.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","shareAlbum"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The album that you wish to share

\n","type":"text/plain"},"key":"albumID","value":"{{albumID}}"},{"description":{"content":"

A comma separated list of email addresses that you wish to share the album with.

\n","type":"text/plain"},"key":"emailAddresses","value":"{{emailAddresses}}"},{"description":{"content":"

Base64 encoded text for the body of the email that will be sent to the recipients.

\n","type":"text/plain"},"key":"emailMessage","value":"{{emailMessage}}"},{"description":{"content":"

Base64 encoded text for the subject of the email that will be sent to the recipients.

\n","type":"text/plain"},"key":"emailSubject","value":"{{emailSubject}}"},{"description":{"content":"

The date that you wish the shared album to be stop being accessible.

\n","type":"text/plain"},"key":"endDate","value":"{{endDate}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

A comma separated list of group IDs that you wish to share the album with.

\n","type":"text/plain"},"key":"groupIDs","value":"{{groupIDs}}"},{"description":{"content":"

The date that you wish the shared album to be accessible.

\n","type":"text/plain"},"key":"startDate","value":"{{startDate}}"},{"description":{"content":"

A comma separated list of transform IDs that you wish to assign to recipients of this album.

\n","type":"text/plain"},"key":"transformIDs","value":"{{transformIDs}}"},{"description":{"content":"

A comma separated list of user IDs that you wish to share the album with.

\n","type":"text/plain"},"key":"userIDs","value":"{{userIDs}}"}],"variable":[{"id":"9447dc49-c3e0-421c-907a-af722156d0c5","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"1899b7ea-5113-4e85-944a-23d3a0d7e465"}],"id":"4b0ef989-8f7c-4ca2-96f5-7ab384e4f821","description":"

Services for interacting with albums.

\n","_postman_id":"4b0ef989-8f7c-4ca2-96f5-7ab384e4f821"},{"name":"Annotations","item":[{"name":"Create annotation","id":"012a0693-b2b5-48fe-ac0d-7c2ba0dc8f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.brandworkz.com/v1.6/:client_id/createAnnotation?format={{json}}","description":"

\n
Creates an annotation/comment.
\n

BODY PARAMETERS

artworkID (integer)
\n
artworkVersion (integer)
\n
boxes (array)
\n
comment (string)
\n
dateActioned (string)
\n
dateCreated (string)
\n
dateModified (string)
\n
id (integer)
\n
isEditable (boolean)
\n
objectWorkflowStageID (string)
\n
pageNo (integer)
\n
parent (integer)
\n
status (integer)
\n
userActioned (integer)
\n
userActionedFullName (string)
\n
userCreated (integer)
\n
userFullName (string)
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","createAnnotation"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"1af02955-ccc5-4c32-9634-f10b3635d53b","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"012a0693-b2b5-48fe-ac0d-7c2ba0dc8f02"},{"name":"Delete annotation","id":"99e20861-ec85-4876-8562-635191fbbae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/deleteAnnotation?annotationID={{annotationID}}&format={{json}}","description":"

\n
Deletes an annotation/comment.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","deleteAnnotation"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

annotationID

\n","type":"text/plain"},"key":"annotationID","value":"{{annotationID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"c0d44384-9f26-4ef3-956a-4fa7382cdd18","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"99e20861-ec85-4876-8562-635191fbbae8"},{"name":"Get annotations","id":"ff0bc4f7-d584-43ed-8a9f-cb5fbe229a98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAnnotations?assetID={{assetID}}&assetVersion={{assetVersion}}&creatorID={{creatorID}}&format={{json}}&objectWorkflowStageID={{objectWorkflowStageID}}&pageNo={{pageNo}}&parentID={{parentID}}&sortBy={{dateCreated:desc}}","description":"

\n
Returns a list of annotations/comments.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAnnotations"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetID

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

assetVersion

\n","type":"text/plain"},"key":"assetVersion","value":"{{assetVersion}}"},{"description":{"content":"

creatorID

\n","type":"text/plain"},"key":"creatorID","value":"{{creatorID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

objectWorkflowStageID

\n","type":"text/plain"},"key":"objectWorkflowStageID","value":"{{objectWorkflowStageID}}"},{"description":{"content":"

pageNo

\n","type":"text/plain"},"key":"pageNo","value":"{{pageNo}}"},{"description":{"content":"

parentID

\n","type":"text/plain"},"key":"parentID","value":"{{parentID}}"},{"description":{"content":"

sortBy

\n","type":"text/plain"},"key":"sortBy","value":"{{dateCreated:desc}}"}],"variable":[{"id":"b09dedb2-5383-4c49-8b0c-fc111a24bfd9","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"ff0bc4f7-d584-43ed-8a9f-cb5fbe229a98"},{"name":"Get workflow annotation previews","id":"b153f66a-d5ae-4e10-bf84-83e9debefc77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getWorkflowAnnotationPreviews?assetID={{assetID}}&format={{json}}&isFullScreen={{0}}&objectWorkflowStageID={{objectWorkflowStageID}}","description":"

\n
Returns preview for annotating an asset in a workflow.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getWorkflowAnnotationPreviews"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

ID of the asset in the middle you wish to get previews for

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether this is a fullscreen request or not (should bring back previews of the larger size. 0 = False, 1= True

\n","type":"text/plain"},"key":"isFullScreen","value":"{{0}}"},{"description":{"content":"

objectWorkflowStageID

\n","type":"text/plain"},"key":"objectWorkflowStageID","value":"{{objectWorkflowStageID}}"}],"variable":[{"id":"f8cc2f8e-6a42-41b8-9aca-5faadf7567b2","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"b153f66a-d5ae-4e10-bf84-83e9debefc77"},{"name":"Update comment","id":"b2d87fe3-eda7-4014-8027-b1b177c721f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/updateComment?annotationID={{annotationID}}&comment={{comment}}&format={{json}}","description":"

\n
Updates an annotation/comment.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","updateComment"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The ID of the annotation you wish to update.

\n","type":"text/plain"},"key":"annotationID","value":"{{annotationID}}"},{"description":{"content":"

The new comment text for the given annotation.

\n","type":"text/plain"},"key":"comment","value":"{{comment}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"ca8c3b69-2992-485a-a7fe-0a368dacc40b","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"b2d87fe3-eda7-4014-8027-b1b177c721f4"}],"id":"bc965eb5-7731-4cdd-86d1-fcc14ba9a3e9","description":"

Services for working with asset annotations.

\n","_postman_id":"bc965eb5-7731-4cdd-86d1-fcc14ba9a3e9"},{"name":"Assets","item":[{"name":"Assemble","id":"48ba0573-6821-421a-bd43-a86be2fc3c87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.brandworkz.com/v1.6/:clientId/assemble","description":"

\n
If you under the /createUploadPath endpoint specified uploadType=multipart, or you didn't specify this and the file was larger than 15MB, you will after uploading each part to need to call this endpoint to assemble the uploaded parts/chunks into one file. See the 'Uploading' section of apidocs.brandworkz.com for further details on usage.
\n

BODY PARAMETERS

objectKey (string): The object key as previously returned from the /createUploadPath endpoint in the data.keyname value.
\n
uploadId (string): The upload ID obtained previously by calling /createUploadPath.
\n
parts (array): The parts to assemble together. Each part should contain the partNumber, and the eTag, returned in the header when the chunk was uploaded.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","assemble"],"host":["api","brandworkz","com"],"query":[],"variable":[{"id":"6673eda0-e7de-4519-8aca-3927c4767b8b","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{clientId}}","key":"clientId"}]}},"response":[],"_postman_id":"48ba0573-6821-421a-bd43-a86be2fc3c87"},{"name":"Copy assets","id":"c311bb23-b096-4c3c-b09f-f8e5a59a9515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/copyAssets?assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Sets in session attributes copied_assets and/or copied_shortcuts.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","copyAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetIDs

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

shortcutIDs

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"49859067-b9de-4935-adbd-7a3017a88dba","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"c311bb23-b096-4c3c-b09f-f8e5a59a9515"},{"name":"Create upload path","id":"1ddf4213-b630-4961-a27f-f68b66783d45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"body":{"mode":"raw","raw":"{}"},"url":"https://api.brandworkz.com/v1.6/:clientId/createUploadPath","description":"

\n
First step to uploading a file. This endpoint will return the upload URL(s) which the file should be PUT to. See the 'Uploading' section of apidocs.brandworkz.com for further details on usage.
\n

BODY PARAMETERS

fileName (string): The name of the file being uploaded incl suffix. e.g. myLogo.png.
\n
fileSize (integer): The size of the file being uploaded in bytes.
\n
categoryGuid (string): The GUID of the category being uploaded into.
\n
assetGuid (string): If you would like to upload a new file/version to an existing asset then specify the assetGuid of the asset you would like to upload this new version to. Also, if you are uploading a custom thumbnail to an existing asset then you must specify this.
\n
isCustomThumbnail (boolean): If this is set to true then the path returned will be for uploading a custom thumbnail/preview to an existing asset. You must specify a valid assetGuid if this is set to true and also set the equivalent parameter to true in the subsequent /importAsset endpoint.
\n
uploadType (string): Can be either 'single-upload' or 'multipart-upload'. This will control if this function returns a single link for uploading the entire file in one PUT, or an array of links for uploading the file in chunks. If this isn't specified then a single upload link will be returned for files of less than 15MB, and an array of upload links for each 15MB chunk for files larger than this. See the 'Uploading' section of apidocs.brandworkz.com for further guidance on this.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","createUploadPath"],"host":["api","brandworkz","com"],"query":[],"variable":[{"id":"5ea48c00-b34f-49aa-8a98-bd6800eddb83","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{clientId}}","key":"clientId"}]}},"response":[],"_postman_id":"1ddf4213-b630-4961-a27f-f68b66783d45"},{"name":"Delete assets","id":"03b9fe8b-474f-4ecf-9229-832ec5055a94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/deleteAssets?assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Deletes the specified asset or shortcut Ids.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","deleteAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetIDs

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

shortcutIDs

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"370a5b9d-110d-42b6-ab97-9400b6b7271c","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"03b9fe8b-474f-4ecf-9229-832ec5055a94"},{"name":"Delete relations","id":"4237daf9-6fd6-41c6-9c90-c450fea9f9c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/deleteRelations?assetID={{assetID}}&assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Removes the relation between the given assets and shortcuts.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","deleteRelations"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

ID of the asset you wish to remove the assets/shortcuts from.

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

IDs of the assets that you wish to remove the relation from.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

IDs of the shortcuts that you wish to remove the relation from.

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"c72c06c7-1122-46bd-b854-6dd1e3d99666","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"4237daf9-6fd6-41c6-9c90-c450fea9f9c6"},{"name":"Get app download links","id":"e102e4be-eeae-40ea-95ab-924a9fad45eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAppDownloadLinks?assetIDs={{assetIDs}}&format={{json}}","description":"

\n
Gets the download links for the specified assets.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAppDownloadLinks"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetIDs

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"150dff00-3c4a-40c5-b266-dcb34d1c16d1","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"e102e4be-eeae-40ea-95ab-924a9fad45eb"},{"name":"Get asset dependencies","id":"db056a75-8063-4e5d-88bb-457d4494d26f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/assets/:assetIds/dependencies","description":"

\n
Returns the number of albums, shortcuts and relations the specified asset Ids have.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","assets",":assetIds","dependencies"],"host":["api","brandworkz","com"],"query":[],"variable":[{"id":"90f0c492-d1a0-42f9-be87-57198f94ac1c","description":{"content":"

The asset IDs for which you wish to get dependencies

\n","type":"text/plain"},"type":"any","value":"{{assetIds}}","key":"assetIds"},{"id":"01a8c694-39f4-46db-8df8-5654407fd46e","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"db056a75-8063-4e5d-88bb-457d4494d26f"},{"name":"Get asset embed form","id":"ef0d0fd4-a2cf-43d5-ba59-fceebbd67e9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getEmbedForm?assetID={{assetID}}&format={{html}}","description":"

\n
Gets the embed form for the specified asset Id.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getEmbedForm"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The numeric ID of the asset you would the like the embed link form for.

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{html}}"}],"variable":[{"id":"fc0ad9c7-efcc-41da-9cbb-e656b18ba412","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"ef0d0fd4-a2cf-43d5-ba59-fceebbd67e9f"},{"name":"Get asset embed link","id":"62b14378-d8df-4265-89fe-0b9327552068","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getEmbedLink?assetGUID={{assetGUID}}&assetID={{assetID}}&format={{json}}&sourceFields={{sourceFields}}&systemName={{systemName}}&usage={{usage}}","description":"

\n
Returns the asset embed links for each transform.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getEmbedLink"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The GUID of the asset you would the like the embed link for. You must provide either this parameter or the numeric ID

\n","type":"text/plain"},"key":"assetGUID","value":"{{assetGUID}}"},{"description":{"content":"

The numeric ID of the asset you would the like the embed link for. You must provide either this parameter or the GUID

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Comma-separated list of metadata fields.
The built-in fields for assets are:
title,description,extendedKeywords,breadcrumb,dateCreated,dateModified,objectURL,repositoryFilename,
repositoryFolder,thumbnailUrl,GUID,versionGUID,createdBy,createdByUserID,
createdByUser_ID,categoryID,fileCategory,icon_class,serialNumber,
serialNumberText,version,original_fileName,fileSizeOnDiskKB,orientation,
documentFulltext,pixelWidth,pixelHeight,dpi,pagecount,duration,assetExpiry,
fileType,filetypeTab,filetype_friendly,colourSpace,folder.

\n","type":"text/plain"},"key":"sourceFields","value":"{{sourceFields}}"},{"description":{"content":"

The system name of the transform wizard.

\n","type":"text/plain"},"key":"systemName","value":"{{systemName}}"},{"description":{"content":"

The Transform usage type eg Embed Link, sitecore.

\n","type":"text/plain"},"key":"usage","value":"{{usage}}"}],"variable":[{"id":"c54232df-c061-4992-8e15-a97867240b8d","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"62b14378-d8df-4265-89fe-0b9327552068"},{"name":"Get asset embed logs","id":"856d6422-a228-4859-85b7-b2254833db9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAssetEmbedLogs?assetID={{assetID}}&format={{json}}","description":"

\n
Gets the embed logs for the specified asset Id.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAssetEmbedLogs"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

ID of the asset that you want to process.

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"9c431b7f-c3b5-40e2-8b7e-fad0d976f374","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"856d6422-a228-4859-85b7-b2254833db9d"},{"name":"Get asset last modified date","id":"fe572410-3ed2-4480-abe4-2b9687dcd819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/assetLastModified?assetID={{assetID}}&assetVersion={{assetVersion}}","description":"

\n
Gets the date that the asset was last modified. This includes any metadata, album, or folder related activity.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","assetLastModified"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The ID of the asset you wish to check

\n","type":"text/plain"},"key":"assetID","value":"{{assetID}}"},{"description":{"content":"

The version of the asset you wish to check

\n","type":"text/plain"},"key":"assetVersion","value":"{{assetVersion}}"}],"variable":[{"id":"aeadb191-f7ff-40d1-835e-793c564d8566","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"fe572410-3ed2-4480-abe4-2b9687dcd819"},{"name":"Get asset permissions","id":"4fed4c16-2be7-4e95-a1f2-dc2ac55136ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAssetsPermissions?assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAssetsPermissions"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetIDs

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

shortcutIDs

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"1bc6c0e1-32e1-48ed-b7e4-16b700c669ea","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"4fed4c16-2be7-4e95-a1f2-dc2ac55136ad"},{"name":"Get asset permissions including transforms","id":"1aec8a4d-5da5-45db-b8c5-c2e378833e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:clientId/assets/permissions?albumId={{albumId}}&allowedTransformSystemrefs={{allowedTransformSystemrefs}}&assetGuids={{assetGuids}}&assetType={{assetType}}&shortcutGuids={{shortcutGuids}}&usage={{usage}}","description":"

\n
Gets a user's list of permissions for an asset. You must specify an asset and/or shortcut GUID.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","assets","permissions"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

Album Id for which to get the transforms and permissions. If using album Id you must also specify asset and/or shortcut GUID of the asset(s) to get the permissions for.

\n","type":"text/plain"},"key":"albumId","value":"{{albumId}}"},{"description":{"content":"

Optionally limit down to one or more specific transforms by entering their systemref(s) here. Enter as comma-separated list. \nEnter their 'System Name' as entered in the admin UI for that transform

\n","type":"text/plain"},"key":"allowedTransformSystemrefs","value":"{{allowedTransformSystemrefs}}"},{"description":{"content":"

Asset Guids for which to get the transforms and permissions. More than one can be specified comma-separated.

\n","type":"text/plain"},"key":"assetGuids","value":"{{assetGuids}}"},{"description":{"content":"

Optionally limit down to just Image or Video transforms. Note that if you pass in Audio, Document, 3D, Other, or Font then you will just get 'Download original' transforms back for those types.

\n","type":"text/plain"},"key":"assetType","value":"{{assetType}}"},{"description":{"content":"

Shortcut Guids for which to get the transforms and permissions. More than one can be specified comma-separated.

\n","type":"text/plain"},"key":"shortcutGuids","value":"{{shortcutGuids}}"},{"description":{"content":"

Limit down to transforms marked with a certain usage. Allowed values are CMSBRANDWORKZ, WEBEMBED, SITECORE, WORDPRESS, DRUPAL, OFFICE

\n","type":"text/plain"},"key":"usage","value":"{{usage}}"}],"variable":[{"id":"0049fb2d-1f65-432e-b516-6e6a7f289b1d","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{clientId}}","key":"clientId"}]}},"response":[],"_postman_id":"1aec8a4d-5da5-45db-b8c5-c2e378833e1a"},{"name":"Get asset rendition","id":"02a4ad50-00d6-427a-8b56-fdc42655cb01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:clientId/getAssetRendition?ag={{ag}}&format={{json}}&s={{s}}","description":"

\n
Gets a download link for the given asset in the given rendition. Will only return links for users who have the CI Hub integration enabled.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","getAssetRendition"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The assetGuid

\n","type":"text/plain"},"key":"ag","value":"{{ag}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

The size/rendition. Can be either 'BWKZOriginal' for the original file, or 'BWKZFPO' for a low-res, 72dpi version of the original For Positional Only (FPO) within print-related applications. Note that only bitmap images will have an FPO version, other filetypes will return the original even if BWKZFPO is specified along with an appropriate result.message

\n","type":"text/plain"},"key":"s","value":"{{s}}"}],"variable":[{"id":"0561f42b-c1c5-40d4-9773-4a4b531262a5","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{clientId}}","key":"clientId"}]}},"response":[],"_postman_id":"02a4ad50-00d6-427a-8b56-fdc42655cb01"},{"name":"Get asset transforms","id":"4d55037b-9079-43a0-89aa-70147a4dbbe2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:clientId/transforms?albumId={{albumId}}&allowedTransformSystemrefs={{allowedTransformSystemrefs}}&assetGuids={{assetGuids}}&assetType={{assetType}}&shortcutGuids={{shortcutGuids}}&usage={{usage}}","description":"

\n
We highly encourage you to not use this endpoint since it will be removed in future versions. Instead, please use /assets/permissions, which also returns asset transforms.
Gets a list of asset transforms, filtered by the specified parameters.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","transforms"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

Album Id for which to get the transforms.

\n","type":"text/plain"},"key":"albumId","value":"{{albumId}}"},{"description":{"content":"

Optionally limit down to one or more specific transforms by entering their systemref(s) here. Enter as comma-separated list. \nEnter their 'System Name' as entered in the admin UI for that transform

\n","type":"text/plain"},"key":"allowedTransformSystemrefs","value":"{{allowedTransformSystemrefs}}"},{"description":{"content":"

Asset Ids for which to get the transforms.

\n","type":"text/plain"},"key":"assetGuids","value":"{{assetGuids}}"},{"description":{"content":"

Optionally limit down to just Image or Video transforms. Note that if you pass in Audio, Document, 3D, Other, or Font then you will just get 'Download original' transforms back for those types.

\n","type":"text/plain"},"key":"assetType","value":"{{assetType}}"},{"description":{"content":"

Shortcut Ids for which to get the transforms.

\n","type":"text/plain"},"key":"shortcutGuids","value":"{{shortcutGuids}}"},{"description":{"content":"

Limit down to transforms marked with a certain usage. Allowed values are CMSBRANDWORKZ, WEBEMBED, SITECORE, WORDPRESS, DRUPAL, OFFICE

\n","type":"text/plain"},"key":"usage","value":"{{usage}}"}],"variable":[{"id":"c9565844-e6f9-450c-8822-d0eef4d74945","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{clientId}}","key":"clientId"}]}},"response":[],"_postman_id":"4d55037b-9079-43a0-89aa-70147a4dbbe2"},{"name":"Get asset usage","id":"47921b05-1caa-478c-b3a2-98eaff7ad3c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getUsage?assetIDs={{assetIDs}}&format={{json}}&summary={{1}}","description":"

\n
Gets the usage of the given assets, e.g. views, downloads.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getUsage"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The asset IDs that you wish to get the usage information for.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether you just need a simple count of usage or more details.

\n","type":"text/plain"},"key":"summary","value":"{{1}}"}],"variable":[{"id":"64ee50f9-a128-4aef-a775-32b7de033428","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"47921b05-1caa-478c-b3a2-98eaff7ad3c5"},{"name":"Get assets","id":"affe1c12-84f3-4464-aa31-daec9618c088","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getAssets?assetIDs={{assetIDs}}&format={{json}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Returns the assets for the given IDs. This includes the thumbnail links.
\n

The thumbnails returned are 350x350 (if available). The assets will be returned in the order in which they are passed in.

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

IDs of the assets you wish to see.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

IDs of the shortcuts you wish to see. Note: the asset IDs need to be included in the ass

\n","type":"text/plain"},"key":"shortcutIDs","value":"{{shortcutIDs}}"}],"variable":[{"id":"17b29e5a-be20-4576-88bb-a20773b4c0db","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"affe1c12-84f3-4464-aa31-daec9618c088"},{"name":"Get category assets","id":"ee8b76dc-7c8e-4ddc-a7f6-7d812c285b72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getCategoryAssets?assetTypes={{all}}&categoryID={{categoryID}}&fileName={{fileName}}&format={{json}}&integration={{0}}&integrationTemplate={{/ntegrations/assetItem}}&log={{1}}&numberOfResults={{50}}&sortBy={{sortBy}}&sourceFields={{sourceFields}}&start={{1}}","description":"

\n
Returns the assets for a given category. This includes the thumbnail links, and any video previews required.
\n

The thumbnails returned are 1220x2525 (if available).

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getCategoryAssets"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

A comma separated list of strings representing the types of assets you wish to bring back. Values are all,audio,document,folder,image,template,video

\n","type":"text/plain"},"key":"assetTypes","value":"{{all}}"},{"description":{"content":"

ID of the category you wish to get assets for.

\n","type":"text/plain"},"key":"categoryID","value":"{{categoryID}}"},{"description":{"content":"

This is a basic filter that will only bring back assets that have this value in their file name

\n","type":"text/plain"},"key":"fileName","value":"{{fileName}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

Whether this call is coming from an integration or not

\n","type":"text/plain"},"key":"integration","value":"{{0}}"},{"description":{"content":"

The template string to use for this integration

\n","type":"text/plain"},"key":"integrationTemplate","value":"{{/ntegrations/assetItem}}"},{"description":{"content":"

Whether to log this call as a view to a category

\n","type":"text/plain"},"key":"log","value":"{{1}}"},{"description":{"content":"

The number of results that you wish to be returned

\n","type":"text/plain"},"key":"numberOfResults","value":"{{50}}"},{"description":{"content":"

A comma separated list of strings in the format: field:order e.g. alpha:asc,size_disk:asc

\n","type":"text/plain"},"key":"sortBy","value":"{{sortBy}}"},{"description":{"content":"

This will additionally return extendedKeywords, description, or both.

\n","type":"text/plain"},"key":"sourceFields","value":"{{sourceFields}}"},{"description":{"content":"

The row of data you wish to start from (for pagination)

\n","type":"text/plain"},"key":"start","value":"{{1}}"}],"variable":[{"id":"f8d3475f-008a-46df-ab45-a28c8fc509cf","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"ee8b76dc-7c8e-4ddc-a7f6-7d812c285b72"},{"name":"Get category transforms","id":"921c763b-abac-4882-9701-0e95fc5181be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getCategoryTransforms?categoryID={{categoryID}}&format={{json}}&template={{transforms}}","description":"

\n
Gets the list of available transforms for the specified category/folder Id.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getCategoryTransforms"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

categoryID

\n","type":"text/plain"},"key":"categoryID","value":"{{categoryID}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

template

\n","type":"text/plain"},"key":"template","value":"{{transforms}}"}],"variable":[{"id":"f5a395fb-57ca-4ff1-838e-030992b06f95","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"921c763b-abac-4882-9701-0e95fc5181be"},{"name":"Get download original links","id":"6be637e1-9294-475b-bc04-72fe0e4f33e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getDownloadOriginalLinks?assetIDs={{assetIDs}}&format={{json}}","description":"

\n
Gets the original artwork paths for the given asset IDs.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getDownloadOriginalLinks"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The asset IDs that you wish to get the usage information for.

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"}],"variable":[{"id":"9ef9cff8-f1d8-49fe-89dc-82f0095ae4ff","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"6be637e1-9294-475b-bc04-72fe0e4f33e7"},{"name":"Get full screen previews","id":"4d53c75e-a633-4fc5-8253-dab21b440313","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:client_id/getFullScreenPreviews?assetIDs={{assetIDs}}&format={{json}}&pageNumbers={{1}}","description":"

\n
Returns the full screen thumbnails for the specified asset Ids.
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":client_id","getFullScreenPreviews"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

assetIDs

\n","type":"text/plain"},"key":"assetIDs","value":"{{assetIDs}}"},{"description":{"content":"

The format you wish the data to be returned

\n","type":"text/plain"},"key":"format","value":"{{json}}"},{"description":{"content":"

pageNumbers

\n","type":"text/plain"},"key":"pageNumbers","value":"{{1}}"}],"variable":[{"id":"50bd8213-796a-4b3f-8df5-9345b161a4d8","description":{"content":"

Your client ID.

\n","type":"text/plain"},"type":"any","value":"{{client_id}}","key":"client_id"}]}},"response":[],"_postman_id":"4d53c75e-a633-4fc5-8253-dab21b440313"},{"name":"Get large previews","id":"eb355cb7-f430-459c-8376-1734a3dd4ff6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"text/html"},{"key":"Accept","value":"application/json;charset=UTF-8"}],"url":"https://api.brandworkz.com/v1.6/:clientId/getLargePreviews?activeID={{0}}&albumID={{albumID}}&assetID={{assetID}}&format={{json}}&isFullScreen={{0}}&post={{post}}&pre={{pre}}&shortcutIDs={{shortcutIDs}}","description":"

\n
Returns large preview code for the parameters passed in
\n

\n","urlObject":{"protocol":"https","path":["v1.6",":clientId","getLargePreviews"],"host":["api","brandworkz","com"],"query":[{"description":{"content":"

The asset ID that is to be shown first. Currently used for lazy loading, so as to be able to not have an active asset.

\n","type":"text/plain"},"key":"activeID","value":"{{0}}"},{"description":{"content":"

ID of the album that you are using, if viewing previews in an album.