Acquia Connector v1.0 Initial Release

Version 1

View API Documentation

POST

Analytics: List Asset 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

POST

Analytics: List Asset 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

POST

Analytics: List Asset 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

POST

Assets: Complete Chunked 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

DELETE

Assets: Delete Alternate Preview

Upload a new file as an alternate preview to an Asset.

Parameters

DELETE

Assets: Delete Assets

Parameters

GET

Assets: Get Asset Groups

Get a list of Asset Groups that the calling User has permission to view.

Parameters

GET

Assets: List All Upload 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

GET

Assets: List By Scrolling Search

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

GET

Assets: List By Search Query

Parameters

PUT

Assets: Rename

Parameters

GET

Assets: Retrieve Asset 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

GET

Assets: Retrieve Asset Security

Parameters

GET

Assets: Retrieve by ID

Parameters

POST

Assets: Start Chunked 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

PUT

Assets: Update Security

Parameters

POST

Assets: Upload Alternate Preview

Upload a new file as an alternate preview to an Asset.

Parameters

POST

Assets: Upload Chunk

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

POST

Assets: Upload a file

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

GET

Attributes: List 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

GET

Attributes: List 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

GET

Categories: List Product Categories

Parameters

GET

Channels: List Channels

Parameters

GET

Collections: List collections

Parameters

DELETE

Metadata: Delete Value

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

GET

Metadata: List Values

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

GET

Metadata: Retrieve Single Value

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

GET

Metadata: Viewable

The metadata fields endpoint allows you to query for a list of metadata fields that you have permission to see.

Parameters

DELETE

OAuth: Invalidate 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

POST

OAuth: Obtain 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

GET

Product Types: List Product Types

Parameters

POST

Products: Create a New Product

Parameters

DELETE

Products: Delete Products

Parameters

POST

Products: List Products by Search Query

Parameters

GET

Products: List Products for Channel

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

PUT

Products: Rename

Parameters

GET

Products: Retrieve by ID

Parameters

PUT

Products: Update Attribute Values

Parameters

PUT

Products: Update Featured Image

Parameters

PUT

Products: Update Parent Product

Parameters

PUT

Products: Update Product Category

Parameters

PUT

Products: Update Product Type

Parameters

GET

Search Connector: Instant Search Connector 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

GET

Toggles: List Toggles

Parameters

GET

Usage: Get API Usage

Parameters

GET

Users: Get User

Returns information about the user associated with the given Access Token.

Parameters

POST

Workflow Projects: Add Deliverable to Project

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

PUT

Workflow Projects: Close Deliverable

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

POST

Workflow Projects: Create new Project

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

DELETE

Workflow Projects: Delete Deliverable

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

DELETE

Workflow Projects: Delete Project

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

GET

Workflow Projects: Retrieve Deliverable By 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

GET

Workflow Projects: Retrieve all Project 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

GET

Workflow Projects: Retrieve supporting 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

POST

Workflow Projects: Upload Proof to Deliverable

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

POST

Workflow Webhooks: Add new Webhook

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

DELETE

Workflow Webhooks: Delete Webhook

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

GET

Workflow Webhooks: List all 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