CRcrowdin
Glossaries

Export Glossary

Required scopes: glossary (Read only).

post/glossaries/{glossaryId}/exports

Request

Path parameters

glossaryIdinteger required

Glossary Identifier. Get via List Glossaries

Request body

format'tbx' | 'tbx_v3' | 'csv' | 'xlsx'

Supported formats:

  • 'tbx'
  • 'tbx_v3'
  • 'csv'
  • 'xlsx'
exportType'concepts' | 'terms'

Determines whether the export keeps every term of a matching concept (concepts, default)

  • or only the terms that match the active filters (terms).
textstring
caseSensitiveboolean

Note: Must be used together with text

searchStrictboolean

Note: Must be used together with text

searchFullMatchboolean

Note: Must be used together with text

status'PREFERRED' | 'ADMITTED' | 'NOT_RECOMMENDED' | 'OBSOLETE' | 'DRAFT'

Deprecated: use statuses instead. Cannot be combined with statuses.

statusesstring[]

Filter terms by one or more statuses.

partOfSpeech'NOUN' | 'VERB' | 'ADJ' | 'PRON' | 'PROPN' | 'DET' | 'ADV' | 'ADP' | 'CCONJ' | 'SCONJ' | 'NUM' | 'INTJ' | 'AUX' | 'PRT' | 'SYM' | 'X'

Deprecated: use partsOfSpeech instead. Cannot be combined with partsOfSpeech.

partsOfSpeechstring[]

Filter terms by one or more parts of speech.

type'FULL_FORM' | 'ACRONYM' | 'ABBREVIATION' | 'SHORT_FORM' | 'PHRASE' | 'VARIANT'

Deprecated: use types instead. Cannot be combined with types.

typesstring[]

Filter terms by one or more types.

gender'MASCULINE' | 'FEMININE' | 'NEUTER' | 'COMMON' | 'OTHER'

Deprecated: use genders instead. Cannot be combined with genders.

gendersstring[]

Filter terms by one or more genders.

authorIdinteger

Deprecated: use authorIds instead. Cannot be combined with authorIds.

authorIdsinteger[]

Filter terms by one or more authors. Up to 50 values.

languageIdsstring[]

Filter terms by one or more language IDs. Up to 50 values.

dateFromstring date-time

Export date from in UTC, ISO 8601

dateTostring date-time

Export date to in UTC, ISO 8601

exportFieldsstring[]

Array fields for export.

Note: Used for export CSV or XLSX format only

Example request

{
  "format": "csv",
  "exportType": "terms",
  "text": "value",
  "status": "DRAFT",
  "statuses": [
    "PREFERRED",
    "ADMITTED"
  ],
  "partOfSpeech": "VERB",
  "partsOfSpeech": [
    "NOUN",
    "VERB"
  ],
  "type": "ACRONYM",
  "types": [
    "ACRONYM",
    "ABBREVIATION"
  ],
  "gender": "OTHER",
  "genders": [
    "MASCULINE",
    "FEMININE"
  ],
  "authorId": 12,
  "authorIds": [
    12,
    34
  ],
  "languageIds": [
    "uk",
    "de"
  ],
  "dateFrom": "2024-01-23T07:00:14+00:00",
  "dateTo": "2024-09-27T07:00:14+00:00",
  "exportFields": [
    "term",
    "description",
    "partOfSpeech"
  ]
}

Response

Glossary export was successfully started

Example response

{
  "data": {
    "identifier": "5ed2ce93-6d47-4402-9e66-516ca835cb20",
    "status": "created",
    "attributes": {
      "format": "csv",
      "exportFields": [
        "term",
        "description",
        "partOfSpeech"
      ],
      "text": "value",
      "status": "DRAFT",
      "partOfSpeech": "VERB",
      "type": "ACRONYM",
      "gender": "OTHER",
      "authorId": 12,
      "dateFrom": "2024-09-23T11:26:54+00:00",
      "dateTo": "2024-12-23T11:26:54+00:00"
    },
    "createdAt": "2019-09-23T07:06:43+00:00",
    "updatedAt": "2019-09-23T07:06:43+00:00"
  }
}

Changes

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