Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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/documents/{id}/log

PARAMETERS

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
skipOptional, default is 0. Permits to paginate transactions. A value of 20 means that we show the 20th, 21th etc. transactionint?, Optional
takeOptional, default is 20. Retrieve this number of transaction. The maximum allowed value is 100.int?, Optional


RESULTS

A file with JSON documents. Each document represents one push operationJSON object containing some details of the Flex document plus a list of the transactions.

A typical record:

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": {}
	}
}

...

For a detailed description of properties please refer to: apps/wbflex/documents/{id}/log/report

EXAMPLES

-A typical document: