Page Comparison

...

token

Use API media/upload to upload a file. It returns the token to be included here. Note: The upload of your file or files must be done prior to calling the present method.

string, Mandatory

name

The file name, with or without folders. The file will be stored with this name & folders in the project. Some valid filenames:

Code Block
my-file.docx marketing/section1/presentation.ppt marketing\\section1\\presentation.ppt strings.product.json

Note: When using “\” make sure to escape with “\\”. This is not necessary when using the forward “/” as folder separator.

string, Mandatory

Optional parameters

formatId

Optional document format configuration to be used for extracting content from the file. See Document formats to enumerate all existing file formats.

Normally, you do not need to override the defaults: By default, the system selects the filter from the project’s File Filter configuration.

int?, Optional

disableMt

Optional, default is false. If you explicitly want to prevent machine translation when preparing the file, set this property to true. Machine translation is enabled or disabled in the project’s word count profile.

bool, Optional

reference

Optional sender ID for the document. For example, this can hold an identifier you assign to the document outside of Wordbee.

string?, Optional

comments

Optional comments added to the document and shown in the translation editor.

string?, Optional

RESULTS

The result is the updated invoice document.

See Invoice Document Record for detailsThis method is an asynchronous operation: Your request is queued and executes as soon as possible.

Info

Asynchronous operations - How to:
The API method immediately returns a JSON object that includes the ID of the operation - look for the requestId property. However, it has not yet been executed. You will need to await the operation’s termination in order to get results. Waiting can be done in two ways: Either you regularly poll for the operation’s status, or you wait for a webhook call. The latter is the callbackurl parameter you may want to add in your request. We definitely recommend the latter approach. Please read Asynchronous operations for more details.

The JSON results, obtained with polling or with a callback, includes the operation status as well as any results specific to the API method. Below an example for successful termination:

Code Block

 {
    "trm": {
        "requestid": 13432,
        "isbatch": false,
        "status": "Finished",
        "statusText": "Finished!"
    },
    "custom": {
        "files": [
            {
                "name": "file-003.htm",
                "format": {
                    "formatId": 7952,
                    "formatName": "Default",
                    "formatDomain": "HTML"
                },
                "exists": false,
                "success": true,
                "error": null,
                "did": 288981,
                "segments": 87
            }
        ],
        "request": {
            ...
        }
    }
}

Check the status of trm/status. In case of success it should say “Finished”.

The node custom/files lists each submitted file with these properties:

name: The name of the document in the project, including any folders.
format: The document format configuration used to extract content from the file. It shows the document format ID (see settings/documentformats/configs/list) , the format configuration name and the type of document (HTML, JSON, XML…).
exists: Indicates if the file did already exist and was replaced with this new version. If you disallowed file version updates (see allowUpdates) then the next property will indicate an error.
error: Null if success. Otherwise shows the specific error why the file could not be processed. This may have many reasons. For example the file might be invalid.
did: The document ID. You will need this number for subsequent workflow operations such as to download the translation.
segments: The number of segments in the file.

The node custom/request contains your initial payload, including some extra properties.

files: The list of files you submitted
src: The source locale
trgs: List of target locales.
projectId: The project ID.
resourceId: The project memory ID.
etc.

ERROR HANDLING

Correct and complete error handling will require some efforts. There are three levels of errors:

Invalid payload

Immediate

If you submit an invalid payload, your API call will immediately be rejected with the error payload typical for the API. Here is an example when submitting an invalid source locale:

Code Block
{ "error": { "operation": null, "date": "2024-04-03T15:57:01.2110105Z", "title": "Invalid parameter 'src': Invalid source locale" }, "reason": "Invalid parameter 'src': Invalid source locale" }

Resolution: You likely need to fix your payload.

Operation failed

Delayed

If your payload is valid, your request is now queued. If the operation then fails with a fatal error, you get the async error payload. For example:

Code Block
{ "trm": { "requestid": 559, "isbatch": false, "status": "Failed", "statusText": "Operation failed!", "statusInfo": "The parameter xy was not properly supplied" } }

Resolution: Depending on the error message. You should not see such issues often. If the error details are unclear you may need to reach out to Wordbee support.

Operation ok but file failed

Delayed

The operation may have executed just fine but a submitted file (or several) could not be processed. The file specific error will be listed in the results, for example:

Code Block

"custom": {
        "files": [
            {
                "name": "file-003.htm",
                "format": {
                    "formatId": 7952,
                    "formatName": "Default Gemini",
                    "formatDomain": "HTML"
                },
                "exists": false,
                "success": false,
                "error": "Failed to process file. No segments.",
                "did": null,
                "segments": null
            }
        ]

Resolution: Depending on the message. You likely face one of these issues:

The file is invalid and failed to process. Think of a badly formatted XML file. Please check your files test manually in Wordbee Translator.
The file name is invalid, such as too long or contains invalid characters. Please fix file naming conventions.
The file contains 0 segments. Please do not submit empty files, Wordbee does not like them.

Versions Compared

Old Version 5

New Version 6

Key

RESULTS

ERROR HANDLING