Terminology
Add terms
Terminology
Add terms
POST
/
terminology
/
organization
/
{organizationId}
/
team
/
{teamId}
curl --request POST \
--url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"models": [
{
"reference": "<string>",
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"examples": [
{
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"reference": "<string>",
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"tag": "<string>"
}
],
"linkedTerms": [
{
"reference": "<string>",
"linkedTermId": 123
}
],
"approvedTermExtension": {
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"failHandling": "accumulate"
}'
{
"models": [
{
"id": 123,
"termBankId": 123,
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"creationTime": "2023-11-07T05:31:56Z",
"modificationTime": "2023-11-07T05:31:56Z",
"createdUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"modifiedUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"examples": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"id": 123,
"tag": "<string>",
"termId": 123,
"parentTagId": 123
}
],
"linkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"backlinkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"fails": [
{
"description": "<string>",
"key": "<string>",
"extras": "<any>"
}
]
}
We’re deprecating these API endpoints, so the AI Studio API key setup won’t work. [Contact support] (https://support.writer.com/) if you need them.
Headers
Authorization
string
requiredPath Parameters
organizationId
integer
requiredteamId
integer
requiredBody
application/json
models
object[]
models.reference
string
models.term
string
requiredmodels.type
enum<string>
requiredAvailable options:
approved
, banned
, pending
models.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.caseSensitive
boolean
requiredmodels.description
string
models.highlight
boolean
models.examples
object[]
models.examples.example
string
requiredmodels.examples.type
enum<string>
requiredAvailable options:
good
, bad
models.mistakes
object[]
models.mistakes.reference
string
models.mistakes.mistake
string
requiredmodels.mistakes.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.mistakes.caseSensitive
boolean
requiredmodels.tags
object[]
models.tags.tag
string
requiredmodels.linkedTerms
object[]
models.linkedTerms.reference
string
models.linkedTerms.linkedTermId
integer
models.approvedTermExtension
object
models.approvedTermExtension.capitalize
boolean
requiredmodels.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.approvedTermExtension.fixCase
boolean
requiredfailHandling
enum<string>
Available options:
accumulate
, validate
, skip
, validateOnly
Response
200 - application/json
models
object[]
models.id
integer
requiredmodels.termBankId
integer
requiredmodels.term
string
requiredmodels.type
enum<string>
requiredAvailable options:
approved
, banned
, pending
models.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.caseSensitive
boolean
requiredmodels.description
string
models.highlight
boolean
requiredmodels.creationTime
string
requiredmodels.modificationTime
string
requiredmodels.createdUser
object
requiredmodels.createdUser.id
integer
requiredmodels.createdUser.fullName
string
models.createdUser.email
string
models.modifiedUser
object
requiredmodels.modifiedUser.id
integer
requiredmodels.modifiedUser.fullName
string
models.modifiedUser.email
string
models.examples
object[]
models.examples.id
integer
models.examples.termId
integer
requiredmodels.examples.termBankId
integer
requiredmodels.examples.example
string
requiredmodels.examples.type
enum<string>
requiredAvailable options:
good
, bad
models.mistakes
object[]
models.mistakes.id
integer
models.mistakes.termId
integer
requiredmodels.mistakes.termBankId
integer
requiredmodels.mistakes.mistake
string
requiredmodels.mistakes.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.mistakes.caseSensitive
boolean
requiredmodels.tags
object[]
models.tags.id
integer
requiredmodels.tags.tag
string
requiredmodels.tags.termId
integer
requiredmodels.tags.parentTagId
integer
requiredmodels.linkedTerms
object[]
models.linkedTerms.id
integer
models.linkedTerms.termId
integer
requiredmodels.linkedTerms.linkedTermId
integer
requiredmodels.linkedTerms.term
string
requiredmodels.linkedTerms.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.linkedTerms.caseSensitive
boolean
requiredmodels.linkedTerms.approvedTermExtension
object
models.linkedTerms.approvedTermExtension.id
integer
models.linkedTerms.approvedTermExtension.termId
integer
requiredmodels.linkedTerms.approvedTermExtension.capitalize
boolean
requiredmodels.linkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.linkedTerms.approvedTermExtension.fixCase
boolean
requiredmodels.backlinkedTerms
object[]
models.backlinkedTerms.id
integer
models.backlinkedTerms.termId
integer
requiredmodels.backlinkedTerms.linkedTermId
integer
requiredmodels.backlinkedTerms.term
string
requiredmodels.backlinkedTerms.pos
enum<string>
Available options:
noun
, verb
, adverb
, adjective
models.backlinkedTerms.caseSensitive
boolean
requiredmodels.backlinkedTerms.approvedTermExtension
object
models.backlinkedTerms.approvedTermExtension.id
integer
models.backlinkedTerms.approvedTermExtension.termId
integer
requiredmodels.backlinkedTerms.approvedTermExtension.capitalize
boolean
requiredmodels.backlinkedTerms.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.backlinkedTerms.approvedTermExtension.fixCase
boolean
requiredmodels.approvedTermExtension
object
models.approvedTermExtension.id
integer
models.approvedTermExtension.termId
integer
requiredmodels.approvedTermExtension.capitalize
boolean
requiredmodels.approvedTermExtension.fixCommonMistakes
boolean
requiredmodels.approvedTermExtension.fixCase
boolean
requiredfails
object[]
fails.description
string
requiredfails.key
string
requiredfails.extras
any
requiredcurl --request POST \
--url https://enterprise-api.writer.com/terminology/organization/{organizationId}/team/{teamId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"models": [
{
"reference": "<string>",
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"examples": [
{
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"reference": "<string>",
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"tag": "<string>"
}
],
"linkedTerms": [
{
"reference": "<string>",
"linkedTermId": 123
}
],
"approvedTermExtension": {
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"failHandling": "accumulate"
}'
{
"models": [
{
"id": 123,
"termBankId": 123,
"term": "<string>",
"type": "approved",
"pos": "noun",
"caseSensitive": true,
"description": "<string>",
"highlight": true,
"creationTime": "2023-11-07T05:31:56Z",
"modificationTime": "2023-11-07T05:31:56Z",
"createdUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"modifiedUser": {
"id": 123,
"fullName": "<string>",
"email": "<string>"
},
"examples": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"example": "<string>",
"type": "good"
}
],
"mistakes": [
{
"id": 123,
"termId": 123,
"termBankId": 123,
"mistake": "<string>",
"pos": "noun",
"caseSensitive": true
}
],
"tags": [
{
"id": 123,
"tag": "<string>",
"termId": 123,
"parentTagId": 123
}
],
"linkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"backlinkedTerms": [
{
"id": 123,
"termId": 123,
"linkedTermId": 123,
"term": "<string>",
"pos": "noun",
"caseSensitive": true,
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"approvedTermExtension": {
"id": 123,
"termId": 123,
"capitalize": true,
"fixCommonMistakes": true,
"fixCase": true
}
}
],
"fails": [
{
"description": "<string>",
"key": "<string>",
"extras": "<any>"
}
]
}