try out ↗

← API Index


/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

Name Description Type
msg the message payload (max 65535 chars) string
t optional message topic; defaults to 'No Topic' string
u optional unique message id used for de-duplication; defaults to a hash over payload and topic string
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth 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. int

Error Responses

HTTP Status Error Code Description
403 security no authenticated session (or anonymous user)
400 error neither msg nor t given, or msg exceeds 65535 chars

Response Types

Type Version Description
MsgResult 1 Result of queuing a message for the PCG backend (msgqueue table).

OpenAPI

See msg1.yaml