Output Consumer

Ausgabe-Systeme

put

Path parameters

idinteger · int64Required

ID des Printservers

Body

application/json

stringOptional

Responses

200

OK

No content

put

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

HTTPcURLJavaScriptPython

PUT /api/cmn/output/consumer/{id}/rule-value HTTP/1.1
Host: localhost:53907
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

HTTPcURLJavaScriptPython

PUT /api/cmn/output/consumer/{id}/request-refresh HTTP/1.1
Host: localhost:53907
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

HTTPcURLJavaScriptPython

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

200

OK

No content

deaktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [
    {
      "id": "text",
      "label": "text",
      "description": "text"
    }
  ],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-02-10T15:21:14.022Z",
  "ruleValue": {},
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

aktiviert eine bestehende Resource

put

Path parameters

idinteger · int64Required

identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

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

HTTPcURLJavaScriptPython

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [
    {
      "id": "text",
      "label": "text",
      "description": "text"
    }
  ],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-02-10T15:21:14.022Z",
  "ruleValue": {},
  "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

404

Resource with given ID was not found

application/json

get

/cmn/output/consumer/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/output/consumer/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [
    {
      "id": "text",
      "label": "text",
      "description": "text"
    }
  ],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-02-10T15:21:14.022Z",
  "ruleValue": {},
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

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

ruleValueobjectOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/output/consumer/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/output/consumer/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 197

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [
    {
      "id": "text",
      "label": "text",
      "description": "text"
    }
  ],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-02-10T15:21:14.022Z",
  "ruleValue": {},
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

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}

HTTPcURLJavaScriptPython

DELETE /api/cmn/output/consumer/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

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

post

Path parameters

idinteger · int64Required

ID des Printservers

Responses

200

OK

application/json

post

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

HTTPcURLJavaScriptPython

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

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "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": [
    {
      "contentType": "TEXT",
      "content": "text",
      "subject": "text"
    }
  ],
  "attachmentReferences": [
    "text"
  ],
  "state": "REQUESTED",
  "processingResult": "text",
  "fromUserRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "successfulAttempts": 1,
  "failedAttempts": 1,
  "ruleResult": {},
  "importance": "LOW"
}

Create new Resource

post

Body

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

ruleValueobjectOptional

Search-Dialog

appIdentifierstring · uuidOptional

App-Identifier

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/cmn/output/consumer

HTTPcURLJavaScriptPython

POST /api/cmn/output/consumer HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 197

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

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T15:21:14.022Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T15:21:14.022Z",
    "updatedFrom": "text"
  },
  "id": 1,
  "label": "text",
  "outputTypes": [
    {
      "id": "text",
      "label": "text",
      "description": "text"
    }
  ],
  "description": "text",
  "pushMode": "NONE",
  "systemPresetting": false,
  "active": true,
  "lastSeenAt": "2026-02-10T15:21:14.022Z",
  "ruleValue": {},
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}