{ "info": { "_postman_id": "a9bf8414-cf4a-4fe1-8b8d-ef05aa002126", "name": "Postman Bynder Collection - For Dev page", "description": "Update the following variables\n\n- Authorization (Create and use a Bynder permanent API token ([https://support.bynder.com/hc/en-us/articles/360013875300-Create-Permanent-Tokens](https://support.bynder.com/hc/en-us/articles/360013875300-Create-Permanent-Tokens)) \n- API Base URL (Your Bynder portal url excluding the '/' after <.com>\n- Your brand ID", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "15687334", "_collection_link": "https://red-star-825075.postman.co/workspace/Bynder-ONB-Team~4f08cdc6-3b90-4a43-a74a-4176df2fa391/collection/15687334-a9bf8414-cf4a-4fe1-8b8d-ef05aa002126?action=share&source=collection_link&creator=15687334" }, "item": [ { "name": "OAuth 2.0", "item": [ { "name": "Authorization endpoint", "item": [ { "name": "Authorize application", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Origin", "value": "http://localhost:3000", "disabled": true } ], "url": { "raw": "{{Authentication Base URL}}/auth?client_id={{OAuth App Client ID}}&redirect_uri={{OAuth App Client Redirect URI}}&scope={{All scopes}}&state=state&response_type=code", "host": [ "{{Authentication Base URL}}" ], "path": [ "auth" ], "query": [ { "key": "client_id", "value": "{{OAuth App Client ID}}", "description": "The client id provided for the OAuth application.\nExample: 00000000-0000-0000-0000-000000000000." }, { "key": "redirect_uri", "value": "{{OAuth App Client Redirect URI}}", "description": "The URL for the authorize response redirect. This must exactly match one of the \"Authorization redirect URIs\" values specified for the OAuth application.\nExample: http://localhost/callback." }, { "key": "scope", "value": "{{All scopes}}", "description": "Scopes to request authorization for. These must be separated by a space. Include offline to get a Refresh Token.\nExample: offline asset:read." }, { "key": "state", "value": "state", "description": "A random string used to maintain state between the request and callback. This value must is used to prevent CSRF attacks.\nExample: state." }, { "key": "response_type", "value": "code", "description": "Determines the flow being performed. The only option at the moment is code for Authorization Code Grant Flow.\nExample: code." } ] }, "description": "To use OAuth 2.0 an OAuth application is required. An OAuth application is used for generating your access token.In order to create your OAuth application you will need to have access to the Bynder portal as an administrator and go to your-bynder-domain/pysettings (for example https://company.bynder.com/pysettings)." }, "response": [] } ] }, { "name": "Token endpoint", "item": [ { "name": "Retrieve token", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Origin", "value": "http://localhost:3000", "disabled": true } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_id", "value": "Insert your OAuth app client id" }, { "key": "client_secret", "value": "Insert your OAuth app client secret" }, { "key": "redirect_uri", "value": "Insert your OAuth app redirect uri" }, { "key": "scope", "value": "offline admin.profile:read admin.user:read admin.user:write current.profile:read current.user:read asset:read asset:write asset.usage:read asset.usage:write collection:read collection:write meta.assetbank:read meta.assetbank:write meta.workflow:read workflow.campaign:read workflow.campaign:write workflow.group:read workflow.group:write workflow.job:read workflow.job:write workflow.preset:read brandstore.order:read brandstore.order:write" }, { "key": "grant_type", "value": "authorization_code" }, { "key": "code", "value": "" } ] }, "url": { "raw": "{{Authentication Base URL}}/token", "host": [ "{{Authentication Base URL}}" ], "path": [ "token" ] }, "description": "To use OAuth 2.0 an OAuth application is required. An OAuth application is used for generating your access token.In order to create your OAuth application you will need to have access to the Bynder portal as an administrator and go to your-bynder-domain/pysettings (for example https://company.bynder.com/pysettings)." }, "response": [] }, { "name": "Retrieve token Client Credentials", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "accessToken", "value": "", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Origin", "value": "http://localhost:3000", "disabled": true } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_id", "value": "Insert your OAuth app client id" }, { "key": "client_secret", "value": "Insert your OAuth app client secret" }, { "key": "scope", "value": "" }, { "key": "grant_type", "value": "client_credentials" } ] }, "url": { "raw": "{{Authentication Base URL}}/oauth2/token", "host": [ "{{Authentication Base URL}}" ], "path": [ "oauth2", "token" ] }, "description": "To use OAuth 2.0 an OAuth application is required. An OAuth application is used for generating your access token.In order to create your OAuth application you will need to have access to the Bynder portal as an administrator and go to your-bynder-domain/pysettings (for example https://company.bynder.com/pysettings)." }, "response": [] }, { "name": "Refresh token", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Origin", "value": "http://localhost:3000", "disabled": true } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "client_id", "value": "Insert your OAuth app client id" }, { "key": "client_secret", "value": "Insert your OAuth app client secret" }, { "key": "refresh_token", "value": "" }, { "key": "grant_type", "value": "refresh_token" } ] }, "url": { "raw": "{{Authentication Base URL}}/token", "host": [ "{{Authentication Base URL}}" ], "path": [ "token" ] }, "description": "To use OAuth 2.0 an OAuth application is required. An OAuth application is used for generating your access token.In order to create your OAuth application you will need to have access to the Bynder portal as an administrator and go to your-bynder-domain/pysettings (for example https://company.bynder.com/pysettings)." }, "response": [] } ] }, { "name": "Scopes endpoint", "item": [ { "name": "Retrieve scopes", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{Authentication Base URL}}/scopes", "host": [ "{{Authentication Base URL}}" ], "path": [ "scopes" ] } }, "response": [] } ] } ] }, { "name": "Security roles", "item": [ { "name": "Security profile operations", "item": [ { "name": "Retrieve security profiles", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/profiles/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "profiles", "" ] }, "description": "Security roles can be used to determine whether or not a user has the permission to perform a certain action.\n\nMore information about the different security roles can be found [here](https://help.bynder.com/Permissions/available-permissions.htm).\n\nTo determine the security profile for your user you can compare the security profile id with the profileId retrieved from either the **Retrieve specific user** or **Retrieve current user** call. It’s the API’s responsibility to enforce that users can only perform allowed actions but nevertheless we recommend that your application checks whether or not an action can be performed because this will create a better user experience.\n\n**Warning:** Requires the **PERMISSIONMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Specific security profile operations", "item": [ { "name": "Retrieve specific security profile", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/profiles/828E2FCA-C0CC-4761-AEEBE499089E6C69/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "profiles", "828E2FCA-C0CC-4761-AEEBE499089E6C69", "" ] }, "description": "This call allows you to retrieve your own security profile without requiring the **PERMISSIONMANAGEMENT** security role.\n\nIn order to get your own security profile use your user profile id retrieved by executing the **Specific User** or **Current User** call.\n\n**Warning:** Requires the **PERMISSIONMANAGEMENT** security role if not retrieving your own security profile." }, "response": [] } ] } ] }, { "name": "Users", "item": [ { "name": "User operations", "item": [ { "name": "Retrieve users", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/users/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "users", "" ], "query": [ { "key": "includeInActive", "value": "", "description": "Whether to include inactive users in the list of results.\nDefault: 0", "disabled": true }, { "key": "limit", "value": null, "disabled": true }, { "key": "page", "value": null, "disabled": true } ] }, "description": "**Warning**: User operations require the **USERMANAGEMENT** security role." }, "response": [] }, { "name": "Create user", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "username", "value": "johndoe" }, { "key": "password", "value": "secret123" }, { "key": "email", "value": "john.doe@xample.com" }, { "key": "profileId", "value": "" }, { "key": "firstname", "value": "John" }, { "key": "lastname", "value": "Doe" }, { "key": "active", "value": "", "type": "text", "disabled": true }, { "key": "isSSOOnly", "value": "", "type": "text" }, { "key": "language", "value": "", "type": "text" }, { "key": "infix", "value": "", "type": "text" }, { "key": "groupIds", "value": "", "type": "text" }, { "key": "phoneNumber", "value": "", "type": "text" }, { "key": "companyName", "value": "", "type": "text" }, { "key": "department", "value": "", "type": "text" }, { "key": "job", "value": "", "type": "text" }, { "key": "costCenter", "value": "", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/v4/users/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "users", "" ] }, "description": "**Warning**: User operations require the **USERMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Specific user operations", "item": [ { "name": "Retrieve specific user", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/users/{id}/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "users", "{id}", "" ] }, "description": "**Warning**: User operations require the **USERMANAGEMENT** security role." }, "response": [] }, { "name": "Modify user", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "username", "value": "", "type": "text" }, { "key": "password", "value": "", "type": "text" }, { "key": "email", "value": "", "type": "text" }, { "key": "profileId", "value": "", "type": "text" }, { "key": "active", "value": "", "type": "text" }, { "key": "isSSOnly", "value": "", "type": "text" }, { "key": "language", "value": "", "type": "text" }, { "key": "firstname", "value": "", "type": "text" }, { "key": "infix", "value": "", "type": "text" }, { "key": "lastname", "value": "", "type": "text" }, { "key": "groupIds", "value": "", "type": "text" }, { "key": "phoneNumber", "value": "", "type": "text" }, { "key": "companyName", "value": "", "type": "text" }, { "key": "department", "value": "", "type": "text" }, { "key": "job", "value": "", "type": "text" }, { "key": "costCenter", "value": "", "type": "text" }, { "key": "termsAccepted", "value": "", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/v4/users/{id}/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "users", "{id}", "" ] }, "description": "**Warning**: User operations require the **USERMANAGEMENT** security role." }, "response": [] }, { "name": "Delete user", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/users/{id}/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "users", "{id}", "" ] }, "description": "**Warning**: User operations require the **USERMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Current user operations", "item": [ { "name": "Retrieve current user", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/currentUser/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "currentUser", "" ] }, "description": "Retrieve the current user information. Unlike **Retrieve specific user** this call doesn't require you to know your user id in order to retrieve your current user information." }, "response": [] } ] } ] }, { "name": "Brands", "item": [ { "name": "Brand operations", "item": [ { "name": "Retrieve brands and subbrands", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/brands/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "brands", "" ] } }, "response": [] } ] } ] }, { "name": "Assets", "item": [ { "name": "Asset operations", "item": [ { "name": "Retrieve assets", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" }, { "key": "X-Bynder-NextCursor", "value": "", "description": "SOLR nextCursorMark which can be used to return the next X number of results. Returned when solr-cursor account feature is enabled.", "disabled": true } ], "url": { "raw": "{{API Base URL}}/v4/media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "" ], "query": [ { "key": "brandId", "value": "", "description": "Brand id, can be retrieved using the **Retrieve brands and subbrands** call.\nExample: 00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "subBrandId", "value": "", "description": "Sub-brand id, can be retrieved using the **Retrieve brands and subbrands** call.\nExample: 00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "collectionId", "value": "", "description": "Collection id, can be retrieved using the **Retrieve collections** call.\nExample: 00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "ids", "value": "", "description": "Comma-separated list of asset ids. Will return a asset for each existing id.\nExample: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "propertyOptionId", "value": "", "description": "Comma-separated list of (metaproperty) option ids, can be retrieved using the **Retrieve metaproperties** call. This parameter searches for assets that contain at least one of the metaproperty options passed in the list.\nExample: 00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "tags", "value": "", "description": "Comma-separated list of tags, can be retrieved using the **Retrieve tags** call.\nExample: pictures,animals", "disabled": true }, { "key": "type", "value": "", "description": "Comma-separated list of asset types.\nExample: image,video\nPossible values: image, document, audio, video", "disabled": true }, { "key": "orientation", "value": "", "description": "Asset orientation.\nExample: square.\nPossible values: square, portrait, landscape.", "disabled": true }, { "key": "property_NAME", "value": "", "description": "Metaproperty option name.\nExample: property_Country=Netherlands\nOR\nComma-separated list ids of metaproperty options for that metaproperty.\nExample: property_Country=00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "limited", "value": "", "description": "Indicates whether or not the return should only contain assets marked as \"limited usage\".\nExample: 1", "disabled": true }, { "key": "archive", "value": "", "description": "Indicates whether or not the return should only contain archived assets.\nExample: 1", "disabled": true }, { "key": "isPublic", "value": "", "description": "Indicates whether or not the return should only contain assets marked as public.\nExample: 1", "disabled": true }, { "key": "keyword", "value": "", "description": "Search on filenames, tags, extensions, collection names, guidelines, brandstore, campaigns in workflow, enriched PDFs, word documents.\nExample: Amsterdam", "disabled": true }, { "key": "dateCreated", "value": "", "description": "Retrieve assets created after this date.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-25T10:30:00Z", "disabled": true }, { "key": "dateCreatedTo", "value": "", "description": "Set a date range together with the \"dateCreated\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-26T10:30:00Z", "disabled": true }, { "key": "dateCreatedOn", "value": "", "description": "Retrieve assets created on this specific date.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-25T10:30:00Z", "disabled": true }, { "key": "dateModified", "value": "", "description": "Retrieve assets modified after this date.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-25T10:30:00Z.", "disabled": true }, { "key": "dateModifiedTo", "value": "", "description": "Set a date range together with the \"dateModified\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-26T10:30:00Z", "disabled": true }, { "key": "dateModifiedOn", "value": "", "description": "Retrieve assets modified on this specific date.\nISO8601 format: yyyy-mm-ddThh:mm:ssZ.\nExample: 2014-12-25T10:30:00Z", "disabled": true }, { "key": "orderBy", "value": "", "description": "Order of the returned list of assets.\nExample: name asc\nPossible values: dateCreated asc, dateModified asc, name asc, dateCreated desc, dateModified desc, name desc", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of results.\nMaximum: 1000\nDefault: 50", "disabled": true }, { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results.\nExample: 1", "disabled": true }, { "key": "count", "value": "", "description": "Indicating whether or not the return should include count results.\nExample: 1", "disabled": true }, { "key": "total", "value": "", "description": "Indicating whether or not the return should include the total count of results.\nExample: 1", "disabled": true }, { "key": "includeMediaItems", "value": "", "description": "Indicating whether or not the response should include all the different media items (derivatives) available for each asset. Example: 1", "disabled": true }, { "key": "cursor", "value": "", "description": "cursorMark returned in the X-Bynder-NextCursor response header which allows to return the next set of results.\nNote: This parameter can only be used if solr-cursor account feature is enabled.\nExample: AoJwh+sCPwQ3RNS05NjcxLzQTkwQzMwRA==", "disabled": true } ] }, "description": "**Warning:** To retrieve archived assets the security role **ARCHIVEMEDIA** or **ARCHIVEDOWNLOAD** is required.\n\n**Warning:** To retrieve limited usage assets the security role **EMBARGOMEDIA** or **KEYVISUALSDOWNLOAD** is required.\n\n**Note:** To include a URL to the orignal asset file in the response, the asset needs to be public, you need to enable api-orginal in your account settings and setup an seoBaseUrl." }, "response": [] } ] }, { "name": "Specific asset operations", "item": [ { "name": "Retrieve specific asset", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/media//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "", "" ], "query": [ { "key": "versions", "value": "", "description": "Include info about the different asset versions.\nDefault: 0", "disabled": true }, { "key": "stats", "value": "", "description": "Include information about views and downloads.\nDefault: 0", "disabled": true } ] }, "description": "**Warning:** Requires the **STATISTICS** security role in order to retrieve views and downloads statistics data in the response, using the **stats** parameter." }, "response": [] }, { "name": "Modify asset", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "name", "value": "", "type": "text", "disabled": true }, { "key": "description", "value": "", "type": "text", "disabled": true } ] }, "url": { "raw": "{{{{API Base URL}}}}/api/v4/media/asset_id/", "host": [ "{{{{API Base URL}}}}" ], "path": [ "api", "v4", "media", "asset_id", "" ] }, "description": "**Warning:** Requires the **MEDIAEDIT** security role. Requires the **MARKPUBLIC** security role in order to change a asset's isPublic state." }, "response": [] }, { "name": "Delete asset", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/media/F156F575-5629-4341-92EC80297533A5D4/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "F156F575-5629-4341-92EC80297533A5D4", "" ] }, "description": "**Warning:** Requires the **MEDIAREMOVE** security role." }, "response": [] } ] }, { "name": "Asset Metaproperty Operations", "item": [ { "name": "Add Metaproperty Options", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "asset_id", "value": "", "type": "text" }, { "key": "metaproperty_id", "value": "", "type": "text" }, { "key": "metaproperty_option_ids", "value": "", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/api/media/options/", "host": [ "{{API Base URL}}" ], "path": [ "api", "media", "options", "" ], "query": [ { "key": null, "value": null, "disabled": true }, { "key": "", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Delete Metaproperty Options", "request": { "method": "DELETE", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "asset_id", "value": "", "type": "text" }, { "key": "metaproperty_id", "value": "", "type": "text" }, { "key": "metaproperty_option_ids", "value": "", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/api/media/options/", "host": [ "{{API Base URL}}" ], "path": [ "api", "media", "options", "" ], "query": [ { "key": null, "value": null, "disabled": true }, { "key": "", "value": null, "disabled": true } ] } }, "response": [] } ] }, { "name": "Similar Assets Operations", "item": [ { "name": "Search for similar assets Copy", "request": { "auth": { "type": "oauth2", "oauth2": [ { "key": "clientSecret", "value": "", "type": "string" }, { "key": "clientId", "value": "", "type": "string" }, { "key": "accessTokenUrl", "value": "", "type": "string" }, { "key": "tokenName", "value": "", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"assetIds\":[\"2989b7cc-5fd4-4c91-aae3-c0728b44ed0b\"]\n// \"imageUrl\": \"https://wave-us.getbynder.com/transform/33571867-87a0-498e-980d-6db2447817d1/Headphone-Mustard\"\n// \"imageData\":\"data:image/jpeg;base64,...\"\n// \"textQuery\":\"Image of headphones\"\n}\n\n//only 1 search parameter can be used at a time", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.bynder.com/api/1/assets/similarity-search", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "1", "assets", "similarity-search" ] } }, "response": [] } ] } ] }, { "name": "Asset usage", "item": [ { "name": "Asset usage operations", "item": [ { "name": "Create asset usage", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "integration_id", "value": "" }, { "key": "asset_id", "value": "" } ] }, "url": { "raw": "{{API Base URL}}/media/usage", "host": [ "{{API Base URL}}" ], "path": [ "media", "usage" ] }, "description": "These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support article](https://help.bynder.com/System/Integrations/asset-tracker.htm). If you want to register a new third party application please contact us at [integrations@bynder.com](mailto:integrations@bynder.com).\n\n**Warning:** Requires the **STATISTICS** security role." }, "response": [] }, { "name": "Retrieve asset usage", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/media/usage", "host": [ "{{API Base URL}}" ], "path": [ "media", "usage" ], "query": [ { "key": "asset_id", "value": "", "description": "Asset id.\nExample: 00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "integration_id", "value": "", "description": "\nIntegration id.\nExample: 00000000-0000-0000-0000000000000000", "disabled": true }, { "key": "uri", "value": "", "description": "URI\nExample: /hippo/first_post", "disabled": true } ] }, "description": "These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support article](https://help.bynder.com/System/Integrations/asset-tracker.htm). If you want to register a new third party application please contact us at [integrations@bynder.com](mailto:integrations@bynder.com).\n\n**Warning:** Requires the **STATISTICS** security role." }, "response": [] }, { "name": "Delete asset usage", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/media/usage", "host": [ "{{API Base URL}}" ], "path": [ "media", "usage" ], "query": [ { "key": "integration_id", "value": "", "description": "Integration id.\nExample: 00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "asset_id", "value": "", "description": "Asset id.\nExample: 00000000-0000-0000-0000-000000000000", "disabled": true }, { "key": "uri", "value": "", "description": "Asset location.\nExample: /hippo/first_post", "disabled": true } ] }, "description": "These calls allow you to keep track of assets being exported from Bynder and imported into a third party application. In order to get started or find an existing integration id you should check out this [Bynder support article](https://help.bynder.com/System/Integrations/asset-tracker.htm). If you want to register a new third party application please contact us at [integrations@bynder.com](mailto:integrations@bynder.com).\n\n**Warning:** Requires the **STATISTICS** security role." }, "response": [] } ] }, { "name": "Sync asset usage operations", "item": [ { "name": "Sync asset usage", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"integration_id\":\"\",\"uris\":[\"\"],\"usages\":[{\"asset_id\":\"\",\"uri\":\"\",\"additional\":\"\"}]}" }, "url": { "raw": "{{API Base URL}}/media/usage/sync", "host": [ "{{API Base URL}}" ], "path": [ "media", "usage", "sync" ] }, "description": "This alternative API call allows you to sync all your usage from a single integration.\n\n**Warning:** Requires the **STATISTICS** security role." }, "response": [] } ] } ] }, { "name": "Upload Assets", "item": [ { "name": "1. Get closest AmazonS3 upload endpoint", "item": [ { "name": "Get closest AmazonS3 upload endpoint", "event": [ { "listen": "test", "script": { "exec": [ "let location = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"awsLocation\", location.replace(/[\"]+/, ''));" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/api/upload/endpoint", "host": [ "{{API Base URL}}" ], "path": [ "api", "upload", "endpoint" ] }, "description": "\n" }, "response": [] } ] }, { "name": "2. Initialise upload", "item": [ { "name": "Initialise upload", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "let jsonData = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"uploadid\", jsonData.s3file.uploadid);", "pm.collectionVariables.set(\"targetid\", jsonData.s3file.targetid);", "pm.collectionVariables.set(\"s3_filename\", jsonData[\"s3_filename\"] + \"/p1\");", "pm.collectionVariables.set(\"acl\", jsonData.multipart_params.acl);", "pm.collectionVariables.set(\"success_action_status\", jsonData.multipart_params[\"success_action_status\"]);", "pm.collectionVariables.set(\"Content-Type\", jsonData.multipart_params[\"Content-Type\"]);", "pm.collectionVariables.set(\"key\", jsonData.multipart_params.key + \"/p1\");", "pm.collectionVariables.set(\"Policy\", jsonData.multipart_params.Policy);", "pm.collectionVariables.set(\"X-Amz-Signature\", jsonData.multipart_params[\"X-Amz-Signature\"]);", "pm.collectionVariables.set(\"x-amz-credential\", jsonData.multipart_params[\"x-amz-credential\"]);", "pm.collectionVariables.set(\"x-amz-algorithm\", jsonData.multipart_params[\"x-amz-algorithm\"]);", "pm.collectionVariables.set(\"x-amz-date\", jsonData.multipart_params[\"x-amz-date\"]);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "filename", "value": "PASTE FILENAME HERE", "description": "The value should be an exact string match of the filename to be uploaded (exentsion included).", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/api/upload/init", "host": [ "{{API Base URL}}" ], "path": [ "api", "upload", "init" ], "query": [ { "key": "", "value": null, "disabled": true } ] }, "description": "**Warning:** Uploading a new asset requires the **MEDIAUPLOAD** or **MEDIAUPLOADFORAPPROVAL** security role.\n\n**Warning:** Uploading a new asset version or additional requires the **MEDIAUPLOAD** security role." }, "response": [] } ] }, { "name": "3. Upload file in chunks and register every uploaded chunk", "item": [ { "name": "Upload file in chunks", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false, "disableUrlEncoding": false, "disabledSystemHeaders": {} }, "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data", "disabled": true } ], "body": { "mode": "formdata", "formdata": [ { "key": "Content-Type", "value": "{{Content-Type}}", "contentType": "", "type": "text" }, { "key": "Policy", "value": "{{Policy}}", "type": "text" }, { "key": "X-Amz-Signature", "value": "{{X-Amz-Signature}}", "type": "text" }, { "key": "acl", "value": "{{acl}}", "type": "text" }, { "key": "key", "value": "{{key}}", "type": "text" }, { "key": "success_action_status", "value": "{{success_action_status}}", "type": "text" }, { "key": "x-amz-algorithm", "value": "{{x-amz-algorithm}}", "type": "text" }, { "key": "x-amz-credential", "value": "{{x-amz-credential}}", "type": "text" }, { "key": "x-amz-date", "value": "{{x-amz-date}}", "type": "text" }, { "key": "name", "value": "PASTE FILENAME HERE", "description": "The value should be an exact string match of the filename to be uploaded (exentsion included).", "type": "text" }, { "key": "chunk", "value": "1", "contentType": "application/json", "type": "text" }, { "key": "chunks", "value": "1", "contentType": "application/json", "type": "text" }, { "key": "Filename", "value": "{{s3_filename}}", "type": "text" }, { "key": "file", "description": "Select and upload your file here", "type": "file", "src": [] } ] }, "url": { "raw": "{{awsLocation}}", "host": [ "{{awsLocation}}" ] }, "description": "Uploading a file consists of:\n\n* Breaking down your file in parts/chunks. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload. For more information, about how amazon handles parts/chunks, visit: [Amazon's website](https://docs.aws.amazon.com/AmazonS3/latest/API/mpUploadUploadPart.html).\n\n* Sending the chunks over to Amazon and then registering them to Bynder. You can repeat those calls up until your file has been uploaded completely.\n\nMakes a POST request to the Amazon upload endpoint you received from calling Get closest AmazonS3 upload endpoint.\nUse a multipart/form-data to send all of the parameters that the multipart_params of the previous request included; plus the following additional parameters:" }, "response": [] }, { "name": "Register uploaded chunk", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false, "disabledSystemHeaders": {}, "strictSSL": true }, "request": { "method": "POST", "header": [ { "key": "charset", "value": "utf-8", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "chunkNumber", "value": "1" }, { "key": "targetid", "value": "{{targetid}}" }, { "key": "filename", "value": "{{s3_filename}}" } ] }, "url": { "raw": "{{API Base URL}}/api/v4/upload/{{uploadid}}/", "host": [ "{{API Base URL}}" ], "path": [ "api", "v4", "upload", "{{uploadid}}", "" ] }, "description": "After uploading a chunk, you must register it's completion to Bynder." }, "response": [] } ] }, { "name": "4. Finalise a completely uploaded file", "item": [ { "name": "Finalise a completely uploaded file", "event": [ { "listen": "test", "script": { "exec": [ "let assetData = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"importId\", assetData.importId);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false, "disabledSystemHeaders": {} }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "disabled": true }, { "key": "Connection", "value": "close", "type": "text", "disabled": true }, { "key": "Host", "value": "tonysmith.getbynder.com", "type": "text", "disabled": true } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "chunks", "value": "1" }, { "key": "targetid", "value": "{{targetid}}" }, { "key": "s3_filename", "value": "{{s3_filename}}" }, { "key": "original_filename", "value": "PASTE FILENAME HERE", "description": "The value should be an exact string match of the filename to be uploaded (exentsion included)." } ] }, "url": { "raw": "{{API Base URL}}/api/v4/upload/{{uploadid}}/", "host": [ "{{API Base URL}}" ], "path": [ "api", "v4", "upload", "{{uploadid}}", "" ], "query": [ { "key": null, "value": "", "disabled": true } ] }, "description": "**Warning:** Uploading is completed after executing the \"Finalise a completely uploaded file and save as a new asset additional\" call successfully, no additional steps are required." }, "response": [] }, { "name": "Finalise a completely uploaded file and save as a new asset additional", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "chunks", "value": "1" }, { "key": "targetid", "value": "{{targetid}}" }, { "key": "s3_filename", "value": "{{s3_filename}}" } ] }, "url": { "raw": "{{API Base URL}}/api/v4/media//save/additional/{{uploadid}}/", "host": [ "{{API Base URL}}" ], "path": [ "api", "v4", "media", "", "save", "additional", "{{uploadid}}", "" ] }, "description": "**Warning:** This call should only be used if you are uploading an additional file for an asset, if you are not go to step 5." }, "response": [] } ] }, { "name": "5. Poll processing state of finalised files", "item": [ { "name": "Retrieve poll state", "event": [ { "listen": "test", "script": { "exec": [ "let newImportIds = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"itemsDone\", newImportIds.itemsDone);" ], "type": "text/javascript" } }, { "listen": "prerequest", "script": { "exec": [ "setTimeout(function(){}, [15000]);" ], "type": "text/javascript" } } ], "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false, "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "formdata", "formdata": [] }, "url": { "raw": "{{API Base URL}}/api/v4/upload/poll/?items={{importIds}}", "host": [ "{{API Base URL}}" ], "path": [ "api", "v4", "upload", "poll", "" ], "query": [ { "key": "items", "value": "{{importIds}}", "description": "Comma-separated import id's of a finalised file, as returned by the finalise call.\nExample: 00000000-0000-0000-0000000000000000" } ] }, "description": "**Warning:** This call needs to be executed in a loop until its response returns the item(s) id(s) passed in the **items** parameter." }, "response": [] } ] }, { "name": "6. Saving a completed upload", "item": [ { "name": "Save as a new asset", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "brandId", "value": "{{Brand_ID}}" }, { "key": "name", "value": "INSERT ASSET NAME HERE", "description": "The asset's name as it will be displayed in the Bynder DAM", "type": "text" } ] }, "url": { "raw": "{{API Base URL}}/api/v4/media/save/{{itemsDone}}/", "host": [ "{{API Base URL}}" ], "path": [ "api", "v4", "media", "save", "{{itemsDone}}", "" ] }, "description": "**Warning:** Uploading a new asset requires the **MEDIAUPLOAD** or **MEDIAUPLOADFORAPPROVAL** security role.\n\n**Warning:** Uploading a new asset version or additional requires the **MEDIAUPLOAD** security role." }, "response": [] }, { "name": "Save as a new version", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/media//save/6360FAA9-9D97-45FB-B50C063FD1E981C8/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "", "save", "6360FAA9-9D97-45FB-B50C063FD1E981C8", "" ] }, "description": "**Warning:** Uploading a new asset requires the **MEDIAUPLOAD** or **MEDIAUPLOADFORAPPROVAL** security role.\n\n**Warning:** Uploading a new asset version or additional requires the **MEDIAUPLOAD** security role." }, "response": [] } ] } ], "description": "Upload steps to consider:\n\n- \\-Necessary on step 2 \"Initialise upload\" in the body.\n- \\-Necessary on step 3 \"Upload file in chunks\" in the body\n- \\-Necessary on Step 4 \"Finalise a completely uploaded file\" in the body\n\n- \\-Insert the Asset's Name to be stored in Bynder on Step 6 \"Save as a new asset\" in the body \n \n\n- \\-Insert the filename into the fields that request it" }, { "name": "Download", "item": [ { "name": "Download operations", "item": [ { "name": "Retrieve asset download location", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/media/ACD76FEB-EE5C-4D0D-B6D375C49215AC77/download/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "ACD76FEB-EE5C-4D0D-B6D375C49215AC77", "download", "" ], "query": [ { "key": "type", "value": "", "description": "Type of files to download. Note that when multiple additional files are available only the download url of the latest one will be returned.\nDefault: original\nPossible values: original, additional", "disabled": true } ] }, "description": "**Warning:** Requires the **MEDIAHIGHRES** security role.\n\n**Warning:** Requires the **ARCHIVEDOWNLOAD** security role if the asset in question is archived.\n\n**Warning:** Requires the **DOWNLOADWATERMARK** security role if the asset in question is watermarked.\n\n**Warning:** Requires the **KEYVISUALSDOWNLOAD** security role if the asset in question is marked as limited usage." }, "response": [] }, { "name": "Retrieve asset version download location", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/media///download/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "", "", "download", "" ] } }, "response": [] }, { "name": "Retrieve specific asset item download location", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/media//download//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "media", "", "download", "", "" ], "query": [ { "key": "hash", "value": "0", "description": "Indicates whether or not to treat the itemId as a hashed item id.\nExample: 1\nDefault: 0", "disabled": true } ] } }, "response": [] } ] } ] }, { "name": "Metaproperties", "item": [ { "name": "Metaproperty operations", "item": [ { "name": "Retrieve metaproperties", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "" ], "query": [ { "key": "count", "value": "0", "description": "Indicates whether or not the response should include asset count results for metaproperty-options.\nDefault: 0", "disabled": true }, { "key": "type", "value": "image", "description": "Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1.\nExample: image\nPossible values: image, document, audio, video", "disabled": true }, { "key": "options", "value": "1", "description": "Indicates whether or not the response should include the metaproperty-options of each metaproperty.\nDefault: 1", "disabled": true }, { "key": "ids", "value": "", "description": "Comma-separated list of metaproperty ids. Will return a metaproperty for each existing id.\nExample:\n00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000.", "disabled": true } ] } }, "response": [] }, { "name": "Create metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "{\"name\": \"Colour\", \"type\": \"select\", \"label\": \"Colour\"}" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Specific metaproperty operations", "item": [ { "name": "Retrieve specific metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "" ], "query": [ { "key": "count", "value": "", "description": "Indicates whether or not the response should include asset count results for metaproperty-options.\nDefault: 0", "disabled": true }, { "key": "type", "value": "", "description": "Comma-separated list of asset types. Filters the count results by asset type. It only makes sense to be defined if the count parameter was set to 1.\nExample: image\nPossible values: image, document, audio, video", "disabled": true }, { "key": "options", "value": "", "description": "Indicates whether or not the response should include the metaproperty-options of the metaproperty.\nDefault: 1", "disabled": true } ] } }, "response": [] }, { "name": "Modify metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "{\"label\": \"Test\", \"isMainfilter\": \"true\"}" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] }, { "name": "Delete metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Metaproperty dependency operations", "item": [ { "name": "Retrieve metaproperty dependencies", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//dependencies/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "dependencies", "" ] }, "description": "When a metaproperty has dependencies, the metaproperty won't be visble until a linked option is selected in the upload/bulk edit. This call returns a list of depending meteproperty option ids." }, "response": [] } ] }, { "name": "Specific metaproperty dependency operations", "item": [ { "name": "Create dependency", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//dependencies//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "dependencies", "", "" ] }, "description": "**Warning:** Specific metaproperty dependency operations require the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] }, { "name": "Delete dependency", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//dependencies//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "dependencies", "", "" ] }, "description": "**Warning:** Specific metaproperty dependency operations require the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Metaproperty option operations", "item": [ { "name": "Retrieve metaproperty options by ids", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties/options/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "options", "" ], "query": [ { "key": "ids", "value": "", "description": "Comma-separated list of metaproperty-option ids.\nExample:\n00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true } ] } }, "response": [] }, { "name": "Retrieve metaproperty options", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//options/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "" ], "query": [ { "key": "name", "value": "", "description": "Metaproperty option name.\nExample: Amsterdam", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of results.\nMaximum: 1000. \nExample: 250", "disabled": true }, { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results.\nExample: 1", "disabled": true }, { "key": "externalReference", "value": null, "description": "External reference string exact match.", "disabled": true } ] } }, "response": [] }, { "name": "Create metaproperty option", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "{\"name\": \"Netherlands\", \"externalReference\":\"Netherlands1\",\"label\": \"Netherlands\"}" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Specific metaproperty option operations", "item": [ { "name": "Modify metaproperty option", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "{\"label\": \"Holland\",\"externalReference\":\"Netherlands1\",}" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] }, { "name": "Delete metaproperty option", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYMANAGEMENT** or **METAMANAGEMENT** security role." }, "response": [] } ] } ] }, { "name": "Metaproperty option dependencies", "item": [ { "name": "Retrieve all metaproperty option dependencies globally", "item": [ { "name": "Retrieve global option dependencies", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties/options/dependencies/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "options", "dependencies", "" ] }, "description": "Metaproperty options can have dependant options, which are options that need to be selected for the option to become available for the user to pick. Option dependencies can be grouped, specifying that all the options in that group need to be selected for the option to become available, or ungrouped." }, "response": [] } ] }, { "name": "Retrieve all metaproperty option dependencies for a metaproperty", "item": [ { "name": "Retrieve metaproperty option dependencies", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//options/dependencies/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "dependencies", "" ] } }, "response": [] } ] }, { "name": "Retrieve options a metaproperty option depends on", "item": [ { "name": "Retrieve specific metaproperty option dependencies", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "" ], "query": [ { "key": "includeGroupedResults", "value": "", "description": "Use grouped results like other option dependency calls.\nExample: 1", "disabled": true } ] } }, "response": [] } ] }, { "name": "Manage ungrouped metaproperty option dependencies", "item": [ { "name": "Add a dependency", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "", "" ] } }, "response": [] }, { "name": "Delete a dependency", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "", "" ] } }, "response": [] } ] }, { "name": "Create metaproperty option dependency group", "item": [ { "name": "Create a dependency group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/group/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "group", "" ] } }, "response": [] } ] }, { "name": "Specific metaproperty option dependency group operations", "item": [ { "name": "Modify dependency group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "data", "value": "" } ] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/group//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "group", "", "" ] } }, "response": [] }, { "name": "Delete dependency group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/group//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "group", "", "" ] } }, "response": [] } ] }, { "name": "Manage option dependency in dependency group ", "item": [ { "name": "Add a dependency option to a group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/group///", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "group", "", "", "" ] } }, "response": [] }, { "name": "Remove a dependency option from a group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/metaproperties//options//dependencies/group///", "host": [ "{{API Base URL}}" ], "path": [ "v4", "metaproperties", "", "options", "", "dependencies", "group", "", "", "" ] } }, "response": [] } ] } ] }, { "name": "Smartfilters", "item": [ { "name": "Smartfilters operations", "item": [ { "name": "Retrieve smartfilters", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/smartfilters/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "smartfilters", "" ] } }, "response": [] } ] } ] }, { "name": "Tags", "item": [ { "name": "Tag operations", "item": [ { "name": "Retrieve tags", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/tags/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "tags", "" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results.\nMaximum: 1000 (if page is set)\nDefault: 50 (if page is set)", "disabled": true }, { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results.\nExample: 1", "disabled": true }, { "key": "orderBy", "value": "", "description": "Desired order of returned tags set.\nDefault: Order of tags is based on the way they're retrieved from the database\nExample: tag asc\nPossible values: tag asc, tag desc, mediaCount asc, mediaCount desc", "disabled": true }, { "key": "keyword", "value": "", "description": "Search on matching names.\nExample: Amsterdam", "disabled": true }, { "key": "mincount", "value": "", "description": "Minimum media count that the returned tags should have.\nDefault: 0", "disabled": true } ] } }, "response": [] } ] }, { "name": "Tag operations on assets", "item": [ { "name": "Add tag to assets", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/tags//media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "tags", "", "media", "" ] }, "description": "**Warning:** Tag operations on assets require the **MEDIAEDIT** or **MEDIAAUDIT** security role." }, "response": [] }, { "name": "Remove tag from assets", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/tags//media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "tags", "", "media", "" ], "query": [ { "key": "deleteIds", "value": "", "description": "Comma-separated asset ids from which to remove the tag.\nExample:\n00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true } ] } }, "response": [] } ] } ] }, { "name": "Collections", "item": [ { "name": "Collection operations", "item": [ { "name": "Retrieve collections", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/collections/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results.\nMaximum: 1000\nExample: 250\nDefault: 50", "disabled": true }, { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results.\nExample: 1", "disabled": true }, { "key": "orderBy", "value": "", "description": "Desired order of returned collection set.\nDefault: Order of collections is based on the way they're retrieved from the database\nExample: dateCreated desc\nPossible values: dateCreated asc, dateCreated desc, name asc, name desc", "disabled": true }, { "key": "count", "value": "", "description": "Indicates whether or not the response should include count results.\nDefault: false", "disabled": true }, { "key": "keyword", "value": "", "description": "Search on matching names.\nExample: Amsterdam", "disabled": true }, { "key": "isPublic", "value": "", "description": "Indicates whether or not the return should only contain collections marked as public.\nExample: false", "disabled": true }, { "key": "minCount", "value": "", "description": "Minimum collectionCount that the returned collections should have.\nExample: 5", "disabled": true } ] }, "description": "**Warning:** To retrieve public collections the **collection.public.view** security role is required.\n\n**Warning:** To retrieve collections other users shared/received the **INBOXPUBLIC** or **OUTBOXPUBLIC** security role is required.\n\n**Warning:** To retrieve collections other users created the **PUBLICCOLLECTIONS** security role is required." }, "response": [] }, { "name": "Create collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "" ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role." }, "response": [] } ] }, { "name": "Specific collection operations", "item": [ { "name": "Retrieve specific collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/collections//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "" ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role." }, "response": [] }, { "name": "Modify collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "" ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role. Requires the **PUBLISHCOLLECTIONS** security role in order to change a collection's isPublic state." }, "response": [] }, { "name": "Delete collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "" ] } }, "response": [] } ] }, { "name": "Share collection operations", "item": [ { "name": "Share collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections//share/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "share", "" ] }, "description": "**Warning:** Requires the **SHARECOLLECTION** or **SHARING** security role." }, "response": [] } ] }, { "name": "Asset operations on a collection", "item": [ { "name": "Retrieve the assets of a specific collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/collections//media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "media", "" ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role." }, "response": [] }, { "name": "Add assets to a collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections//media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "media", "" ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role." }, "response": [] }, { "name": "Remove assets from a collection", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/v4/collections//media/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "collections", "", "media", "" ], "query": [ { "key": "deleteIds", "value": "", "description": "Comma-separated asset ids to remove from the collection.\nExample:\n00000000-0000-0000-0000000000000000,00000000-0000-0000-0000000000000000", "disabled": true } ] }, "description": "**Warning:** Requires the **COLLECTIONS** security role." }, "response": [] } ] } ] }, { "name": "Account", "item": [ { "name": "Account operations", "item": [ { "name": "Retrieve account Information", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/account/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "account", "" ] } }, "response": [] } ] }, { "name": "Derivative operations", "item": [ { "name": "Retrieve derivatives", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/account/derivatives/", "host": [ "{{API Base URL}}" ], "path": [ "v4", "account", "derivatives", "" ] }, "description": "A derivative is a file that is based on another source, for example, a low-resolution representation of a print-quality photo. During the upload process, Bynder can automatically create pre-defined image derivatives with different dimensions, quality, and format. Bynder can either maintain the original aspect ratio of an image, or crop or pad an image to fit the specified dimensions. We can create smaller versions of your original image asset in both a JPG and PNG file extension. However, the resolution of derivatives can't be larger than the original file." }, "response": [] } ] } ] }, { "name": "Access Rights Copy", "item": [ { "name": "Metaproperties", "item": [ { "name": "Retrieve Metaproperty Access", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/content_access/metaproperties/{{metaproperty ID}}/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "content_access", "metaproperties", "{{metaproperty ID}}", "" ] } }, "response": [] }, { "name": "Create Metaproperty Access", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": " {\n \"principals\": [\n {\n \"principalId\": \"{{user, group, or permission profile ID}}\",\n \"principalType\": \"(user, group, profile)\"\n }\n ],\n \"level\": \"metaproperty.hide\"\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.bynder.com/api/content_access/metaproperties/{{metaproperty ID}}/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "content_access", "metaproperties", "{{metaproperty ID}}", "" ] } }, "response": [] }, { "name": "Delete Metaproperty Access", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": " {\n \"contentAccessIds\":[\"ID of dependency from Retrieve Metaproperty Access Call\"]\n \n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.getbynder.com/api/content_access/metaproperties/{{metaproperty ID}}/", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "content_access", "metaproperties", "{{metaproperty ID}}", "" ] } }, "response": [] } ] }, { "name": "Options", "item": [ { "name": "Retrieve Options Access Rights", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.getbynder.com/api/1/content-access/options/{{option Id}}/", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "1", "content-access", "options", "{{option Id}}", "" ], "query": [ { "key": "principalId", "value": null, "disabled": true }, { "key": "limit", "value": null, "disabled": true }, { "key": "start", "value": null, "disabled": true }, { "key": "before", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Modify Options Access Rights", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": " {\n \"principalId\": \"{{user, groups, or permission profile ID}}\",\n \"principalType\": \"{{user, group, or profile}}\",\n \"levels\": [\n \"media.show\",\n \"media.hide\",\n \"media.add\",\n \"media.edit\",\n \"media.approve\",\n \"media.delete\",\n \"media.disable\",\n \"media.audit.download\",\n \"media.create.restrict\",\n \"product.show\",\n \"product.hide\"\n ]\n }", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.getbynder.com/api/1/content-access/options/{{option id}}", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "1", "content-access", "options", "{{option id}}" ] } }, "response": [] }, { "name": "Retrieve Options Default Visibility", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.getbynder.com/api/1/content-access/options/{{option ID}}/visibility", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "1", "content-access", "options", "{{option ID}}", "visibility" ] } }, "response": [] }, { "name": "Modify option default visibility", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"hideByDefault\": false\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.getbynder.com/api/1/content-access/options/{{option ID}}/visibility", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "1", "content-access", "options", "{{option ID}}", "visibility" ] } }, "response": [] } ] } ] }, { "name": "Trash", "item": [ { "name": "Trash operations", "item": [ { "name": "Retrieve recently removed assets", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/trash/media/", "host": [ "{{API Base URL}}" ], "path": [ "trash", "media", "" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results.\nDefault: 10", "disabled": true }, { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results.\nDefault: 1", "disabled": true }, { "key": "dateRemoved", "value": "", "description": "Retrieve assets removed after this date.\nFormat: yyyy-mm-dd hh:mm:ss\nExample: 20170401 00:00:00", "disabled": true }, { "key": "field", "value": "", "description": "Field to sort on the returned list of assets.\nExample: media.dateCreated\nPossible values: media.dateCreated, media.dateRemoved, media.name, media.username", "disabled": true }, { "key": "order", "value": "asc", "description": "Sort order of returned list of assets. Sorts the list of assets by the field parameter defined, if the field parameter was not defined the results will be sorted by media.name.\nExample: asc\nPossible values: asc, desc", "disabled": true } ] }, "description": "**Warning:** You can only retrieve the removed assets from the last 30 days.\n\n**Warning:** Requires the **trash.assets** security role." }, "response": [] } ] } ] }, { "name": "Product layer metaproperties", "item": [ { "name": "Metaproperty operations", "item": [ { "name": "Retrieve metaproperties", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/pim/metaproperties", "host": [ "{{API Base URL}}" ], "path": [ "pim", "metaproperties" ] }, "description": "These documented API calls describe the Product Layer Metaproperty calls that are currently implemented in the API. The following product layer metaproperties are available: select, select2 and autocomplete.\n\n**Warning:** Requires the **metaproperty.view** security role." }, "response": [] } ] }, { "name": "Specific metaproperty operations", "item": [ { "name": "Retrieve specific metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/pim/metaproperties//", "host": [ "{{API Base URL}}" ], "path": [ "pim", "metaproperties", "", "" ] }, "description": "Retrieve the metaproperty details and it's metaproperty options.\n\n**Warning:** Requires the **METAPROPERTYMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Metaproperty option retrieve operations", "item": [ { "name": "Retrieve metaproperty options", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/pim/metaproperties//options/", "host": [ "{{API Base URL}}" ], "path": [ "pim", "metaproperties", "", "options", "" ], "query": [ { "key": "order", "value": "", "description": "Order of the options, based on the option z-index and option name.\nExample: asc.", "disabled": true }, { "key": "page", "value": "", "description": "Index to load a specific set of metaproperty options.\nExample: 1.", "disabled": true }, { "key": "limit", "value": "", "description": "Amount of options that are retrieved per page.\nExample: 20.", "disabled": true } ] }, "description": "Retrieves a paginated list of options for the given metaproperty id and these options' sub options.\n\n**Warning:** Requires the **METAPROPERTYMANAGEMENT** security role." }, "response": [] } ] }, { "name": "Metaproperty option modify operations", "item": [ { "name": "Modify metaproperty option", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"children\":[\"\"]}" }, "url": { "raw": "{{API Base URL}}/pim/metapropertyoptions//", "host": [ "{{API Base URL}}" ], "path": [ "pim", "metapropertyoptions", "", "" ] }, "description": "**Warning:** Currently you can only edit the children of a metaproperty option." }, "response": [] } ] } ] }, { "name": "Workflow campaigns", "item": [ { "name": "Campaign operations", "item": [ { "name": "Retrieve campaigns", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/campaigns/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNOVERVIEW** security role." }, "response": [] }, { "name": "Create campaign", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\",\"key\":\"\",\"description\":\"\",\"responsibleID\":\"\"}" }, "url": { "raw": "{{API Base URL}}/workflow/campaigns/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNADD** security role." }, "response": [] } ] }, { "name": "Specific campaign operations", "item": [ { "name": "Retrieve specific campaign", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/campaigns//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNOVERVIEW** security role." }, "response": [] }, { "name": "Modify campaign", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\",\"key\":\"\",\"responsibleID\":\"\"}" }, "url": { "raw": "{{API Base URL}}/workflow/campaigns//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNEDIT** security role." }, "response": [] }, { "name": "Delete campaign", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/workflow/campaigns//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNREMOVE** security role." }, "response": [] } ] } ] }, { "name": "Workflow jobs", "item": [ { "name": "Job preset operations", "item": [ { "name": "Retrieve specific job preset", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/presets/jobs//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "presets", "jobs", "", "" ] }, "description": "**Warning:** Requires the **PRESETOVERVIEW** security role." }, "response": [] } ] }, { "name": "Specific Stage Operations", "item": [ { "name": "Retrieve Specific Stage", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/stages/id/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "stages", "id", "" ] } }, "response": [] }, { "name": "Retrieve Specific Stage Copy", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n 'name': 'string',\n 'description': 'string',\n 'deadline': 'string',\n 'responsible':{\n 'id': 'string',\n 'type': 'string'\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportal.bynder.com/api/workflow/stages/id/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "stages", "id", "" ] } }, "response": [] } ] }, { "name": "Job operations", "item": [ { "name": "Retrieve jobs", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/jobs/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "jobs", "" ] }, "description": "**Warning:** Requires the **JOBOVERVIEW** security role." }, "response": [] }, { "name": "Retrieve the jobs of a specific campaign", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/campaigns//jobs/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "campaigns", "", "jobs", "" ] }, "description": "**Warning:** Requires the **CAMPAIGNOVERVIEW** security role." }, "response": [] }, { "name": "Create job", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\",\"campaignID\":\"\"}" }, "url": { "raw": "{{API Base URL}}/workflow/jobs/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "jobs", "" ] }, "description": "**Warning:** Requires the **JOBADD** security role." }, "response": [] } ] }, { "name": "Specific job operations", "item": [ { "name": "Retrieve specific job", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/jobs/268deb1f-ff09-4135-a7de-3fdf4f9b5e46/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "jobs", "268deb1f-ff09-4135-a7de-3fdf4f9b5e46", "" ] }, "description": "**Warning:** Requires the **JOBOVERVIEW** security role." }, "response": [] }, { "name": "Retrieve Media of specific job", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/jobs/id/media/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "jobs", "id", "media", "" ] } }, "response": [] }, { "name": "Retrieve stages of specific job", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/jobs/id/stages/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "jobs", "id", "stages", "" ] } }, "response": [] }, { "name": "Modify job", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{API Base URL}}/workflow/jobs//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "jobs", "", "" ] }, "description": "**Warning:** Requires the **JOBEDIT** security role." }, "response": [] }, { "name": "Delete job", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "{{API Base URL}}/workflow/jobs//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "jobs", "", "" ] }, "description": "**Warning:** Requires the **JOBREMOVE** security role." }, "response": [] }, { "name": "Finish job", "request": { "method": "PATCH", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/jobs/id/finish", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "jobs", "id", "finish" ] } }, "response": [] } ] }, { "name": "Upload asset to Job", "item": [ { "name": "2 - Prepare Upload", "event": [ { "listen": "test", "script": { "exec": [ "let jsonData = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"workflow_file_id\", jsonData.file_id);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "filename", "value": "test_file.jpg", "type": "text", "disabled": true } ] }, "url": { "raw": "https://yourportal.bynder.com/v7/file_cmds/upload/prepare", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "v7", "file_cmds", "upload", "prepare" ] } }, "response": [] }, { "name": "3 - Upload Chunks", "event": [ { "listen": "prerequest", "script": { "exec": [ "const CryptoJS = require(\"crypto-js\");", "", "// Specify the file path within your collection", "const fileName = \"WAVE - background.jpg\";", "", "// Fetch the file", "pm.sendRequest({", " url: pm.environment.get(\"postman_collection_baseurl\") + '/path/to/your/file',", " method: 'GET',", " header: {", " 'Content-Type': 'application/octet-stream'", " }", "}, (err, res) => {", " if (err) {", " console.error('Error fetching file:', err);", " } else {", " // Convert file data to a WordArray for hashing", " const fileData = CryptoJS.lib.WordArray.create(res.stream);", "", " // Calculate SHA-256 hash", " const hash = CryptoJS.SHA256(fileData).toString(CryptoJS.enc.Hex);", "", " // Store hash in an environment variable", " pm.environment.set(\"file_sha256\", hash);", "", " console.log(\"SHA-256 Hash:\", hash);", " }", "});", "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Content-SHA256", "value": "b917f5730a82405351e305e1266401fcb0af4cde08d63c239321e080f361aabe", "type": "text" }, { "key": "Content-Type", "value": "application/octet-stream", "type": "text" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "https://yourportal.bynder.com/v7/file_cmds/upload/{{workflow_file_id}}/chunk/0", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "v7", "file_cmds", "upload", "{{workflow_file_id}}", "chunk", "0" ] } }, "response": [] }, { "name": "4 - Finalize Upload", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "fileName", "value": "", "type": "text", "disabled": true }, { "key": "fileSize", "value": "", "type": "text", "disabled": true }, { "key": "chunksCount", "value": "", "type": "text", "disabled": true } ] }, "url": { "raw": "https://yourportal.bynder.com/v7/file_cmds/upload/{{workflow_file_id}}/finalise_api", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "v7", "file_cmds", "upload", "{{workflow_file_id}}", "finalise_api" ] } }, "response": [] }, { "name": "5 - Push File to Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fileId\": \"{{workflow_file_id}}\",\n \"name\": \"name of asset.jpg\",\n \"fileSize\": num - size of file\n}" }, "url": { "raw": "https://yourportal.bynder.com/api/workflow/jobs/{{job_id}}/upload", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "jobs", "{{job_id}}", "upload" ] } }, "response": [] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "", "type": "string" }, { "key": "clientSecret", "value": "582ebcc6-b8e1-42d9-b813-98010b113e99", "type": "string" }, { "key": "clientId", "value": "f29c2346-dc9c-4575-8090-3977911db16f", "type": "string" }, { "key": "accessTokenUrl", "value": "https://tonysmith.getbynder.com/v6/authentication/oauth2/token", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "refreshRequestParams", "value": [], "type": "any" }, { "key": "tokenRequestParams", "value": [], "type": "any" }, { "key": "authRequestParams", "value": [ { "key": "response_type", "value": "code", "enabled": true, "send_as": "request_url" }, { "key": "", "value": "", "enabled": false, "send_as": "request_url" } ], "type": "any" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "useBrowser", "value": true, "type": "boolean" }, { "key": "state", "value": "State", "type": "string" }, { "key": "authUrl", "value": "https://tonysmith.getbynder.com/v6/authentication/oauth2/auth", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "client_authentication", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] } ] }, { "name": "Workflow - Upload Asset to Job", "item": [ { "name": "1 - Prepare Upload", "event": [ { "listen": "test", "script": { "exec": [ "let jsonData = JSON.parse(responseBody);", "", "pm.collectionVariables.set(\"workflow_file_id\", jsonData.file_id);" ], "type": "text/javascript", "packages": {} } } ], "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "filename", "value": "test_file.jpg", "type": "text", "disabled": true } ] }, "url": { "raw": "https://tonysmith.getbynder.com/v7/file_cmds/upload/prepare", "protocol": "https", "host": [ "tonysmith", "getbynder", "com" ], "path": [ "v7", "file_cmds", "upload", "prepare" ] } }, "response": [] }, { "name": "2 - Upload Chunks", "event": [ { "listen": "prerequest", "script": { "exec": [ "const CryptoJS = require(\"crypto-js\");", "", "// Specify the file path within your collection", "const fileName = \"WAVE - background.jpg\";", "", "// Fetch the file", "pm.sendRequest({", " url: pm.environment.get(\"postman_collection_baseurl\") + '/path/to/your/file',", " method: 'GET',", " header: {", " 'Content-Type': 'application/octet-stream'", " }", "}, (err, res) => {", " if (err) {", " console.error('Error fetching file:', err);", " } else {", " // Convert file data to a WordArray for hashing", " const fileData = CryptoJS.lib.WordArray.create(res.stream);", "", " // Calculate SHA-256 hash", " const hash = CryptoJS.SHA256(fileData).toString(CryptoJS.enc.Hex);", "", " // Store hash in an environment variable", " pm.environment.set(\"file_sha256\", hash);", "", " console.log(\"SHA-256 Hash:\", hash);", " }", "});", "" ], "type": "text/javascript", "packages": {} } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "content-type": true } }, "request": { "method": "POST", "header": [ { "key": "Content-SHA256", "value": "SHA256 VALUE FOR FILE", "type": "text" }, { "key": "Content-Type", "value": "application/octet-stream", "type": "text" } ], "body": { "mode": "file", "file": { "src": "" } }, "url": { "raw": "https://yourportal.getbynder.com/v7/file_cmds/upload/{{workflow_file_id}}/chunk/0", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "v7", "file_cmds", "upload", "{{workflow_file_id}}", "chunk", "0" ] } }, "response": [] }, { "name": "3 - Finalize Upload", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "fileName", "value": "", "type": "text" }, { "key": "fileSize", "value": "FILE SIZE FOR FILE", "type": "text" }, { "key": "chunksCount", "value": "1", "type": "text" } ] }, "url": { "raw": "https://yourportal.getbynder.com/v7/file_cmds/upload/{{workflow_file_id}}/finalise_api", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "v7", "file_cmds", "upload", "{{workflow_file_id}}", "finalise_api" ] } }, "response": [] }, { "name": "4 - Push File to Job", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"fileId\": \"{{workflow_file_id}}\",\n \"name\": \"name of asset.jpg\",\n \"fileSize\": 18642\n}" }, "url": { "raw": "https://yourportal.getbynder.com/api/workflow/jobs/{{Workflow Job Id}}/upload", "protocol": "https", "host": [ "yourportal", "getbynder", "com" ], "path": [ "api", "workflow", "jobs", "{{Workflow Job Id}}", "upload" ] } }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "packages": {}, "exec": [ "" ] } } ] }, { "name": "Workflow metaproperties", "item": [ { "name": "Metaproperty operations", "item": [ { "name": "Retrieve metaproperties", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/metaproperties/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "metaproperties", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYOVERVIEW** security role." }, "response": [] } ] }, { "name": "Specific metaproperty operations", "item": [ { "name": "Retrieve specific metaproperty", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/metaproperties/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "metaproperties", "" ] }, "description": "**Warning:** Requires the **METAPROPERTYOVERVIEW** security role." }, "response": [] } ] } ] }, { "name": "Workflow users", "item": [ { "name": "User operations", "item": [ { "name": "Retrieve users", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/users/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "users", "" ] }, "description": "**Warning:** Requires the **USERMANAGEMENT** security role." }, "response": [] }, { "name": "Retrieve Specific Users", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/users/id/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "users", "id", "" ] } }, "response": [] }, { "name": "Retrieve Users with Pagination", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportal.bynder.com/api/workflow/users/", "protocol": "https", "host": [ "yourportal", "bynder", "com" ], "path": [ "api", "workflow", "users", "" ], "query": [ { "key": "paginate", "value": "True", "disabled": true }, { "key": "page", "value": "1", "disabled": true }, { "key": "page_size", "value": "10", "disabled": true } ] } }, "response": [] } ] } ] }, { "name": "Workflow groups", "item": [ { "name": "Group operations", "item": [ { "name": "Retrieve groups", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/groups/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "groups", "" ] }, "description": "**Warning:** Requires the **GROUPOVERVIEW** or **WORKFLOWADMIN** security role." }, "response": [] }, { "name": "Create group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\",\"user_ids\":[\"\"]}" }, "url": { "raw": "{{API Base URL}}/workflow/groups/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "groups", "" ] }, "description": "**Warning:** Requires the **GROUPOVERVIEW** or **WORKFLOWADMIN** security role." }, "response": [] } ] }, { "name": "Specific group operations", "item": [ { "name": "Retrieve specific group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/workflow/groups//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "groups", "", "" ] }, "description": "**Warning:** Requires the **GROUPOVERVIEW** or **WORKFLOWADMIN** security role." }, "response": [] }, { "name": "Modify group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"name\":\"\",\"user_ids\":[\"\"]}" }, "url": { "raw": "{{API Base URL}}/workflow/groups/d6ca2bdc-9fcc-4777-9f01-3ea95ac96eb6/", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "groups", "d6ca2bdc-9fcc-4777-9f01-3ea95ac96eb6", "" ] }, "description": "**Warning:** Requires the **GROUPOVERVIEW** or **WORKFLOWADMIN** security role." }, "response": [] }, { "name": "Delete group", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{}" }, "url": { "raw": "{{API Base URL}}/workflow/groups//", "host": [ "{{API Base URL}}" ], "path": [ "workflow", "groups", "", "" ] }, "description": "**Warning:** Requires the **GROUPOVERVIEW** or **WORKFLOWADMIN** security role." }, "response": [] } ] } ] }, { "name": "Brandstore", "item": [ { "name": "Order operations", "item": [ { "name": "Retrieve orders", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/store/order/", "host": [ "{{API Base URL}}" ], "path": [ "store", "order", "" ], "query": [ { "key": "page", "value": "", "description": "Offset page for results: return the N-th set of limit-results. Limit is currently hardcoded to 10.\nExample: 1.", "disabled": true } ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.view** security role." }, "response": [] } ] }, { "name": "Specific order operations", "item": [ { "name": "Retrieve specific order info", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/v4/store/order//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "store", "order", "", "" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.view** security role." }, "response": [] }, { "name": "Retrieve specific order by id", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/store/order//products", "host": [ "{{API Base URL}}" ], "path": [ "store", "order", "", "products" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.edit** security role." }, "response": [] }, { "name": "Retrieve specific order by number", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/store/order//products", "host": [ "{{API Base URL}}" ], "path": [ "store", "order", "", "products" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.edit** security role." }, "response": [] }, { "name": "Modify order", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "status", "value": "" }, { "key": "message", "value": "" }, { "key": "trackingnumber", "value": "" } ] }, "url": { "raw": "{{API Base URL}}/v4/store/order//", "host": [ "{{API Base URL}}" ], "path": [ "v4", "store", "order", "", "" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.edit** security role." }, "response": [] } ] }, { "name": "Specific orderline operations", "item": [ { "name": "Retrieve specific orderline", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "url": { "raw": "{{API Base URL}}/store/orderproducts//", "host": [ "{{API Base URL}}" ], "path": [ "store", "orderproducts", "", "" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.view** security role." }, "response": [] }, { "name": "Modify orderline", "protocolProfileBehavior": { "followRedirects": false, "followOriginalHttpMethod": false, "followAuthorizationHeader": false }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Authorization", "value": "{{Authorization}}" } ], "body": { "mode": "raw", "raw": "{\"status\":\"\",\"customerReference\":\"\"}" }, "url": { "raw": "{{API Base URL}}/store/orderproducts//", "host": [ "{{API Base URL}}" ], "path": [ "store", "orderproducts", "", "" ] }, "description": "**Warning:** Requires the **brandstore.orderadmin.edit** security role." }, "response": [] } ] } ] }, { "name": "Analytics", "item": [ { "name": "Asset View", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/view", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "view" ], "query": [ { "key": "limit", "value": null, "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": null, "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": null, "description": "String. Retrieve view events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": null, "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset View CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/view.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "view.csv" ], "query": [ { "key": "limit", "value": null, "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": null, "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": null, "description": "String. Retrieve view events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": null, "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Download", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/download", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "download" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve download events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Download CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/download.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "download.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve download events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Download V2", "request": { "method": "GET", "header": [], "url": { "raw": "https://your-bynder-domain/v7/analytics/api/v1/asset/v2/download", "protocol": "https", "host": [ "your-bynder-domain" ], "path": [ "v7", "analytics", "api", "v1", "asset", "v2", "download" ], "query": [ { "key": "limit", "value": null, "disabled": true }, { "key": "cursor", "value": null, "disabled": true }, { "key": "fromDateTime", "value": null, "disabled": true }, { "key": "toDateTime", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Asset Create", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/create", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "create" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve create events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Create CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/create.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "create.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve create events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Archive", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/archive", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "archive" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve archive events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Archive CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/archive.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "archive.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve archive events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Remove", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/remove", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "remove" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve remove events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Remove CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/remove.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "remove.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve remove events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/{assetId}/", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "{assetId}", "" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve events performed after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Asset Activity CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/asset/{assetId}.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "asset", "{assetId}.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve events performed ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00", "disabled": true } ] } }, "response": [] }, { "name": "Search Keyword", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/search/keyword", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "search", "keyword" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve keyword events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true } ] } }, "response": [] }, { "name": "Search Keyword CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/search/keyword.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "search", "keyword.csv" ], "query": [ { "key": "limit", "value": null, "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": null, "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": null, "description": "String. Retrieve keyword events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": null, "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true } ] } }, "response": [] }, { "name": "User Login", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/user/login", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "user", "login" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve login events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true } ] } }, "response": [] }, { "name": "User Login CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/user/login.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "user", "login.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve login events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true } ] } }, "response": [] }, { "name": "User Activity", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/user/{{userId}}/", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "user", "{{userId}}", "" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true }, { "key": "", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "User Activity CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/user/{{userId}}.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "user", "{{userId}}.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true }, { "key": "", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Collection View", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/collection/view", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "collection", "view" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve view events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true }, { "key": "", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Collection View CSV", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/collection/view.csv", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "collection", "view.csv" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateTime", "value": "", "description": "String. Retrieve view events ocurred after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateTime", "value": "", "description": "String. Set a date range together with the \"fromDateTime\" parameter. ISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true }, { "key": "", "value": "", "disabled": true } ] } }, "response": [] }, { "name": "Asset Reports", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/report/asset/", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "report", "asset", "" ], "query": [ { "key": "limit", "value": "", "description": "Number. The maximum number of analytics events to retrieve. Allowed values are between 1 and 10000. Example: 100. Default: 1000.", "disabled": true }, { "key": "cursor", "value": "", "description": "String. Cursor mark returned in the response headers to be used for pagination purposes. Example: MTAwMA. Default: MA.", "disabled": true }, { "key": "fromDateCreated", "value": "", "description": "String. Retrieve reports of assets created after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateCreated", "value": "", "description": "String. Set a date range together with the \"fromDateCreated\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true }, { "key": "fromDateModified", "value": null, "description": "String. Retrieve reports of assets modified after this date.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-01-01T01:00.", "disabled": true }, { "key": "toDateModified", "value": null, "description": "String. Set a date range together with the \"fromDateModified\" parameter.\nISO8601 format: yyyy-mm-ddThh:mm[:ssZ] with optional seconds. Example: 2022-06-01T01:00.", "disabled": true } ] } }, "response": [] }, { "name": "Specific Asset Report", "request": { "method": "GET", "header": [], "url": { "raw": "{{API Base URL}}/v7/analytics/api/v1/report/asset/{{assetId}}", "host": [ "{{API Base URL}}" ], "path": [ "v7", "analytics", "api", "v1", "report", "asset", "{{assetId}}" ] } }, "response": [] } ] }, { "name": "Antivirus Operations", "item": [ { "name": "Retrieve an antivirus asset by ID", "request": { "method": "GET", "header": [], "url": { "raw": "https://your-bynder-domain/v7/antivirus/v1/antivirus-asset", "protocol": "https", "host": [ "your-bynder-domain" ], "path": [ "v7", "antivirus", "v1", "antivirus-asset" ], "query": [ { "key": "assetId", "value": "", "description": "asset id ", "disabled": true } ] } }, "response": [] }, { "name": "New Request", "request": { "method": "POST", "header": [], "body": { "mode": "urlencoded", "urlencoded": [] }, "url": { "raw": "https://your-bynder-domain/v7/antivirus/v1/antivirus-audit", "protocol": "https", "host": [ "your-bynder-domain" ], "path": [ "v7", "antivirus", "v1", "antivirus-audit" ] } }, "response": [] } ] }, { "name": "Webhooks", "item": [ { "name": "Get Webhooks Configuration", "request": { "method": "GET", "header": [], "url": { "raw": "https://yourportalurl.bynder.com/v7/webhooks/public/api/subscriptions", "protocol": "https", "host": [ "yourportalurl", "bynder", "com" ], "path": [ "v7", "webhooks", "public", "api", "subscriptions" ] } }, "response": [] }, { "name": "Create a Webhook Configuration", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"NAME OF WEBHOOK\",\n \"endpoint\":\"ENDPOINT URL OR ARN OR EMAIL\",\n \"protocol\": \"PROTOCOL\",\n \"events\":[\"asset_bank.media.archived\",\n \"asset_bank.media.pre_archived\",\n \"asset_bank.media.deleted\"],\n \"preArchivedNotificationDays\": 5\n\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportalurl.bynder.com/v7/webhooks/public/api/subscriptions", "protocol": "https", "host": [ "yourportalurl", "bynder", "com" ], "path": [ "v7", "webhooks", "public", "api", "subscriptions" ] } }, "response": [] }, { "name": "Update a Webhook Configuration", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"events\":[\"asset_bank.media.archived\",\n \"asset_bank.media.pre_archived\"\n ],\n \"preArchivedNotificationDays\": 5\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportalurl.bynder.com/v7/webhooks/public/api/subscriptions/{id}", "protocol": "https", "host": [ "yourportalurl", "bynder", "com" ], "path": [ "v7", "webhooks", "public", "api", "subscriptions", "{id}" ] } }, "response": [] }, { "name": "Patch a Webhook Configuration", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"name\": \"Updated name via API\",\n \"status\": 1\n \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportalurl.bynder.com/v7/webhooks/public/api/subscriptions/{id}", "protocol": "https", "host": [ "yourportalurl", "bynder", "com" ], "path": [ "v7", "webhooks", "public", "api", "subscriptions", "{id}" ] } }, "response": [] }, { "name": "Delete a Webhook Configuration", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://yourportalurl.bynder.com/v7/webhooks/public/api/subscriptions/{id}", "protocol": "https", "host": [ "yourportalurl", "bynder", "com" ], "path": [ "v7", "webhooks", "public", "api", "subscriptions", "{id}" ] } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "{{API Base URL}}", "value": "{{your Bynder portal URL}}", "type": "string" }, { "key": "{{Brand_ID}}", "value": "{{youe Bynder portal Brand ID}}", "type": "string" } ] }