Versions Compared

Version Old Version 1 New Version 2
Changes made by

Stephan Böhmig

Stephan Böhmig

Saved on

Key

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

Use to upload a file and synchronize contents with a Flex container. The synchronization is two-way:

  • First, changes from the file can be optionally be pushed into the Flex container.

  • Second, the file contents is updated with the latest translations from the Flex container.

The result is your updated file.

URL

Code Block
(POST) /api/projects/{pid}/workflows/{did}/status/{trg}/delivery/success

PARAMETERS

The URL parameters are:

file

A JSON object with the reference to the uploaded file, the parser configuration for content extraction and more. Please see a full list of properties here: Pushing content - "files" property . The file must be uploaded using media/upload to obtain a token, see example below.

Example:

Code Block
 "file": {
        "token": "{{uploadedFile}}",
        "name": "software-strings.xlsx",
        "formatId": 137,
        "stringKeyPattern": "string-{seq}"
    }

object, Mandatory

push

An optional JSON object that defines how file content is updated to the Flex container. If not specified then no updating will be done. See specifications further down.

Example:

Code Block
"push": {
    "enabled": true
}

bool, Optional

The push node has these properties:

enabled

Specifies if content shall be synchronized into the Flex container or not.

bool, Mandatory

isPreviewMode

Optional boolean, default is false. If true then the system simulates the update and returns all the details but it will not actually update the Flex container.

bool, Optional

RESULTS

…