Retrieves the log file which lists every successful push of content.
URL
(GET) /api/apps/wbflex/documents/{id}/logPARAMETERS
URL parameters are:
id | Specify either a document ID (such as 1000) or a job ID (such as c300). | Mandatory |
RESULTS
A file with JSON documents. Each document represents one push operation.
A typical record:
{
"ts": "2019-05-16T12:54:18.6476328Z",
"success": true,
"error": null,
"mode": "FULL",
"source": {
"segmentsTotal": 1,
"segmentsErrors": 0,
"header": {
"pushAll": null,
"pushAllDeleteSegments": null,
"chgStatusTarget": null,
"chgStatusSource": null,
"chgBookmarkTarget": null,
"chgBookmarkSource": null,
"major": "alpha",
"minor": "2000"
}
},
"updates": {
"total": 0,
"totalAdded": 0,
"totalUpdated": 0,
"totalRemoved": 0,
"texts": {},
"textsMeta": {}
}
}
The main properties are:
| ts | Date of operation | datetime |
| success | True if success. False if failure. | bool |
| error | If failed, contains a short error message | string? |
| mode | The push mode. Either "FULL" or "PARTIAL" | string |
| source | Provides information on the flex file content which was pushed: Number of segments and texts as well as instructions (in the header node). | object |
| updates | Statistics on updates: Number of segments, texts and meta data added, updated or removed (for the given major/minor version) | object |
For a detailed description of properties please refer to: apps/wbflex/documents/{id}/log/report
EXAMPLES
-