Connect REST API Developer Guide
jPersonalization Transformers Resource
Get, create, update, or delete Personalization Transformers.
- Resource
- This resource is applicable for GET (single), PUT, and DELETE
methods.The idOrName is the unique ID or API name of the transformer.
- This resource is applicable for GET (collection) and POST
methods.For GET, append query parameters. Query parameters can include limit, offset, and source.
- Resource example
- This example shows a sample resource applicable for GET (single), PUT, and DELETE
methods.This example shows a sample resource applicable for GET (collection) and POST methods.
- Available version
- 66.0
- HTTP methods
- GET, POST, PUT, DELETE
- Query parameter for GET, PUT, and DELETE (Single Transformer)
-
Name Type Description Required or Optional AVAILABLE VERSION idOrName String Unique ID or API name of the personalization transformer to retrieve, update, or delete. Required 66.0 - Request body for POST, PUT, and GET (Single Transformer)
-
- JSON Example
-
-
Name Type Description Required or Optional Available Version name String Unique name of the object. Required 66.0 label String Human-readable label or title for the object. Required 66.0 description String Description of the object. Optional 66.0 dataConnectors String[] List of websites or mobile apps this personalization transformer belongs to. This can be id, name, appSourceId, or Data360 StreamingAppDataConnector. Optional 66.0 channel String Specifies whether this ttransformer is for a website or mobile application. Values are: MobileApp, WebApp. Optional 66.0 substitutionDefinitions Substitution Variable Input Object added by substitution name. Each value matches the substitution variable input. Optional 66.0 schemaReference String If the Transformer Substitution Definitions were created referencing a response template, the name of that template. Optional 66.0 isEnabled Boolean Specifies whether this transformer is enabled when delivered to the mobile app or website. Optional 66.0 transformerType String Instruction to the SDK on how the transformer works. Values are: Handlebars, HtmlElementModifier, AgentScript, Component. Optional 66.0 transformerTypeDetails Transformer Type Details Input Data specific to the type of transformer. Optional 66.0
- Response body for POST (Transformers Collection), GET, and PUT (Single Transformer)
- Transformer
- Response for DELETE (Single Transformer)
- 204: Successful Delete
- Query Parameters for GET (Transformers Collection)
-
Name Type Description Required or Optional AVAILABLE VERSION limit Integer Limits the number of personalization transformers returned. The default is 50 and the value must be between 1 and 299. The list is sorted by name. Optional 66.0 offset Integer Number of personalization transformers to skip when retrieving the list. The default is 0 and the value must be between 0 and the number of personalization transformers. The list is sorted by name. Optional 66.0 source Source of the personalization transformers to retrieve. Values: Global, Organization. Default is Organization. Optional 66.0 - Response body for GET (Transformers Collection)
- Transformer Collection