List Email Templates
Gets the list of published email templates available in the specified unit. For each available template the Model.xml is looked up and appended to a large XML.
GET /connectr/api/units/{unitId}/emailtemplates
Example Request URL: http://connectr.example.org:8080/connectr/api/units/4.1/emailtemplates?path=/Publish/Contoso/HR
Template parameter | Value | Description |
---|---|---|
unit (Mandatory) | string | Unit code as used in Data Manager. This is currently defined in the Publish Store settings. |
Query parameter | Value | Description |
---|---|---|
path (Mandatory) | String | Relative path of a Unit in the Publish Store. Use Sketch’s “Properties” view to find the “location” property, then use everything after the first /modelstore/ part of that field. Might be optional in the future. |
Response status code | Content type | Description |
---|---|---|
200 OK | application/xml | Request completed successfully, templates list in response. See appendix “XML Schema for Template List / Details”, this call returns the “Models” element. |
Bad request | text/plain | Path is too short or contains illegal characters. |
404 Not found | text/plain | The unit could not be found. |
Response example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<EmailModels StageName="PUB_dev-01" UnitName="Test" >
<EmailModel IsPackage="false">
<Email-Model-Uri>http://dev-01.connective.local:15220/modelstore/PublishStore/PUB_dev-01/Test/Template_7.3_3.3.0</Email-Model-Uri>
<XSD-Form-Uri></XSD-Form-Uri>
<Key>Template_7.3_3.3.0</Key>
<LanguageEmailModel LanguageCode="nl-BE"/>
<Description Code="en-US">Template_7.3_3.3.0</Description>
<Categories/>
<SearchKeys/>
<MetaData>
<CEM-Uri>http://localhost:15220/modelstore/ModelStore/Contoso/Test/Template_7.3_3.3.0.cem</CEM-Uri>
<CEM-Version>1.2</CEM-Version>
<CEM-CheckedIn-UserID>usertest1</CEM-CheckedIn-UserID>
<Published-UserID>usertest1</Published-UserID>
<Published-Comment></Published-Comment>
<LSClient-Version>6.0.0</LSClient-Version>
</MetaData>
</EmailModel>
<EmailModel IsPackage="false">
<Email-Model-Uri>http://dev-01.connective.local:15220/modelstore/PublishStore/PUB_dev-01/Test/Template_7.3_3.2.12</Email-Model-Uri>
<XSD-Form-Uri></XSD-Form-Uri>
<Key>Template_7.3_3.2.12</Key>
<LanguageEmailModel LanguageCode="nl-NL"/>
<Description Code="en-US">Template_7.3_3.2.12</Description>
<Categories/>
<SearchKeys/>
<MetaData>
<CEM-Uri>http://localhost:15220/modelstore/ModelStore/Contoso/Test/Template_7.3_3.2.12.cem</CEM-Uri>
<CEM-Version>1.2</CEM-Version>
<CEM-CheckedIn-UserID>usertest1</CEM-CheckedIn-UserID>
<Published-UserID>usertest1</Published-UserID>
<Published-Comment></Published-Comment>
<LSClient-Version>6.0.0</LSClient-Version>
</MetaData>
</EmailModel>
</EmailModels>