All URIs are relative to https://api.dyspatch.io
| Method | HTTP request | Description |
|---|---|---|
| GetTemplateById | Get /templates/{templateId} | Get Template by ID |
| GetTemplates | Get /templates | List Templates |
TemplateRead GetTemplateById(ctx, templateId, targetLanguage, accept)
Get Template by ID
Gets a template object with the matching ID. If the template has published content the "compiled" field will contain the template .
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| templateId | string | A template ID | |
| targetLanguage | string | The type of templating language to compile as. Should only be used for visual templates. | |
| accept | string | A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" |
- Content-Type: Not defined
- Accept: application/vnd.dyspatch.2020.11+json, /
[Back to top] [Back to API list] [Back to Model list] [Back to README]
TemplatesRead GetTemplates(ctx, accept, optional)
List Templates
Gets a list of Template Metadata objects for all templates. Up to 25 results returned before results are paginated.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| accept | string | A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" | |
| optional | *GetTemplatesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetTemplatesOpts struct
| Name | Type | Description | Notes |
|---|
cursor | optional.String| A cursor value used to retrieve a specific page from a paginated result set. |
- Content-Type: Not defined
- Accept: application/vnd.dyspatch.2020.11+json, /
[Back to top] [Back to API list] [Back to Model list] [Back to README]