Retrieves the log file which lists every successful push of contentmost recent transactions of a Flex document in JSON format.
URL
(GET) /api/apps/wbflex/documentstransactions/{id}/logPARAMETERS
URL parameters are:
id | Specify either The Flex document identifier. Either a document ID (such as 1000) or a job ID (such as c300). | int/string, Mandatory |
...
A file with JSON documents. Each document represents one push operation.
...
| skip | Optional, default is 0. Permits to paginate transactions. A value of 20 means that we show the 20th, 21th etc. transaction | int?, Optional |
| take | Optional, default is 20. Retrieve this number of transaction. The maximum allowed value is 100. | int?, Optional |
RESULTS
A JSON object containing some details of the Flex document plus a list of the transactions:
| Code Block |
|---|
{
"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:
...
Date of operation
...
Provides information on the flex file content which was pushed: Number of segments and texts as well as instructions (in the header node).
...
"skip": 0,
"take": 6,
"total": 6,
"id": 10683,
"name": "Sample document.wbflex",
"filterName": "SRX",
"pid": 3623,
"pname": "JAWS-417",
"src": { "v": "en-GB", "t": "English (United Kingdom)" },
"trgs": [ { "v": "fr-FR", "t": "French (France)" }
],
"rows": [ ..... ]
} |
Comments on some properties:
- id - The document ID
- name: The document name
- filterName: The filter configuration's name that applies to this document. The configuration is assigned when creating the Flex document.
- pid: The project ID
- pname: The project name
- src: The source language information
- trgs: The target language(s) information
- rows: The list of transactions. Each element in rows is a transaction.
For a detailed description of properties please refer to: apps/wbflex/documents/{id}/log/report
...