Page Comparison

id

Specify either a document ID (such as 1000) or a job ID (such as c300).

string, Mandatory

changed

Mandatory date.

The method filters components and languages where any segment in the language was modified at or after this date. For example you will then receive all components and translations that are newly completed since recently.

Note: The date must be at maximum 7 days into the past.

Example:

{
  "changed": "2021-10-01T00:00:00Z"
}

datetime, Mandatory

metric

Identifies which languages in a component shall be returned. The options are:

• StatusNoneOk : Translations in a component must all be in status “gray” or “green” (and none in “red”). Permits to select components that are fully translated.

• StatusOk : Translations in component must all be in “green” status. Permits to select components that are fully translated and flagged “green”.

• BookmarkBlue : Translations must all be bookmarked with the blue color. If your workflow requires that translators or revisers flag completely finished translations with a bookmark then this is the way to go.

If not specified then StatusNotOk is used.

Example: Select those components and languages where translation were finished between changed and now:

{
  "metric": "StatusNoneOk"
}

string?, Optional

invert

When false (default), the metric operates as described above.

If true then the method returns the languages that do not satisfy the metric requirement.

Example: Select those components and languages that were edited since changed but remain unfinished:

{
  "metric": "StatusNoneOk",
  "invert": true
}

bool?, Optional

locales

Optional list of locales. If not specified, the system uses all Flex document target languages.

With this property you can restrict the results to a subset of languages. The list can also contain the source language.

Example:

"status": [ "fr", "de" ]

string[]?, 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

callbackurl, 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)

Optional