HTML Compositions
Last updated
Last updated
When you want to deploy your custom HTML composition, you have two options:
Use the REST API for HTML compositions
Use the CompositionEditor
The HTML composition REST API is deprecated from Starcounter 2.3.1. Compositions can still be accessed through the class HTMLComposition
The REST API allows importing compositions for sets of blended HTML partials. The CompositionEditor has to run for this API to work.
GET
http://localhost:8080/sc/partial/composition?key={?}&ver={?}
Returns the HTML of a specific composition
Name | Type | Description |
---|---|---|
POST
http://localhost:8080/sc/partial/composition?key={?}&ver={?}
Creates a new composition at the specified key if there's no composition there. The body consists of the composition HTML
DELETE
http://localhost:8080/sc/partial/composition?key={?}&ver={?}
Deletes the composition with the specific key and version
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
key
string
The key of the composition.
ver
string
The version of the composition.
key
string
The key of the composition.
ver
string
The version of the composition.
key
string
The key of the composition. If the key is "all", all composition are deleted.
ver
string
The version of the composition.