Wordbee proposes many different reports and you can even build your own "Translation-" report templates with the Business Report module.
The present method returns a list of all available reports (or report templates) including a unique ID. This ID is then passed to the method that creates the report.
URL
...
This method provides detailed information for a scope:
- Whether user can access segments in the scope or not
- Accessible languages, segment fields, custom fields, labels, etc.
- Allowed editing operations such as for texts, meta information, split/merge etc.
- Lists all languages with code and name, all custom fields, all labels and so on
This information can be used if you build a translation editing interface and you need to know in advance what information the user can access and modify.
URL
(POST) /api/resources/segments/reports/items/{scope}rights
PARAMETERS
URL parameters areThe message body contains a JSON object:
...
scopeBODY | Specify the scope of segments, such as Project, Job, DocumentSet, Resource etc. for which you intend to print the report. Some reports are available only for certain scopes. This page: scope object explains all available options. If omitted, this method returns only those reports that are available with all scopes. | string, Optional |
RESULTS
The method returns all available reports with ID, title and description:
| Code Block |
|---|
[
{
"id": "_revisions",
"title": "Revisions",
"description": "Print segments with human revisions"
},
{
"id": "_postedits",
"title": "Post-edits",
"description": "Print segments with human editing of machine or pretranslations"
},
{
"id": "_all",
"title": "All",
"description": "Print all segments"
},
{
"id": "S710",
"title": "Document translations, revisions and comments",
"description": "This report prints source texts and translations for a document or project with revisions history and comments. It contains information for a single target language."
}
] |
EXAMPLES
Get all reports to print translations of a job:
The scope json object. For example, for a job, project, memory, term base, global search etc. Example for a job:
Example for a project:
See Scope (Object) for more details. | object, Mandatory |
RESULTS
The method returns all the information for the scope.
See Rights (Object)
ACCESS RIGHTS
Requesting information for a scope the user is not authorized to access at all, will return an error.
For example, an external translator will not be able to obtain information for a project-scope. He/She may get information for authorized jobs only (such as assigned jobs).