All URIs are relative to https://api.phrase.com/v2
| Method | HTTP request | Description |
|---|---|---|
| UploadCreate | Post /projects/{project_id}/uploads | Upload a new file |
| UploadShow | Get /projects/{project_id}/uploads/{id} | Get a single upload |
| UploadsList | Get /projects/{project_id}/uploads | List uploads |
Upload UploadCreate(ctx, projectId, file, fileFormat, localeId, optional)
Upload a new file
Upload a new language file. Creates necessary resources in your project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| file | os.Fileos.File | File to be imported | |
| fileFormat | string | File format. Auto-detected when possible and not specified. | |
| localeId | string | Locale of the file's content. Can be the name or id of the locale. Preferred is id. | |
| optional | *UploadCreateOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UploadCreateOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use | tags | optional.String| List of tags separated by comma to be associated with the new keys contained in the upload. | updateTranslations | optional.Bool| Indicates whether existing translations should be updated with the file content. | updateTranslationKeys | optional.Bool| Pass `false` here to prevent new keys from being created and existing keys updated. | [default to true] updateTranslationsOnSourceMatch | optional.Bool| Update target translations only if the source translations of the uploaded multilingual file match the stored translations. | [default to false] updateDescriptions | optional.Bool| Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions. | convertEmoji | optional.Bool| This option is obsolete. Providing the option will cause a bad request error. | skipUploadTags | optional.Bool| Indicates whether the upload should not create upload tags. | skipUnverification | optional.Bool| Indicates whether the upload should unverify updated translations. | fileEncoding | optional.String| Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\". | localeMapping | optional.Interface of map[string]interface{}| Mapping between locale names and translation columns. Required in some formats like CSV or XLSX. | formatOptions | optional.Interface of map[string]interface{}| Additional options available for specific formats. See our format guide for the complete list. | autotranslate | optional.Bool| If set, translations for the uploaded language will be fetched automatically. | markReviewed | optional.Bool| Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project. | tagOnlyAffectedKeys | optional.Bool| Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false` | [default to false] translationKeyPrefix | optional.String| This prefix will be added to all uploaded translation key names to prevent collisions. Use a meaningful prefix related to your project or file to keep key names organized. |
- Content-Type: multipart/form-data
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Upload UploadShow(ctx, projectId, id, optional)
Get a single upload
View details and summary for a single upload.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| id | string | ID | |
| optional | *UploadShowOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UploadShowOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | branch | optional.String| specify the branch to use |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]Upload UploadsList(ctx, projectId, optional)
List uploads
List all uploads for the given project.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| projectId | string | Project ID | |
| optional | *UploadsListOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UploadsListOpts struct
| Name | Type | Description | Notes |
|---|
xPhraseAppOTP | optional.String| Two-Factor-Authentication token (optional) | page | optional.Int32| Page number | perPage | optional.Int32| Limit on the number of objects to be returned, between 1 and 100. 25 by default | branch | optional.String| specify the branch to use |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]