Version 1.0
Connector Overview: This page documents all 58 actions for the Acquiaconnector v1.0.
Analytics (3)
POST List Asset Downloads
/analytics/assets/downloads
The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset. Events may take up to 24 hours before appearing in analytics API results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify the maximum number of download records to return in a single response. |
|
|
Provide the token to fetch the next page of download results. |
POST List Asset Shares
/analytics/assets/shares
The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset. Events may take up to 24 hours before appearing in analytics API results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify the maximum number of share records to return in a single response. |
|
|
Provide the token to fetch the next page of share results. |
POST List Asset Views
/analytics/assets/views
The Analytics endpoints provide information about asset usage from the Insights application. The API will return download, view, and share details for a single asset. Events may take up to 24 hours before appearing in analytics API results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Specify the maximum number of view records to return in a single response. |
|
|
Provide the token to fetch the next page of view results. |
Assets (16)
POST Complete Chunked Upload
/uploads/chunks/complete
Assets with large filesizes can be broken into pieces and uploaded as smaller chunks.
``Start Chunked Upload`` begins a chunked uploading session. The session_id in the response must be used for subsequent upload chunk and complete chunk calls. This session_id is good for 7 days.
Use ``Upload Chunk` to upload each piece of the file. Each call must include the session_id from the `Start Chunked Upload` call. The tag in each `Upload Chunk` response must be used in the `Complete Chunked Upload`` call.
Once all file chunks have been uploaded, call ``Complete Chunked Upload` with a list of all tags to complete the upload and put the file chunks back together into one file. The file_id in the reponse can be used in the `Create Asset`` call to create an Asset from this file.
Note: Some Collective accounts do not support chunked uploading. If you receive a 'Chunked uploads are not currently available for this account' error response, please contact support@widen.com to discuss your use case.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Session ID for this chunked upload as returned by the Start Chunked Upload call |
|
|
Array of tags returned by the Upload Chunk calls. Order is not important |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide configuration options and metadata required to complete the chunked upload process. |
DELETE Delete Alternate Preview
/assets/{id}/alternatepreview
Upload a new file as an alternate preview to an Asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Assets
/assets/{id}
Permanently delete a specific asset using its unique ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset ID |
|
|
Specify related resources or fields to expand in the response. |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Asset Groups
/assets/assetgroups
Get a list of Asset Groups that the calling User has permission to view.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List All Upload Profiles
/uploads/profiles
All uploads require a profile. Profiles control a new asset's initial metadata and security defaults.
Use the Collective administrative tools to configure profiles to accommodate your use case.
See Stackoverflow for examples of creating multipart/form-data requests for your language.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
GET List By Scrolling Search
/assets/search/scroll
The scroll endpoint can be used to retrieve large numbers of results (or even all results) from a single search request.
<p>Scrolling is not intended for real time user requests, but rather for processing large amounts of data, e.g. with a background batch application that syncs Acquia Collective data locally. For more details on when to use scrolling and when to use an offset, see this [Widen Developer blog post](https://developer.widen.com/blog/pagination-in-search/).
<p>In order to use the scroll endpoint, the initial List By Search Query request should specify a `scroll=true` parameter in the query. The result set will contain a `scroll_id` field that can be passed into the scrolling search endpoint.
<p>Each call to the scroll endpoint with the previous response's `scroll_id` returns the next batch of results until there are no more results left to return, ie the result list is empty. You must make the next call within the response's `scroll_timeout` value (in ms) before the `scroll_id` becomes invalid.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
scroll_id as returned by the original List By Search Query request |
|
|
Comma-seperated list of data items to expand on result set |
|
|
The response format expected from the API (e.g. application/json). |
GET List By Search Query
/assets/search
Search and retrieve assets based on specified query parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Collective quicksearch query. Uses the same quick search syntax used within the Acquia Collective web UI. For more information on the format of a query string, see
|
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 100. |
|
|
Starting position of query result set. For more details on when to use an offset and when to use scrolling, see this Widen Developer blog post. |
|
|
Field to order the result-set; prefix term with - (negative sign) to for descending order. Default is -created_date (newest assets first). |
|
|
Comma-seperated list of data items to expand on the result set |
|
|
Comma-seperated list of data items to facet on the result set. For more details on faceting, see this Widen Developer blog post. |
|
|
If true, a scroll_id is included with the results to allow scrolling through large result sets. Default value is false. |
|
|
If true, deleted assets will be returned in the results, if the user associated with the access token has permission to view deleted assets. Default value is false. |
|
|
If true, archived assets will be returned in the results, if the user associated with the access token has permission to view archived assets. Default value is false. |
|
|
If true, will include searching of document text in your search results. Default value is false. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Rename
/assets/{id}/filename
Change the filename of an existing asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the configuration options including the new filename for the asset. |
GET Retrieve Asset Metadata
/assets/{id}/metadata
Metadata subresource simply returns the metadata property of the asset. The object structure returned by search endpoint and this method are identical.
All assigned fields for the asset will be included. Empty fields are repesented with an empty array.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of asset |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve Asset Security
/assets/{id}/security
Retrieve security configurations, access controls, and permissions for a specific asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of asset |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve by ID
/assets/{id}
Retrieve details of a specific asset using its unique identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset ID |
|
|
Additional properties to be included in response (comma delimited list). |
|
|
The response format expected from the API (e.g. application/json). |
POST Start Chunked Upload
/uploads/chunks/start
Assets with large filesizes can be broken into pieces and uploaded as smaller chunks.
``Start Chunked Upload`` begins a chunked uploading session. The session_id in the response must be used for subsequent upload chunk and complete chunk calls. This session_id is good for 7 days.
Use ``Upload Chunk` to upload each piece of the file. Each call must include the session_id from the `Start Chunked Upload` call. The tag in each `Upload Chunk` response must be used in the `Complete Chunked Upload`` call.
Once all file chunks have been uploaded, call ``Complete Chunked Upload` with a list of all tags to complete the upload and put the file chunks back together into one file. The file_id in the reponse can be used in the `Create Asset`` call to create an Asset from this file.
Note: Some Collective accounts do not support chunked uploading. If you receive a 'Chunked uploads are not currently available for this account' error response, please contact support@widen.com to discuss your use case.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update Security
/assets/{id}/security
Update security settings, release and expiration dates, and access groups for a specific asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of asset |
|
|
Comma seperated list of properties to update. Valids values are all, expiration_date, release_date, asset_groups. |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Set the date and time when the asset should expire and no longer be accessible. |
|
|
Set the date and time when the asset should be released and made available. |
|
|
Specify an array of asset groups that have access to this asset. |
POST Upload Alternate Preview
/assets/{id}/alternatepreview
Upload a new file as an alternate preview to an Asset.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Asset ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
(multipart/form-data field) Binary file of the alternate preview file for this asset |
POST Upload Chunk
/uploads/chunks/upload
Assets with large filesizes can be broken into pieces and uploaded as smaller chunks.
``Start Chunked Upload`` begins a chunked uploading session. The session_id in the response must be used for subsequent upload chunk and complete chunk calls. This session_id is good for 7 days.
Use ``Upload Chunk` to upload each piece of the file. Each call must include the session_id from the `Start Chunked Upload` call. The tag in each `Upload Chunk` response must be used in the `Complete Chunked Upload`` call.
Once all file chunks have been uploaded, call ``Complete Chunked Upload` with a list of all tags to complete the upload and put the file chunks back together into one file. The file_id in the reponse can be used in the `Create Asset`` call to create an Asset from this file.
Note: Some Collective accounts do not support chunked uploading. If you receive a 'Chunked uploads are not currently available for this account' error response, please contact support@widen.com to discuss your use case.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
(multipart/form-data field) Session ID for this chunked upload as returned by the Start Chunked Upload call |
|
|
(multipart/form-data field) The chunk number. Must be between 1 and 10,000 |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
(multipart/form-data field) Binary file chunk for upload. Cannot be greater than 100MB, and must be at least 5MB unless it's the last chunk. |
POST Upload a file
/uploads
All uploads require a profile. Profiles control a new asset's initial metadata and security defaults.
Use the Collective administrative tools to configure profiles to accommodate your use case.
See Stackoverflow for examples of creating multipart/form-data requests for your language.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide the authorization credentials or token for authenticating the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide details and options for the file being uploaded. |
Attributes (2)
GET List Attributes
/attributes
The Attributes endpoint lists all product attributes that have been configured in Entries, and all controlled vocabulary values for any single-select or multi-select attribute.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 1000. Defaults to 100. |
|
|
Starting position of query result set. Defaults to 0. |
|
|
The response format expected from the API (e.g. application/json). |
GET List Vocabulary
/attributes/{id}/vocabulary
The Attributes endpoint lists all product attributes that have been configured in Entries, and all controlled vocabulary values for any single-select or multi-select attribute.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Attribute ID |
|
|
The response format expected from the API (e.g. application/json). |
Categories
GET List Product Categories
/product-categories
Retrieve a list of all product categories defined in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 50. Defaults to 50. |
|
|
Starting position of query result set. Defaults to 0. |
|
|
Optional parent product category id. If ommittedd, the top level categories will be returned. |
|
|
The response format expected from the API (e.g. application/json). |
Channels
GET List Channels
/channels
Retrieve a list of available channels.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 1000. Defaults to 100. |
|
|
Starting position of query result set. Defaults to 0. |
|
|
The response format expected from the API (e.g. application/json). |
Collections
GET List collections
/collections
Retrieve a list of collections.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Filter for type of collections. One of global, private or shared. |
|
|
The response format expected from the API (e.g. application/json). |
Metadata (4)
DELETE Delete Value
/metadata/{displayKey}/vocabulary/{existingValue}
The metadata controlled vocabulary endpoint allows you to query, add, update, re-order, or delete controlled vocabulary values to your drop-down, palette, and checkbox group metadata fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Display key of the controlled vocabulary metadata field |
|
|
The controlled vocabulary value you wish to delete |
|
|
The response format expected from the API (e.g. application/json). |
GET List Values
/metadata/{displayKey}/vocabulary
The metadata controlled vocabulary endpoint allows you to query, add, update, re-order, or delete controlled vocabulary values to your drop-down, palette, and checkbox group metadata fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Display key of the controlled vocabulary metadata field |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve Single Value
/metadata/{displayKey}/vocabulary/{existingValue}
The metadata controlled vocabulary endpoint allows you to query, add, update, re-order, or delete controlled vocabulary values to your drop-down, palette, and checkbox group metadata fields.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Display key of the controlled vocabulary metadata field |
|
|
The controlled vocabulary value |
|
|
The response format expected from the API (e.g. application/json). |
GET Viewable
/metadata/fields/viewable
The metadata fields endpoint allows you to query for a list of metadata fields that you have permission to see.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The field type that you want to query |
|
|
A filter that only returns metadata fields with display names alphabetically greater than this value. |
|
|
A filter that only returns metadata fields with display names that start with this value |
|
|
The max number of metadata fields returned by this query. Must be between 1 and 100. |
|
|
The response format expected from the API (e.g. application/json). |
OAuth (2)
DELETE Invalidate Access Token
/oauth/access-token
When obtaining an access token, a successful response will contain the following fields:
-
access_token: This is your access token. It should be stored securely and included with any requests to access protected resources.
-
token_type: This is the type of token you received. At this time, the token type will always be "Bearer".
If the OAuth client used to obtain an access token is set up to use refresh tokens, the response will include two additional fields.
-
refresh_token: This is a refresh token that can be used to obtain a new access token.
-
expires_in: Number of seconds until the access_token expires.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Provide the authorization header containing the access token to be invalidated. |
|
|
The response format expected from the API (e.g. application/json). |
POST Obtain Access Token
/oauth/access-token
When obtaining an access token, a successful response will contain the following fields:
-
access_token: This is your access token. It should be stored securely and included with any requests to access protected resources.
-
token_type: This is the type of token you received. At this time, the token type will always be "Bearer".
If the OAuth client used to obtain an access token is set up to use refresh tokens, the response will include two additional fields.
-
refresh_token: This is a refresh token that can be used to obtain a new access token.
-
expires_in: Number of seconds until the access_token expires.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Specify the expected response media type. |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Specify the type of OAuth grant being requested. |
|
|
Provide the authorization code obtained from the authorization server, if using the authorization code flow. |
|
|
Provide the client application identifier. |
|
|
Provide the client application secret key. |
Product Types
GET List Product Types
/product-types
Retrieve a list of product types available in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 1000. Defaults to 100. |
|
|
Starting position of query result set. Defaults to 0. |
|
|
The response format expected from the API (e.g. application/json). |
Products (11)
POST Create a New Product
/products
Create a new product entry.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide details and options for the new product being created. |
DELETE Delete Products
/products/{product_id}
Permanently delete a product by its unique product identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
POST List Products by Search Query
/products/search
Search and retrieve products matching specified criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
Optional term that will search for this string in product name or sku |
|
|
Max 100, Min 0, Default 10 |
|
|
Max 9999, Min 0, Default 0 |
|
|
If included, result set will be expanded with additional data |
|
|
Defaults to empty. Filters are AND-ed together. To mimic Entries channel export use the exclude_variants filter. To mimic Entries product search page use the exclude_variant and search_parents_via_variants filters. |
GET List Products for Channel
/products/channels/{channel_id}
The Channel Products endpoint returns a list of products associated with a given channel in Entries. Only the products and attributes that are configured for the channel will be included in the response.
Note that channel_id is case sensitive.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Channel ID (case-sensitive) |
|
|
Numeric limit of the total number of results to retrieve. Maximum value is 100. Defaults to 100. |
|
|
Starting position of query result set. Defaults to 0. |
|
|
The response format expected from the API (e.g. application/json). |
PUT Rename
/products/{product_id}/rename
Change the name of a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify the new name for the product. |
GET Retrieve by ID
/products/{product_id}
Retrieve details of a specific product using its product identifier.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update Attribute Values
/products/{product_id}/attributes
Update the attributes and properties of a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update Featured Image
/products/{product_id}/featured-image
Set or update the featured image of a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify the unique ID of the asset to be set as the featured image. |
PUT Update Parent Product
/products/{product_id}/parent-product
Set or update the parent product relationship for a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify the ID of the parent product. |
PUT Update Product Category
/products/{product_id}/product-category
Update the product category associated with a specified product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
PUT Update Product Type
/products/{product_id}/product-type
Update the product type of a specific product.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
ID of the Product (case sensitive) |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The unique identifier of the product type to assign to the product. |
Search Connector
GET Instant Search Connector URL
/integrations/url
The Instant Search Connector allows external applications access to Acquia Collective Asset search, without having to implement a native search UI.
-
The Instant Search Connector UI is provided by Acquia via a secure dynamic web url endpoint.
-
This Search Connector url is returned by an API call to /integrations/url (described below).
-
The Search Connector UI is intended to be displayed in an iframe within the parent application.
-
Searching and selecting of multiple Assets is provided by the Search Connector UI.
-
Search permissions will match those of the API caller that made the query to /integrations/url for the search endpoint.
-
The Search Connector url is valid for 24 hours, and is signed via a one-way hash to prevent modification of its parameters.
When a user selects one or more Assets in the Search Connector UI, information about the user’s selection is passed back to the parent application with a javascript postMessage call:
{
"count": 1,
"action": "embed",
"items": [
{
"id": "190dfsaf-f82c-462m-bc5e-eab2b8ed3bf9",
"external_id": "fzsf3duqp0",
"filename": "beef_soup.psd",
"embed_name": "640px Landscape",
"embed_link": "https://embed.widencdn.net/img/demo/fzsf3duqp0/640px/beef_soup.jpeg?u=xkzj3k",
"embed_code": "<img width=\"640\" alt=\"beef_soup\" src=\"https://embed.widencdn.net/img/demo/fzsf3duqp0/640px/beef_soup.jpeg?u=xkzj3k\">",
"share_link": "https://p.widencdn.net/g6dnbl/Mimco4",
"thumbnail_link": "https://embed.widencdn.net/img/demo/fzsf3duqp0/2048px/beef_soup.jpeg
}
]
}
The hosting application's javascript can receive this and process this message by listening for the "message" event:
window.addEventListener('message', function(event)
{
console.log(event.data);
var embedCode = event.data.items[0].embed_code;
console.log(embedCode);
// Insert embedCode into user’s html content
// Close iframe
})
The parent application can use the embed_code to insert into web page content, or the share_link for outbound email messages, or store the selected Asset IDs for future use.
See our support article for more information about the Instant Search Connector.Returns a url to the Search Connector UI. This UI intended to be displayed in an iframe within the parent application. The returned url is valid for 24 hours and is signed via a one-way hash to prevent modification of its parameters.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Optional URL-encoded search term to initially seed the Search Connector results page. |
|
|
Optional flag to remove the search bar from the user interface. Useful when used with the optional query parameter to simply present a set of search results. Default value is 'false'. |
|
|
The response format expected from the API (e.g. application/json). |
Toggles
GET List Toggles
/toggles
Retrieve a list of available feature toggles in the system.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Usage
GET Get API Usage
/usage/api
Retrieve API usage metrics and statistics.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The content type header for the request, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Users
GET Get User
/user
Returns information about the user associated with the given Access Token.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The content type header for the request, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
Workflow Projects (9)
POST Add Deliverable to Project
/workflow/projects/{project_id}/deliverables
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide details and options for the new product being created. |
PUT Close Deliverable
/workflow/projects/{project_id}/deliverables/{deliverable_id}/close
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
Deliverable ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The upload profile configuration to use when closing the deliverable. |
|
|
The name of the file associated with the final deliverable. |
POST Create new Project
/workflow/projects
Projects are the container object for all work that is to be reviewed. A project can have zero to many deliverables and is managed by a single person, the project manager.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
The name of the new workflow project. |
|
|
A brief description explaining the purpose of the project. |
|
|
The scheduled start date for the workflow project. |
|
|
The scheduled completion or end date for the workflow project. |
|
|
The name or identifier of the project manager. |
|
|
The name or identifier of the project owner. |
|
|
A list of workgroups assigned to participate in this project. |
DELETE Delete Deliverable
/workflow/projects/{project_id}/deliverables/{deliverable_id}
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
Deliverable ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Project
/workflow/projects/{project_id}
Projects are the container object for all work that is to be reviewed. A project can have zero to many deliverables and is managed by a single person, the project manager.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve Deliverable By ID
/workflow/projects/{project_id}/deliverables/{deliverable_id}
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
Deliverable ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve all Project Deliverables
/workflow/projects/{project_id}/deliverables
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Retrieve supporting files
/workflow/projects/{project_id}/support-files
Projects are the container object for all work that is to be reviewed. A project can have zero to many deliverables and is managed by a single person, the project manager.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Upload Proof to Deliverable
/workflow/projects/{project_id}/deliverables/{deliverable_id}/proofs
Deliverables represent the individual components of a Workflow project. A deliverable contains a review workflow, dates, and acquires one to many versions of a proof throughout the review cycle.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Project ID |
|
|
Deliverable ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The filename of the proof being uploaded. |
|
|
The direct URL where the proof file can be accessed. |
|
|
The size of the proof file content in bytes. |
Workflow Webhooks (3)
POST Add new Webhook
/workflow/webhooks
Webhooks allow you to subscribe to changes within Acquia Workflow and be updated of these changes as they happen. This is a more convenient and efficient mechanism to receive notification of changes (Events) without using polling.
The API allows you to retrieve a list of all webhook subscriptions, create new subscriptions, and remove existing subscriptions. Event updates are made via an HTTP POST and Workflow currently sends one Event object per POST.
Events supported (and example HTTP POST bodies):
-
`DELIVERABLE_STATUS_CHANGED` Event - updated when a deliverable changes status such as moving from “In Review” to “Needs Proof”:
```
{
"deliverable_key": "001",
"old_status": "NEEDS_SETUP",
"new_status: "NEEDS_PROOF"
}
```
Possible values (for `old_status` and `new_status`):
- `NEEDS_SETUP`
- `NEEDS_PROOF`
- `NEEDS_PROOF_WITH_EDITS`
- `IN_REVIEW`
- `REVIEW_COMPLETE`
- `CLOSED`
-
`PROJECT_CREATED` Event - updated when a new project has been created. Returns the project ID and title:
```
{
"project_id": "TLA-0002",
"title": "DAM Decisions"
}
```
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
The content type of the request payload sent to the API (e.g. application/json). |
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The specific workflow event name that triggers the webhook. |
|
|
The target URL where webhook event payloads will be sent. |
DELETE Delete Webhook
/workflow/webhooks
Webhooks allow you to subscribe to changes within Acquia Workflow and be updated of these changes as they happen. This is a more convenient and efficient mechanism to receive notification of changes (Events) without using polling.
The API allows you to retrieve a list of all webhook subscriptions, create new subscriptions, and remove existing subscriptions. Event updates are made via an HTTP POST and Workflow currently sends one Event object per POST.
Events supported (and example HTTP POST bodies):
-
`DELIVERABLE_STATUS_CHANGED` Event - updated when a deliverable changes status such as moving from “In Review” to “Needs Proof”:
```
{
"deliverable_key": "001",
"old_status": "NEEDS_SETUP",
"new_status: "NEEDS_PROOF"
}
```
Possible values (for `old_status` and `new_status`):
- `NEEDS_SETUP`
- `NEEDS_PROOF`
- `NEEDS_PROOF_WITH_EDITS`
- `IN_REVIEW`
- `REVIEW_COMPLETE`
- `CLOSED`
-
`PROJECT_CREATED` Event - updated when a new project has been created. Returns the project ID and title:
```
{
"project_id": "TLA-0002",
"title": "DAM Decisions"
}
```
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The content type header for the request, typically application/json. |
|
|
The response format expected from the API (e.g. application/json). |
GET List all Webhooks
/workflow/webhooks
Webhooks allow you to subscribe to changes within Acquia Workflow and be updated of these changes as they happen. This is a more convenient and efficient mechanism to receive notification of changes (Events) without using polling.
The API allows you to retrieve a list of all webhook subscriptions, create new subscriptions, and remove existing subscriptions. Event updates are made via an HTTP POST and Workflow currently sends one Event object per POST.
Events supported (and example HTTP POST bodies):
-
`DELIVERABLE_STATUS_CHANGED` Event - updated when a deliverable changes status such as moving from “In Review” to “Needs Proof”:
```
{
"deliverable_key": "001",
"old_status": "NEEDS_SETUP",
"new_status: "NEEDS_PROOF"
}
```
Possible values (for `old_status` and `new_status`):
- `NEEDS_SETUP`
- `NEEDS_PROOF`
- `NEEDS_PROOF_WITH_EDITS`
- `IN_REVIEW`
- `REVIEW_COMPLETE`
- `CLOSED`
-
`PROJECT_CREATED` Event - updated when a new project has been created. Returns the project ID and title:
```
{
"project_id": "TLA-0002",
"title": "DAM Decisions"
}
```
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
The response format expected from the API (e.g. application/json). |