Most of the API methods for resources, segments and related data ask for a "scope". The scope both delimits the set of data you need to access as well as the access rights to these data. For example the "job" scope gives access to segments and files for one specific job.
...
| Code Block |
|---|
{
"type": "Resource",
"dsid": 992,
"psc":
{
"type": "Job",
"jobid": 9927,
"jobcdyt": true
}
} |
Multi-resource scope
This scope permits to query ALL segments in the platform.
The authenticated user's user profile must have access rights R600 and R602 enabled. See Settings > Access Rights in Wordbee Translator.
The scope does NOT allow any update operations. It is for retrieval only.
| Property | Value | Type |
|---|---|---|
| type | Resources | string |
| locs | The list of locales that the scope shall give access to. This list must contain at least one locale. | string[] |
Example:
| Code Block |
|---|
{
"type": "Resources",
"locs": ["en", "fr", "de"]
} |
Global Search scope
This scope gives access to all the segments in the platform: All projects, resources, jobs.
The authenticated user's user profile must have access rights R699 or R700 enabled. See Settings > Access Rights in Wordbee Translator. In addition, the "Global Search" feature must be active in the platform.
Please note that configuration parameters influence what is accessible: Global Search can enabled/disabled, Resources can be enabled/disabled for global search access and so on.
...