Connectors Reference

Marketing Content Hub

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

 

Actions:

Name

Summary

ListEntityDefinitions ()

List Entity Definitions

ListCultures ()

List Cultures

ListPublishableRenditions ()

List Publishable Renditions

AddFetchJob ([Optional]AddFetchJobSchema items)

Add Fetch Job

GetFetchJobById (number id)

Get FetchJob Status

GetEntitySchemaByDefinition (string type, [internal][Optional]string X-Operation-Type)

Get Entity Definition Schema

DeleteEntityById (string id)

Delete Entity By Id

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)

List Entities

AddEntityByDefinition (string type-dynamic, [Optional]AddEntityByDefinitionParameterDynamicTypeSchema dynamicTypeSchema)

Add Entity

GetEntityByIdentifier (string type-dynamic, string identifier)

Get Entity By Identifier

UpdateEntityByIdentifier (string type-dynamic, string identifier, [Optional]UpdateEntityByIdentifierParameterDynamicTypeSchema dynamicTypeSchema)

Update Entity by Identifier

DeleteEntityByIdentifier (string identifier)

Delete Entity By Identifier

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)

Query Entities (Simple)

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)

Query Entities (Advanced)

 

Triggers:

Name

Summary

OnEntitySaveTrigger ([Optional]OnEntitySaveRequestBody AddSaveEntityTriggerSchema)

On Entity Save

 

Objects:

Name

Summary

AddEntityByDefinitionParameterDynamicTypeSchema

 

AddEntityByDefinitionResponse

 

AddFetchJobResponse

 

AddFetchJobSchema

 

GetEntityByIdentifierResponse

 

GetEntitySchemaByDefinitionResponse

 

GetFetchJobByIdResponse

 

ListCulturesResponseItem

 

ListEntitiesByDefinitionResponse

 

ListEntityDefinitionsResponseItem

 

ListPublishableRenditionsResponseItem

 

OnEntitySaveCreationResponse

 

OnEntitySaveRequestBody

 

QueryEntitiesByDefinitionAdvancedResponse

 

QueryEntitiesByDefinitionSimpleParameterDynamicTypeSchema

 

QueryEntitiesByDefinitionSimpleResponse

 

UpdateEntityByIdentifierParameterDynamicTypeSchema

 

 

Actions:

ListEntityDefinitions

Summary: List Entity Definitions

Description: Lists the available entity definitions.

 

Syntax:

MarketingContentHub.ListEntityDefinitions ()

 

Returns:

          Type:array of (ListEntityDefinitionsResponseItem)

 

ListCultures

Summary: List Cultures

Description: Lists the available cultures.

 

Syntax:

MarketingContentHub.ListCultures ()

 

Returns:

          Type:array of (ListCulturesResponseItem)

 

ListPublishableRenditions

Summary: List Publishable Renditions

Description: Lists the publishable renditions.

 

Syntax:

MarketingContentHub.ListPublishableRenditions ()

 

Returns:

          Type:array of (ListPublishableRenditionsResponseItem)

 

AddFetchJob

Summary: Add Fetch Job

Description: Adds a FetchJob.

 

Syntax:

MarketingContentHub.AddFetchJob ([Optional]AddFetchJobSchema items)

 

Parameters:

Name

Type

Summary

Required

Related Action

items

AddFetchJobSchema

 

 

False

 

Returns:

          Type:AddFetchJobResponse

 

GetFetchJobById

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:

          Type:GetFetchJobByIdResponse

 

GetEntitySchemaByDefinition

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

 

DeleteEntityById

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:

 

ListEntitiesByDefinition

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

ListEntityDefinitions

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

ListPublishableRenditions

culture

string

(Culture)

Specify the culture to be retrieved.

False

ListCultures

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

ListCultures

 

Returns:

          Type:ListEntitiesByDefinitionResponse

 

AddEntityByDefinition

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

ListEntityDefinitions

dynamicTypeSchema

AddEntityByDefinitionParameterDynamicTypeSchema

 

 

False

 

Returns:

          Type:AddEntityByDefinitionResponse

 

GetEntityByIdentifier

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

ListEntityDefinitions

identifier

string

(Entity identifier)

Unique entity identifier.

True

 

Returns:

          Type:GetEntityByIdentifierResponse

 

UpdateEntityByIdentifier

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

ListEntityDefinitions

identifier

string

(Entity identifier)

Unique entity Identifier.

True

dynamicTypeSchema

UpdateEntityByIdentifierParameterDynamicTypeSchema

 

 

False

 

Returns:

 

DeleteEntityByIdentifier

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:

 

QueryEntitiesByDefinitionSimple

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

ListEntityDefinitions

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

ListPublishableRenditions

culture

string

(Culture)

Specify the culture to be retrieved.

False

ListCultures

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

ListCultures

 

Returns:

          Type:QueryEntitiesByDefinitionSimpleResponse

 

QueryEntitiesByDefinitionAdvanced

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

ListEntityDefinitions

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

ListPublishableRenditions

culture

string

(Culture)

Specify the culture to be retrieved.

False

ListCultures

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

ListCultures

 

Returns:

          Type:QueryEntitiesByDefinitionAdvancedResponse

 

Triggers:

Trigger OnEntitySaveTrigger

Summary: On Entity Save

Description: Trigger that executes for every entity save.

 

Syntax:

MarketingContentHub.OnEntitySaveTrigger ([Optional]OnEntitySaveRequestBody AddSaveEntityTriggerSchema)

 

Parameters:

Name

Type

Summary

Required

Related Action

AddSaveEntityTriggerSchema

OnEntitySaveRequestBody

 

 

False

 

Returns:

          Type:OnEntitySaveCreationResponse

 


 

AddEntityByDefinitionParameterDynamicTypeSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

AddEntityByDefinitionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer

 

 

identifier

string

 

 


 

AddFetchJobResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

number

 

 


 

AddFetchJobSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary

assetId

integer

 

 

uri

string

 

 


 

GetEntityByIdentifierResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetEntitySchemaByDefinitionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

GetFetchJobByIdResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer

 

 

FilesCount

integer

 

 

FilesCompleted

integer

 

 

State

string

 

 

StateDescription

string

 

 

Condition

string

 

 


 

ListCulturesResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

identifier

string

 

 

label

string

 

 


 

ListEntitiesByDefinitionResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ListEntityDefinitionsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

integer

 

 

name

string

 

 

label

string

 

 


 

ListPublishableRenditionsResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

identifier

string

 

 

label

string

 

 


 

OnEntitySaveCreationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OnEntitySaveRequestBody

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.


 

QueryEntitiesByDefinitionAdvancedResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QueryEntitiesByDefinitionSimpleParameterDynamicTypeSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

QueryEntitiesByDefinitionSimpleResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

UpdateEntityByIdentifierParameterDynamicTypeSchema

Summary:

Description:

 

          Properties:

Name

Type

Summary