> For the complete documentation index, see [llms.txt](https://developer.vario-software.de/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.vario-software.de/api-reference/output-module.md).

# Output Module

Manage VARIO Cloud output modules via API, including reports, localizations, report groups, templates, parameters, activation and printing.

Output Modules API.

## GET /cmn/output/reports/{id}

> Find an existing Resource by identifier

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}":{"get":{"tags":["Output-Module"],"summary":"Find an existing Resource by identifier","operationId":"getById_130","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is this report active?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reportTypeRef":{"$ref":"#/components/schemas/common-output-OutputReport.ReportTypeReference"},"outputTemplateSource":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"],"readOnly":true},"textTemplates":{"type":"array","description":"Text as a ReportTemplate (messages).","items":{"$ref":"#/components/schemas/common-output-OutputTextTemplate"}},"languages":{"type":"array","description":"Languages selected for this report.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"systemPresetting":{"type":"boolean","description":"Is this the system report? Its selection must not be changed.","readOnly":true},"moduleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"description"},"alias":{"type":"string","description":"Alias name for the sub-reports."},"copied":{"type":"boolean","description":"Indicates whether this is a copy of another report.","readOnly":true},"exportFilename":{"type":"string","description":"Preset for the file name."},"reportUrl":{"type":"string","description":"VARIO report URL.","readOnly":true},"reportParameter":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"templateFactoryConfiguration":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputReport.ReportTypeReference":{"description":"Report type.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"templateEngine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true}},"required":["id"]},"common-output-OutputTextTemplate":{"description":"Text as a ReportTemplate (messages).","properties":{"contentType":{"type":"string","description":"Format","enum":["TEXT","HTML"]},"subjectTemplate":{"type":"string","description":"Template part for the subject."},"bodyTemplate":{"type":"string","description":"Template part for the body."}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## PUT /cmn/output/reports/{id}

> Update existing Resource&#x20;

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}":{"put":{"tags":["Output-Module"],"summary":"Update existing Resource ","operationId":"update_134","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is this report active?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reportTypeRef":{"$ref":"#/components/schemas/common-output-OutputReport.ReportTypeReference"},"outputTemplateSource":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"],"readOnly":true},"textTemplates":{"type":"array","description":"Text as a ReportTemplate (messages).","items":{"$ref":"#/components/schemas/common-output-OutputTextTemplate"}},"languages":{"type":"array","description":"Languages selected for this report.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"systemPresetting":{"type":"boolean","description":"Is this the system report? Its selection must not be changed.","readOnly":true},"moduleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"description"},"alias":{"type":"string","description":"Alias name for the sub-reports."},"copied":{"type":"boolean","description":"Indicates whether this is a copy of another report.","readOnly":true},"exportFilename":{"type":"string","description":"Preset for the file name."},"reportUrl":{"type":"string","description":"VARIO report URL.","readOnly":true},"reportParameter":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"templateFactoryConfiguration":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputReport.ReportTypeReference":{"description":"Report type.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"templateEngine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true}},"required":["id"]},"common-output-OutputTextTemplate":{"description":"Text as a ReportTemplate (messages).","properties":{"contentType":{"type":"string","description":"Format","enum":["TEXT","HTML"]},"subjectTemplate":{"type":"string","description":"Template part for the subject."},"bodyTemplate":{"type":"string","description":"Template part for the body."}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## DELETE /cmn/output/reports/{id}

> Delete an existing Resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}":{"delete":{"tags":["Output-Module"],"summary":"Delete an existing Resource","operationId":"delete_121","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"409":{"description":"unable to delete Resource, due to constraints, existing references or internal state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-api-OperationMessage"}}}}}}}},"components":{"schemas":{"core-api-OperationMessage":{"properties":{"context":{"type":"string","description":"message context"},"messageValue":{"type":"string","description":" message"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## PUT /cmn/output/reports/{id}/deactivate

> Deactivate an existing resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/deactivate":{"put":{"tags":["Output-Module"],"summary":"Deactivate an existing resource","operationId":"deactivate_63","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is this report active?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reportTypeRef":{"$ref":"#/components/schemas/common-output-OutputReport.ReportTypeReference"},"outputTemplateSource":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"],"readOnly":true},"textTemplates":{"type":"array","description":"Text as a ReportTemplate (messages).","items":{"$ref":"#/components/schemas/common-output-OutputTextTemplate"}},"languages":{"type":"array","description":"Languages selected for this report.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"systemPresetting":{"type":"boolean","description":"Is this the system report? Its selection must not be changed.","readOnly":true},"moduleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"description"},"alias":{"type":"string","description":"Alias name for the sub-reports."},"copied":{"type":"boolean","description":"Indicates whether this is a copy of another report.","readOnly":true},"exportFilename":{"type":"string","description":"Preset for the file name."},"reportUrl":{"type":"string","description":"VARIO report URL.","readOnly":true},"reportParameter":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"templateFactoryConfiguration":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputReport.ReportTypeReference":{"description":"Report type.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"templateEngine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true}},"required":["id"]},"common-output-OutputTextTemplate":{"description":"Text as a ReportTemplate (messages).","properties":{"contentType":{"type":"string","description":"Format","enum":["TEXT","HTML"]},"subjectTemplate":{"type":"string","description":"Template part for the subject."},"bodyTemplate":{"type":"string","description":"Template part for the body."}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## PUT /cmn/output/reports/{id}/activate

> Activate an existing resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/activate":{"put":{"tags":["Output-Module"],"summary":"Activate an existing resource","operationId":"activate_63","parameters":[{"name":"id","in":"path","description":"identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}}},"404":{"description":"Resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is this report active?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reportTypeRef":{"$ref":"#/components/schemas/common-output-OutputReport.ReportTypeReference"},"outputTemplateSource":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"],"readOnly":true},"textTemplates":{"type":"array","description":"Text as a ReportTemplate (messages).","items":{"$ref":"#/components/schemas/common-output-OutputTextTemplate"}},"languages":{"type":"array","description":"Languages selected for this report.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"systemPresetting":{"type":"boolean","description":"Is this the system report? Its selection must not be changed.","readOnly":true},"moduleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"description"},"alias":{"type":"string","description":"Alias name for the sub-reports."},"copied":{"type":"boolean","description":"Indicates whether this is a copy of another report.","readOnly":true},"exportFilename":{"type":"string","description":"Preset for the file name."},"reportUrl":{"type":"string","description":"VARIO report URL.","readOnly":true},"reportParameter":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"templateFactoryConfiguration":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputReport.ReportTypeReference":{"description":"Report type.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"templateEngine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true}},"required":["id"]},"common-output-OutputTextTemplate":{"description":"Text as a ReportTemplate (messages).","properties":{"contentType":{"type":"string","description":"Format","enum":["TEXT","HTML"]},"subjectTemplate":{"type":"string","description":"Template part for the subject."},"bodyTemplate":{"type":"string","description":"Template part for the body."}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## PUT /cmn/output/modules/{moduleKey}/texts/{id}

> Update Localisation

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/texts/{id}":{"put":{"tags":["Output-Module"],"summary":"Update Localisation","operationId":"update_135","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportLocalizedText"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportLocalizedText"}}}}}}}},"components":{"schemas":{"common-output-OutputReportLocalizedText":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"Key for finding the translation; this key may only be changed for entries that have no preset text."},"presetText":{"type":"string","description":"Original text (language: vario).","readOnly":true},"presetParameter":{"type":"array","description":"Possible printout parameters.","items":{"type":"string","description":"Possible printout parameters."},"readOnly":true},"text":{"type":"string","description":"Localized variant."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/output/modules/{moduleKey}/texts/{id}

> Deletes translation by id

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/texts/{id}":{"delete":{"tags":["Output-Module"],"summary":"Deletes translation by id","operationId":"deleteTranslation","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/script

> Returns the script of an output module

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/script":{"get":{"tags":["Output-Module"],"description":"Returns the script of an output module","operationId":"getModuleScript","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputModuleScript"}}}}}}}},"components":{"schemas":{"common-output-OutputModuleScript":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Key of the output module","readOnly":true},"label":{"type":"string","description":"Label of this script","minLength":1},"script":{"$ref":"#/components/schemas/common-scripting-Script"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-scripting-Script":{"description":"Script","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleName":{"type":"string","description":"Script module name.","minLength":1},"scriptSource":{"type":"string","description":"Script to execute.","maxLength":2147483647,"minLength":0},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["moduleName"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/output/modules/{moduleKey}/script

> Creates or changes the script of an output module

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/script":{"put":{"tags":["Output-Module"],"description":"Creates or changes the script of an output module","operationId":"setModuleScript","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputModuleScript"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputModuleScript"}}}}}}}},"components":{"schemas":{"common-output-OutputModuleScript":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Key of the output module","readOnly":true},"label":{"type":"string","description":"Label of this script","minLength":1},"script":{"$ref":"#/components/schemas/common-scripting-Script"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"common-scripting-Script":{"description":"Script","properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleName":{"type":"string","description":"Script module name.","minLength":1},"scriptSource":{"type":"string","description":"Script to execute.","maxLength":2147483647,"minLength":0},"scriptModuleRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"required":["moduleName"]},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/output/modules/{moduleKey}/script

> Removes the script of an output module

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/script":{"delete":{"tags":["Output-Module"],"description":"Removes the script of an output module","operationId":"deleteModuleScript","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/report-groups/{id}

> Reads a group.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/report-groups/{id}":{"get":{"tags":["Output-Module"],"description":"Reads a group.","operationId":"getReportGroup","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}}}}}}},"components":{"schemas":{"common-output-OutputReportGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Report ModuleKey.","readOnly":true},"reportRefs":{"type":"array","description":"Reports.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"systemPresetting":{"type":"boolean","description":"Is this a system group? It cannot be deleted.","readOnly":true},"defaultGroup":{"type":"boolean","description":"Is this the OutputModule's default group?","readOnly":true},"freePrinting":{"type":"boolean","default":false,"description":"Are the group reports freely accessible?"},"label":{"type":"string","description":"custom label","minLength":1},"identifier":{"type":"string","description":"Group identifier.","minLength":1},"exportFilename":{"type":"string","description":"Preset for the file name when the report does not determine one itself."},"outputFilterScript":{"type":"string","description":"output-filter-script (if supported)"}},"required":["identifier","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/output/modules/{moduleKey}/report-groups/{id}

> Updates a group.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/report-groups/{id}":{"put":{"tags":["Output-Module"],"description":"Updates a group.","operationId":"updateReportGroup","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}}}}}}},"components":{"schemas":{"common-output-OutputReportGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Report ModuleKey.","readOnly":true},"reportRefs":{"type":"array","description":"Reports.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"systemPresetting":{"type":"boolean","description":"Is this a system group? It cannot be deleted.","readOnly":true},"defaultGroup":{"type":"boolean","description":"Is this the OutputModule's default group?","readOnly":true},"freePrinting":{"type":"boolean","default":false,"description":"Are the group reports freely accessible?"},"label":{"type":"string","description":"custom label","minLength":1},"identifier":{"type":"string","description":"Group identifier.","minLength":1},"exportFilename":{"type":"string","description":"Preset for the file name when the report does not determine one itself."},"outputFilterScript":{"type":"string","description":"output-filter-script (if supported)"}},"required":["identifier","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## DELETE /cmn/output/modules/{moduleKey}/report-groups/{id}

> Deletes this group.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/report-groups/{id}":{"delete":{"tags":["Output-Module"],"description":"Deletes this group.","operationId":"deleteReportGroup","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}}}}}}},"components":{"schemas":{"common-output-OutputReportGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Report ModuleKey.","readOnly":true},"reportRefs":{"type":"array","description":"Reports.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"systemPresetting":{"type":"boolean","description":"Is this a system group? It cannot be deleted.","readOnly":true},"defaultGroup":{"type":"boolean","description":"Is this the OutputModule's default group?","readOnly":true},"freePrinting":{"type":"boolean","default":false,"description":"Are the group reports freely accessible?"},"label":{"type":"string","description":"custom label","minLength":1},"identifier":{"type":"string","description":"Group identifier.","minLength":1},"exportFilename":{"type":"string","description":"Preset for the file name when the report does not determine one itself."},"outputFilterScript":{"type":"string","description":"output-filter-script (if supported)"}},"required":["identifier","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## PUT /cmn/output/modules/{moduleKey}/report-groups/{id}/default-group

> This group becomes the module's default group (when no identifier is given).

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/report-groups/{id}/default-group":{"put":{"tags":["Output-Module"],"description":"This group becomes the module's default group (when no identifier is given).","operationId":"setReportGroupDefault","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}}}}}}},"components":{"schemas":{"common-output-OutputReportGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Report ModuleKey.","readOnly":true},"reportRefs":{"type":"array","description":"Reports.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"systemPresetting":{"type":"boolean","description":"Is this a system group? It cannot be deleted.","readOnly":true},"defaultGroup":{"type":"boolean","description":"Is this the OutputModule's default group?","readOnly":true},"freePrinting":{"type":"boolean","default":false,"description":"Are the group reports freely accessible?"},"label":{"type":"string","description":"custom label","minLength":1},"identifier":{"type":"string","description":"Group identifier.","minLength":1},"exportFilename":{"type":"string","description":"Preset for the file name when the report does not determine one itself."},"outputFilterScript":{"type":"string","description":"output-filter-script (if supported)"}},"required":["identifier","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/output/reports

> Create new Resource

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports":{"post":{"tags":["Output-Module"],"summary":"Create new Resource","operationId":"create_124","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportCreateRequest"}}},"required":true},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReport"}}}},"422":{"description":"Resource was not valid to process","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReportCreateRequest":{"properties":{"copyFromId":{"type":"integer","format":"int64","description":"Copy: the identifier of the report to copy. When this value is set, outputModuleKey is ignored."},"fullCopy":{"type":"boolean","description":"Create full copy including the report file"},"toGroupId":{"type":"integer","format":"int64","description":"Copy or new creation: the group the report is created in as a new report."},"outputModuleKey":{"type":"string","description":"New creation: the module key."},"reportTypeId":{"type":"integer","format":"int64","description":"New creation: which report type this is."},"label":{"type":"string","description":"New report label."},"alias":{"type":"string","description":"New report alias."}}},"common-output-OutputReport":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"active":{"type":"boolean","default":true,"description":"Is this report active?","readOnly":true},"groupRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"reportTypeRef":{"$ref":"#/components/schemas/common-output-OutputReport.ReportTypeReference"},"outputTemplateSource":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"],"readOnly":true},"textTemplates":{"type":"array","description":"Text as a ReportTemplate (messages).","items":{"$ref":"#/components/schemas/common-output-OutputTextTemplate"}},"languages":{"type":"array","description":"Languages selected for this report.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"}},"systemPresetting":{"type":"boolean","description":"Is this the system report? Its selection must not be changed.","readOnly":true},"moduleRule":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"label":{"type":"string","description":"Label.","maxLength":255,"minLength":0},"description":{"type":"string","description":"description"},"alias":{"type":"string","description":"Alias name for the sub-reports."},"copied":{"type":"boolean","description":"Indicates whether this is a copy of another report.","readOnly":true},"exportFilename":{"type":"string","description":"Preset for the file name."},"reportUrl":{"type":"string","description":"VARIO report URL.","readOnly":true},"reportParameter":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"templateFactoryConfiguration":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"required":["label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"common-output-OutputReport.ReportTypeReference":{"description":"Report type.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true},"templateEngine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true}},"required":["id"]},"common-output-OutputTextTemplate":{"description":"Text as a ReportTemplate (messages).","properties":{"contentType":{"type":"string","description":"Format","enum":["TEXT","HTML"]},"subjectTemplate":{"type":"string","description":"Template part for the subject."},"bodyTemplate":{"type":"string","description":"Template part for the body."}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}}}}}
```

## POST /cmn/output/reports/{id}/reset

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/reset":{"post":{"tags":["Output-Module"],"operationId":"postReset","parameters":[{"name":"id","in":"path","description":"report identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK"}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/texts

> Find all by module key and isoalpha2

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/texts":{"get":{"tags":["Output-Module"],"summary":"Find all by module key and isoalpha2","operationId":"getAllTranslations","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"languageId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-output-OutputReportLocalizedText"}}}}}}}}},"components":{"schemas":{"common-output-OutputReportLocalizedText":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"Key for finding the translation; this key may only be changed for entries that have no preset text."},"presetText":{"type":"string","description":"Original text (language: vario).","readOnly":true},"presetParameter":{"type":"array","description":"Possible printout parameters.","items":{"type":"string","description":"Possible printout parameters."},"readOnly":true},"text":{"type":"string","description":"Localized variant."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/output/modules/{moduleKey}/texts

> Create translation

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/texts":{"post":{"tags":["Output-Module"],"summary":"Create translation","operationId":"createTranslation","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportLocalizedText"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportLocalizedText"}}}}}}}},"components":{"schemas":{"common-output-OutputReportLocalizedText":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"languageRef":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"key":{"type":"string","description":"Key for finding the translation; this key may only be changed for entries that have no preset text."},"presetText":{"type":"string","description":"Original text (language: vario).","readOnly":true},"presetParameter":{"type":"array","description":"Possible printout parameters.","items":{"type":"string","description":"Possible printout parameters."},"readOnly":true},"text":{"type":"string","description":"Localized variant."}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/output/modules/{moduleKey}/report-groups

> Creates a group.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/report-groups":{"post":{"tags":["Output-Module"],"description":"Creates a group.","operationId":"createReportGroup","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportGroup"}}}}}}}},"components":{"schemas":{"common-output-OutputReportGroup":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"moduleKey":{"type":"string","description":"Report ModuleKey.","readOnly":true},"reportRefs":{"type":"array","description":"Reports.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"systemPresetting":{"type":"boolean","description":"Is this a system group? It cannot be deleted.","readOnly":true},"defaultGroup":{"type":"boolean","description":"Is this the OutputModule's default group?","readOnly":true},"freePrinting":{"type":"boolean","default":false,"description":"Are the group reports freely accessible?"},"label":{"type":"string","description":"custom label","minLength":1},"identifier":{"type":"string","description":"Group identifier.","minLength":1},"exportFilename":{"type":"string","description":"Preset for the file name when the report does not determine one itself."},"outputFilterScript":{"type":"string","description":"output-filter-script (if supported)"}},"required":["identifier","label"]},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## POST /cmn/output/modules/{moduleKey}/print/{masterId}

> General endpoint for printing reports

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/print/{masterId}":{"post":{"tags":["Output-Module"],"summary":"General endpoint for printing reports","operationId":"printReport","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}},{"name":"masterId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object"}}}}}}}},"components":{"schemas":{"common-output-OutputRequest":{"properties":{"exportFormat":{"type":"string","description":"Output format for the mail or file export.","enum":["PDF","XLSX","JSON_RAW","REPORT_TEMPLATE"]},"exportFilename":{"type":"string","description":"File name (without extension) for a file export."},"mailRecipients":{"type":"array","description":"Recipient.","items":{"$ref":"#/components/schemas/common-output-OutputRecipient.MailRecipient"}},"outputType":{"type":"string","description":"outputType"},"groupIdentifier":{"type":"string","description":"OutputReportGroup identifier (optional), otherwise the module default group."},"published":{"type":"boolean","default":false,"description":"Should only documents that are already published be considered?"},"directPrintEnabled":{"type":"boolean","default":true,"description":"Return output directly to the client."}}},"common-output-OutputRecipient.MailRecipient":{"description":"Recipient.","properties":{"type":{"type":"string","description":"(mail) recipient type","enum":["TO","CC","BCC"]},"address":{"type":"string","description":"(mail) recipient address"},"name":{"type":"string","description":"(mail) recipient name"}}}}}}
```

## GET /cmn/output/subscription

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/subscription":{"get":{"tags":["Output-Module"],"operationId":"getPossibleSubscription","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-observer-PossibleSubscription"}}}}}}}}},"components":{"schemas":{"common-observer-PossibleSubscription":{"properties":{"refKey":{"type":"string"},"eventTypes":{"type":"array","items":{"type":"string"}}}}}}}
```

## GET /cmn/output/reports/{id}/template-configuration

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/template-configuration":{"get":{"tags":["Output-Module"],"operationId":"getTemplateConfiguration","parameters":[{"name":"id","in":"path","description":"report identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/reports/{id}/template-configuration-meta

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/template-configuration-meta":{"get":{"tags":["Output-Module"],"operationId":"getTemplateConfigurationMeta","parameters":[{"name":"id","in":"path","description":"report identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/reports/{id}/resource

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/resource":{"get":{"tags":["Output-Module"],"operationId":"getReportTemplateRef","parameters":[{"name":"id","in":"path","description":"report identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-ReportTemplateResponse"}}}}}}}},"components":{"schemas":{"common-output-ReportTemplateResponse":{"properties":{"id":{"type":"integer","format":"int64","description":"Resource identifier in the DMS.","readOnly":true},"description":{"type":"string","description":"Description.","readOnly":true},"filename":{"type":"string","description":"File name.","readOnly":true}}}}}}
```

## GET /cmn/output/reports/{id}/parameter

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{id}/parameter":{"get":{"tags":["Output-Module"],"operationId":"getParameter_1","parameters":[{"name":"id","in":"path","description":"report identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/reports/{alias}/by-resource-alias

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/reports/{alias}/by-resource-alias":{"get":{"tags":["Output-Module"],"operationId":"getReportTemplateRef_1","parameters":[{"name":"alias","in":"path","description":"report identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-ReportTemplateResponse"}}}}}}}},"components":{"schemas":{"common-output-ReportTemplateResponse":{"properties":{"id":{"type":"integer","format":"int64","description":"Resource identifier in the DMS.","readOnly":true},"description":{"type":"string","description":"Description.","readOnly":true},"filename":{"type":"string","description":"File name.","readOnly":true}}}}}}
```

## GET /cmn/output/report-types/{id}

> Find an existing Resource by identifier

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/report-types/{id}":{"get":{"tags":["Output-Module"],"summary":"Find an existing Resource by identifier","operationId":"getById_162","parameters":[{"name":"id","in":"path","description":"an identifier","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/common-output-OutputReportType"}}}},"404":{"description":"Resource with given ID was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/core-error-ApiError"}}}}}}}},"components":{"schemas":{"common-output-OutputReportType":{"properties":{"version":{"type":"string","description":"Version Identifier for this Object (for PUT)"},"info":{"$ref":"#/components/schemas/core-api-MetaInfo"},"id":{"type":"string","description":"Unique identifier of the Object"},"outputTypes":{"type":"array","description":"Output types for this ReportType.","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"engine":{"type":"string","description":"Print technologies.","enum":["VQL_REPORTS","TEXT_ONLY"],"readOnly":true},"systemPresetting":{"type":"boolean","description":"Print technology used.","readOnly":true},"label":{"type":"string","description":"Short label.","readOnly":true}}},"core-api-MetaInfo":{"description":"MetaInformations for this Object","properties":{"createdAt":{"type":"string","format":"date-time","description":"Created At Timestamp","readOnly":true},"createdFrom":{"type":"string","description":"TenantUser-Identifier of the creator","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"Last Updated AT Timestamp","readOnly":true},"updatedFrom":{"type":"string","description":"TenantUser-Identifier of most recent updater","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]},"core-error-ApiError":{"properties":{"instance":{"type":"string","description":"the resource that produced the error","readOnly":true},"trackingId":{"type":"string","description":"Internal tracking number for this Error","readOnly":true},"timeOfOccurence":{"type":"string","format":"date-time","description":"Internal timestamp, when this error happened","readOnly":true},"errors":{"$ref":"#/components/schemas/core-error-ApiError.Errors"},"decisions":{"type":"array","description":"all decisions, we need to take care of","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision"},"readOnly":true,"uniqueItems":true},"httpStatus":{"type":"integer","format":"int32","description":"HTTP-Status code"},"debug-info-url":{"type":"string","format":"uri","description":"optional url to get a more detailed stack trace","readOnly":true}},"required":["decisions","errors","instance","timeOfOccurence","trackingId"]},"core-error-ApiError.Errors":{"description":"all occured errors","properties":{"fieldErrors":{"type":"object","additionalProperties":{"type":"array","description":"One or more validation errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true},"description":"One or more validation errors","readOnly":true},"services":{"type":"array","description":"One or more generel service errors","items":{"$ref":"#/components/schemas/core-error-ApiErrorDetail"},"readOnly":true,"uniqueItems":true}},"readOnly":true,"required":["fieldErrors","services"]},"core-error-ApiErrorDetail":{"description":"One or more generel service errors","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"property":{"type":"string","description":"property that has a constraint violation  (optional)"}},"readOnly":true},"core-api-LocalizeableMessage":{"description":"localizeable message","properties":{"messageCode":{"type":"string","description":"Internal unique identifier/key for this message"},"messageParameters":{"type":"object","additionalProperties":{"type":"object","description":"list of parameters to fill a formattable message"},"description":"list of parameters to fill a formattable message"},"formattedMessage":{"type":"string","description":"formatted message (default language)"}}},"core-error-ApiErrorDecision":{"description":"all decisions, we need to take care of","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"title":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"multipleAnswersAllowed":{"type":"boolean","default":false,"description":"true, if an array of answers is required","readOnly":true},"textInput":{"type":"boolean","default":false,"description":"true, if text input instead of decisions is required","readOnly":true},"options":{"type":"array","description":"possible options for this decision","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOption"},"readOnly":true},"answerProperty":{"type":"string","description":"property to fill the decision into","readOnly":true},"answerPropertyType":{"type":"string","description":"type of the target property","enum":["FIELD","PARAMETER"],"readOnly":true},"searchDialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"}},"readOnly":true},"core-error-ApiErrorDecision.DecisionOption":{"description":"possible options for this decision","properties":{"message":{"$ref":"#/components/schemas/core-api-LocalizeableMessage"},"value":{"type":"string","description":"value for this decision","readOnly":true},"defaultOption":{"type":"boolean","default":false,"description":"default option","readOnly":true},"searchDialogs":{"type":"array","description":"Search dialogs to use.","items":{"$ref":"#/components/schemas/core-error-ApiErrorDecision.DecisionOptionSearchDialog"},"readOnly":true}}},"core-error-ApiErrorDecision.DecisionOptionSearchDialog":{"description":"Search dialogs to use.","properties":{"dialog":{"$ref":"#/components/schemas/unknownservice-unknownmodule-JsonNode"},"answerKey":{"type":"string","description":"Key for the search dialog result.","readOnly":true}}},"unknownservice-unknownmodule-JsonNode":{"description":"Search dialog.","properties":{"empty":{"type":"boolean"},"array":{"type":"boolean"},"null":{"type":"boolean"},"object":{"type":"boolean"},"float":{"type":"boolean"},"missingNode":{"type":"boolean"},"valueNode":{"type":"boolean"},"container":{"type":"boolean"},"integralNumber":{"type":"boolean"},"binary":{"type":"boolean"},"nodeType":{"type":"string","enum":["ARRAY","BINARY","BOOLEAN","MISSING","NULL","NUMBER","OBJECT","POJO","STRING"]},"string":{"type":"boolean"},"pojo":{"type":"boolean"},"short":{"type":"boolean"},"int":{"type":"boolean"},"long":{"type":"boolean"},"double":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"textual":{"type":"boolean","deprecated":true},"boolean":{"type":"boolean"},"floatingPointNumber":{"type":"boolean"},"number":{"type":"boolean"},"embeddedValue":{"type":"boolean"}}}}}}
```

## GET /cmn/output/modules

>

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules":{"get":{"tags":["Output-Module"],"operationId":"getModuleInfos","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/common-output-OutputModuleInfo"}}}}}}}}},"components":{"schemas":{"common-output-OutputModuleInfo":{"properties":{"key":{"type":"string","description":"output module key"},"label":{"type":"string","description":"output module label"},"domainIdentifier":{"type":"string","description":"Which domain this OutputModule belongs to (relevant for placeholders and the like).","readOnly":true},"canCreateLayout":{"type":"boolean","default":false,"description":"Is there a way to register new reports for this print?","readOnly":true},"sources":{"type":"array","description":"Which creation modes are supported?","items":{"type":"string","description":"Report sources.","enum":["PARAMETER_MODE","FILE_MODE"]},"readOnly":true},"supportedOutputType":{"type":"array","default":false,"description":"Which output types are supported?","items":{"$ref":"#/components/schemas/core-api-ApiObjectReference"},"readOnly":true},"subreportOnlyModule":{"type":"boolean","default":false,"description":"Does the module only support sub-reports and therefore provide no print implementation of its own?","readOnly":true},"supportOutputFilterScript":{"type":"boolean","default":false,"description":"Does the module support output filter scripts?","readOnly":true},"outputFilterScriptModule":{"type":"string","description":"Script module for output filter scripts.","readOnly":true},"freePrinting":{"type":"boolean","description":"Is this module a free report?","readOnly":true}}},"core-api-ApiObjectReference":{"description":"Parent category.","properties":{"id":{"type":"string","description":"Identifier"},"label":{"type":"string","description":"a label","readOnly":true},"description":{"type":"string","description":"a short description","readOnly":true},"active":{"type":"boolean","description":"Active.","readOnly":true}},"required":["id"]}}}}
```

## GET /cmn/output/modules/{moduleKey}/template-factory-meta

> Returns the parameters for building the template.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/template-factory-meta":{"get":{"tags":["Output-Module"],"description":"Returns the parameters for building the template.","operationId":"getTemplateFactoryMeta","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/rule-meta

> Returns the report or output rule structure.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/rule-meta":{"get":{"tags":["Output-Module"],"description":"Returns the report or output rule structure.","operationId":"getRuleMeta","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/parameter-value

> Returns the report parameters needed for the layout.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/parameter-value":{"get":{"tags":["Output-Module"],"description":"Returns the report parameters needed for the layout.","operationId":"getReportParameter","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{}}}}}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/parameter-meta

> Returns the report parameter structure.

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/parameter-meta":{"get":{"tags":["Output-Module"],"description":"Returns the report parameter structure.","operationId":"getParameterMeta_1","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```

## GET /cmn/output/modules/{moduleKey}/additional-options-meta

> Parameter meta description of the module-specific additional options

```json
{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"2026.42.0"},"tags":[{"name":"Output-Module","description":"Output Modules API."}],"servers":[{"url":"api.example.com"}],"paths":{"/cmn/output/modules/{moduleKey}/additional-options-meta":{"get":{"tags":["Output-Module"],"summary":"Parameter meta description of the module-specific additional options","operationId":"getAdditionalOptionsMeta","parameters":[{"name":"moduleKey","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developer.vario-software.de/api-reference/output-module.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
