Version 1.0
Connector Overview: This page documents all 199 actions for the Ampliencedynamiccontentconnector v1.0.
Administration (10)
POST Enable the Content Delivery 2 module on a hub
/admin/modules/hubs/{hubId}/content-delivery-2
Enable the Content Delivery 2 module on the specified hub. Simply follow the appropriate link for the resource passing in the id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Enable the Search Index module on a hub
/admin/modules/hubs/{hubId}/algolia-search
Enable the Search Indexes module (Algolia Search) on the specified hub. Simply follow the appropriate link for the resource passing in the id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a member by id
/admin/access/{resource}/{resourceId}/members/{sid}
Given a resource and a member id you can navigate directly to a specific member by following the "member" link from the resource.
|
Resource Type |
Required Functional Permissions |
Required ACLs |
|---|---|---|
|
hubs |
|
|
|
content\-repositories |
|
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Resource Type |
|
|
Resource ID |
|
|
Member ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Administrative Operations
/admin
Lists the available administrative operations.
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 Module Operations on a Hub
/admin/modules/hubs/{hubId}
Given the id of a hub for which you are an administrator, you can see the various module management operations that you can perform. Simply follow the appropriate link for the resource passing in the id.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Operations on a resource
/admin/access/{resource}/{resourceId}
Given the id of a resource for which you are an administrator, you can see the various operations that you can perform. Simply follow the appropriate link for the resource passing in the id.
|
Resource Type |
Required Functional Permissions |
Required ACLs |
|---|---|---|
|
hubs |
|
|
|
content\-repositories |
|
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Resource Type |
|
|
Resource ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List members on a resource
/admin/access/{resource}/{resourceId}/members
The memebrs link will list the memebrs that have access to a particular resource. This includes the member's id (sid) and the list of permissions they have.
|
Resource Type |
Required Functional Permissions |
Required ACLs |
|---|---|---|
|
hubs |
|
|
|
content\-repositories |
|
|
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Resource Type |
|
|
Resource ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Manage Access to Resources
/admin/access
With the ability to manage access you can control which users have which permissions to the resources you administer.
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 Manage Modules on Resources
/admin/modules
Modules offer additional functionality which is not enabled by default. With the ability to manage modules you can control which modules are enabled on the resources you administer.
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). |
DELETE Revoking permissions
/admin/access/{resource}/{resourceId}/members/{sid}/permissions/{permissions}
Revoke access to a specific resource by deleting a members permission.
From a member, follow the "revoke-permission" link passing in the permission to delete.
You can specify one or multiple permissions. Multiple permissions are comma separated.
Resource TypeRequired Functional PermissionsRequired ACLs hubsCONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:HUB:MANAGE_ACCESSHub - READ
Hub - MANAGE_ACCESScontent-repositoriesCONTENT:FUNCTIONAL:ADMIN:MANAGE_ACCESS CONTENT:FUNCTIONAL:REPOSITORY:MANAGE_ACCESSHub - READ
ContentRepository - MANAGE_ACCESS
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Resource Type |
|
|
Resource ID |
|
|
Member ID |
|
|
Permission(s) to revoke (comma separated list) |
|
|
The response format expected from the API (e.g. application/json). |
Content Items (25)
POST Archive Content Item
/content-items/{contentItemId}/archive
Archive a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Version to archive |
PATCH Assigning a Delivery Key
/content-items/{contentItemId}/delivery-key
Assign a delivery key to a content item or slot and replace any existing key. The delivery key must meet the validation rules and be unique within the hub.
The current version of the content item must be included in the request payload. If the version specified is not the current one, then a 400 error will be returned in the response.
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Delivery key |
|
|
Version |
PATCH Assigning a Workflow State
/content-items/{contentItemId}/workflow
Assigning a Workflow State to a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Version to unarchive |
|
|
Workflow State ID |
POST Copy Content Item
/content-repositories/{contentRepositoryId}/content-items/{sourceContentItemId}
Copy a Content Item. Please note that deliveryKey can only be set when Content Delivery 2 is enabled. Copying a content item will not copy the deliveryKey.
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. |
|
|
Content Repository ID |
|
|
Source Content Item ID (used to copy an existing Content Item) |
|
|
The response format expected from the API (e.g. application/json). |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
ID |
|
|
Label |
|
|
Folder ID |
|
|
Assignees |
|
|
Created Date |
|
|
Locale |
|
|
Version number (starts at 1) |
|
|
Status |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
|
|
Last Published Date |
|
|
Last Published Version |
|
|
Last Unpublished Date |
|
|
Last Unpublished Version |
|
|
Publishing Status |
|
|
ID |
POST Create Content Item
/content-repositories/{contentRepositoryId}/content-items
Create a Content Item. Please note that deliveryKey can only be set when Content Delivery 2 is enabled. Copying a content item will not copy the deliveryKey.
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
ID |
|
|
Label |
|
|
Folder ID |
|
|
Assignees |
|
|
Created Date |
|
|
Locale |
|
|
Version number (starts at 1) |
|
|
Status |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
|
|
Last Published Date |
|
|
Last Published Version |
|
|
Last Unpublished Date |
|
|
Last Unpublished Version |
|
|
Publishing Status |
|
|
ID |
POST Faceting Content Items with Search by Text
/hubs/{hubId}/content-items/facet
Facet content items and search by text. See Text Search Query Syntax for a summary of the query syntax.
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. |
|
|
Hub ID |
|
|
Sort |
|
|
Direction of sort |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Return Entities |
POST Filtering Content Items by Collection Keys
/hubs/{hubId}/content-items/filter
Filter content items using Collection Keys.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
collectionKey |
GET Finding Content Items by Delivery Keys
/hubs/{hubId}/delivery-keys/content-item
Find content items using the Delivery Key.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The delivery key |
|
|
The response format expected from the API (e.g. application/json). |
GET Finding Content by Content Version Number
/content-items/{contentItemId}/versions/{version}
Finding Content by Content Version Number
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
Version |
|
|
The response format expected from the API (e.g. application/json). |
GET Finding Content by Epoch
/content-items/{contentItemId}/planned
Find content items that are candidates for being published at a point in time.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Epoch Time |
|
|
Time |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Content Item
/content-items/{contentItemId}
Get a Content Item
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Content Item Associations
/content-items/{contentItemId}/associations
Get Content Item Associations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Getting Linked Child Content Items
/content-items/search/findByIdWithChildren
Get Linked Child Content Items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Getting Linked Parent Content Items
/content-items/search/findByIdWithParents
Get Linked Parent Content Items
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Id |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Item History
/content-items/{contentItemId}/history
List Content Item History
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Item History for a Version
/content-items/{contentItemId}/versions/{version}/history
List Content Item History for a Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
Version |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Item Versions
/content-items/{contentItemId}/versions
List Content Item Versions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Localize Content Item
/content-items/{contentItemId}/localize
Localize a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
List of locales |
|
|
Content item version number |
POST Publish Content Item
/content-items/{contentItemId}/publish
Publish a Content Item
The response Location header is the a URL of the created Publishing Job
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional publishing options as a JSON string, for example to set the publish date or include related items. |
PUT Restore Content by Content Version Number
/content-items/{contentItemId}/restore
Restore Content by Content Version Number
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Version |
|
|
Restore Version |
GET Search Content Items by Text
/hubs/{hubId}/content-items/find
Text is the default search field. See Text Search Query Syntax for a summary of the query syntax.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Query |
|
|
The response format expected from the API (e.g. application/json). |
POST Unarchive Content Item
/content-items/{contentItemId}/unarchive
Unarchive a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Version to unarchive |
POST Unpublish Content Item
/content-items/{contentItemId}/unpublish
Unpublish a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional unpublishing options as a JSON string, such as to set an unpublish date or include related items. |
PATCH Update Content Item
/content-items/{contentItemId}
Update a Content Item. Please note that deliveryKey can only be set when Content Delivery 2 is enabled.
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
ID |
|
|
Label |
|
|
Folder ID |
|
|
Assignees |
|
|
Created Date |
|
|
Locale |
|
|
Version number (starts at 1) |
|
|
Status |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
|
|
ID |
PATCH Update Multiple Content Items
/content-items
Update Multiple Content Items
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 |
|---|---|
|
|
Label |
|
|
Version |
|
|
Folder ID |
|
|
Assignee |
|
|
ID |
Content Repositories (11)
POST Assign Content Type to Content Repository
/content-repositories/{contentRepositoryId}/content-types
Assign Content Type to a Content Repository
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Content Type ID |
POST Assign a feature
/content-repositories/{contentRepositoryId}/features
Assign a feature to a Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
Feature |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Content Repository
/hubs/{hubId}/content-repositories
Create a new Content Repository
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Name |
|
|
Name |
|
|
Status (defaults to ACTIVE) |
|
|
Features |
|
|
Repository Type |
|
|
Locales |
GET Find by feature
/hubs/{hubId}/content-repositories/search/findByFeaturesContaining
Find all the Content Repositories that contain a feature
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Feature |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Content Repository
/content-repositories/{contentRepositoryId}
Get a new Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Items
/content-repositories/{contentRepositoryId}/content-items
This lists all of the Content Items within this Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
"basic" - omits the body property from the return Content Items |
|
|
Page number |
|
|
Folder ID |
|
|
Status |
|
|
Exclude hierarchical child items |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Repositories
/hubs/{hubId}/content-repositories
List Content Repositories for a Hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove Content Type from Content Repository
/content-repositories/{contentRepositoryId}/content-types/{contentTypeId}
Remove a Content Type from a Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Remove a feature
/content-repositories/{contentRepositoryId}/features
Remove a feature from a Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
Feature |
|
|
The response format expected from the API (e.g. application/json). |
POST Share a Content Repository
/content-repositories/{contentRepositoryId}/share
Share a Content Repository with another user
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
User ID |
|
|
Additional Permissions |
PATCH Update Content Repository
/content-repositories/{contentRepositoryId}
Update the Content Repository
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Name |
|
|
Name |
|
|
Status (defaults to ACTIVE) |
|
|
Features |
|
|
Repository Type |
|
|
Locales |
Content Types (6)
POST Archive Content Type
/content-types/{contentTypeId}/archive
Archive a Content Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Content Type
/hubs/{hubId}/content-types
Create a new Content Type
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Content Type URI |
|
|
ID |
|
|
Status |
GET Get Content Type
/content-types/{contentTypeId}
Get the request Content Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Content Types
/hubs/{hubId}/content-types
List Content Types for a Hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
Comma seperated list of statuses |
|
|
The response format expected from the API (e.g. application/json). |
POST Unarchive Content Type
/content-types/{contentTypeId}/unarchive
Unarchive a Content Type
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update Content Type
/content-types/{contentTypeId}
Update the Content Type
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. |
|
|
Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Content Type URI |
|
|
Status |
Editions (28)
POST Archive Edition
/editions/{editionId}/archive
Archiving an edition is irreversible, you cannot unarchive.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
POST Assign Edition Slots
/editions/{editionId}/slots
Assign Edition Slots
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. |
|
|
Edition Id |
|
|
Source Edition Slot ID used to copy Edition Slot to Edition |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
ID |
PATCH Associate Edition Content
/editions/{editionId}/edition-contents/{editionContentsId}/content
Associate Snapshot to Edition Content
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. |
|
|
Edition Id |
|
|
Edition Content ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Edition
/events/{eventId}/editions
Create a new edition for a given event. Use this to add a version of the event, such as for different dates or locations.
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. |
|
|
Edition Id |
|
|
Duplicate an Edition by providing an Edition Id |
|
|
Include parent event for edition |
|
|
The response format expected from the API (e.g. application/json). |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Edition Name |
|
|
Edition Comment |
|
|
Date/Time |
|
|
Date/Time |
|
|
ID |
|
|
Published Status |
|
|
Slots Remaining |
|
|
Scheduling Errors |
|
|
Active End Date |
|
|
ID |
|
|
Date/Time |
|
|
Scheduling User |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
|
|
Date/Time |
|
|
Slot Collisions |
POST Create Edition Content
/editions/{editionId}/edition-contents
Create Edition Content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
POST Create Edition Preview
/editions/{editionId}/preview
If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.
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. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Last Modified Date |
|
|
Type |
PUT Create Edition Slot Content
/editions/{editionId}/slots/{slotId}/content
Create Edition Slot Content
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. |
|
|
Edition Id |
|
|
Slot ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
DELETE Delete Edition
/editions/{editionId}
Delete Edition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Edition Content
/editions/{editionId}/edition-contents/{editionContentsId}
Delete Edition Content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
Edition Content ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Edition Preview
/editions/{editionId}/preview
If an Edition has been Previewed it can be deleted, if the Edition is Scheduled then it cannot be deleted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete Edition Slot
/editions/{editionId}/slots/{slotId}
Delete Edition Slot
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
Slot ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Find By Date Range
/editions/search/findByDate
Find Editions using a Date Range
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The start date to search from |
|
|
The end date to search to |
|
|
Include child Editions |
|
|
Find events that have either started or ended within the date range |
|
|
Set the number of results per page |
|
|
Page number |
|
|
Sort parameter |
|
|
The response format expected from the API (e.g. application/json). |
GET Find By Event
/editions/search/findByEvent
Find Event by Id
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Event Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition
/editions/{editionId}
Get Edition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Conflict by Id and Version
/editions/{editionId}/conflicts/findByIdAndVersion
Get Edition Conflict by Id and Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
Version |
|
|
Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Conflicts
/editions/{editionId}/conflicts
Get Edition Conflicts
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Content
/editions/{editionId}/edition-contents/{editionContentsId}
Get Edition Content
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
Edition Content ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Preview
/editions/{editionId}/preview
If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Slot
/editions/{editionId}/slots/{slotId}
Get Edition Slot
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
Slot ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Slot Collisions
/editions/{editionId}/slot-collisions
Get Edition Slot Collisions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Edition Slots
/editions/{editionId}/slots
Get Edition Slots
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
page to retrieve |
|
|
page size to retrieve |
|
|
Retrieving Slots associated to an Edition filtered by content item |
|
|
The response format expected from the API (e.g. application/json). |
GET List Edition Contents
/editions/{editionId}/edition-contents
List Edition Contents
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
page to retrieve |
|
|
page size to retrieve |
|
|
The response format expected from the API (e.g. application/json). |
GET List Editions
/events/{eventId}/editions
Retrieve a list of all editions belonging to a specific event. Use this to get an overview of available editions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Page number |
|
|
Page size |
|
|
The response format expected from the API (e.g. application/json). |
PUT Resolve Edition Conflicts
/editions/{editionId}/conflicts
Resolve Edition Conflicts
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. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Comment |
|
|
Last Modified Date |
POST Schedule Edition
/editions/{editionId}/schedule
In order to schedule an Edition, the Edition must be in the DRAFT state, all Edition Slots must be in the 'VALID' state if there are any, the Edition must have at least one Slot or Content Snapshot, and there must be no conflicts in the Edition. This will then trigger the publishing job to take place on the start date of the Edition.
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. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Last Modified Date |
GET Search Editions
/events/{eventid}/editions/search
Search for editions within an event based on query parameters. Use this to find editions that match specific criteria.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Event Id |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Unschedule Edition
/editions/{editionId}/schedule
If the Edition has been scheduled it is possible to cancel the publishing job by unscheduling the edition.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update Edition
/editions/{editionId}
Update Edition
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. |
|
|
Edition Id |
|
|
The response format expected from the API (e.g. application/json). |
Options (19)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Edition Name |
|
|
Edition Comment |
|
|
Date/Time |
|
|
Date/Time |
|
|
ID |
|
|
Published Status |
|
|
Slots Remaining |
|
|
Scheduling Errors |
|
|
Active End Date |
|
|
ID |
|
|
Date/Time |
|
|
Scheduling User |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
|
|
Date/Time |
|
|
Slot Collisions |
Events (8)
POST Archive Events
/events/{eventId}/archive
Archiving an event is irreversible, you cannot unarchive. Archiving an event will also archive all editions contained within the event.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Event ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Create a new Event
/hubs/{hubId}/events
Create a new Event for a particular Hub.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Name |
|
|
Comment |
|
|
The Event start date |
|
|
The Event end date |
|
|
Brief - external URI that related to this Event |
|
|
Provide a comma-separated list of locale codes to define which languages the event supports. |
DELETE Delete an Event
/events/{eventId}
Delete an Event by ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Event ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an Event
/events/{eventId}
Get an Event by ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Event ID |
|
|
Include related Editions |
|
|
The response format expected from the API (e.g. application/json). |
GET List Events
/hubs/{hubId}/events
List all of the Events created for a hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Search Events by date
/events/search/findByDateRange
List all of the Events for a given date
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The start date to search from |
|
|
The end date to search to |
|
|
Include child Editions |
|
|
Find events that have either started or ended within the date range |
|
|
Set the number of results per page |
|
|
The response format expected from the API (e.g. application/json). |
GET Search Events by date range and Slots
/events/search/findByDateRangeAndSlots
List all of the Events for a given date range and slot ID
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The start date to search from |
|
|
The end date to search to |
|
|
Include child Editions |
|
|
Find events that have either started or ended within the date range |
|
|
Slot ID |
|
|
Locale to match |
|
|
Set the number of results per page |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update an Event
/events/{eventId}
Update an Event by ID
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. |
|
|
Event ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Name |
|
|
Comment |
|
|
The Event start date |
|
|
The Event end date |
|
|
Brief - external URI that related to this Event |
|
|
Provide a comma-separated list of locale codes to update the set of supported languages for the event. |
Extensions (6)
POST Create Extension
/hubs/{hubId}/extensions
Create a new Extension.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
System name |
|
|
User friendly name |
|
|
Description |
|
|
Url |
|
|
Height of the extension |
|
|
Sets whether the extension is globally enabled or intended for a specific content type |
|
|
Type of extension |
|
|
The settings parameter is used to store undefined extension settings such as security rule. |
|
|
Set the initial status of the extension, such as "active" or "inactive", to control its availability. |
|
|
User who created the Extension |
|
|
Created Date |
|
|
User who last changed the Extension |
|
|
Last modified date |
DELETE Delete Extension
/extensions/{id}
Delete an Extension
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Extension ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Extension
/extensions/{id}
Return the extension with the specified ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Extension ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Extension by name
/hubs/{hubId}/extensions/{name}
Return the extension with the specified name, in current hub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Extension name |
|
|
The response format expected from the API (e.g. application/json). |
GET List Extensions
/hubs/{hubId}/extensions
List all of the extension created for a hub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Patch Extension
/extensions/{id}
Patch an Extension
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. |
|
|
Extension ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (14)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
System name |
|
|
User friendly name |
|
|
Description |
|
|
Url |
|
|
Height of the extension |
|
|
Sets whether the extension is globally enabled or intended for a specific content type |
|
|
Type of extension |
|
|
The settings parameter is used to store undefined extension settings such as security rule. |
|
|
Update the status of the extension, for example to activate or deactivate it. |
|
|
User who created the Extension |
|
|
Created Date |
|
|
User who last changed the Extension |
|
|
Last modified date |
Folders (7)
PATCH Create Folder
/folders/{folderId}
Update a folder
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. |
|
|
Folder ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Folder name |
POST Create Folder
/content-repositories/{contentRepositoryId}/folders
Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository.
To create a new folder follow the "create-folder" link from a content repository.
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Folder name |
POST Create Sub-Folder
/folders/{folderId}/folders
Create a new sub-folder.
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Folder name |
DELETE Delete Folder
/folders/{folderId}
Delete a folder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Folder
/folders/{folderId}
Get a folder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Folders
/content-repositories/{contentRepositoryId}/folders
List all of the top-level Folders for a Content Repository
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
GET List Sub-folders
/folders/{folderId}/folders
List the sub-folders of a folder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Folder ID |
|
|
The response format expected from the API (e.g. application/json). |
Hierarchies Publish
POST Publish hierarchy nodes
/hierarchies/publish
To publish a hierarchy tree, you need to specify the root node and set getDescendants to true.
To publish a hierarchy branch, you need to specify the parent node and set getDesendants to true.
To publish a hierarchy node without any children and set getDescendants to false.
To publish multiple nodes individually supply their IDs, you cannot publish multiple nodes with getDescendants set to true.
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 |
|---|---|
|
|
ID's |
|
|
Set to true to also publish all descendant nodes of the selected hierarchy nodes. |
Hierarchies Snapshot
POST Snapshot hierarchy nodes
/hierarchies/snapshot
To snapshot a hierarchy tree, you need to specify the root node and set getDescendants to true.
To snapshot a hierarchy branch, you need to specify the parent node and set getDesendants to true.
To snapshot a hierarchy node without any children and set getDescendants to false.
To snapshot multiple nodes individually supply their IDs, you cannot snapshot multiple nodes with getDescendants set to true.
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 (4)
|
Option Name |
Description |
|---|---|
|
|
ID's |
|
|
Set to true to include all descendant nodes in the snapshot. |
|
|
Indicates the type of Snapshot (USER or SYSTEM) |
|
|
Comment |
Hierarchy Node (3)
POST Change a Hierarchy Node's Position
/hierarchy-node/{id}/position
Change a Hierarchy Node's position
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Child Hierarchy Nodes
/hierarchy-node/{id}/children
Get a List of Child Hierarchy Nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Parent Hierarchy Nodes
/hierarchy-node/{id}/parents
Get a List of Parent Hierarchy Nodes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Hubs (23)
POST Create Hub
/hubs
A Hub is a container for multiple repositories including media, content, content types.
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 (8)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Hub name |
|
|
Hub label |
|
|
Hub description |
|
|
Hub Plan |
|
|
Algolia Search enabled flag |
|
|
CD2 enabled flag |
|
|
Organization ID |
GET Get Bulk Apply Locale Job
/hubs/{hubId}/bulk-apply-locale/{bulkJobId}
Retrieve the status and results of a bulk apply locale job. Use this to check progress after submitting a bulk locale operation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Archive Job
/hubs/{hubId}/bulk-archive/{jobId}
Retrieve the status and results of a bulk archive job. Use this to monitor the progress of archiving multiple items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Assign Users Job
/hubs/{hubId}/bulk-assign-users/{jobId}
Retrieve the status and results of a bulk assign users job. Use this to check the outcome of assigning users to roles in bulk.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Copy Item Job
/hubs/{hubId}/bulk-copy-item/{jobId}
Retrieve the status and results of a bulk copy item job. Use this to track the progress of copying multiple items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Publish Job
/hubs/{hubId}/bulk-publish-items/{bulkJobId}
Retrieve the status and results of a bulk publish job. Use this to monitor the publishing of multiple items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Unarchive Job
/hubs/{hubId}/bulk-unarchive/{jobId}
Retrieve the status and results of a bulk unarchive job. Use this to check the progress of unarchiving multiple items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Bulk Update Workflow Job
/hubs/{hubId}/bulk-update-workflow/{bulkJobId}
Retrieve the status and results of a bulk update workflow job. Use this to monitor the progress of updating workflows for multiple items.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Bulk Job Id |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Hub
/hubs/{hubId}
Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Hub Asset Management Settings
/hubs/{hubId}/asset-management
Retrieve the asset management settings for a specific hub. Use this to view configuration related to asset handling.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Hubs
/hubs
Retrieve a list of all hubs available to the authenticated user. Use this to get an overview of your hubs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Page number |
|
|
Page size |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Apply Locale Job
/hubs/{hubId}/bulk-apply-locale
Submit a new bulk apply locale job for a hub. Use this to apply a locale to multiple items in one operation.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Archive Job
/hubs/{hubId}/bulk-archive
Submit a new bulk archive job for a hub. Use this to archive multiple items in one operation.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Assign Users Job
/hubs/{hubId}/bulk-assign-users
Submit a new bulk assign users job for a hub. Use this to assign multiple users to roles in one operation.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Copy Item Job
/hubs/{hubId}/bulk-copy-item
Submit a new bulk copy item job for a hub. Use this to copy multiple items in one operation.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Publish Job
/hubs/{hubId}/bulk-publish-items
Submit a bulk publish job for multiple items in a hub to make them live simultaneously.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Unarchive Job
/hubs/{hubId}/bulk-unarchive
Submit a bulk unarchive job to restore multiple archived items in a hub.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Post Bulk Update Workflow Job
/hubs/{hubId}/bulk-update-workflow
Submit a bulk workflow update job to change the workflow state of multiple items in a hub.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Share Hub
/hubs/{hubId}/share
Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
User Id |
|
|
Permissions to share |
PATCH Update Hub
/hubs/{hubId}
Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Hub name |
|
|
Hub label |
|
|
Hub description |
|
|
Hub Plan |
|
|
Algolia Search enabled flag |
|
|
CD2 enabled flag |
|
|
Organization ID |
PUT Update Hub Asset Management Settings
/hubs/{hubId}/asset-management
Update the asset management settings for a hub, including enabling or disabling the feature and providing client configuration.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Enable or disable the asset management feature for the hub. |
|
|
Provide the client configuration string required for asset management integration. |
PATCH Update Hub Plan
/hubs/{hubId}/plan
Update the plan or subscription level for a hub.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Hub Plan |
PATCH Update Hub Settings
/hubs/{hubId}/settings
Update general settings for a hub, such as name or other configuration options.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Integrations
GET List Available Integrations
/hubs/{hubId}/integrations
List all of the Integrations created for a hub (dependent on functional permissions)
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
Locale Labels (2)
PUT Manage Locale Labels
/hubs/{hubId}/locale-labels
Manage locale labels for a hub by creating, updating, or deleting label translations.
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). |
GET Read Local Labels
/hubs/{hubId}/locale-labels
Get a list of locals and labels
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). |
Localization (6)
POST Assigning locales to Content Items
/content-items/{contentItemId}/locale
Assign a locale to a Content Item
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. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Locale |
|
|
Version |
PATCH Assigning locales to Content Repository
/content-repositories/{contentRepositoryId}/item-locales
In order to organise your localized content into separate repositories you can assign a set locales to a Content Repository. You may want to do this in order to give different teams different permissions to create or edit content based on locale.
Assigning locales to a Content Repository has 2 effects. Firstly, you will only be able to assign locales to Content Items which match those assigned to the repository. Secondly, when localizing a content graph, the newly created Content Items will be created in the appropriate Content Repository which match the desired locale.
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Item locales |
GET Get Content Repository localization group locales
/content-repositories/{contentRepositoryId}/localization-group/locales
List of all supported item locales in a Content Repository localization group.
This request can be made using the ID of any repository in the localization group.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Listing the Localizations of a Content Item
/content-items/{contentItemId}/localizations
Once a Content Item has been localized into one or more desired locales, you will be able to see the list of all localizations by following the "localizations" HAL link.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Localization Jobs
/localization-jobs/search/findByRootContentItem/{id}
Content item localization is performed asynchronously - the request to localize a content item graph creates a Localization Job which will be completed at some point in the future. It is possible to track the status of these jobs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Content Item ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Updating a Content Repository localization group
/content-repositories/{contentRepositoryId}/localization-group
The following API allows you to make 2 or more Content Repositories part of the same "group". The new repository will leave it’s current group and join the group of the target repository. To do this, follow the "join-localization-group" HAL link from the target repository and specify the new repository in the body.
For example, lets say you have 3 Content Repositories, Repo1 has no locales assigned, Repo2 and Repo3 are both members of the same group and are assigned locales ["en-GB", "en-US"] and ["fr-FR"] respectively. The following example shows localizing en-GB content into fr-FR. A1 signifies that item A exists in Repo1.
A1 A1 A'1
/ \ / \ / \
B2 C1 ==> B2 C1 B'3 C'1
/ / \ / / \ / / \
D2 E2 F2 D2 E2 F2 D'3 E'3 F'3
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. |
|
|
Content Repository ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
New Content Repository ID |
Publishing Jobs (2)
PATCH Cancelling a Publishing Job
/publishing-jobs/{publishingJobId}
Canelling a Publishing Job
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. |
|
|
Publishing Job ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Assign state to "CANCELLED" |
GET Get a Publishing Job
/publishing-jobs/{publishingJobId}
Get a Publishing Job
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Publishing Job ID |
|
|
The response format expected from the API (e.g. application/json). |
Salesforce Commerce Cloud (SFCC) (5)
POST Create SFCC Integration
/integrations/sfcc
Create a SFCC Integration
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 |
|---|---|
|
|
Hub ID |
|
|
ID |
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
|
|
Locales to use when creating SFCC content, any valid locale can be used |
|
|
Date/Time |
DELETE Delete SFCC Integration
/integrations/sfcc/{integrationId}
Delete an SFCC Integration
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 Get a SFCC Integration
/integrations/sfcc/{integrationId}
Get a specific SFCC Integration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Integration ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List SFCC Integrations
/integrations/sfcc
List all of the SFCC Integrations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Cursor specific to a page |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update SFCC Integration
/integrations/sfcc/{integrationId}
Update an SFCC Integration
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 |
|---|---|
|
|
ID |
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
|
|
Hub ID |
|
|
Locales to use when creating SFCC content, any valid locale can be used |
|
|
Date/Time |
Salesforce Marketing Cloud (SFMC) (5)
POST Create SFMC Integration
/integrations/sfmc
Create a SFMC Integration
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 |
|---|---|
|
|
Hub ID |
|
|
ID |
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
|
|
Set whether the integration is active or inactive. |
|
|
Provide the timestamp of the last successful invocation of the integration. |
DELETE Delete SFMC Integration
/integrations/sfmc/{integrationId}
Delete an SFMC Integration
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 Get a SFMC Integration
/integrations/sfmc/{integrationId}
Get a specific SFMC Integration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Integration ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List SFMC Integrations
/integrations/sfmc
List all of the SFMC Integrations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Cursor specific to a page |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update SFMC Integration
/integrations/sfmc/{integrationId}
Update an SFMC Integration
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 |
|---|---|
|
|
ID |
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
|
|
Set whether the integration is active or inactive. |
|
|
Hub ID |
|
|
Provide the timestamp of the last successful invocation of the integration. |
Search Indexes - Analytics (7)
GET Get count of searches for an index
/algolia-search/{hubId}/indexes/{indexId}/analytics/searches-count
Returns the number of searches across the given time range. A value is returned for the whole range. Additionally, values for each day are returned.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
GET Get count of users
/algolia-search/{hubId}/indexes/{indexId}/analytics/user-count
Returns count of distinct user across the given time range.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
The response format expected from the API (e.g. application/json). |
GET Get rate of no results for an index
/algolia-search/{hubId}/indexes/{indexId}/analytics/no-results-rate
Returns the rate at which searches did not return any results. A value is returned for the whole range. Values per days are also returned. Additionally, the search count and the count of searches without results, used to compute the rates, are returned as well.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
GET Get top filters no result search
/algolia-search/{hubId}/indexes/{indexId}/analytics/top-filters-no-result-search
Returns top filters that did not return any results for given search. Limited to the top 1000.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The query term. Must match the exact user input |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
How many items to fetch. |
|
|
From which position to start retrieving results. |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
GET Get top hits for an index
/algolia-search/{hubId}/indexes/{indexId}/analytics/top-hits
If search is supplied, the top hits for the given search.
If search is omitted, the overall top hits will be returned for this index.
Limited to the 1000 most frequent ones.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Get top hits for a given search. Must match the exact user input. |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
How many items to fetch. |
|
|
From which position to start retrieving results. |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
GET Get top searches for an index
/algolia-search/{hubId}/indexes/{indexId}/analytics/top-searches
Returns top searches. Limited to the 1000 most frequent ones. For each search, also returns the average number of hits returned.
If clickAnalytics=true, then for each search, also returns:
-
the click through rate,
-
the conversion rate,
-
the average click position.
You can also order the results using orderBy and direction.
Distinguishing _no data_ vs 0% CTR, 0% CR, no average
-
You have click analytics enabled but no queries were received with clickAnalytics=true
-
in that case CTR, CR and average will be
null. -
You have click analytics enabled, we received queries with clickAnalytics=true
-
CTR and CR are 0 until we receive click/conversion events
-
average will stay null until we receive a click event
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
If true, then for each search, also returns: the click through rate,
|
|
|
You can reorder the results by passing one of the following: searchCount
|
|
|
Change the order of the results |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
How many items to fetch. |
|
|
From which position to start retrieving results. |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
GET Get top searches with no results
/algolia-search/{hubId}/indexes/{indexId}/analytics/searches-with-no-results
Returns top searches that did not return any results. Limited to the 1000 most frequent.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The lower bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to 7 days ago, 00:00:00am, UTC |
|
|
The upper bound timestamp (a date, a string like “2006-01-02”) of the period to analyze. Defaults to Today, 23:59:59pm, UTC |
|
|
How many items to fetch. |
|
|
From which position to start retrieving results. |
|
|
Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded. E.g: “lang:fr OR lang:en”
|
|
|
Include replica data in the results (Can only be used in conjunction with primary indexes). |
|
|
The response format expected from the API (e.g. application/json). |
Search Indexes (18)
POST Archive an Algolia Search Index
/algolia-search/{hubId}/indexes/{indexId}/archive
Archive an Algolia Search Index
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Clear an Index
/algolia-search/{hubId}/indexes/{indexId}/clear
Remove all objects from an Algolia search index
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. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional unpublishing options as a JSON string, such as to set an unpublish date or include related items. |
POST Create an Assigned Content Type
/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types
Assign content type to a search index. Assigning a content type will create an associated webhook, which updates the index with content item data.
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. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Registered Content Type Schema |
|
|
Created Date |
|
|
Last Modified Date |
POST Create an Index
/algolia-search/{hubId}/indexes
Create a new Algolia search index
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (10)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
ID of the replicas parent index |
|
|
Number of replica indexes for this index (only present on non-replica indexes) |
|
|
Generated index name including the hub name and user defined suffix |
|
|
Index suffix |
|
|
User defined index label |
|
|
Type of index |
|
|
Created Date |
|
|
Last Modified Date |
|
|
Status |
DELETE Delete an Assigned Content Type
/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types/{contentTypeId}
Delete an assigned content type for a search index.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Assigned Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete an Index
/algolia-search/{hubId}/indexes/{indexId}
Delete an Algolia search index for a given hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
DELETE Delete an Index Object
/algolia-search/{hubId}/indexes/{indexId}/objects/{objectId}
Delete an object from a search index
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Object ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Assigned Content Type
/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types/{contentTypeId}
Get an assigned content type for a search index. A content type should have an associated webhook, which updates the index with content item data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Assigned Content Type ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Search Index Settings
/algolia-search/{hubId}/indexes/{indexId}/settings
Get Algolia search index settings
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Search Index Statistics
/algolia-search/{hubId}/indexes/{indexId}/stats
Get Algolia search index statistics
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an API key
/algolia-search/{hubId}/indexes/{indexId}/keys/{keyId}
Get Algolia search API key for a given index/hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Key ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get an Index
/algolia-search/{hubId}/indexes/{indexId}
Get an Algolia search index for a given hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Assigned Content Types
/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types
List all content types assigned to a search index. Each content type should have an associated webhook, which updates the index with content item data.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
Set the number of results per page |
|
|
Page number |
|
|
Sort parameter |
|
|
The response format expected from the API (e.g. application/json). |
GET List Indexes
/algolia-search/{hubId}/indexes
List Algolia search indexes for a given hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Filter by the parentId. An empty string will return all primary indexes. |
|
|
Project addition values in list response
|
|
|
Set the number of results per page |
|
|
Page number |
|
|
Sort parameter |
|
|
Comma seperated list of statuses |
|
|
The response format expected from the API (e.g. application/json). |
POST Recreate Assigned Content Type Webhook
/algolia-search/{hubId}/indexes/{indexId}/assigned-content-types/{contentTypeId}/recreate-webhook
Recreate the webhook for this assigned content type
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. |
|
|
Hub ID |
|
|
Index ID |
|
|
Assigned Content Type ID |
|
|
Type of webhook to create |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional unpublishing options as a JSON string, such as to set an unpublish date or include related items. |
POST Unarchive an Algolia Search Index
/algolia-search/{hubId}/indexes/{indexId}/unarchive
Unarchive an Algolia Search Index
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update Search Index Settings
/algolia-search/{hubId}/indexes/{indexId}/settings
Update settings on an active Algolia search index.
For a complete list of index settings visit the Algolia settings documentation.
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. |
|
|
Hub ID |
|
|
Index ID |
|
|
Forward to replicas |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Index replicas that are managed by Dynamic Content should follow the naming convention . - e.g. anyafinn.womens-clothing-replica |
PATCH Update an Index
/algolia-search/{hubId}/indexes/{indexId}
Update an active Algolia search index.
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. |
|
|
Hub ID |
|
|
Index ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
User defined index label |
Snapshots (11)
POST Create Batch of Snapshot
/hubs/{hubId}/snapshots/batch
Create new Snapshots for a batch of Content Items.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Comment |
|
|
Created Date |
|
|
User who created the Snapshot |
|
|
Indicates if this Snapshot was created by an Edition or a Content-Item |
|
|
Indicates the type of Snapshot (USER or SYSTEM) |
|
|
The locale |
|
|
ID of the root Content-Item |
POST Create Publishing-Job for Snapshot
/snapshots/{snapshotId}/publishing-jobs
Create a Publishing Job for a Snapshot
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. |
|
|
Snapshot ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (6)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Scheduled date & time for Publishing Job |
|
|
Date Publishing Job was created |
|
|
User who created the Publishing Job |
|
|
State of Publishing Job |
|
|
Publish error status (only present if state=FAILED) |
POST Create Snapshot
/hubs/{hubId}/snapshots
Create a new Snapshot for a particular Content-Item.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Comment |
|
|
Created Date |
|
|
User who created the Snapshot |
|
|
Indicates if this Snapshot was created by an Edition or a Content-Item |
|
|
Indicates the type of Snapshot (USER or SYSTEM) |
|
|
The locale |
|
|
ID of the root Content-Item |
POST Create Snapshot Edition Link
/snapshots/{snapshotId}/edition-links
Create a link between the specified snapshot and edition.
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. |
|
|
Snapshot ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Date link was created |
|
|
User who created the Snapshot Edition Link |
|
|
Edition ID |
DELETE Delete Snapshot Edition Link
/snapshots/{snapshotId}/edition-links/{editionId}
Delete a Snapshot Edition Link
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Edition ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Snapshot
/snapshots/{snapshotId}
Return the snapshot with the specified ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Snapshot ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get Snapshot Edition Links
/snapshots/{snapshotId}/edition-links
Return a list of edition links for the specified snapshot.
Simply follow the HAL link with rel "snapshot-edition-links" from a snapshot response.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Snapshot ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
GET List Snapshots
/hubs/{hubId}/snapshots
List all of the snapshots created for a hub. The list can be filtered by user or system created snapshots.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
Type filter |
|
|
The response format expected from the API (e.g. application/json). |
GET List all publishing jobs for a Snapshot
/snapshots/{snapshotId}/publishing-jobs
Get a list of all Publishing Jobs for a Snapshot
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Snapshot ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
GET Search Snapshots
/hubs/{hubId}/snapshots/search
List all of the support search queries for a Snapshot
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
POST Snapshot Facets
/snapshots/search/facet
Add a search facet to a snapshot.
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. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Return entities in the response |
Webhooks (9)
POST Create Webhooks
/hubs/{hubId}/webhooks
Create a new Webhook for a Hub
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Label for the Webhook |
|
|
List of events to register the Webhook against |
|
|
List of URLs to receive the Webhook |
|
|
Indicates if the Webhook should be fired |
|
|
Shared secret between the handler and DC |
|
|
Created Date |
|
|
Last Modified Date |
|
|
Webhook HTTP method |
DELETE Delete a Webhook
/hubs/{hubId}/webhooks/{webhookId}
Delete a specified webhook
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a Webhook
/hubs/{hubId}/webhooks/{webhookId}
Get a specified webhook
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
The response format expected from the API (e.g. application/json). |
GET Get a Webhook Request
/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}
Get a single webhook request
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
Webhook Request ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Requests for a Webhook
/hubs/{hubId}/webhooks/{webhookId}/requests
List all of the requests created for a webhook
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Webhooks for a Hub
/hubs/{hubId}/webhooks
List all of the Webhooks created for a hub
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
POST Preview Webhook Request
/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}/preview
You can test your unsaved Webhook Subscription against an already sent Webhook Request
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. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
Webhook Request ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Webhook handler URL |
|
|
Webhook HTTP method |
|
|
Shared secret between the handler and DC |
POST Resend a Webhook Request
/hubs/{hubId}/webhooks/{webhookId}/requests/{requestId}/resend
Only available for Webhook Requests that have a requestState that is either "SUCCESS", "FAILED" or "PROCESSING_FAILED"
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. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
Webhook Request ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide additional unpublishing options as a JSON string, such as to set an unpublish date or include related items. |
PATCH Update a Webhook
/hubs/{hubId}/webhooks/{webhookId}
Update a specified webhook
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. |
|
|
Hub ID |
|
|
Webhook ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (9)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Label for the Webhook |
|
|
List of events to register the Webhook against |
|
|
List of URLs to receive the Webhook |
|
|
Indicates if the Webhook should be fired |
|
|
Shared secret between the handler and DC |
|
|
Created Date |
|
|
Last Modified Date |
|
|
Webhook HTTP method |
Workflows (4)
POST Create Workflow State
/hubs/{hubId}/workflow-states
You may create up to 100 workflow states per hub.
The color property is an RGB value representing the color which should be used to display the workflow state within Dynamic Content.
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. |
|
|
Hub ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Label |
|
|
Color |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |
GET Get Workflow State
/workflow-states/{workflowStateId}
Returns the workflow state with the specified ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Workflow State ID |
|
|
The response format expected from the API (e.g. application/json). |
GET List Workflow States
/hubs/{hubId}/workflow-states
List all of the workflow stats for a hub.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
Additional HTTP header name/value pairs to include in the request. |
|
|
Hub ID |
|
|
Page number |
|
|
Page size |
|
|
Sort paramter |
|
|
The response format expected from the API (e.g. application/json). |
PATCH Update Workflow State
/workflow-states/{workflowStateId}
Update the workflow state
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. |
|
|
Workflow State ID |
|
|
The response format expected from the API (e.g. application/json). |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
ID |
|
|
Specify a label for the content being placed in the slot, such as a display name or identifier. |
|
|
Set the color associated with the workflow state. |
|
|
Created by User Id |
|
|
Created Date |
|
|
Last Modified by User Id |
|
|
Last Modified Date |