Page Comparison

Provides a wide range of tools to update one or more filtered segments in batch. The batch operations include: Change text, Find & Replace, Change status and bookmarks, Pre-translate from memories etc.

...

actions

An array with one or more actions to apply. The structure of each element is described below.

The action type is contained in property type. See the following links for details on each action type:

Child pages (Children Display)

Mandatory

onChangeBookmark

Optional.

When a segment text or a property of the text is updated by an operation then optionally update the bookmark value as follows:

null: Leave bookmarks unchanged
0: Reset bookmark
1: Set blue bookmark
2: Set red bookmark

Optional

onChangeStatus

Optional.

When a segment text or a property of the text is updated by an operation then optionally update the status of the text as follows:

null: Leave status unchanged
0: Reset status
1: Set status to OK (green)
2: Set status to Error (red)

Search filtering and sorting Not yet released.

ctxboost

Optional. Specifies to what extent a matching context promotes a hit in the search results (you need to also set the ctx property).

0: Disabled. The search results disregard whether the context matches or not. In other words, the ctx parameter is disregarded.
1: Minimal promotion. Makes sure that the top results contain good hits that also match the context
...
5: Maximal promotion. This will give high importance to hits with the same context, even if text similarity is not so high.

With this setting you can give additional boost to hits that have the same context value as the segment being searched. The context of a segment typically contains formatting information such as "Heading 1", "Hyperlink" etc. or, when localizing software, string IDs or keys. Specifically with software localization this setting should be increased.

Optional,

int?

filter

Optional array of filters on various properties such as status, bookmarks, context, change date and so on.

See chapter further down.

Optional

object[]?

...

Search filtering and sorting Not yet released.

ctxboost

Optional. Specifies to what extent a matching context promotes a hit in the search results (you need to also set the ctx property).

0: Disabled. The search results disregard whether the context matches or not. In other words, the ctx parameter is disregarded.
1: Minimal promotion. Makes sure that the top results contain good hits that also match the context
...
5: Maximal promotion. This will give high importance to hits with the same context, even if text similarity is not so high.

With this setting you can give additional boost to hits that have the same context value as the segment being searched. The context of a segment typically contains formatting information such as "Heading 1", "Hyperlink" etc. or, when localizing software, string IDs or keys. Specifically with software localization this setting should be increased.

Optional,

int?

filters

Optional array of filters on various properties such as status, bookmarks, context, change date and so on.

See chapter further down.

Optional

object[]?

...

Code Block

{
  "total": 3,
  "totalChanged": 2,
  "totalFailedToSave": 0,
  "totalIssues": null,
  "error": null,
 
"actions": { 	"items": [
    {
      "action": "Bookmark",
      "total": 3,
      "totalChanged": 2,
      "totalIssues": null,
	  "updatedSegments": [],
      "error": null
    }
  	]
  }
}

This example shows the result for two actions.

...

Code Block

{
  "total": 3,
  "totalChanged": 2,
  "totalFailedToSave": 0,
  "totalIssues": 2,
  "error": null,
  "actionsitems": [
    {
      "action": "Bookmark",
      "total": 3,
      "totalChanged": 1,
      "totalIssues": null,
	  "updatedSegments": [],
      "error": null
    },
    {
      "action": "QuickCheck",
      "total": 3,
      "totalChanged": 0,
      "totalIssues": 2,
      "updatedSegments": [],
      "error": null
    }
  ]
}

Versions Compared

Old Version 11

New Version Current

Key