Versions Compared

Key

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

...

A JSON with these properties:

total

The total number of segments processed / looked at.

int

totalChangedThe total number of segments that were updated. Segments may not be updated if they already have the wanted value or they are read-only or another condition in the action does not apply.int
totalFailedToSaveNumber of segments that could not be updated. Failure means a technical problem with the saving. This value should be 0 always.int
   

 

 

EXAMPLES

This example is obtained when running a bookmark action. The bookmarks of 2 out of 3 segments were updated. One segment was not updated and the reason may be multiple:

  • The segment is read-only, for example locked
  • The segment already has the wanted bookmark set

 

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

 

This example shows the result for two actions.

The QuickCheck is an algorithm that also counts the number of issues next to the number of changes if it is configured to not apply tag fixes (for example) but simply count the problems.

 

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