documents/{id}/contents/push

id

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

If set to true then the result of this method will include the cost of the push. To get this to work, some configuration will be required such as adding pricing information and enabling costing in the Wordbee project workflow.

Read more: Cost summary / Flex

Specify if the file is a full update or a partial update:

• full: The file contains all segments of the container. The system removes segments in the target flex document that are no longer referenced (or deprecates them for the chosen major/minor version).
• partial: Use to update or add segments

Optional. Default string format to use with all segments (can be overridden by segment). If not specified the system assumes that the default is "plain".

plain

Plain text content.

html_1:

Use with HTML content. The system identifies markup and protects it against tampering in the translation editor. The segment will not be split at markup.

html_2:

Similar to html_1 with one difference: Outermost enclosing markup is removed in the translation interface. Example:

String value: <p id="1"><span>Hello <b>world</b></span></p> 

Translation editor: Hello <b>world</b>

The format can be overridden individually per segment using the format property on segment level.

Optional. With a source text change, reset status of all translations.

• null/nil: Use default setting in the Wordbee Translation Flex File format configuration for the target document.
• 0: Reset to normal.
• 2: Set to red (error) status.

Optional.

• Null or not specified (recommended): The system applies the segmentation rules from the Flex configuration that was used when the Flex container was created. This is the default and recommended setting..
• srx: Apply SRX-based segmentation
• none: Do not segment.
• htmltags: Segment at the html tags specified in segmentationParams.

Note: When working with a specific Flex document, you should stick to a specific mechanism of segmentation. It should not be changed over time since this may lead to inconsistent splits of content.

Optional. Required when segmentation above is set to htmltags.

Enumerate html tags at which segments shall be split. Example: "br span ul li".

string?, Optional

Optional parent key after which to position the present segment. This property gives you full control over positioning of segments (e.g. when viewed in the translation editor)

Possible values are:

• Property not included: If the segment is new it will be appended at the end of the flex container. If it already exists, its position will not change.
• null: Same as when property is not included.
• "": Empty string. The segment will be added in the top of the flex container (first position) 
• (a key): The segment will added right after the segment with this key. If no such key exists, the segment is appended to the end.

Optional component ID. You can use this field to group related keys. A component may be a web page ID, a software module namespace or any other grouping.

The benefit of using components is that you can pull segments by component ID (apps/wbflex/documents/{id}/contents/pull) or obtain the translation status of components.

Read more at: Components / Flex

Optional. If not specified inherits the format setting from the header node. See the latter for the different options. 

Default format of text content. If not specified the system assumes that the default is "plain".

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

To download the list of all languages available in Wordbee Translator, use: settings/languages/codes

Custom fields to set.

If not specified or null: Custom fields will not be changed in the destination segment (if it exists already).

Empty array: Clears custom fields in destination segment.

Each array element has properties id (custom field ID) and v (custom field value).

Optional. If not null then set the minimum character length for translations of this segment.

Values 0, 1, 2... to set the minimum length. Value -1 to remove any minimum length.

Optional. If not null then set the minimum character length for translations of this segment.

Same options as above but the smallest maximum length is 1.

Optionally update status of ALL segment translations.

Sample use case: You want translators to rework the translations because it was rejected by the content creators. Set status to red color.

Permitted values: 0 = reset to neutral (gray), 1 = reset to green (OK), 2 = reset to red (PROBLEM)

Set to true if you want to explicitly delete this segment. In this case it is sufficient to provide the key property. All other properties are not needed.

An example can be found here: Push updates - JSON samples

(Note that in "full" mode, the system automatically deletes any segments in the flex document that are not included in the uplodaded JSON)

The text.

Special cases:

• Set to null or omit the "v" property entirely: In this case the current text (if any) is not updated and left unchanged.
  Use if you only want to update meta-information like custom fields, comments or labels.
  
  
• Set to "" (empty string): An existing text will be cleared.
  
  

Custom fields to set.

If not specified or null: Custom fields will not be changed in the destination text.

Empty array: Clears custom fields in destination text.

Each array element has properties id (custom field ID) and v (custom field value).

Labels to set.

If not specified or null: Labels will not be changed in the destination text.

Empty array: Clears labels in destination text.

Labels (null if there are none). Each array element has properties id (label ID) and v (selected label value)

Comments attached to text. An array of objects with these properties:

• v: Comment text (mandatory)
• cat: A numeric category of the comment (optional)

Date of execution

true: Successful, false: Failed

An object describing the content found in the submitted JSON file:

• segmentsTotal: Total pushed segments, including erroneous segments
• segmentsErrors: Total pushed segments in file that are incorrect. Errors included in the errors list above.
• segmentsSkipped: Total pushed segments excluded due to the Flex configuration,
• header: A copy of the submitted header.

While pushing content to the target container, the system tracks the total container content scanned:

• targetParagraphs: Total paragraphs in the target container. A paragraph may be split by segmentation into one or more target segments. In the case of a full update, the number of target paragraphs matches segmentsTotal
• targetSegments: Total segments in the target container. This is always equal or above the target paragraphs count. It is above is one or more paragraphs are split (segmented).

This node then contains the actual target segments that were added to the container, updated in the container or removed from the target container:

• total: Total segments added, modified or deleted.
• totalAdded: Total new segments added to the Flex document.
• totalUpdated: Total existing segments updated in the Flex document.
• totalRemoved: Total existing segments removed from Flex document (or deprecated in new version)
• totalInvalid: Counts segments that specify a translation but no source text and which key does not exist in the Flex document. Basically attempts to update a translation where the target Flex segment does not exist or was deleted previously. The first invalid keys are then included in totalInvalidKeys.
• texts: Dictionary. Per each target locale, the number of text value changes or additions.
• textsMeta: Dictionary. Per each target locale, the number of text meta data changes or additions.