...
FILTERS | ||||||
| dtchange | Optional filter on last change of segments. Changes may be anything from texts in languages, meta information, comments etc. See Date filter (Filter) for details. The following finds texts changed the last 3 days:
Find changes of October (UTC):
| object?, Optional | ||||
| keys | Optional list of segment keys to pull. Note: You can request up to 500 keys with one pull. Note: This filter is case insensitive. | string[]?, Optional | ||||
| key | Optional filter on keys using a prefix, suffix, infix, wildcard or regex pattern. See String filter (Filter) for details. Note: This filter is case insensitive.
| object?, Optional | ||||
| components | Optional list of component IDs to pull. See Components / Flex for more information. Note: You can request up to 500 keys with one pull. Note: This filter is case sensitive.
| string[]?, Optional | ||||
| component | Optional filter on keys using a prefix, suffix, infix, wildcard or regex pattern. See String filter (Filter) for details. Note: This filter is case sensitive. | object?, Optional | ||||
| segments | Optional list of segment IDs to pull. Please note that you more likely would use the "keys" property to fetching specific segments. NOTE: You can request up to 500 keys with one pull. | int[]?, Optional | ||||
| bsidMin | Optional for pagination. Return only segments with a sequential ID equal or above. The sequential number starts at 1 (first segment in container). | int?, Optional | ||||
| bsidMax | Optional for pagination. Return only segments with a sequential ID equal or below. | int?, Optional | ||||
| VERSIONS | ||||||
| major | Optional. Query segments for this major version. | string?, Optional | ||||
| minor | Optional. Query segments for this minor version. You must specify the major version as well. | string?, Optional | ||||
| CONTENT | ||||||
| locales | Optional. List of locales to export. If not set or null then content in all languages is included. | string[]?, Optional | ||||
| includeCustomFields | Optional, default is false. Export segment and text level custom fields with the results. | bool?, Optional | ||||
| includeLabels | Optional, default is false. Export text labels with the results. | bool?, Optional | ||||
| includeComments | Optional, default is false. Export segment and text level custom fields with the results. | bool?, Optional | ||||
| excludeTexts | Optional. Permits to specify if a segment's translation shall be included with a segment. A segment may be split into multiple sub-segments in the Wordbee Translation Editor and each such sub-segment may have its own status (None, Ok, Problem). When pulling the segment, the system uses this filter to decide whether a specific translation shall be included or not with the segment. The available options are:
| string?, Optional | ||||
| excludeTextsProblem | Please now use the more comprehensive "excludeTexts" property instead. Optional, default is false. If true, then an exported segment does not print any text-elements in status Problem (red color). You can also find this status in the st property on the text-element. The purpose of this property is to reduce the size of the returned JSON by excluding data that apparently has issues still in the translation team and you very likely do not want to import in the first place. Please note that this does not filter any segments. You still get all segments but texts nodes are not included depending on status. | bool?, Optional | ||||
| copySourceToTarget | Optional, default is true. If true, then texts with empty/missing translation are returned with the source text value. This is done under these conditions:
Set to false to disable this copy-over behavior. | bool?, Optional | ||||
| CALLBACK URL / WEBHOOK | ||||||
| callbackurl, callback | Optional Specify a URL which will be called upon success or failure of operation. This makes polling for results (see below) unnecessary. URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format. Suggestion: Include your own references in the URL, example: http://callmeback.mycompany.com?operationid=22222&mydata=abcde string?,operation status unnecessary. See Callbacks (with asynchronous operations) | Optional |
RESULTS
The operation may take more or less time depending on the amount of data to export. Therefore it is implemented as an asynchronous operation.
...