Output Module

Ausgabe Module

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

application/json
get
/cmn/output/reports/{id}

Update existing Resource

put
Path parameters
idinteger · int64Required

an identifier

Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

activebooleanRead-onlyOptional

ist dieser Report aktiv?

Default: true
outputTemplateSourcestring · enumRead-onlyOptional

Report Quellen

Possible values:
systemPresettingbooleanRead-onlyOptional

handelt es sich um den systemreport. Bei diesem darf die selektion nicht verändert werden

moduleRuleobjectOptional

Search-Dialog

labelstring · max: 255Required

Label

descriptionstringOptional

description

aliasstringOptional

Alias Name für die Subreporte

exportFilenamestringOptional

Vorgabe für den Dateinamen

reportUrlstringRead-onlyOptional

die vario-report-url

reportParameterobjectOptional

Search-Dialog

templateFactoryConfigurationobjectOptional

Search-Dialog

Responses
chevron-right
200

successful operation

application/json
put
/cmn/output/reports/{id}

Delete an existing Resource

delete
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

application/json
delete
/cmn/output/reports/{id}
get
Path parameters
idinteger · int64Required

report identifier

Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/reports/{id}/template-configuration
200

OK

put
Path parameters
idinteger · int64Required

report identifier

Body
stringOptional
Responses
chevron-right
200

OK

No content

put
/cmn/output/reports/{id}/template-configuration
200

OK

No content

get
Path parameters
idinteger · int64Required

report identifier

Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/reports/{id}/parameter
200

OK

put
Path parameters
idinteger · int64Required

report identifier

Body
stringOptional
Responses
chevron-right
200

OK

No content

put
/cmn/output/reports/{id}/parameter
200

OK

No content

deaktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
chevron-right
200

successful operation

application/json
put
/cmn/output/reports/{id}/deactivate

aktiviert eine bestehende Resource

put
Path parameters
idinteger · int64Required

identifier

Responses
chevron-right
200

successful operation

application/json
put
/cmn/output/reports/{id}/activate

Update Localisation

put
Path parameters
moduleKeystringRequired
idinteger · int64Required
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringOptional

Der Key zum finden der Übersetzung. dieser Key darf nur bei Einträgen verändert werden, die keinen preset Text haben

presetTextstringRead-onlyOptional

original text (Sprache: vario)

presetParameterstring[]Read-onlyOptional

mögliche parameter bei dem ausdruck

textstringOptional

lokalisierte variante

Responses
chevron-right
200

OK

application/json
put
/cmn/output/modules/{moduleKey}/texts/{id}
200

OK

Deletes translation by id

delete
Path parameters
moduleKeystringRequired
idinteger · int64Required
Responses
chevron-right
200

OK

No content

delete
/cmn/output/modules/{moduleKey}/texts/{id}
200

OK

No content

get

liest eine Gruppe

Path parameters
moduleKeystringRequired
idinteger · int64Required
Responses
chevron-right
200

OK

application/json
get
/cmn/output/modules/{moduleKey}/report-groups/{id}
200

OK

put

aktualisiert eine Gruppe

Path parameters
moduleKeystringRequired
idinteger · int64Required
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

moduleKeystringRead-onlyOptional

der ModuleKey des Reports

systemPresettingbooleanRead-onlyOptional

handelt es sich um eine System-Gruppe? diese kann nicht gelöscht werden

defaultGroupbooleanRead-onlyOptional

ist das die default Gruppe für dieses OutputModul

labelstringRequired

custom label

identifierstringRequired

Identifier für die Gruppe

exportFilenamestringOptional

Vorgabe für den Dateinamen, falls der Report keinen selbst bestimmt

outputFilterScriptstringOptional

output-filter-script (if supported)

Responses
chevron-right
200

OK

application/json
put
/cmn/output/modules/{moduleKey}/report-groups/{id}
200

OK

delete

löscht diese Gruppe

Path parameters
moduleKeystringRequired
idinteger · int64Required
Responses
chevron-right
200

OK

application/json
delete
/cmn/output/modules/{moduleKey}/report-groups/{id}
200

OK

put

diese Gruppe wird für das Modul die Standardgruppe (falls kein Identifier angegeben wird)

Path parameters
moduleKeystringRequired
idinteger · int64Required
Responses
chevron-right
200

OK

application/json
put
/cmn/output/modules/{moduleKey}/report-groups/{id}/default-group
200

OK

Create new Resource

post
Body
copyFromIdinteger · int64Optional

kopie: die Id des Reports, der kopiert werden soll. Wenn dieser Wert gesetzt ist, wird outputModuleKey ignoriert

toGroupIdinteger · int64Optional

kopie/neuanlage: die Gruppe, in die der Report als neuer Report angelegt wird

outputModuleKeystringOptional

neuanlage: der modul key

reportTypeIdinteger · int64Optional

neuanlage: welcher Reporttyp liegt vor

labelstringOptional

Bezeichnung des neuen Reports

aliasstringOptional

Alias des neuen Reports

Responses
chevron-right
200

successful operation

application/json
post
/cmn/output/reports
post
Path parameters
idinteger · int64Required

report identifier

Responses
chevron-right
200

OK

No content

post
/cmn/output/reports/{id}/reset
200

OK

No content

Find all by module key and isoalpha2

get
Path parameters
moduleKeystringRequired
Query parameters
languageIdinteger · int64Optional
Responses
chevron-right
200

OK

application/json
get
/cmn/output/modules/{moduleKey}/texts
200

OK

Create translation

post
Path parameters
moduleKeystringRequired
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

keystringOptional

Der Key zum finden der Übersetzung. dieser Key darf nur bei Einträgen verändert werden, die keinen preset Text haben

presetTextstringRead-onlyOptional

original text (Sprache: vario)

presetParameterstring[]Read-onlyOptional

mögliche parameter bei dem ausdruck

textstringOptional

lokalisierte variante

Responses
chevron-right
200

OK

application/json
post
/cmn/output/modules/{moduleKey}/texts
200

OK

post

erstellt eine Gruppe

Path parameters
moduleKeystringRequired
Body
versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

moduleKeystringRead-onlyOptional

der ModuleKey des Reports

systemPresettingbooleanRead-onlyOptional

handelt es sich um eine System-Gruppe? diese kann nicht gelöscht werden

defaultGroupbooleanRead-onlyOptional

ist das die default Gruppe für dieses OutputModul

labelstringRequired

custom label

identifierstringRequired

Identifier für die Gruppe

exportFilenamestringOptional

Vorgabe für den Dateinamen, falls der Report keinen selbst bestimmt

outputFilterScriptstringOptional

output-filter-script (if supported)

Responses
chevron-right
200

OK

application/json
post
/cmn/output/modules/{moduleKey}/report-groups
200

OK

get
Responses
chevron-right
200

OK

application/json
get
/cmn/output/subscription
200

OK

get
Path parameters
idinteger · int64Required

report identifier

Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/reports/{id}/template-configuration-meta
200

OK

get
Path parameters
idinteger · int64Required

report identifier

Responses
chevron-right
200

OK

application/json
get
/cmn/output/reports/{id}/resource
200

OK

get
Path parameters
aliasstringRequired

report identifier

Responses
chevron-right
200

OK

application/json
get
/cmn/output/reports/{alias}/by-resource-alias
200

OK

Find an existing Resource by identifier

get
Path parameters
idinteger · int64Required

an identifier

Responses
chevron-right
200

successful operation

application/json
get
/cmn/output/report-types/{id}
get
Responses
chevron-right
200

OK

application/json
get
/cmn/output/modules
200

OK

get

liefert die Parameter um das Template zu bauen

Path parameters
moduleKeystringRequired
Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/modules/{moduleKey}/template-factory-meta
200

OK

get

liefert die Regel-Struktur des Reports/Ausgabe

Path parameters
moduleKeystringRequired
Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/modules/{moduleKey}/rule-meta
200

OK

get

liefert die Report-Parameter, die für das Layout gebraucht werden

Path parameters
moduleKeystringRequired
Responses
chevron-right
200

OK

application/json
get
/cmn/output/modules/{moduleKey}/parameter-value
200

OK

get

liefert die Parameter-Struktur des Reports

Path parameters
moduleKeystringRequired
Responses
chevron-right
200

OK

application/json
Responsestring
get
/cmn/output/modules/{moduleKey}/parameter-meta
200

OK

Last updated

Was this helpful?