apps/wbflex/documents/{id}/log (POST)

Appends a custom message to the log. Normally, logs are populated with each push operation. In certain integration scenarios you may want to add additional log entries.

Deprecated

This method is replaced by apps/wbflex/transactions/{id}/event (POST)


URL

(POST) /api/apps/wbflex/documents/{id}/log

PARAMETERS

URL parameters are:

id

Specify either a document ID (such as 1000) or a job ID (such as c300).

int, Mandatory


The body is a JSON object with these properties:

messages

A JSON array with 1 or more messages.

Note: Characters \n and \r are removed. For multi-line messages, add each line as separate array element:

"messages": ["This is my first line.", "May second line"],

string[], Mandatory

successIndicate if the event refers to a success or a failure. This helps to understand the purpose of the event

bool, Mandatory

originOptional string. Permits to specify who or what initiated or sent the message. For information purposes only.

string?, Optional


RESULTS

The method returns no result.


EXAMPLES

(POST) /api/apps/wbflex/documents/111/log
BODY:
{
   "messages": ["This is an information", "For no special reason"],
   "success": true,
   "origin": "Administrator"
}




Copyright Wordbee - Buzzin' Outside the Box since 2008