Versions Compared

Key

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

...

token

The token obtained on connection

Required

projectid

The unique project identifier

Required

documentid

The unique document identifier

Required

source

The source language code.

Example: "source=en"

Required

target

The target language code.

Example: "locale2=de"

Required

filter

A json containing the filter information (see below)

Optional

from

The first record to show starting with index 0. Default is 0

Optional

count

The number of records to show, up to 1000 at a time. Default is 1000.

Optional

 

JSON format of "data"

...

parameter

Only specify those fields that you want to update.

 

commentedOnlySet true to get only commented segments. If false, all segments are returned.Optional
constraintOnlySet true to get only segments that have constraints defined. If false, all segments are returned.Optional
errorneousOnlySet true to get errorneous segments. That means segments in red status or untranslated segments. If false, all segments are returned.Optional
lockedSet true to get only locked segments. If false, only unlocked segments are returned.Optional
bookmarkTo filter on the bookmark value. Existing values:None = 0,Level1 = 1,Level2 = 2Optional
statusTo filter on the text's status. Existing values: None = 0,Ok = 1,Problem = 2Optional
sinceTo filter on the last modification date of the segment.Optional

 

RESULTS

Returns a list of ApiSegmentRecord items.

...