Writer

根据预设的样式指南检查您的内容

POSThttps://enterprise-api.writer.com/content/organization/{organizationId}/team/{teamId}/check

请求参数

Path 参数

organizationId

string

必需

teamId

string

必需

Header 参数

content-type

string

必需

示例值:

application/json

settings

object

必需

passiveVoice

boolean

必需

wordiness

boolean

必需

unclearReference

boolean

必需

genderInclusivePronouns

boolean

必需

genderInclusiveNouns

boolean

必需

ageAndFamilyStatus

boolean

必需

disability

boolean

必需

genderIdentitySensitivity

boolean

必需

raceEthnicityNationalitySensitivity

boolean

必需

sexualOrientationSensitivity

boolean

必需

substanceUseSensitivity

boolean

必需

confidence

boolean

必需

healthyCommunication

boolean

必需

grammar

boolean

必需

spelling

boolean

必需

contentSafeguards

boolean

必需

{
  "settings": {
    "passiveVoice": true,
    "wordiness": true,
    "unclearReference": true,
    "genderInclusivePronouns": true,
    "genderInclusiveNouns": true,
    "ageAndFamilyStatus": true,
    "disability": true,
    "genderIdentitySensitivity": true,
    "raceEthnicityNationalitySensitivity": true,
    "sexualOrientationSensitivity": true,
    "substanceUseSensitivity": true,
    "confidence": true,
    "healthyCommunication": true,
    "grammar": true,
    "spelling": true,
    "contentSafeguards": true
  }
}

示例代码

返回响应

成功(200)

请求有误(400)

没有权限(401)

禁止访问(403)

记录不存在(404)

服务器错误(500)

HTTP 状态码: 200

内容格式: JSONapplication/json

issues

array [object {5}]

必需

from

integer

可选

until

integer

可选

service

string

可选

suggestions

array[string]

可选

description

string

可选

{
  "issues": [
    {
      "from": 0,
      "until": 0,
      "service": "common-mistakes",
      "suggestions": [
        "string"
      ],
      "description": "string"
    }
  ]
}

最后修改时间： 10 个月前