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/v1/projects/{projectUid}/jobs/connectorTask

Create job from connector asynchronous download task

cURL

curl --request POST \
  --url https://cloud.memsource.com/web/api2/v1/projects/{projectUid}/jobs/connectorTask \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetLangs": [
    "<string>"
  ],
  "assignments": [
    {
      "assignedUsers": [
        {
          "id": 123
        }
      ],
      "providers": [
        {
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "targetLang": "<string>"
    }
  ],
  "callbackUrl": "<string>",
  "due": "2023-11-07T05:31:56Z",
  "path": "<string>",
  "preTranslate": true,
  "semanticMarkup": true,
  "useProjectFileImportSettings": true,
  "workflowSettings": [
    {
      "assignments": [
        {
          "assignedUsers": [
            {
              "id": 123
            }
          ],
          "providers": [
            {
              "type": "<string>",
              "id": "<string>"
            }
          ],
          "targetLang": "<string>"
        }
      ],
      "due": "2023-11-07T05:31:56Z",
      "id": "<string>"
    }
  ]
}
'

201

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

Authorizations

ApiTokenOAuth2

Authorization · string · header · required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

projectUid · string · required

Query Parameters

downloadTaskId · string

continuous · boolean · default: false

Body

application/json

targetLangs · string[] · required

assignments · object[]

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

Show child attributes

callbackUrl · string

due · string<date-time>

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

importSettings · object

Show child attributes

jobPreviewPackageFileUidRef · object

Show child attributes

notifyProvider · object

Show child attributes

path · string

Maximum string length: 255

preTranslate · boolean

remoteFile · object

Show child attributes

semanticMarkup · boolean

useProjectFileImportSettings · boolean

Default: false

workflowSettings · object[]

Show child attributes

xmlAssistantProfile · object

Show child attributes

Response

201

application/json

Created

asyncRequest · object

Show child attributes

jobs · object[]

Show child attributes

unsupportedFiles · string[]

warnings · object[]

Show child attributes