Versions Compared

Old Version 4

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version 5

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

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

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

...