Download resource file

get

https://api.lingohub.com/v1/{workspaceUrl}/projects/{projectUrl}/resources/{fileName}

Downloads the specified resource file from the project. Supports extensive export customization through query parameters including blank content handling, status filtering, character encoding, HTML encoding, and format conversion (e.g. export an iOS .strings file as Android XML). The response body contains the raw file content with appropriate content type headers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspaceUrl

string

required

workspaceUrl

projectUrl

string

required

projectUrl

fileName

string

required

Name of the resource file to download

Query Params

path

string

Path of the resource file to download. if the fileName won't be unique.

iso2_slug

string

The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_code'.

iso2_code

string

The iso code of the resource file locale. Overrides the language information that might be given in the path. Alias of 'iso2_slug'.

source:blankContentHandling

string

enum

Should the segment be exported if source content is blank.

Allowed:

target:blankContentHandling

string

enum

Should the segment be exported if target content is blank.

Allowed:

source:filterByStatus

string

enum

Filter for source segments based on status.

Allowed:

target:filterByStatus

string

enum

Filter for target segments based on status.

Allowed:

htmlEncoding

string

enum

If the segment content holds HTML. How should it be escaped

Allowed:

encoding

string

The character set encoding the file should have.

escapeMode

string

enum

Alias of 'htmlEncoding'

Allowed:

addLocaleInformationToFilename

string

enum

If the language information should be added to the filename.

Allowed:

escapeCharacters

boolean

If special characters should be escaped. Different behaviour according to resource type.

exportTargetComments

boolean

Should comments be exported to files of the target language

exportSourceLocale

boolean

If a resource file holds multiple languages, this indicates if the source language should be included in this export.

exportHeader

boolean

If the file header (if applicable) should be exported.

exportTitle

boolean

if the title of a segment (if applicable) should be exported.

exportDescription

boolean

If a resource file holds multiple languages, this indicates if the description of the segments should be exported at all.

projectType

string

enum

Overrides the project type of the project for this export. Enables to eg. download an iOS file as Android XML or vice versa.

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successfully returns the content of the specified resource file as a byte stream.

401Unauthorized: Authentication credentials are missing or invalid.

403Forbidden: The authenticated user does not have resource view permission on this project.

404Not Found: The specified workspace, project, or resource file does not exist.

500Internal Server Error: An unexpected error occurred during resource file export.