CRcrowdin
Glossaries

Update Concept

Required scopes: glossary (Read and Write).

Updates the concept and the definition and note stored for each of its languages. fields writes the whole set of custom field values: a field the request omits, or whose value is empty, is cleared.

Note: There is no separate method for concept creation. Concepts are automatically created when adding a term without specifying a conceptId.

put/glossaries/{glossaryId}/concepts/{conceptId}

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

conceptIdinteger required

Concept Identifier. Get via List Concepts

Request body

subjectstring

subject

definitionstring

This is a sample definition.

translatableboolean
notestring

Any kind of note, such as a usage note, explanation, or instruction

urlstring

Base URL

figurestring

Used for an external cross-reference, such as a URL, or to point to an external graphic file

fieldsEnterpriseAdditionalFields

Fields. Keys get via List Fields

Example request

{
  "subject": "general",
  "definition": "This is a sample definition.",
  "note": "Any concept-level note information",
  "url": "www.example.com",
  "figure": "www.example.com/image.png",
  "languagesDetails": [
    {
      "languageId": "en",
      "definition": "This is a sample definition.",
      "note": "Any kind of note, such as a usage note, explanation, or instruction."
    }
  ],
  "fields": {
    "some-field-1": "some value 1",
    "some-field-2": 12,
    "some-field-3": true,
    "some-field-4": [
      "en",
      "ja"
    ]
  }
}

Response

Concept was successfully updated

Example response

{
  "data": {
    "id": 2,
    "userId": 6,
    "glossaryId": 6,
    "subject": "general",
    "definition": "Some definition",
    "translatable": true,
    "note": "Any kind of note, such as a usage note, explanation, or instruction",
    "url": "www.example.com",
    "figure": "www.example.com/image.png",
    "languagesDetails": [
      {
        "languageId": "en",
        "userId": 12,
        "definition": "Some definition",
        "note": "Some note",
        "createdAt": "2019-09-19T14:14:00+00:00",
        "updatedAt": "2019-09-19T14:14:00+00:00"
      }
    ],
    "createdAt": "2019-09-23T07:19:47+00:00",
    "updatedAt": "2019-09-23T07:19:47+00:00",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.