Workflow Assignment

Assign a user to workflow steps

Changed on

Grants a user a workflow-level role and assigns them to one or more workflow steps for the given locale pairs.

roleValue must be ROLE_TRANSLATION_RESOURCE or ROLE_TRANSLATION_RESOURCE_MANAGER. Each assigned step's type must be allowed for that role: ROLE_TRANSLATION_RESOURCE allows TRANSLATION and POST_TRANSLATION steps; ROLE_TRANSLATION_RESOURCE_MANAGER additionally allows ADMIN_APPROVAL, ANALYSIS, and WORK_APPROVAL steps. Every workflow step must belong to the given account.

The assignments are added to those the user already holds. Assignments the user already has are left unchanged. Workflow steps or locale pairs that do not exist are skipped without an error, so compare the response with your request to confirm what was created.

If the user does not yet belong to the account, they are added to it. The user receives a notification email about the new access, and each new assignment is recorded in the audit log.

Available only to ROLE_ACCOUNT_OWNER and ROLE_PROJECT_MANAGER.

post/people-api/v3/accounts/{accountUid}/users/{userUid}/workflow-steps/assign

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

userUidstring required

Unique identifier of a user — 12 lowercase alphanumeric characters.

Example:99b0662fbae1

UID of the user.

Request body

roleValue'ROLE_TRANSLATION_RESOURCE' | 'ROLE_TRANSLATION_RESOURCE_MANAGER' required

Workflow-level role to grant.

Example request

{
  "workflowStepAssignments": [
    {
      "workflowStepUid": "7564fc097a85",
      "localePairs": [
        {
          "sourceLocaleId": "fr-FR",
          "targetLocaleIds": [
            "fr-FR"
          ]
        }
      ]
    }
  ]
}

Response

Workflow step assignments created.

Example response

{
  "response": {
    "data": {
      "items": [
        {
          "workflowStepUid": "7564fc097a85",
          "localePairs": [
            {
              "sourceLocaleId": "fr-FR",
              "targetLocaleIds": [
                "fr-FR"
              ]
            }
          ]
        }
      ]
    }
  }
}

Changes