This method retrieves a list of components from a Flex document. It includes the number of segments in each component.
URL
(POST) /api/apps/wbflex/documents/{id}/components
PARAMETERS
The URL parameters are:
id | Specify either a document ID (such as 1000) or a job ID (such as c300). | string, Mandatory |
The body must contain a JSON object with filters.
If you do not specify a filter you will receive every single component appearing in the document. If you specify filters then you will receive the components of the filtered segments.
locales | Optional list of locales. If not specified, the system uses all Flex document target languages. This property is only used to delimit all other filters below to specific languages. Using more than one language means that a filter must apply in at least one of those languages in a segment for the segment to be retained. It does NOT mean that the filters below must apply to ALL languages! Example to restrict to 2 languages: "status": [ "fr", "de" ] | |
status | Optional list of numeric translation statuses. See Text Status (Enumeration) Example to filter translations with errors (red status): "status": [ 2 ] | int[]?, Optional |
bookmarks | Optional list of numeric bookmark statuses. See Text Bookmark (Enumeration) Example to filter translations bookmarked in either gray or blue: "bookmarks": [ 0, 1 ] | int[]?, Optional |
components | Optional list of component IDs. By default this is null. If specified, the method will only dig into these components. Example to filter translations bookmarked in either gray or blue: "components": [ "frontend.module1", "backend.sql", "backend.classes" ] Note: You can specify up to 500 elements. | string[]?, Optional |
component | Optional filter on components using a prefix, suffix, infix, wildcard or regex pattern. See String filter (Filter) for details. Example to filter all components starting with “frontend.”. It captures “frontend.ux”, “frontend.page1.js” etc. "component": { "value": "frontend.", "mode": "Prefix" ]
| object?, Optional |
dtchange | Optional filter on the last change of a translation or its properties. See details here: Date filter (Filter) Filter changes at or after October 2021: "dtchange": { "min": "2021-10-01T00:00:00Z" }
Filter changes since 3 days:
| object?, Optional |