Issues

Creates a new issue for a string. Issue text is treated as plain text. Smartling will save the text as provided, and will not attempt to render this text with any special formatting in its UIs. It will not be rendered as HTML or markdown. Users of the Issues API should be aware, and escape the text as needed before attempting to render it. Maximum length is 4000 characters.

post/issues-api/v2/projects/{projectId}/issues

Request

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

Path parameters

projectIdstring required

Unique identifier of a Smartling project — 9 lowercase alphanumeric characters.

Example:84c012a33

A unique project identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Request body

issueTextstring required

Free text field explaining an issue.

issueTypeCode'SOURCE' | 'TRANSLATION' required

Identifies the issue type. issueTypeCode is either SOURCE or TRANSLATION. Each have their own set of issueSubType values.

issueSubTypeCode'CLARIFICATION' | 'MISSPELLING' | 'POOR_TRANSLATION' | 'DOES_NOT_FIT_SPACE' | 'PLACEHOLDER_ISSUE' | 'REVIEW_TRANSLATION' | 'CUSTOM' | 'MT_ERROR' required

For issueTypeCode=SOURCE - CLARIFICATION | MISSPELLING, For issueTypeCode=TRANSLATION - POOR_TRANSLATION | DOES_NOT_FIT_SPACE | PLACEHOLDER_ISSUE | REVIEW_TRANSLATION | MT_ERROR

assigneeUserUidstring

Unique identifier of a user — 12 lowercase alphanumeric characters.

issueSeverityLevelCode'LOW' | 'MEDIUM' | 'HIGH'

Issue Severity Level identifier

Example request

{
  "issueText": "This translation is incorrect. Please fix.",
  "string": {
    "hashcode": "d41d8cd98f00b204e9800998ecf8427e",
    "localeId": "fr-FR"
  },
  "assigneeUserUid": "99b0662fbae1"
}

Response

OK

Example response

{
  "response": {
    "data": {
      "projectId": "84c012a33",
      "reportedByUserUid": "99b0662fbae1",
      "resolvedByUserUid": "99b0662fbae1",
      "assigneeUserUid": "99b0662fbae1",
      "reopenedByUserUid": "99b0662fbae1",
      "string": {
        "hashcode": "d41d8cd98f00b204e9800998ecf8427e",
        "localeId": "fr-FR"
      }
    }
  }
}

Changes