Download Content Summary

When creating the content summary with Calculate Content Summary you obtained a token. This token is used to download the actual details.

URL

CODE

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

PARAMETERS

The URL parameters are:

id

Specify the Flex container ID

string, Mandatory

The BODY must be a JSON object with these properties:

token

The token obtained when creating the content summary

object, Mandatory

RESULTS

The results is a JSON object like printed below.

Main properties:

branches: List of all branches, each containing its details.
locales: Subdivision of a branch’s details by locale.
openJobs: IDs of the Standard jobs assigned to a specific branch/locale pair.
textsInProgress: Number of texts in the branch/locale that are currently assigned to an open job.
textsWillBePropagatedTo: Number of texts being worked on in other branches that will overwrite (propagate to) this branch upon completion.
textsToAssign: Number of changed or new texts for the branch/locale that still need to be assigned to jobs.
segments: Total number of segments in the branch.
totalOpenKeysProcessed: Count of software keys analyzed among segments that are either in open jobs or marked as new/changed. The system caps analysis at ~10,000 keys.
totalOpenKeysHasMore: Indicates whether additional keys exist beyond the 10,000-key processing cap.

Example:

CODE

{
    "branches": [
        {
            "branch": "V1",
            "locales": [
                {
                    "branch": "V1",
                    "locale": "en",
                    "openJobs": [1244],
                    "textsInProgress": 1,
                    "textsWillBePropagatedTo": 0,
                    "textsToAssign": 0,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V1",
                    "locale": "de",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 0,
                    "textsToAssign": 2,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V1",
                    "locale": "fr",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 0,
                    "textsToAssign": 2,
                    "segmentsToAssign": null
                }
            ],
            "segments": 2,
            "textsInProgress": 0,
            "textsWillBePropagatedTo": 0,
            "textsToAssign": 4
        },
        {
            "branch": "V2",
            "locales": [
                {
                    "branch": "V2",
                    "locale": "en",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 0,
                    "textsToAssign": 0,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V2",
                    "locale": "de",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 2,
                    "textsToAssign": 1,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V2",
                    "locale": "fr",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 2,
                    "textsToAssign": 1,
                    "segmentsToAssign": null
                }
            ],
            "segments": 3,
            "textsInProgress": 0,
            "textsWillBePropagatedTo": 4,
            "textsToAssign": 2
        },
        {
            "branch": "V3",
            "locales": [
                {
                    "branch": "V3",
                    "locale": "en",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 0,
                    "textsToAssign": 0,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V3",
                    "locale": "de",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 2,
                    "textsToAssign": 0,
                    "segmentsToAssign": null
                },
                {
                    "branch": "V3",
                    "locale": "fr",
                    "openJobs": [],
                    "textsInProgress": 0,
                    "textsWillBePropagatedTo": 2,
                    "textsToAssign": 0,
                    "segmentsToAssign": null
                }
            ],
            "segments": 2,
            "textsInProgress": 0,
            "textsWillBePropagatedTo": 4,
            "textsToAssign": 0
        }
    ],
    "totals": {
        "branch": null,
        "locales": [
            {
                "branch": null,
                "locale": "en",
                "openJobs": [],
                "textsInProgress": 0,
                "textsWillBePropagatedTo": 8,
                "textsToAssign": 6,
                "segmentsToAssign": []
            },
            {
                "branch": null,
                "locale": "de",
                "openJobs": [],
                "textsInProgress": 0,
                "textsWillBePropagatedTo": 8,
                "textsToAssign": 6,
                "segmentsToAssign": []
            },
            {
                "branch": null,
                "locale": "fr",
                "openJobs": [],
                "textsInProgress": 0,
                "textsWillBePropagatedTo": 8,
                "textsToAssign": 6,
                "segmentsToAssign": []
            }
        ],
        "segments": 7,
        "textsInProgress": 0,
        "textsWillBePropagatedTo": 8,
        "textsToAssign": 6
    },
    "totalOpenKeysProcessed": 3,
    "totalOpenKeysHasMore": false
}