Page Comparison

To add one or more files to an existing Codyt project.

Depending Based on the project configurationsettings, the operation will get initiates translation workflows ready and going: Save by saving files to the project, mark marking them online, conducting pre-translate translation and word count, create and creating and assign assigning jobs.

URL

(PUTPOST) /api/projects/{pid}/workflows/new

PARAMETERS

The URL parameters are:

The request BODY contains a JSON object with these properties:

[
    {
        "token": "77ca3562-ff01f5882dd1",
        "name": "myfolder/myfile.docx"
    }
]

"trgs": [ "es-ES", "fr-FR" ]

"deadline": "2024-04-03T06:00:00Z"

"jobsCfs": {
    fields": [
      { "title": "Activity", "value": "Fulltime" },
      { "id": 4, "value": "A-221" }    
    ]
}

...

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

The optional attachments array contains one record per attachment. Properties are:

RESULTS

This method is an asynchronous operation: Your request is queued and executes will execute as soon as possible.

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

 {
    "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,
                "attachments": 0
            }
        ],
        "request": {
            ...
        }
    }
}

...

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

• did: The document ID. You will need this number for all subsequent workflow operations related to this document and its workflows (in the different target languages).

• 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.

• didsegments: 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 filenumber of segments in the file.

• attachments: Total number of attachments that could be saved. If a token is invalid, the attachment is disregarded.

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 Effective error handling will require some efforts. There are involves careful consideration and effort. Let’s break it down into three levels of errors:

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

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

"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
            }
        ]

...