Versions Compared

Key

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

...

typeFlex export descriptor. Disregard.string
versionFlex export version. Disregard.string
majorMajor version of content. Null if no versioning used.string?
minorMinor version of content. Null if no versioning used.string?
didFlex document ID.int
dsidFlex document resource ID. Can be used with other API methods that require this ID.int
cfsConfigIf includeCustomFields is true: List of all custom fields with their "id" and their title "t".object[]?
lblsConfigIf includeLabels is true: List of all custom fields with their "id" and their title "t".object[]?
chminMinimum character length for translations. Only included in JSON if a minimum is set.int?
chmaxMaximum character length for translations. Only included in JSON if a maximum is set.int?
segmentsArray of segments. See below.object[]

...

keySegment keystring
componentThe component ID if it was assigned to the segment with a push.
formatThe content format such as "plain" or "html_1".string
dtThe last date of change of any property of the segment (texts, status, ...)datetime
bsidSequential number assigned for display in the translation editor. This number may change with push requests.int
cfsSegment level custom fields (null if there are none). Each array element has properties id (custom field ID) and v (custom field value)object[]?
texts

A dictionary of texts. The key is the locale and the value a text object, see below.

Code Block
"texts": { "en": {...}, "fr": {...} }


object[]
chminMinimum character length for translations. Only included in JSON if a minimum is set.int?
chmaxMaximum character length for translations. Only included in JSON if a maximum is set.int?


Each element in texts has these properties:

...