Output Rule

Ausgabe-Regeln

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

targetOutputConsumerResultanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

systemPresettingbooleanRead-onlyOptional

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

404

Resource with given ID was not found

application/json

get/cmn/output/consumer-rule/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/output/consumer-rule/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:30:24.365Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:30:24.365Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": null,
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "sourceReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": null,
  "outputQuantity": 1,
  "systemPresetting": true
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

targetOutputConsumerResultanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

systemPresettingbooleanRead-onlyOptional

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

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

targetOutputConsumerResultanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

systemPresettingbooleanRead-onlyOptional

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

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/output/consumer-rule/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/output/consumer-rule/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "version": "text",
  "info": {},
  "id": "text",
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": null,
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "sourceReportGroupRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": null,
  "outputQuantity": 1
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:30:24.365Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:30:24.365Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": null,
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "sourceReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": null,
  "outputQuantity": 1,
  "systemPresetting": true
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

contextstringOptional

message context

messageValuestringOptional

message

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete/cmn/output/consumer-rule/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/output/consumer-rule/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

targetOutputConsumerResultanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

systemPresettingbooleanRead-onlyOptional

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

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

outputModuleRuleanyOptional

Search-Dialog

targetOutputConsumerResultanyOptional

Search-Dialog

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

systemPresettingbooleanRead-onlyOptional

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

422

Resource was not valid to process

application/json

post/cmn/output/consumer-rule

HTTPcURLJavaScriptPython

POST /api/cmn/output/consumer-rule HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 345

{
  "version": "text",
  "info": {},
  "id": "text",
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": null,
  "sourceOutputTypeRef": {
    "id": "text"
  },
  "targetOutputTypeRef": {
    "id": "text"
  },
  "sourceReportGroupRef": {
    "id": "text"
  },
  "targetReportGroupRef": {
    "id": "text"
  },
  "targetOutputConsumerRef": {
    "id": "text"
  },
  "targetOutputConsumerResult": null,
  "outputQuantity": 1
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T00:30:24.365Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T00:30:24.365Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "moduleRef": {
    "key": "text",
    "label": "text"
  },
  "outputModuleRule": null,
  "sourceOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "sourceReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetReportGroupRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "targetOutputConsumerResult": null,
  "outputQuantity": 1,
  "systemPresetting": true
}