Versions Compared

Version Old Version 2 New Version 3
Changes made by

Stephan Böhmig

Stephan Böhmig

Saved on

Key

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

...

URL

Code Block
(POST) /api/projectsapps/{pid}wbflex/workflowsdocuments/{didid}/status/{trg}/delivery/successcontents/sync

PARAMETERS

The URL parameters are:

id

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

string, Mandatory

The BODY must be a JSON object with these properties:

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

...

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

locales

The list of locales to push.

IMPORTANT: If null or not specified, then the system pushes source texts only (and skips translations).

bool, Optional

timestamp

Optional date/time.

If specified, then the system will only update source texts or translations if those were last modified prior to this date.

The use case is to prevent erasing changes in the Flex container that are more recent than the changes in the file.

datetime, Optional

RESULTS

…