Skip to main content

Calculate Content Summary

This method calculates, globally and per branch:

  • Total branches

  • Total segments per branch

  • Details per branch and language:

  • Texts currently in work (assigned to open jobs).

  • Texts that will be propagated by other branches upon workflow completion.

  • Texts that are changed or new and require assignment to new jobs.

URL

CODE
(POST) /api/apps/wbflex/documents/{id}/branches/content/summary

PARAMETERS

The URL parameters are:

id

Specify the Flex container ID

string, Mandatory

The BODY must be a JSON object with these properties:

query

Optional segments filter. By default the entire Flex container will be analyzed. See resources/segments/search

object, Optional

locales

Optional list of locales to analyze. By default all locales (source and target) of the container are analyzed.

string[], Optional

callback

Specify a URL which will be called upon success or failure of operation. This makes polling for operation status unnecessary. See Callbacks (with asynchronous operations)

object, Optional

RESULTS

The operation is asynchronous and may take a few seconds to complete. The method returns an Asynchronous operation result:

CODE
{
  "trm": {
    "requestid":32230,
    "status":"Waiting",
    "statusText":"Waiting..."
  }
}

Specify the callback in the payload to be automatically notified of completion. Otherwise you need to poll the operation for completion (until status = “Finished”). When finished (or via the callback) you obtain the results as a JSON:

CODE
{
    "trm": { ... }
    "custom": {
        "token": "ded4792e26684dd49be2bf4d3f00d31a"
    }
}

With above results you now obtained atoken.

Download the content summary JSON with: Download Content Summary

 

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.