Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

Depending on the project configuration, the operation will get translation workflows ready and going: Save files to project, mark online, pre-translate and word count, create and assign jobs.

URL

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

PARAMETERS

The URL parameters are:

pid

The project’s ID.

int, Mandatory

The request BODY contains a JSON object with these properties:

files

An array with one or more records, each describing a file to be uploaded. The records include the token referencing an uploaded a file. Example:

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

See detailed description further down.

object[], Mandatory

src

The source language code. This must be a valid project language.

string, Mandatory

trgs

The languages to translate to. These must be valid project languages. Example:

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

string[], Mandatory

deadline

Optional deadline for completion of work. Deadlines are assigned to the jobs that are created with the workflow. Example:

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

datetime?, Optional

workflow

Optional, selects "Default" if not specified. Fine-tune how workflows are created:

  • Default : Create jobs according to the project’s Workflow & Suppliers configuration. Recommended value.

  • None : Do not create any jobs.

string, Optional

allowUpdates

Optional. Default is true.

  • true: You are allowed to replace existing files with new versions. In such cases, the file is replaced, a new set of jobs will be created and the new jobs will be assigned to the same workers as before.

  • false: Any attempt to replace an existing file will return an error.

bool?, Optional

jobsCfs

Optional custom fields to assign to all jobs created for a file’s workflow. See Custom Field Collection Record for details.

Example:

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

RESULTS

The result is the updated invoice document.

See Invoice Document Record for details.

  • No labels