CRcrowdin
Glossaries

Import Glossary

Required scopes: glossary (Read and Write).

post/glossaries/{glossaryId}/imports

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

Request body

storageIdinteger required

Storage Identifier. Get via List Storages

Supported file formats:

  • TBX
  • CSV
  • XLS/XLSX
firstLineContainsHeaderboolean

Defines whether file includes first row header that should not be imported

Note: Used for upload of CSV or XLS/XLSX files only

schemeobject

Defines data columns mapping. Acceptable value is combination of following constants:

  • term_{%language_code%} – column with terms
  • description_{%language_code%} – column with terms description
  • partOfSpeech_{%language_code%} – column with terms part of speech
  • status_{%language_code%} – column with terms status
  • type_{%language_code%} – column with terms type
  • gender_{%language_code%} – column with terms gender
  • url_{%language_code%} – column with terms url
  • note_{%language_code%} – column with terms note where %language_code% – placeholder for your language code
  • conceptDefinition – column with concepts definition
  • conceptSubject – column with concepts subject
  • conceptNote – column with concepts note
  • conceptUrl – column with concepts url
  • conceptFigure – column with concepts figure

Note: Used for upload of CSV or XLS/XLSX files only

Example request

{
  "scheme": {
    "term_en": 0,
    "description_en": 1
  }
}

Response

Glossary import was successfully started

Example response

{
  "data": {
    "identifier": "c050fba2-200e-4ce1-8de4-f7ba8eb58732",
    "status": "created",
    "attributes": {
      "storageId": 36,
      "scheme": {
        "description_en": 1
      },
      "firstLineContainsHeader": true
    },
    "createdAt": "2019-09-23T12:17:54+00:00",
    "updatedAt": "2019-09-23T12:17:54+00:00"
  }
}

Changes

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