How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acoustic Content API

Headless CMS and digital asset management REST API (authoring and delivery) for managing assets, resources, renditions, content items, content types, element definitions, categories/taxonomies, layouts, layout mappings, libraries, sites, pages, comments, reviews, versions, search, rendering, publishing jobs and the tenant webhook profile. Multi-tenant SaaS: the REST base host is regional and the path carries the tenant's Content Hub ID, so the base is https://{DomainName}/api/{ContentHubId} (for example https://content-us-1.content-cms.com/api/{tenantId}).

This API exposes 178 operations across 136 paths, organized into 28 resource areas, and defines 294 schemas. It is described by OpenAPI 3.0.0, at version 1.0.142.

Requests are made against the base URL https://content-us-1.content-cms.com/api/{tenantId}.

178 operations 136 paths 294 schemas 14 DELETE97 GET51 POST16 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.142
Base URL
https://content-us-1.content-cms.com/api/{tenantId}
Resource Areas
28

Paths & Operations 178

Across 136 paths, the API surfaces 178 operations — 14 DELETE, 97 GET, 51 POST, 16 PUT. They span 28 resource areas, including Authoring assets, Authoring categories, Authoring changes, Authoring comments, Authoring content, Authoring Import, Authoring layouts, Authoring reference, and 20 more. Each is listed below with its method, path, parameters, and response codes.

Authoring assets 9

General Use the Content Asset service Rest APIs to work with assets. Assets are file types that are uploaded or created such as an image file, video file, or text that are used in…

GET
/authoring/v1/assets
Retrieve all assets.
4 params → 200429503default
POST
/authoring/v1/assets
Create an asset.
6 params body → 201400409429503default
GET
/authoring/v1/assets/{id}
Retrieve an existing asset.
4 params → 200304404412429503default
DELETE
/authoring/v1/assets/{id}
Delete an existing asset.
2 params → 204404409429503default
PUT
/authoring/v1/assets/{id}
Update an existing asset.
6 params body → 200400409412429503default
GET
/authoring/v1/assets/record
Retrieve an existing asset by path.
4 params → 200304400404412429503default
POST
/authoring/v1/assets/{id}/analyze
AI analyzes the asset. The analysis results are stored on the asset itself.
2 params → 200400404429default
POST
/authoring/v1/assets/{id}/create-draft
Create a draft of existing asset.
3 params → 201400404429default
GET
/authoring/v1/assets/views/by-modified
Retrieve all assets modified within the specified date
7 params → 200400429503default
Authoring categories 8

Use the Acoustic Content category authoring data service Rest APIs to work with category and taxonomy items.

GET
/authoring/v1/categories
Retrieve all the taxonomies.
2 params → 200429
POST
/authoring/v1/categories
Create a new category.
body → 201400409429
GET
/authoring/v1/categories/{id}
Retrieve an existing category item.
1 param → 200404429
PUT
/authoring/v1/categories/{id}
Update an existing category item.
1 param body → 200400404409429
DELETE
/authoring/v1/categories/{id}
Delete an existing category item.
1 param → 200400404429
GET
/authoring/v1/categories/views/by-modified
Gets all categories modified between the start and end date.
6 params → 200429503default
GET
/authoring/v1/categories/{id}/children
Retrieve the child categories of the category with ID {id}.
2 params → 200429
GET
/authoring/v2/categories
Retrieve all the taxonomies and their children.
3 params → 200429
Authoring changes 8

Use the Content Authoring Changes Rest APIs to apply changes, including bulk actions, to multiple types of Content items.

POST
/authoring/v1/changes/status/ready
Mark items as ready for publishing in bulk.
body → 200429503default
POST
/authoring/v1/changes/status/retire
Bulk retire items.
body → 200429503default
POST
/authoring/v1/changes/delete
Beta - Bulk delete items.
body → 200400429503default
POST
/authoring/v1/changes/set-library
Beta - Bulk move items to another library.
body → 200400429503default
POST
/authoring/v1/changes/{uid}/status/ready
Mark the item with the specified unique ID as ready for publishing.
2 params → 200400429503default
POST
/authoring/v1/changes/{uid}/status/retire
Retire an item with the specified unique ID.
2 params → 200400429503default
POST
/authoring/v1/changes/{classification}/{id}/status/ready
Mark an item with the specified classification and ID as ready for publishing.
3 params → 200400429503default
POST
/authoring/v1/changes/{classification}/{id}/status/retire
Retire an item with the specified classification and ID.
3 params → 200400429503default
Authoring comments 6

Use the Content Authoring comment APIs to work with comments. Comments are a simple way to associate a message to an item in Content. Comments are associated with a single item an…

POST
/authoring/v1/comments
Create a comment.
body → 201400429503default
GET
/authoring/v1/comments/{id}
Retrieve an existing comment.
2 params → 200404429503default
PUT
/authoring/v1/comments/{id}
Update an existing comment.
2 params body → 200400404409429503default
DELETE
/authoring/v1/comments/{id}
Delete an existing comment.
1 param → 204404429default
GET
/authoring/v1/comments/by-item/{classification}/{id}
Retrieve all comments for a specific item.
7 params → 200304429503default
GET
/authoring/v1/comments/by-user/{userId}
Retrieve all comments that were created by a user.
6 params → 200429503default
Authoring content 11

General Use the Content content authoring data service Rest APIs to work with content documents. Content includes items that you compose in your content hub and upload from outsid…

GET
/authoring/v1/content
List all content items in the database.
3 params → 200429503default
POST
/authoring/v1/content
Create content items.
1 param body → 201400429503default
GET
/authoring/v1/content/{id}
Retrieve an existing content item.
3 params → 200404429503default
PUT
/authoring/v1/content/{id}
Update an existing content item.
5 params body → 200400404409429503default
DELETE
/authoring/v1/content/{id}
Delete an existing content item immediately.
1 param → 200404409429503default
GET
/authoring/v1/content/views/by-type
Retrieve all content of the specified type.
4 params → 200429503default
GET
/authoring/v1/content/views/by-modified
Retrieve all content modified within the specified date.
10 params → 200401429503default
POST
/authoring/v1/content/{id}/create-draft
Create a draft version of an existing content item.
4 params → 200400404409412429503default
GET
/authoring/v1/content/count
Retrieve the total number of content items in the database.
→ 200429default
POST
/authoring/v1/content/{id}/analyze
AI analyzes and provides tag recommendations for the content.
1 param → 200400404429default
POST
/authoring/v1/content/{id}/validate
Validate the specified content item against its type.
1 param → 200204400401404429503default
Authoring Import 1

Provides generic copying and importing functionality

POST
/authoring/v1/copy/sync
Copies the specified documents.
5 params body → 200400429500
Authoring layouts 23

Use the Content content authoring layout service Rest APIs to work with layouts and layout mappings. Layouts define the template for the type documents. They define the markup and…

POST
/authoring/v1/layouts
Create new layouts.
body → 201400403404409429500
GET
/authoring/v1/layouts
Retrieve all layouts in the database.
6 params → 200429
GET
/authoring/v1/layouts/by-content/{content-id}
Retrieves the layouts associated with the specified content.
7 params → 200400404429
GET
/authoring/v1/layouts/by-path
Retrieve an existing layout by its path.
4 params → 200304400403404429
GET
/authoring/v1/layouts/count
Retrieve the total number of layouts.
→ 200429500
PUT
/authoring/v1/layouts/{id}
Update an existing layout.
2 params body → 200400401403404409429500
DELETE
/authoring/v1/layouts/{id}
Delete an existing layout.
1 param → 200400401403404429500
GET
/authoring/v1/layouts/{id}
Retrieve an existing layout.
4 params → 200304400403404429
GET
/authoring/v1/layouts/views/by-modified
Retrieve all layouts in the database ordered by last modified date.
10 params → 200403429
GET
/authoring/v1/layouts/views/by-name
Retrieve all layouts in the database with the specified name.
5 params → 200400403429
POST
/authoring/v1/layout-mappings
Create new layout mappings.
body → 201400403404409429500
GET
/authoring/v1/layout-mappings
Retrieve all layout mappings in the database.
6 params → 200429
GET
/authoring/v1/layout-mappings/by-path
Retrieve an existing layout mapping by its path.
4 params → 200304400403404429
GET
/authoring/v1/layout-mappings/by-type/{type-id}
Retrieve an existing layout mapping via its associated content-type.
4 params → 200304400404429
DELETE
/authoring/v1/layout-mappings/by-type/{type-id}
Deletes an existing layout mapping via its associated content-type.
1 param → 200400403404429
POST
/authoring/v1/layout-mappings/by-type/{type-id}/copy
Copies an existing layout mapping via its associated content-type.
3 params → 200201404429
GET
/authoring/v1/layout-mappings/count
Retrieve the total number of layout mappings.
→ 200429500
PUT
/authoring/v1/layout-mappings/{id}
Update an existing layout mapping.
2 params body → 200400401403404409429500
DELETE
/authoring/v1/layout-mappings/{id}
Delete an existing layout mapping.
1 param → 200400401403404429500
GET
/authoring/v1/layout-mappings/{id}
Retrieve an existing layout mapping.
4 params → 200304400403404429
POST
/authoring/v1/layout-mappings/{id}/copy
Copies an existing layout mapping.
3 params → 200201404429
GET
/authoring/v1/layout-mappings/views/by-modified
Retrieve all layout mappings in the database ordered by last modified date.
10 params → 200403429
GET
/authoring/v1/layout-mappings/views/by-name
Retrieve all layout mappings in the database with the specified name.
5 params → 200400403429
Authoring reference 4

The Content Authoring reference API is used to retrieve information about references between items in the system. The type of relationships that are tracked depends on the type of…

POST
/authoring/v1/references/outgoing
Retrieve the outgoing references for items.
body → 200429default
GET
/authoring/v1/references/outgoing/{classification}/{id}
Retrieve the outgoing references for an item with the provided ID.
8 params → 200429default
POST
/authoring/v1/references/incoming
Retrieve the incoming references for items.
body → 200429default
GET
/authoring/v1/references/incoming/{classification}/{id}
Retrieve the incoming references for an item with the provided ID.
6 params → 200429
Authoring renditions 4

Use the Content renditions data service Rest APIs to work with image renditions. A 'rendition' of an image defines how you can customize a source image such as the width and heigh…

GET
/authoring/v1/renditions
Retrieve all renditions in the database.
4 params → 200429503default
POST
/authoring/v1/renditions
Create a new rendition.
3 params body → 201400409429503default
GET
/authoring/v1/renditions/{id}
Retrieve an existing rendition.
3 params → 200404429503default
GET
/authoring/v1/renditions/views/by-created
Retrieve all renditions created within the specified date range.
6 params → 200400429503default
Authoring image profiles 7

Use the Acoustic Content authoring image profile service Rest APIs to work with image profiles. You can create, retrieve, and update image profiles in a database.

POST
/authoring/v1/image-profiles
Create new image profiles.
body → 200400404409429500
GET
/authoring/v1/image-profiles
Retrieve all image profiles in the database.
7 params → 200429
GET
/authoring/v1/image-profiles/count
Retrieve the total number of image profiles.
→ 200429default
PUT
/authoring/v1/image-profiles/{id}
Update an existing image profile.
2 params body → 200400401404409429500
DELETE
/authoring/v1/image-profiles/{id}
Delete an existing image profile.
1 param → 200400401404429500
GET
/authoring/v1/image-profiles/{id}
Retrieve an existing image profile.
4 params → 200304404429
GET
/authoring/v1/image-profiles/views/by-modified
Retrieve all image profiles in the database ordered by last modified date.
11 params → 200429
Authoring resources 4

Use the Content resources data service Rest APIs to work with resources. Resources are binary files that are stored in the CMS and used in content or site design. Resources that a…

POST
/authoring/v1/resources
Create a new resource.
3 params body → 201400429503default
GET
/authoring/v1/resources/{id}
Retrieve an existing resource.
3 params → 200206404429503default
PUT
/authoring/v1/resources/{id}
Create a resource at the given id.
4 params body → 200201400409429503default
GET
/authoring/v1/resources/views/by-created
Retrieve all resources created within the specified date range.
9 params → 200400429503default
Authoring review 7

Use the Content Review Rest APIs to review assets and content. Use reviews to receive feedback from other members of your team. You can start, update, and complete the reviews tha…

POST
/authoring/v1/review
Start a review.
body → 201400429503default
GET
/authoring/v1/review/{id}
Retrieve an existing review.
1 param → 200404429503default
PUT
/authoring/v1/review/{id}
Update an existing review.
1 param body → 200400404409429503default
DELETE
/authoring/v1/review/{id}
Delete an existing review.
1 param → 200404409429503default
POST
/authoring/v1/review/{id}/approve
Approve items in a review.
1 param body → 200400429503default
POST
/authoring/v1/review/{id}/approve-all
Approve all items in a review.
1 param → 200400429503default
POST
/authoring/v1/review/{id}/complete
Complete a review.
1 param → 200404429503default
Authoring search 2

General Use the Content authoring search service REST API to access assets, categories, content, content types, image profiles, and taxonomies by searching the content hub. You ne…

GET
/authoring/v1/search
Search in the authoring collection
22 params → 200400404414429500
POST
/authoring/v1/search/json
Search in the authoring collection using post request with json body
→ 200400404414429500
Authoring sites 17

Use the Content authoring sites service Rest APIs to work with sites. Sites are comprised of a site metadata and a hierarchy of pages. You can retrieve or update site metadata and…

GET
/authoring/v1/sites
Get list of all sites
1 param → 200429default
POST
/authoring/v1/sites
Create a new site
1 param body → 201400409429default
GET
/authoring/v1/sites/{site-id}
Retrieve metadata for a site.
2 params → 200400404429default
PUT
/authoring/v1/sites/{site-id}
Update metadata for a site.
3 params body → 200400401403409429default
DELETE
/authoring/v1/sites/{site-id}
Delete a site and the site pages
1 param → 204400404409429default
POST
/authoring/v1/sites/{site-id}/ready
Promote the site and pages metadata from draft to ready status.
1 param → 200400401403404429default
POST
/authoring/v1/sites/{site-id}/cancel
Cancel the draft site metadata undoing any modifications.
1 param → 200400401403404429default
POST
/authoring/v1/sites/{site-id}/pages/ready
Bulk promote the specified page Ids in the specified site from draft to ready status.
1 param body → 204400401403404429default
GET
/authoring/v1/sites/{site-id}/pages
Get the full page hierarchy for a site.
4 params → 200400401403404429default
POST
/authoring/v1/sites/{site-id}/pages
Create a page.
3 params body → 201400401403404429default
GET
/authoring/v1/sites/{site-id}/pages/views/by-modified
Get pages modified between two dates.
8 params → 200400401403404429default
GET
/authoring/v1/sites/{site-id}/pages/{page-id}
Get a page by id.
4 params → 200400401403404429default
DELETE
/authoring/v1/sites/{site-id}/pages/{page-id}
Delete a page.
3 params → 204400401403404409429default
PUT
/authoring/v1/sites/{site-id}/pages/{page-id}
Update a page.
3 params body → 200400401403404409429default
POST
/authoring/v1/sites/{site-id}/pages/move
Move a page.
6 params → 200400401403404429default
POST
/authoring/v1/sites/{site-id}/pages/{page-id}/ready
Promote the page from draft to ready status.
2 params → 200400401403404429default
GET
/authoring/v1/sites/pages/{page-id}
Get a page by unique id.
3 params → 200400401403404429default
Authoring types 16

Use the Acoustic Content authoring type service Rest APIs to work with content type documents. Content types define a set of related elements that are used to create content. You…

POST
/authoring/v1/types
Create new type documents.
body → 200400404409429500
GET
/authoring/v1/types
Retrieve all type documents in the database.
7 params → 200429
GET
/authoring/v1/types/by-path
Retrieve an existing type by its path.
4 params → 200304400403404429
GET
/authoring/v1/types/count
Retrieve the total number of types.
→ 200429default
PUT
/authoring/v1/types/{id}
Update an existing type.
3 params body → 200400401404409429500
DELETE
/authoring/v1/types/{id}
Delete an existing type.
2 params → 200400401404429500
GET
/authoring/v1/types/{id}
Retrieve an existing type.
4 params → 200304404429
POST
/authoring/v1/types/{id}/copy
Copies an existing type.
3 params → 201404429
GET
/authoring/v1/types/{id}/new-content
Returns a skeleton content item based on the specified content-type.
4 params → 200304400404429
GET
/authoring/v1/types/{id}/schema
Retrieve the Json-Schema representation of the document.
2 params → 200304404429
POST
/authoring/v1/types/{id}/validate
Validate the supplied type document instance (eg. content item) against the specified type.
1 param body → 200400401404429
GET
/authoring/v1/types/new
Retrieve a blank content type.
1 param → 200304404429
GET
/authoring/v1/types/views/by-modified
Retrieve all type documents in the database ordered by last modified date.
11 params → 200429
GET
/authoring/v1/types/views/by-name
Retrieve all types in the database with the specified name.
5 params → 200400403429
GET
/authoring/v1/elementdefs/{id}
Retrieve an existing element definition.
4 params → 200304404429
GET
/authoring/v1/elementdefs
Retrieve all element definitions in the database.
5 params → 200429
Authoring version 7

Use the Content version Rest APIs to work with authoring items that have versions. Versioned documents currently includes assets and content items within Content. The version APIs…

GET
/authoring/v1/versions/{classification}/{id}
Retrieve all versions for the specified authoring item.
2 params → 200404429503default
GET
/authoring/v1/versions/{classification}/{id}/{timestamp}
Retrieve a specific version for a specific authoring item.
3 params → 200404429503default
POST
/authoring/v1/versions/restore
Restore a versioned item - currently supported for content and assets.
1 param → 200201429500default
GET
/authoring/v1/versions/policy
Retrieve the current version policy.
→ 200429503default
POST
/authoring/v1/versions/policy/on
Turn on the version-policy.
→ 204429default
POST
/authoring/v1/versions/policy/off
Turn off the version-policy.
→ 204429default
POST
/authoring/v1/versions/policy/disable
Disable the version-policy.
→ 204429default
Authoring context search 1

The Authoring context search is a discretional middleware service that is positioned before the Search service. Use the Authoring context search Rest APIs to retrieve user targete…

GET
/authoring/v1/contextualsearch
Retrieve contextual search results from the authoring collection.
29 params → 200400429default
Delivery context search 1

The Delivery context search is a discretional middleware service that is positioned before the Search service. Use the Delivery context search Rest APIs to retrieve user targeted…

GET
/delivery/v1/contextualsearch
Retrieve contextual search results from the delivery collection
29 params → 200400429default
Delivery content 4

Use the Content delivery content service REST API to retrieve published content items. You can use the /delivery/v1/content routes to access content items as an unauthenticated us…

POST
/delivery/v1/content/bulk_retrieve
Retrieve filtered content by id in bulk
1 param body → 200400429default
POST
/mydelivery/v1/content/bulk_retrieve
Retrieve filtered content items by id in bulk, including restricted ones.
1 param body → 200400429default
GET
/delivery/v1/content/{id}
Get content item
3 params → 200304400404429default
GET
/mydelivery/v1/content/{id}
Get content item, including restricted ones.
3 params → 200304400404429default
Delivery render 7

The Content Delivery rendering REST API provides information to render content and pages in client-side applications. Client-side programming support If you want to create a clien…

GET
/delivery/v1/rendering/render/content/{id}
Applies server side rendering to the specified content item
5 params → 200429500
GET
/delivery/v1/rendering/sites/{id}
Delivery Site By ID
2 params → 200304404429500
GET
/delivery/v1/rendering/context/{id}
Delivery Rendering Context By ID
2 params → 200304404429500
GET
/delivery/v1/rendering/type/{id}
Aggregated type information by ID
2 params → 200304404429500
GET
/delivery/v1/rendering/search
Delivery Rendering Contexts By Search Query
3 params → 200304404429
GET
/mydelivery/v1/rendering/render/content/{id}
Applies server side rendering to the specified content item
5 params → 200429500
GET
/mydelivery/v1/rendering/type/{id}
Aggregated type information by ID
2 params → 200304404429500
Delivery resources 2

The Delivery Resource Service (DRS) provides access to the published resources in Akamai. The recommended URL for addressing published resources is the Akamai URL which is a stati…

GET
/delivery/v1/resources
Retrieve a resource by path.
1 param → 200404429default
GET
/delivery/v1/resources/{fileIdentifier}
Retrieve a resource by Id.
1 param → 200404429default
Delivery search 2

Use the Watson Content Hub delivery search REST API to search for published assets, content items, categories and pages. You can use the /delivery/v1/search route to perform anony…

GET
/delivery/v1/search
Search in the delivery collection
22 params → 200400404414429500
GET
/mydelivery/v1/search
Search in the delivery collection
22 params → 200400404414429500
Delivery sites 8

Use the Content delivery sites service Rest APIs to retrieve published site artefacts.

GET
/delivery/v1/sites/{siteId}
Get the site descriptor of a public site
3 params → 200304400404429default
GET
/mydelivery/v1/sites/{siteId}
Get the site descriptor of a public or protected site.
3 params → 200304400404429default
GET
/delivery/v2/sites/{siteId}
Get the site descriptor of a public site
3 params → 200304400404429default
GET
/mydelivery/v2/sites/{siteId}
Get the site descriptor of a public or protected site.
3 params → 200304400404429default
GET
/delivery/v1/sites/{siteId}/pages/{pageId}
Get the descriptor of a public page from a site.
4 params → 200304400404429default
GET
/mydelivery/v1/sites/{siteId}/pages/{pageId}
Get the descriptor of a public or protected page from a site.
4 params → 200304400404429default
GET
/delivery/v1/sites/{siteId}/pages/by-parent/{parentPageId}
Get all public child pages of a specified parent page
6 params → 200304400429default
GET
/mydelivery/v1/sites/{siteId}/pages/by-parent/{parentPageId}
Get all public or protected child pages of a specified parent page
6 params → 200304400429default
Tenant Registry 2
GET
/registry/v1/currenttenant
Retrieve a tenant
2 params → 200400404429
PUT
/registry/v1/currenttenant
Update a tenant
1 param body → 200400404429
Login service 3

Login service offers endpoint to login into Acoustic Content.

GET
/login/v1/removecookies
Remove tenant and auth cookie.
→ 200429
GET
/login/v1/basicauth
Userid and password login using GET operation
2 params → 200401403404412423429503
POST
/login/v1/basicauth
Userid and password login using POST operation
2 params → 200401403404412423429503
Administering user profiles 6
GET
/user-profile/v1/users/currentuser
Find the current user
1 param → 200400429
GET
/user-profile/v1/users
Find all users.
5 params → 200400429
POST
/user-profile/v1/users
Add a new user.
body → 201400409429
GET
/user-profile/v1/users/{id}
Find user by ID.
4 params → 200400404429
PUT
/user-profile/v1/users/{id}
Update an existing user.
1 param body → 200400404429
DELETE
/user-profile/v1/users/{id}
Delete an existing user.
3 params → 204400404429
Webhook profiles 3

Use the Content webhook service Rest APIs to work with webhook profiles. You can create, retrieve and update webhook profiles in a database. Webhook Timeouts and Retry policy Webh…

GET
/webhook/v1/profile
Retrieves the webhook profile for the current tenant
2 params → 200304404429
PUT
/webhook/v1/profile
Creates or updates the webhook profile for the current tenant
body → 200400401429500
DELETE
/webhook/v1/profile
Deletes the webhook profile for the current tenant.
→ 200401404429500
Publishing 5

Use the Content Publishing APIs to update the default site revision, which is a snapshot of your published site at a specific time. current-job instance is used to track the state…

POST
/publishing/v1/jobs
Create a job
body → 201400429
GET
/publishing/v1/jobs/current-job
Retrieve an existing job
→ 200400404429
GET
/publishing/v1/jobs/current-job/status
Retrieve the status of current-job
→ 200400404429
GET
/publishing/v1/site-revisions/default
Get the default site revision
1 param → 200400429
PUT
/publishing/v1/site-revisions/default
Update the default site revision
body → 200400409429

Schemas 294

The contract defines 294 schemas that model the data the API accepts and returns. The most detailed are Asset0 (40 properties), Tenant35 (32 properties), ExistingType18 (25 properties), TenantPut35 (23 properties). Each schema is shown below with its type and property counts.

Asset0
object
40 properties 1 required
QueryResult0
object
6 properties 4 required
ErrorResponse0
object
an error response.
5 properties 5 required
Error0
object
an individual error, info or warning message.
8 properties 8 required
NewCategory1
object
7 properties 1 required
Category1
object
16 properties 8 required
QueryResult1
object
6 properties
QueryResultV21
object
6 properties
ErrorResponse1
object
an error response.
5 properties 5 required
Error1
object
an individual error, info or warning message.
10 properties 10 required
ProjectCreate2
object
4 properties 1 required
BulkRequest2
object
1 property
BulkRequestWithId2
object
1 property 1 required
BulkMoveRequest2
object
2 properties 2 required
BulkResponse2
object
6 properties
ErrorResponse2
object
an error response.
5 properties 5 required
Error2
object
an individual error, info or warning message.
10 properties 10 required
QueryResult2
object
6 properties
Project2
object
18 properties 2 required
ResponseComment4
object
14 properties 14 required
NewComment4
object
2 properties 2 required
EditComment4
object
1 property 1 required
QueryResult4
object
6 properties 4 required
ErrorResponse4
object
An error response.
5 properties 5 required
Error4
object
an individual error, info or warning message.
8 properties 8 required
Cognitive5
object
2 properties
Count5
object
1 property 1 required
NewContent5
object
5 properties 2 required
Content5
object
22 properties
UpdateContent5
object
2 properties
QueryResult5
object
6 properties
BulkDelete5
object
1 property
ErrorResponse5
object
an error response.
5 properties 5 required
Error5
object
an individual error, info or warning message.
10 properties 10 required
NewDefaultContent5
object
3 properties 2 required
DefaultContent5
object
17 properties
UpdateDefaultContent5
object
2 properties
DefaultContentQueryResult5
object
6 properties
ValidationResult5
object
a validation response.
2 properties
CopyBody7
array
The items to copy. The items need to be either ready OR belong to same project. Additional parameters "name", "add" and "remove" can be passed with each item t…
CopyResponse7
object
An acknowledgement of the copy operation request.
3 properties
CopyRecord7
object
a copy operation document.
14 properties
CopyResult7
object
A copy operation result.
9 properties
ErrorResult7
object
an error response.
5 properties
Message7
object
an individual error, info or warning message.
10 properties
Count9
object
1 property
NewLayout9
object
A new layout.
12 properties 2 required
NewLayoutMapping9
object
A new layout mapping.
8 properties 3 required
ExistingLayout9
object
An existing layout.
19 properties 3 required
ExistingLayoutMapping9
object
An existing layout mapping.
15 properties 4 required
ResolvedLayout9
object
An existing layout returned from one of the resolution end points.
17 properties
LayoutQueryResult9
object
A query result that returns layouts.
6 properties
ResolvedLayoutQueryResult9
object
A query result that returns resolved layouts.
6 properties
LayoutMappingQueryResult9
object
A query result that returns layout mappings.
6 properties
TypeMapping9
object
The mapped content-type. Must be unique. During create and update operations, the mapped content-type can be referred to by either id or name.
2 properties
LayoutMappingEntry9
object
an individual layout mapping entry. During creates and updates, if there is only one layout specified within the 'layouts' property, then the 'defaultLayout' p…
2 properties 2 required
LayoutReference9
object
an individual layout reference.
2 properties 1 required
ErrorResult9
object
an error response.
5 properties
Message9
object
an individual error, info or warning message.
10 properties
IncomingReferenceMetadata11
object
3 properties
BatchIncomingReferenceMetadata11
array
Classification11
string
Every item in content hub has a classification the classification and id combine to make a unique id across different types of items in content hub.
SearchMetadata11
object
The metadata property is only added if you use include=metadata. Additionally the contents of this object mirrors what is returned by search which is why the s…
OutgoingReferenceMetadata11
object
5 properties
OutgoingReferencesResponse11
object
5 properties
OutgoingReferenceRequest11
object
6 properties
IncomingReferencesResponse11
object
6 properties
ErrorResponse11
object
an error response.
5 properties 5 required
Error11
object
an individual error, info or warning message.
10 properties 10 required
IncomingReferenceRequest11
object
5 properties
DeletedQueryResult11
object
6 properties 4 required
DeletedItem11
object
6 properties 5 required
RenditionParameters12
object
7 properties 1 required
Rendition12
Link12
object
1 property 1 required
QueryResult12
object
6 properties 4 required
ErrorResponse12
object
an error response.
5 properties 5 required
Error12
object
an individual error, info or warning message.
9 properties 9 required
Count13
object
1 property
NewImageProfile13
object
An new image profile.
7 properties 3 required
ExistingImageProfile13
object
An existing image profile.
14 properties 5 required
MultiImageProfile13
object
4 properties
Dimension13
object
A indiviual dimension within an image profile.
5 properties
ImageProfileQueryResult13
object
A query result that returns image profiles.
6 properties
ErrorResult13
object
an error response.
5 properties
Message13
object
an individual error, info or warning message.
10 properties
ErrorResponse14
object
an error response.
5 properties 5 required
Error14
object
an individual error, info or warning message.
10 properties 9 required
QueryResult14
object
6 properties 4 required
ResourceMetadata14
object
2 properties 2 required
NewReview15
object
4 properties 1 required
Review15
object
16 properties 3 required
Approval15
object
3 properties
Rejection15
object
3 properties
UpdateReview15
object
4 properties 2 required
UniqueIDs15
array
Provide the ID of the items that you want to submit for review. The unique ID (uid) is the items classification and the ID combined to create an ID that is uni…
User15
object
A user object with user ID.
1 property
DocumentID15
object
The unique document ID is the items classification and the ID combined to create an ID that is unique across all content hub items.
2 properties
BulkRequest15
object
1 property 1 required
RejectRequest15
object
2 properties 1 required
ErrorResponse15
object
An error response.
5 properties 5 required
Error15
object
an individual error, info or warning message.
10 properties 10 required
Documents16
object
1 property
Document16
object
1 property 1 required
collection16
object
6 properties
ErrorMessage16
object
This JSON object describes an error condition.
3 properties 2 required
Error16
object
This JSON object describes a specific error of an error condition.
8 properties 2 required
SiteCreatedUpdatedResponse17
object
Site Metadata update response
5 properties
SiteMetaData17
object
Site Metadata
9 properties
SiteList17
object
List of available sites
1 property
SiteCreate17
object
Create Site Metadata
5 properties
SiteUpdate17
object
Updating Site Metadata
4 properties
AllPages17
object
List of all pages from all sites
1 property
PageHierarchy17
object
Hierachy of pages in the site
1 property
PageList17
object
A list of pages in the site modified between certain dates
1 property
PageNew17
object
Creation of Page Metadata
10 properties
PageUpdate17
object
Update of Page Metadata
13 properties
Page17
object
Page Metadata
17 properties
HierarchicalPage17
object
Page Metadata of page in hierarchy
14 properties
DeletePagesInBulkRequest17
object
Delete pages
1 property
DeletePagesInBulkResponse17
object
1 property
MoveResult17
object
Target Parent Updated Values After Move
2 properties
DraftPageIds17
object
Publish the list of draft page Ids
1 property
ReadyPagesInBulkRequest17
object
Publish the list of draft pages.
2 properties
ReadyPagesIds17
object
List of pages that needs to be moved to ready state
3 properties
ProjectContext17
object
2 properties
ReadyPagesInBulkResponse17
object
1 property
CreateDraftPagesInBulkRequest17
object
List of draft pages to create.
2 properties
DraftPagesToCreateIds17
object
List of pages to be created as drafts
3 properties
DraftsProjectContext17
object
3 properties
CreateDraftPagesInBulkResponse17
object
3 properties
Error17
object
Error
6 properties
ErrorMessage17
object
ErrorMessage
3 properties
BlankContent18
object
An blank content document.
3 properties
NewType18
object
An new type document.
14 properties 6 required
ExistingType18
object
An existing type document.
25 properties 8 required
ElementDef18
object
An element definition.
12 properties
TypeQueryResult18
object
A query result that returns type documents.
6 properties
ElementDefQueryResult18
object
A query result that returns element definitions.
6 properties
TypeElement18
object
Represents an element within a content type. Only properties common to all elements are currently shown. For examples of each of the supported elements, see th…
10 properties 3 required
DocumentLinks18
object
List of available operations, only shown when optional 'include' query string parameter includes 'links'.
1 property
WorkflowStatus18
string
the workflow status.
TypeClassification18
string
the type document classification.
TypeKind18
array
Identifies the sub-classification of the type document. Valid values include: custom-ui: This type document has a custom user interface defined embedded: This…
TypeIcon18
array
Specifies the type of icon to show for this type document within the Type user interface's element palette Only used when the type document has a kind that inc…
TypeUIExtensions18
object
Specifies any user interface extensions registered on this type document.
1 property
ElementDefClassification18
string
the element definition classification.
Count18
object
1 property
ErrorResult18
object
an error response.
5 properties
Message18
object
an individual error, info or warning message.
10 properties
ValidationResult18
object
a validation response.
4 properties
AllVersions20
object
All versions for the specified item.
4 properties 4 required
Version20
object
A specific version of an item.
8 properties
DraftVersion20
object
a Draft version of the specified item
7 properties
VersionPolicyStatus20
object
Response to indicate if the version policy status is in effect.
1 property
VersionPolicy20
object
Representation of the version policy
2 properties
VersionEvent20
string
Version Event: published - Published, The item was published and the ready item was updated created - Created, The item was created updated - Updated, the item…
ErrorResponse20
object
An error response.
5 properties 5 required
Error20
object
an individual error, info or warning message.
10 properties 10 required
Error21
object
Error
6 properties
ErrorMessage21
object
ErrorMessage
3 properties
BulkRetrievalRequest22
object
2 properties 1 required
Content22
object
14 properties
Error22
object
3 properties
IdsListForBulkRetrieval22
array
An array of ids that should be retrieved by this bulk request.
FieldsListForBulkRetrieval22
array
An array of fields that should be returned by this bulk request.
ContentArray22
array
An array of JSON objects that contain the requested content items.
ConfigObject23
object
Configuration information for a tenant
5 properties
Url23
object
Properties of a URL
12 properties
SiteMetaData23
object
Site Metadata
9 properties
PageMetaData23
object
Page Metadata
19 properties
SearchEntry23
object
1 property
RenderingContext23
object
15 properties
ErrorMessage23
object
This JSON object describes an error condition.
3 properties 2 required
Error23
object
This JSON object describes a specific error of an error condition.
8 properties 2 required
ErrorDefault24
object
3 properties
Error24
object
3 properties
Documents25
object
1 property
Document25
object
1 property 1 required
collection25
object
6 properties
ErrorMessage25
object
This JSON object describes an error condition.
3 properties 2 required
Error25
object
This JSON object describes a specific error of an error condition.
8 properties 2 required
Site26
object
8 properties
Content26
object
14 properties
Page26
object
18 properties
Error26
object
3 properties
MultiPages26
object
1 property
Tenant35
object
32 properties 1 required
TenantAnonymous35
object
5 properties
TenantPut35
object
23 properties
AssetPublishApproval35
object
Can not be set for Base tiers
2 properties
ContentPublishApproval35
object
Can not be set for Base tiers
2 properties
DeliveryAccess35
object
3 properties
Error35
object
3 properties
IbmCommerce35
object
7 properties
TenantInfo37
object
Object containing the tenantId and baseUrl
2 properties
TenantArray37
array
The list of available tenants for the authenticated user
Status37
object
3 properties
Error40
object
This JSON record represents an individual error or warning contained in an error message.
8 properties 2 required
ErrorMessage40
object
This JSON record represents an error condition.
3 properties 2 required
Id40
string
The unique internal identifier of the user
ExternalId40
string
The unique external identifier of the user (e.g. BlueID). Although, this field can store email addresses, other types of unique identifiers may be stored too.…
FirstName40
string
The first name of the user
uid40
string
Acoustic Id of the user, if not present during POST call an Acoustic Id will be created for the user
LastName40
string
The last name of the user
DisplayName40
string
The name of the user that can be displayed in the UI
Email40
string
The email of the user that can be displayed in the UI
Roles40
array
The roles of the user that will be used for access control
RolesRetrieval40
array
The roles of the user that will be used for access control (empty for the anonymous user)
LastLogin40
string
Date when this user logged in for the last time before current session
Created40
string
Date when this item was created
LastModified40
string
Date when this item was modified for the last time
HttpVerb40
string
The supported HTTP methods
Creator40
object
URI pointing to the User who has created the item
1 property 1 required
LastModifier40
object
URI pointing to the User who has modified the item
1 property 1 required
PrivacyNotices40
object
The privacy notices that the user has accepted
2 properties 1 required
PrivacyNoticeHistory40
object
The privacy notice that the user has accepted
3 properties 2 required
PrivacyNotice40
object
The privacy notice that the user has accepted
4 properties 2 required
PrivacyNoticeResponse40
object
The privacy notice that the user has accepted
4 properties 1 required
UriSelf40
object
URI pointing to this document
3 properties 2 required
User40
object
The user object that might be returned.
15 properties 3 required
EnrichedUser40
object
The user object that might be returned.
14 properties 3 required
Approver40
object
The approver object that might be returned.
4 properties 1 required
EditorManagerAdmin40
object
The match object that might be returned.
5 properties 1 required
UserCreation40
object
The user object that might be sent for user creation.
7 properties 2 required
UserUpdate40
object
The user object that might be sent to replace the user. The fields id, externalId, links, created, creator, lastModified, and lastModifier will be ignored.
13 properties 1 required
UserUpdateLogin40
object
The user object that might be sent to replace the user. The fields id, externalId, links, created, creator, lastModified, and lastModifier will be ignored.
14 properties 1 required
UriFirst40
object
URI pointing to the first sublist of items of the complete list
1 property 1 required
UriPrev40
object
URI pointing to the previous sublist of items of the complete list
1 property 1 required
UriNext40
object
URI pointing to the next sublist of items of the complete list
1 property 1 required
ItemList40
object
3 properties 2 required
ApproverList40
object
4 properties 1 required
WebhookProfile44
object
A webhook profile.
8 properties
WebhookDef44
object
An individual webhook.
5 properties 1 required
ErrorResult44
object
an error response.
5 properties
Message44
object
an individual error, info or warning message.
10 properties
error46
object
This JSON record represents an individual error or warning contained in an error message.
8 properties 2 required
error_message46
object
This JSON record represents an error condition.
3 properties 2 required
localizedItem46
object
2 properties 1 required
localizedItemCreation46
object
2 properties 1 required
managedItem46
object
7 properties 6 required
managedItemCreation46
object
6 properties
managedItemUpdate46
object
7 properties 2 required
itemList46
object
4 properties 3 required
unmanagedJobDefinition46
object
2 properties
jobDefinitionCore46
object
2 properties
jobDefinition46
object
jobDefinitionCreation46
object
TBD: Give a little help on job definition creation here...
jobDefinitionUpdate46
object
TBD: Give a little help on job definition creation here...
jobDefinitions46
object
Returns a (sub-)list of items from the complete list of jobDefinitions. At most [limit] items are returned.
1 property 1 required
job46
object
3 properties 2 required
jobCreation46
object
created job. When creating a job, you can specify mode that can be used.
1 property
jobs46
object
Returns a (sub-)list of items from the complete list of jobs. At most [limit] items are returned.
1 property 1 required
siteRevisionCore46
object
5 properties
siteRevision46
object
1 required
siteRevisionUpdate46
object
Only properties autoPublishEnabled, name and description will be updated, others will be ignored
siteRevisions46
object
Returns a (sub-)list of items from the complete list of site revisions. At most [limit] items are returned.
1 property 1 required
status46
object
6 properties 6 required
message46
object
4 properties
task46
object
5 properties
profileCore46
object
8 properties
profile46
object
profileCreation46
object
TBD:
profileUpdate46
object
TBD:
profileCreationForJobCreation46
object
TBD:
profiles46
object
Returns a (sub-)list of items from the complete list of profiles. At most [limit] items are returned.
1 property 1 required
sourceCore46
object
1 property
source46
object
sourceCreation46
object
sourceUpdate46
object
sourceDocs46
object
Map which enumerates the events that shall be published grouped by their classification ('content', 'asset', etc.).
6 properties
docEvents46
object
Map which enumerates the items that shall be published groupd by their event type ('created', 'updated', etc.)
3 properties
sources46
object
Returns a (sub-)list of items from the complete list of sources. At most [limit] items are returned.
1 property 1 required
jobState46
string
Enumeration of publishing job states
httpVerb46
string
contentFormat46
string
created46
string
date when this item was created
lastModified46
string
date when this item was modifed for the last time
rev46
string
a string identifying a specific version of the document
description46
object
an object holding the localized description for multiple languages
title46
object
an object holding the localized title for multiple languages
jobMode46
string
Specifies if the site revision will be updated or rebuilt from scratch. Default is 'UPDATE'
site46
object
tbd
1 property
urlSelf46
object
url pointing to this document
3 properties 2 required
urlFirst46
object
URI pointing to the first sublist of items of the complete list
1 property 1 required
urlPrev46
object
URI pointing to the previous sublist of items of the complete list
1 property 1 required
urlNext46
object
URI pointing to the next sublist of items items of the complete list
1 property 1 required
urlLast46
object
URI pointing to the last sublist of the complete list
1 property 1 required
urlCreator46
object
A reference to the User who has created the item
1 property 1 required
urlLastModifier46
object
A reference to the User who has modified the item
1 property 1 required
profileRef46
object
A reference to a publishing profile
1 property 1 required
siteRevisionRef46
object
A reference to a site revision
1 property 1 required
sourceRef46
object
A reference to a publishing source
1 property 1 required
ErrorResponse
object
This JSON record represents an error condition.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acoustic-content-openapi-original.json Raw ↑
Where this information came from

This is an independent, third-party profile of Acoustic Content API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.