Output Consumer

Ausgabe-Systeme

put

Path parameters

idinteger · int64Required

ID des Printservers

Body

stringOptional

Responses

200

OK

No content

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

PUT /api/cmn/output/consumer/{id}/rule-value HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

200

OK

No content

put

Path parameters

idinteger · int64Required

ID des Printservers

Responses

200

OK

No content

put/cmn/output/consumer/{id}/request-refresh

PUT /api/cmn/output/consumer/{id}/request-refresh HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

200

OK

No content

put

Path parameters

idinteger · int64Required

ID des Printservers

Responses

200

OK

No content

put/cmn/output/consumer/{id}/heart-beat

PUT /api/cmn/output/consumer/{id}/heart-beat HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

200

OK

No content

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/output/consumer/{id}/deactivate

PUT /api/cmn/output/consumer/{id}/deactivate HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/output/consumer/{id}/activate

PUT /api/cmn/output/consumer/{id}/activate HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

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)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

404

Resource with given ID was not found

application/json

get/cmn/output/consumer/{id}

GET /api/cmn/output/consumer/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put/cmn/output/consumer/{id}

PUT /api/cmn/output/consumer/{id} HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "version": "text",
  "info": {},
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

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/{id}

DELETE /api/cmn/output/consumer/{id} HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

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

post

Path parameters

idinteger · int64Required

ID des Printservers

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

resourceIdstringRead-onlyOptional

resource id to be printed

filenamestringRead-onlyOptional

filename

subjectstringRead-onlyOptional

short subject

fromAddressstringRead-onlyOptional

(mail) from address

fromNamestring · max: 255Read-onlyOptional

(mail) from name

attachmentReferencesstring[]Read-onlyOptional

(mail) additional file references

statestring · enumRead-onlyOptional

state of the printing task

Possible values:

processingResultstringRead-onlyOptional

Prozessierungs-Ergebnis (für Log)

successfulAttemptsinteger · int64Read-onlyOptional

successfulAttempts

failedAttemptsinteger · int64Read-onlyOptional

failedAttempts

ruleResultanyOptional

Search-Dialog

importancestring · enumRead-onlyOptional

Wichtigkeit/Dringlichkeit

Possible values:

outputQuantityinteger · int32 · min: 1Optional

Anzahl der Ausgabe

post/cmn/output/consumer/{id}/request-next

POST /api/cmn/output/consumer/{id}/request-next HTTP/1.1
Host: 10.102.24.197:32795
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "resourceId": "text",
  "filename": "text",
  "subject": "text",
  "outputConsumerRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "outputTypeRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "fromAddress": "text",
  "fromName": "text",
  "destinations": [],
  "messages": [],
  "attachmentReferences": [
    "text"
  ],
  "state": "REQUESTED",
  "processingResult": "text",
  "fromUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "successfulAttempts": 1,
  "failedAttempts": 1,
  "ruleResult": null,
  "importance": "LOW",
  "outputQuantity": 1
}

Create new Resource

post

Body

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

Responses

200

successful operation

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idinteger · int64Read-onlyOptional

id

labelstring · max: 255Required

label of the print server

descriptionstring · max: 2048Optional

description of the print server

pushModestring · enumRequired

push mode for this consumer

Possible values:

systemPresettingbooleanRead-onlyOptional

system einstellung

Default: false

activebooleanRead-onlyOptional

Aktiv?

Default: true

lastSeenAtstring · date-timeRead-onlyOptional

last seen at

ruleValueanyOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

422

Resource was not valid to process

application/json

post/cmn/output/consumer

POST /api/cmn/output/consumer HTTP/1.1
Host: 10.102.24.197:32795
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "version": "text",
  "info": {},
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-01-01T00:00:00.000Z",
    "createdFrom": "text",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-01-01T00:00:00.000Z",
  "ruleValue": null,
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}