Create job from connector asynchronous download task

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/connectorTask \
  --header 'Content-Type: application/json' \
  --data '{
  "targetLangs": [
    "<string>"
  ],
  "due": "2023-11-07T05:31:56Z",
  "workflowSettings": [
    {
      "id": "<string>",
      "assignments": [
        {
          "targetLang": "<string>",
          "providers": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ],
          "assignedUsers": [
            {
              "id": 123
            }
          ]
        }
      ],
      "due": "2023-11-07T05:31:56Z",
      "notifyProvider": {
        "organizationEmailTemplate": {
          "id": "<string>"
        },
        "notificationIntervalInMinutes": 720
      }
    }
  ],
  "assignments": [
    {
      "targetLang": "<string>",
      "providers": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "assignedUsers": [
        {
          "id": 123
        }
      ]
    }
  ],
  "importSettings": {
    "uid": "<string>"
  },
  "useProjectFileImportSettings": true,
  "preTranslate": true,
  "semanticMarkup": true,
  "notifyProvider": {
    "organizationEmailTemplate": {
      "id": "<string>"
    },
    "notificationIntervalInMinutes": 720
  },
  "callbackUrl": "<string>",
  "path": "<string>",
  "remoteFile": {
    "connectorToken": "<string>",
    "remoteFolder": "<string>",
    "remoteFileName": "<string>",
    "remoteFileNameRegex": true,
    "continuous": true
  },
  "jobPreviewPackageFileUidRef": {
    "uid": "<string>"
  },
  "xmlAssistantProfile": {
    "uid": "<string>"
  }
}'

{
  "unsupportedFiles": [
    "<string>"
  ],
  "jobs": [
    {
      "uid": "<string>",
      "status": "NEW",
      "providers": [
        {
          "type": "<string>",
          "id": "<string>",
          "uid": "<string>"
        }
      ],
      "targetLang": "<string>",
      "workflowLevel": 123,
      "workflowStep": {
        "name": "<string>",
        "id": "<string>",
        "uid": "<string>",
        "order": 123,
        "lqaEnabled": true
      },
      "filename": "<string>",
      "dateDue": "2023-11-07T05:31:56Z",
      "dateCreated": "2023-11-07T05:31:56Z",
      "updateSourceDate": "2023-11-07T05:31:56Z",
      "imported": true,
      "jobAssignedEmailTemplate": {},
      "notificationIntervalInMinutes": 123,
      "continuous": true,
      "sourceFileUid": "<string>"
    }
  ],
  "asyncRequest": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "action": "PRE_ANALYSE"
  }
}

Job

Create job from connector asynchronous download task

Creates the job in project specified by path param projectUid. Source file is defined by downloadTaskId parameter. That is value of finished download async task Connector - Download file (async).

Please supply job metadata in body.

Accepted metadata:

targetLangs - required
due - ISO 8601
workflowSettings - project with workflow - see examples bellow
assignments - project without workflows - see examples bellow
importSettings - re-usable import settings - see Create import settings
useProjectFileImportSettings - mutually exclusive with importSettings
callbackUrl - consumer callback
path - original destination directory
preTranslate - set pre translate job after import
semanticMarkup - set semantic markup processing after import when enabled for organization
xmlAssistantProfile - apply XML import settings defined using XML assistant

Create job simple (without workflow steps, without assignments):

{
  "targetLangs": [
    "cs_cz",
    "es_es"
  ]
}

Create and assign job in project without workflow step:

{
  "targetLangs": [
    "cs_cz"
  ],
  "callbackUrl": "https://my-shiny-service.com/consumeCallback",
  "importSettings": {
    "uid": "abcd123"
  },
  "due": "2007-12-03T10:15:30.00Z",
  "path": "destination directory",
  "assignments": [
    {
      "targetLang": "cs_cz",
      "providers": [
        {
          "id": "4321",
          "type": "USER"
        }
      ]
    }
  ],
  "notifyProvider": {
    "organizationEmailTemplate": {
      "id": "39"
    },
    "notificationIntervalInMinutes": "10"
  }
}

Create and assign job in project with workflow step:

{
  "targetLangs": [
    "de"
  ],
  "useProjectFileImportSettings": "true",
  "workflowSettings": [
    {
      "id": "64",
      "due": "2007-12-03T10:15:30.00Z",
      "assignments": [
        {
          "targetLang": "de",
          "providers": [
            {
              "id": "3",
              "type": "VENDOR"
            }
          ]
        }
      ],
      "notifyProvider": {
        "organizationEmailTemplate": {
          "id": "39"
        },
        "notificationIntervalInMinutes": "10"
      }
    }
  ]
}

POST

api2

projects

{projectUid}

jobs

connectorTask

Create job from connector asynchronous download task

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/connectorTask \
  --header 'Content-Type: application/json' \
  --data '{
  "targetLangs": [
    "<string>"
  ],
  "due": "2023-11-07T05:31:56Z",
  "workflowSettings": [
    {
      "id": "<string>",
      "assignments": [
        {
          "targetLang": "<string>",
          "providers": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ],
          "assignedUsers": [
            {
              "id": 123
            }
          ]
        }
      ],
      "due": "2023-11-07T05:31:56Z",
      "notifyProvider": {
        "organizationEmailTemplate": {
          "id": "<string>"
        },
        "notificationIntervalInMinutes": 720
      }
    }
  ],
  "assignments": [
    {
      "targetLang": "<string>",
      "providers": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "assignedUsers": [
        {
          "id": 123
        }
      ]
    }
  ],
  "importSettings": {
    "uid": "<string>"
  },
  "useProjectFileImportSettings": true,
  "preTranslate": true,
  "semanticMarkup": true,
  "notifyProvider": {
    "organizationEmailTemplate": {
      "id": "<string>"
    },
    "notificationIntervalInMinutes": 720
  },
  "callbackUrl": "<string>",
  "path": "<string>",
  "remoteFile": {
    "connectorToken": "<string>",
    "remoteFolder": "<string>",
    "remoteFileName": "<string>",
    "remoteFileNameRegex": true,
    "continuous": true
  },
  "jobPreviewPackageFileUidRef": {
    "uid": "<string>"
  },
  "xmlAssistantProfile": {
    "uid": "<string>"
  }
}'

{
  "unsupportedFiles": [
    "<string>"
  ],
  "jobs": [
    {
      "uid": "<string>",
      "status": "NEW",
      "providers": [
        {
          "type": "<string>",
          "id": "<string>",
          "uid": "<string>"
        }
      ],
      "targetLang": "<string>",
      "workflowLevel": 123,
      "workflowStep": {
        "name": "<string>",
        "id": "<string>",
        "uid": "<string>",
        "order": 123,
        "lqaEnabled": true
      },
      "filename": "<string>",
      "dateDue": "2023-11-07T05:31:56Z",
      "dateCreated": "2023-11-07T05:31:56Z",
      "updateSourceDate": "2023-11-07T05:31:56Z",
      "imported": true,
      "jobAssignedEmailTemplate": {},
      "notificationIntervalInMinutes": 123,
      "continuous": true,
      "sourceFileUid": "<string>"
    }
  ],
  "asyncRequest": {
    "id": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "action": "PRE_ANALYSE"
  }
}

Path Parameters

projectUid

string

required

Query Parameters

downloadTaskId

string

continuous

boolean

default:false

Body

application/json

targetLangs

string[]

required

due

string<date-time>

only use for projects without workflows; otherwise specify in the workflowSettings object. Use ISO 8601 date format.

workflowSettings

object[]

Show child attributes

assignments

object[]

only use for projects without workflows; otherwise specify in the workflowSettings object

Show child attributes

importSettings

object

Show child attributes

useProjectFileImportSettings

boolean

Default: false

preTranslate

boolean

semanticMarkup

boolean

notifyProvider

object

Show child attributes

callbackUrl

string

path

string

Maximum length: 255

remoteFile

object

Show child attributes

jobPreviewPackageFileUidRef

object

Show child attributes

xmlAssistantProfile

object

Show child attributes

Response

Created

unsupportedFiles

string[]

jobs

object[]

Show child attributes

asyncRequest

object

Show child attributes

Compare jobs on workflow levels Copy Source to Target

⌘I

Guides

API Documentation

Create job from connector asynchronous download task

Path Parameters

Query Parameters

Body

Response