converter

Export Diagnostics To File

GET

/api/converter/{company_name}/templates/{template_id}/export_diagnostics/{language_matrix}

curl --request GET \
  --url '/api/converter/{company_name}/templates/{template_id}/export_diagnostics/{language_matrix}?export_type=categories&media_type=application%2Fvnd.openxmlformats-officedocument.spreadsheetml.sheet&perform_autotranslation=false' \
  --header 'Authorization: Bearer <token>'

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

template_idstringrequired

Required string length: 24 - 24

Pattern: ^[0-9a-f]{24}$

Example: 5eb7cf5a86d9755df3a6c593

company_namestringrequired

language_matrixenum<string>required

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

Query Parameters

export_typeenum<string>queryrequired

Available options: categories, probabilities

media_typeenum<string>queryrequired

Available options: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, text/csv, text/tab-separated-values

languages_sheetsenum<string>[]querydefault:[]

Additional languages to export symptoms and causes sheets for. Default option will export all languages activated in company.

perform_autotranslationbooleanquerydefault:false

Accesses the translate service to translate missing localizations. Returns a 404 error if the translation service is not available.

Response

Successful Response