Marketing Content Hub by Stylelabs integrates and blends boundaries between traditional marketing silos. It provides an integrated solution for Digital asset management (DAM), Product information management (PIM), Marketing resource management (MRM), Web to Print, Marketing portal and Digital rights management (DRM).
Status: Preview |
Tier: Premium |
Version: 1.65 |
Name |
Summary |
List Entity Definitions |
|
List Cultures |
|
List Publishable Renditions |
|
Add Fetch Job |
|
Get FetchJob Status |
|
GetEntitySchemaByDefinition (string type, [internal][Optional]string X-Operation-Type) |
Get Entity Definition Schema |
Delete Entity By Id |
|
List Entities |
|
Add Entity |
|
GetEntityByIdentifier (string type-dynamic, string identifier) |
Get Entity By Identifier |
Update Entity by Identifier |
|
Delete Entity By Identifier |
|
Query Entities (Simple) |
|
Query Entities (Advanced) |
Name |
Summary |
OnEntitySaveTrigger (OnEntitySaveRequestBody AddSaveEntityTriggerSchema) |
On Entity Save |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List Entity Definitions
Description: Lists the available entity definitions.
Syntax:
MarketingContentHub.ListEntityDefinitions ()
Returns:
Type:array of (ListEntityDefinitionsResponseItem)
Summary: List Cultures
Description: Lists the available cultures.
Syntax:
MarketingContentHub.ListCultures ()
Returns:
Type:array of (ListCulturesResponseItem)
Summary: List Publishable Renditions
Description: Lists the publishable renditions.
Syntax:
MarketingContentHub.ListPublishableRenditions ()
Returns:
Type:array of (ListPublishableRenditionsResponseItem)
Summary: Add Fetch Job
Description: Adds a FetchJob.
Syntax:
MarketingContentHub.AddFetchJob ([Optional]AddFetchJobSchema items)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
items |
|
|
False |
Returns:
Type:AddFetchJobResponse
Summary: Get FetchJob Status
Description: Gets the status of a FetchJob.
Syntax:
MarketingContentHub.GetFetchJobById (number id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
number (Fetch Job Id) |
The id of the fetch job you want to get the status from. |
True |
Returns:
Summary: Get Entity Definition Schema
Description: Gets the schema of a record type.
Syntax:
MarketingContentHub.GetEntitySchemaByDefinition (string type, [internal][Optional]string X-Operation-Type)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type |
string (Select Entity) |
Select Entity you want output from. |
True |
|
X-Operation-Type |
string (Select Entity) |
Type of operation. |
False |
Returns:
Type:GetEntitySchemaByDefinitionResponse
Summary: Delete Entity By Id
Description: Deletes an entity.
Syntax:
MarketingContentHub.DeleteEntityById (string id)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
id |
string (Entity Id) |
Unique id of the entity. |
True |
Returns:
Summary: List Entities
Description: Gets entities from a certain entity definition like 'M.Brand' - uses dynamic values and outputs dynamic-schema.
Syntax:
MarketingContentHub.ListEntitiesByDefinition (string type-dynamic, [advanced][Optional]string take, [advanced][Optional]string skip, [advanced][Optional]string members, [advanced][Optional]string renditions, [advanced][Optional]string culture, [advanced][Optional]string sort, [advanced][Optional]string order, [advanced][Optional]string sortCulture)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Entity Definition) |
Select entity definition. |
True |
|
take |
string (Take) |
Specify the number of entities to retrieve (e.g. 10, maximum 100). |
False |
|
skip |
string (Skip) |
Specify the number of entities to skip in the result (e.g. 10). |
False |
|
members |
string (Members) |
Specify the members to be retrieved. |
False |
|
renditions |
string (Renditions) |
Specify the renditions to be retrieved. |
False |
|
culture |
string (Culture) |
Specify the culture to be retrieved. |
False |
|
sort |
string (Sort) |
Specify the sort query to be used. |
False |
|
order |
string (Order)Values: [Asc, Desc] |
Specify the order to be used. |
False |
|
sortCulture |
string (Sort Culture) |
Specify the sort culture to be retrieved. |
False |
Returns:
Type:ListEntitiesByDefinitionResponse
Summary: Add Entity
Description: Adds an entity for a certain entity definition like 'M.Brand' - uses dynamic values and outputs dynamic-schema.
Syntax:
MarketingContentHub.AddEntityByDefinition (string type-dynamic, [Optional]AddEntityByDefinitionParameterDynamicTypeSchema dynamicTypeSchema)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Select Entity Definition) |
Select entity definition. |
True |
|
dynamicTypeSchema |
AddEntityByDefinitionParameterDynamicTypeSchema
|
|
False |
Returns:
Type:AddEntityByDefinitionResponse
Summary: Get Entity By Identifier
Description: Retrieves a certain entity by its identifier and definition.
Syntax:
MarketingContentHub.GetEntityByIdentifier (string type-dynamic, string identifier)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Select Entity Definition) |
Select entity definition. |
True |
|
identifier |
string (Entity identifier) |
Unique entity identifier. |
True |
Returns:
Type:GetEntityByIdentifierResponse
Summary: Update Entity by Identifier
Description: Updates an entity for a certain entity definition - uses dynamic values and outputs dynamic-schema.
Syntax:
MarketingContentHub.UpdateEntityByIdentifier (string type-dynamic, string identifier, [Optional]UpdateEntityByIdentifierParameterDynamicTypeSchema dynamicTypeSchema)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Select Entity Definition) |
Select entity definition. |
True |
|
identifier |
string (Entity identifier) |
Unique entity Identifier. |
True |
|
dynamicTypeSchema |
UpdateEntityByIdentifierParameterDynamicTypeSchema
|
|
False |
Returns:
Summary: Delete Entity By Identifier
Description: Deletes an entity via identifier.
Syntax:
MarketingContentHub.DeleteEntityByIdentifier (string identifier)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
identifier |
string (Entity Identifier) |
The unique identifier of the entity. |
True |
Returns:
Summary: Query Entities (Simple)
Description: Queries entities, based on the type of entity (simple).
Syntax:
MarketingContentHub.QueryEntitiesByDefinitionSimple (string type-dynamic, [Optional]QueryEntitiesByDefinitionSimpleParameterDynamicTypeSchema dynamicTypeSchema, [advanced][Optional]string take, [advanced][Optional]string skip, [advanced][Optional]string members, [advanced][Optional]string renditions, [advanced][Optional]string culture, [advanced][Optional]string sort, [advanced][Optional]string order, [advanced][Optional]string sortCulture)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Select Entity Definition) |
Select entity definition. |
True |
|
dynamicTypeSchema |
QueryEntitiesByDefinitionSimpleParameterDynamicTypeSchema
|
|
False |
|
take |
string (Take) |
Specify the number of entities to retrieve (e.g. 10, maximum 100). |
False |
|
skip |
string (Skip) |
Specify the number of entities to skip in the result (e.g. 10). |
False |
|
members |
string (Members) |
Specify the members to be retrieved. |
False |
|
renditions |
string (Renditions) |
Specify the renditions to be retrieved. |
False |
|
culture |
string (Culture) |
Specify the culture to be retrieved. |
False |
|
sort |
string (Sort) |
Specify the sort query to be used. |
False |
|
order |
string (Order)Values: [Asc, Desc] |
Specify the order to be used. |
False |
|
sortCulture |
string (Sort Culture) |
Specify the sort culture to be retrieved. |
False |
Returns:
Type:QueryEntitiesByDefinitionSimpleResponse
Summary: Query Entities (Advanced)
Description: Queries entities, based on the type of entity (advanced).
Syntax:
MarketingContentHub.QueryEntitiesByDefinitionAdvanced (string type-dynamic, string query, [advanced][Optional]string take, [advanced][Optional]string skip, [advanced][Optional]string members, [advanced][Optional]string renditions, [advanced][Optional]string culture, [advanced][Optional]string sort, [advanced][Optional]string order, [advanced][Optional]string sortCulture)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
type-dynamic |
string (Select Entity Definition) |
Select entity definition. |
True |
|
query |
string (Grammar expression) |
Grammar expression, see Stylelabs API for more info. |
True |
|
take |
string (Take) |
Specify the number of entities to retrieve (e.g. 10, maximum 100). |
False |
|
skip |
string (Skip) |
Specify the number of entities to skip in the result (e.g. 10). |
False |
|
members |
string (Members) |
Specify the members to be retrieved. |
False |
|
renditions |
string (Renditions) |
Specify the renditions to be retrieved. |
False |
|
culture |
string (Culture) |
Specify the culture to be retrieved. |
False |
|
sort |
string (Sort) |
Specify the sort query to be used. |
False |
|
order |
string (Order)Values: [Asc, Desc] |
Specify the order to be used. |
False |
|
sortCulture |
string (Sort Culture) |
Specify the sort culture to be retrieved. |
False |
Returns:
Type:QueryEntitiesByDefinitionAdvancedResponse
Summary: On Entity Save
Description: Trigger that executes for every entity save.
Syntax:
MarketingContentHub.OnEntitySaveTrigger (OnEntitySaveRequestBody AddSaveEntityTriggerSchema)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
AddSaveEntityTriggerSchema |
|
|
True |
Returns:
Type:OnEntitySaveCreationResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
identifier |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
assetId |
integer
|
|
uri |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer
|
|
FilesCount |
integer
|
|
FilesCompleted |
integer
|
|
State |
string
|
|
StateDescription |
string
|
|
Condition |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
identifier |
string
|
|
label |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
integer
|
|
name |
string
|
|
label |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
identifier |
string
|
|
label |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
url |
string
|
HTML URl of Repo. |
entitydefinition |
string Entity Definition |
Select entity definition. |
triggername |
string Trigger Name |
Trigger Name. |
filter |
string Filter |
Filter expression in json format. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |