Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This method retrieves a list of components from a Flex document. It includes the number of segments in each component.

Use cases:

  • List all components with total segments each.

  • List all components that contain translations in error status.

  • List all components containing bookmarked translations.

URL

Code Block
(POST) /api/apps/wbflex/documents/{id}/components

...

  • k : The component ID.

  • s : Total filtered segments with this component ID.

Note: We count the segments as they appear in the translation editor. For example, a Flex segment may be split into multiple segments in Wordbee to ease translation.

Example:

Code Block
[
    {
        "k": "pages.welcome",
        "s": 21
    },
    {
        "k": "pages.login",
        "s": 16
    },
    {
        "k": "pages.login.sso",
        "s": 16
    }
]

...