Language Files

Update a language file

Changes a language file of the account. It is a PARTIAL write over the columns -- name, language, internal_notes -- and file is the one field that is not one of them.

WITH file EVERY LITERAL IS REPLACED by the ones of the .txt that is sent, which is what uploading a file again does in the application; WITHOUT it not a single literal is touched. There is no partial edit of literals on this surface, and the .txt a call replaced is not kept anywhere: before carries the columns and not the literals, so the inverse of a call that carried a file is uploading the previous file again.

NOTHING IS RECOMPUTED BY THE CALL. When the file changes the literals, the cached results of every report printed with this file are dropped, so each one shows the new literals the next time its widgets are drawn; a call that sends the same literals again, or no file, drops nothing. A window of the application that is already open keeps the previous literals until it is reloaded, and the results it draws meanwhile can be stored again with the old literals and served to the reports printed with the file for up to four hours. The drop is best effort: a call that could not clear the stored results still answers 200.

The sixteen files the platform ships and the empty key answer 409 NOT_ALLOWED with details.reason system_defined.

Every write endpoint reads dry_run and idempotency_key; see the Write guarantees section of the introduction.

post/language-files/update

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/language-files/update
  • Auth: HTTP bearer

Request body

language_file_keystring required

The file to change. One of the account's own: the sixteen of the platform answer 409 NOT_ALLOWED.

namestring nullable

Left out or null, it is left as it is.

languagestring nullable

The ISO 639-1 code of the literals. Left out or null, it is left as it is.

internal_notesstring nullable

An empty string takes the note away; null leaves it as it is.

is_systemboolean nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

file_namestring nullable

Accepted and ignored: the name of the .txt is written through the file object. It comes back as a READ_ONLY_FIELD_IGNORED warning.

download_urlstring nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

download_url_expires_atstring nullable

Accepted and ignored: part of what a read publishes. It comes back as a READ_ONLY_FIELD_IGNORED warning.

dry_runboolean

Validate everything and write nothing.

idempotency_keystring

Replays the answer of an identical call for 24 hours.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

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