Versions Compared

Old Version 5

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 6

changes.mady.by.user Stephan Böhmig

Saved on

Key

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

...

reportid

The report to create. To get all available reports, see resources/segments/reports/items

Examples:

  • _all : Prints all segments
  • _revisions : Prints revisions
  • _postedits : Prints post edited segments only
  • S710 : A business report, available when printing in the scope of project or job only.
  • ...

Reports starting with an underscore (_) are pre-configured by Wordbee and cannot be customized. All other reports are fully customizable in the Business Report pages.


Mandatory, string
sloc

The source locale. A report is always for a source - target language couple.

Mandatory, string
tloc

The target locale.

Mandatory, string
scope

The scope of segments such as Project, Job, DocumentSet, etc.

See Scope (Object). Example:

Code Block
"scope": { "type": "Project", "projectid": 3343 }


Mandatory, object
query

An optional query object. To filter the segments of the scope. Example for drilling down on a single document:

Code Block
{
	"reportid": "C1112",
	"sloc": "en",
	"tloc": "de",
	"scope": { "type": "Project", "projectid": 3343 },
	"query": { "documents": [{ "did": 9800 }] }}
}

Important:

  • Business reports require a single document be specified in the "query" object as shown in the above example.


Optional, object


RESULTS

Await creation of text edits report

This API method is an "asynchronous" operation. It either immediately returns the result or instead an operation ID which you need to periodically poll until the operation has finished.

Upon the first call you typically get an "operationid". Use this to further poll the operation status. See full explanation here: Asynchronous operation

When the operation is finished you get the reference to the fileexecutes asynchronously.

  • It immediately returns a reference for the operation in trm.requestid, and an operation status in trm.status.
  • As long as the status is not Finished or Failed, you need to poll the system with the trm.requestid value. See Asynchronous operation for how to do this.
  • Ultimately upon completion the operation status includes the custom.filetoken value which lets you download the JSON result:
Code Block
{
    "trm": {
		"requestid": 559,
        "status": "Finished",
		...
    },
    "custom": {
        "filetoken": "026171df25c641d0b04316a28cf3cca1",
        "filename":
"report-16/12/2019-18:06.xlsx"     }
}

...

Download text edits report

When the operation is finishedhas terminated, download the file JSON report with the filetoken and  and this API method:

Code Block
(GET) /api/media/get/{filetoken}


The JSON has these properties:




EXAMPLES

N/A