RenderEngines
The render engines api controller.
| API | Description |
|---|---|
| POST api/renderengines/select |
Gets the s that match the given . |
| GET api/RenderEngines/{id} |
Get the with the given . |
| POST api/RenderEngines |
Save the provided . |
| POST api/RenderEngines/{id} |
Delete the with the given . |
EditorTypes
The editor types api controller. Provides REST actions for editor types.
| API | Description |
|---|---|
| GET api/editortypes/{id} |
Retrieves an editor type. |
| GET api/editortypes/{dataType} |
Retrieves a list of editor types by data type. |
| PUT api/editortypes/{id} |
Updates an editor type. |
| DELETE api/editortypes/{id} |
Deletes an editor type. |
| GET api/EditorTypes |
Retrieves a list of editor types. |
| POST api/EditorTypes |
Creates an editor type. |
TemplateFilterCategories
The templates filter categories api controller. Provides REST actions for template entities.
| API | Description |
|---|---|
| GET api/templatefiltercategories |
Retrieves a list of template filter categories. |
| GET api/templatefiltercategories/tenant/{tenantId} |
Retrieves a list of template filter categories for a tenant. |
| POST api/templatefiltercategories |
Creates a template filter category. |
| GET api/TemplateFilterCategories/{id} |
Retrieves a template filter category. |
| PUT api/TemplateFilterCategories |
Updates a template filter category. |
| DELETE api/TemplateFilterCategories/{id} |
Deletes a template filter category. |
Campaigns
The campaigns api controller. Provides REST actions for campaign entities.
| API | Description |
|---|---|
| GET api/campaigns/{id}/summary |
Retrieves a campaign summary. |
| GET api/campaigns/user |
Retrieves a list of campaigns for the current user. |
| GET api/campaigns/user/summaries |
Retrieves a list of campaign summaries for the current user. |
| POST api/campaigns/selectsummaries |
Retrieves a list of campaign summaries that match the given criteria. |
| GET api/campaigns/xml/{id} |
Retrieves the xml for a campaign. |
| GET api/campaigns/{id}/previewdetails/{tenantIdProperty} |
Retrieves the preview details for a campaign. |
| POST api/campaigns/previewdetails |
Retrieves the preview details for a campaign. |
| POST api/campaigns/select |
Retrieves a list of campaigns that match the given criteria. |
| GET api/campaigns/preview/{key}/{productId}/{pageNumber}/{tenantIdProperty} |
Retrieves a campaign product preview. |
| GET api/campaigns/proof/{key}/{id} |
Retrieves a campaign proof. |
| GET api/campaigns/prgrammaticproof/{key}/{id}/{TenantId} |
Retrieves a campaign proof for Programmatic. |
| GET api/campaigns/proof/product/{key}/{productId} |
Retrieves a campaign product proof. |
| POST api/campaigns/clone |
Clones a campaign. |
| POST api/campaigns/generatexml |
Generates XML for campaign |
| POST api/campaigns/render/{id}/{key} |
Renders a campaign against a key using the given xml. |
| PUT api/campaigns/status/{id} |
Updates a campaign status. |
| POST api/campaigns/renderProductionOutput/{id} |
Renders production output for a campaign. |
| POST api/campaigns/RenderProductionOutputToDisk/{id} |
Renders production output for a campaign and saves it to disk. |
| POST api/campaigns/RenderProgrammaticProductionOutputToDisk/{id}/{TenantId} |
Renders production output for a campaign and saves it to disk. |
| POST api/campaigns/GetProductionOutputFromDisk/{id} |
Retrieves the production output from disk for a campaign. |
| POST api/campaigns/GetProgrammaticProductionOutputFromDisk/{id}/{TenantId} |
Retrieves the production output from disk for a campaign. |
| GET api/Campaigns/{id} |
Retrieves a campaign. |
| POST api/Campaigns |
Creates a campaign. |
| PUT api/Campaigns/{id} |
Updates a campaign. |
| DELETE api/Campaigns/{id} |
Deletes a campaign. |
CampaignProductSelection
The Campaign Product Selection Controller.
| API | Description |
|---|---|
| GET api/campaignproductselection |
Retrieves a list of campaign production selections. |
Templates
The templates api controller. Provides REST actions for template entities.
| API | Description |
|---|---|
| GET api/templates/{templateId}/description |
Retrieves the description of a template. |
| GET api/templates/published |
Retrieves a list of published templates. |
| POST api/templates/productCodes |
Retrieves a list of published templates with products matching the given codes. |
| POST api/templates/select |
Retrieves a list of templates that match the given criteria. |
| POST api/templates/selectProgrammatic |
Retrieves a list of templates that match the given criteria. |
| POST api/templates/published |
Retrieves a list of published templates with the given template type. |
| GET api/templates/folder/{folderId} |
Retrieves a list of published templates in a given folder. |
| POST api/templates/folders |
Retrieves a list of published templates in the given folders. |
| GET api/templates/code/{templateCode} |
Retrieves a list of templates with the given code. |
| GET api/templates/workflowDefinitionCode/{workflowDefinitionCode} |
Retrieves a list of templates with the given workflow definition code. |
| GET api/templates/audit/{templateId} |
Retrieves the audit history for a template. |
| GET api/templates/audit/stats |
Retrieves audit stats for all templates. |
| GET api/templates/audit/code/{templateCode} |
Retrieves the audit history for templates with the matching code. |
| GET api/templates/export/{id} |
Exports a template. |
| POST api/templates/import |
Imports a template. |
| POST api/templates/bulkimport |
Bulk imports templates. |
| GET api/templates/preview/{key}/{productId}/{pageNumber} |
Retrieves a preview for a template product. |
| POST api/templates/clone |
Clones a template. |
| PUT api/templates/revert/{id} |
Reverts a template to its previous version. |
| GET api/templates/thumbnail/{templateId} |
Retrieves a template thumbnail. |
| GET api/templates/getuserfavorites/{userId} |
No documentation available. |
| POST api/templates/adduserfavorite |
No documentation available. |
| POST api/templates/removeuserfavorite |
No documentation available. |
| GET api/Templates |
Retrieves a list of templates. |
| GET api/Templates/{id} |
Retrieves a template. |
| POST api/Templates |
Creates a template. |
| PUT api/Templates/{id} |
Updates a template. |
| DELETE api/Templates/{id} |
Deletes a template. |
Variables
The template variables api controller. Provides REST actions for template variables.
| API | Description |
|---|---|
| GET api/variables/template/{templateId} |
Retrieves a list of variables by template. |
| GET api/variables/step/{stepId} |
Retrieves a list of variables by step. |
| POST api/variables/select |
Retrieves a list of variables that match the given criteria. |
| PUT api/variables/sortindices |
Updates variable sort indices. |
| PUT api/variables/list/{updateOldTemplates} |
Updates a list of variables. |
| GET api/Variables/{id} |
Retrieves a variable. |
| POST api/Variables |
Creates a variable. |
| PUT api/Variables/{id} |
Updates a variable. |
| DELETE api/Variables/{id} |
Deletes a variable. |
Steps
The steps api controller. Provides REST
| API | Description |
|---|---|
| GET api/steps/product/{productId} |
Retrieves a list of steps for a product. |
| GET api/steps/template/{templateId} |
Retrieves a list of steps for a template. |
| GET api/Steps/{id} |
Retrieves a step. |
| POST api/Steps |
Creates a step. |
| PUT api/Steps/{id} |
Updates a step. |
| DELETE api/Steps/{id} |
Deletes a step. |
WorkflowDefinitions
The workflow definitions api controller. Provides REST actions for workflow definition entities.
| API | Description |
|---|---|
| GET api/workflowdefinitions/wfdfile/{id} |
Retrieves the wfd file for a workflow definition. |
| GET api/workflowdefinitions/xsdfile/{id} |
Retrieves the xsd file for a workflow definition. |
| GET api/workflowdefinitions/tenant/{tenantId} |
Retrieves a list of workflow definitions for a tenant. |
| GET api/workflowdefinitions/code/{code} |
Retrieves a list of workflow definitions by code. |
| GET api/workflowdefinitions/audit/{workflowDefinitionId} |
Retrieves the audit history for a workflow definition. |
| GET api/workflowdefinitions/export/{id} |
Exports a workflow definition. |
| POST api/workflowdefinitions/import |
Imports a workflow definition. |
| POST api/workflowdefinitions/bulkimport |
Bulk imports workflow definitions. |
| POST api/workflowdefinitions/clone |
Clones a workflow definition. |
| GET api/workflowdefinitions/getwfdfile/{workflowDefinitionId} |
Retrieves the wfd file for a workflow definition. |
| GET api/workflowdefinitions/getxsdfile/{workflowDefinitionId} |
Retrieves the xsd file for a workflow definition. |
| GET api/WorkflowDefinitions |
Retrieves a list of workflow definitions. |
| GET api/WorkflowDefinitions/{id} |
Retrieves a workflow definition. |
| POST api/WorkflowDefinitions |
Creates a workflow definition. |
| PUT api/WorkflowDefinitions/{id} |
Updates a workflow definition. |
| DELETE api/WorkflowDefinitions/{id} |
Deletes a workflow definition. |
Metrics
| API | Description |
|---|---|
| GET metrics |
Retrieves the service metrics. |
Products
The products api controller. Provides REST
| API | Description |
|---|---|
| GET api/products/active/template/{templateId} |
Retrieves a list of active products for a template. |
| GET api/products/template/{templateId} |
Retrieves a list of products for a template. |
| GET api/products/proof/{id} |
Retrieves a proof for a product. |
| GET api/Products/{id} |
Retrieves a product. |
| POST api/Products |
Creates a product. |
| PUT api/Products/{id} |
Updates a product. |
| DELETE api/Products/{id} |
Deletes a product. |