/api/system/msg1

Queue a message for the PCG backend. Primarily for tools within the PCG ecosystem: the message is stored in an internal queue table and picked up by the backend.

Change Note: dedicated endpoint using POJO pattern, replaces exec2.jsp dispatch

Parameters

(string) the message payload (max 65535 chars)
(string) optional message topic; defaults to 'No Topic'
(string) optional unique message id used for de-duplication; defaults to a hash over payload and topic
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Error Responses

HTTP StatusError CodeDescription
403securityno authenticated session (or anonymous user)
400errorneither msg nor t given, or msg exceeds 65535 chars

Response Types

MsgResult

MsgResult (v1) docs

Result of queuing a message for the PCG backend (msgqueue table).

Fields (4)
#FieldTypeDescription
0actionstringthe action that was performed
1resultstringexit code: ok (message queued), duplicate (a message with the same unique id was already queued - nothing was written)
2openintnumber of messages currently waiting in the queue (not yet processed by the backend)
3laststringunique id of the most recently processed message, empty if none was processed yet

Data (1 record)

actionresultopenlast
Msgsecurity0