CRcrowdin
Source Files

Edit File

Required scopes: project.source.file (Read and Write).

patch/projects/{projectId}/files/{fileId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

fileIdinteger required

File Identifier. Get via List Files

Request body

op'replace' | 'test' required

Patch operation to perform

path'/branchId' | '/directoryId' | '/name' | '/title' | '/context' | '/priority' | '/importOptions/cleanTagsAggressively' | '/importOptions/translateHiddenText' | '/importOptions/translateHyperlinkUrls' | '/importOptions/translateHiddenRowsAndColumns' | '/importOptions/importNotes' | '/importOptions/importHiddenSlides' | '/importOptions/firstLineContainsHeader' | '/importOptions/importKeyAsSource' | '/importOptions/importTranslations' | '/importOptions/scheme' | '/importOptions/translateContent' | '/importOptions/importHiddenSheets' | '/importOptions/translateAttributes' | '/importOptions/contentSegmentation' | '/importOptions/translatableElements' | '/importOptions/srxStorageId' | '/importOptions/hideAttributeValues' | '/importOptions/customSegmentation' | '/importOptions/excludedElements' | '/importOptions/excludeIncludeDirectives' | '/importOptions/excludedFrontMatterElements' | '/importOptions/excludeCodeBlocks' | '/importOptions/inlineTags' | '/importOptions/inlineHyperlinkText' | '/importOptions/translateDocProperties' | '/importOptions/translateComments' | '/importOptions/ignoreWhitespaceStyles' | '/importOptions/addTabAsCharacter' | '/importOptions/addLineSeparatorAsCharacter' | '/importOptions/lineSeparatorReplacement' | '/importOptions/replaceNoBreakHyphenTag' | '/importOptions/ignoreSoftHyphenTag' | '/importOptions/complexFieldDefinitionsToExtract' | '/importOptions/translateWordHeadersFooters' | '/importOptions/translateWordGraphicName' | '/importOptions/translateWordGraphicDescription' | '/importOptions/ignoreWordFontColors' | '/importOptions/wordFontColorsMinIgnoranceThreshold' | '/importOptions/wordFontColorsMaxIgnoranceThreshold' | '/importOptions/excludeWordStyles' | '/importOptions/translateWordInExcludeStyleMode' | '/importOptions/wordHighlightColors' | '/importOptions/translateWordInExcludeHighlightMode' | '/importOptions/translateWordExcludeColors' | '/importOptions/wordExcludedColors' | '/importOptions/translateExcelCellsCopied' | '/importOptions/translateExcelSheetNames' | '/importOptions/excelExcludedColors' | '/importOptions/translateExcelDiagramData' | '/importOptions/translateExcelDrawings' | '/exportOptions/exportPattern' | '/exportOptions/escapeQuotes' | '/exportOptions/exportQuotes' | '/exportOptions/escapeSpecialCharacters' | '/exportOptions/allowWordStyleOptimization' | '/exportOptions/translateExcelExcludeColors' | '/excludedTargetLanguages' | '/attachLabelIds' | '/detachLabelIds' | '/fields' | '/fields/{fieldSlug}' json-pointer required

A JSON Pointer as defined by <a href="https://tools.ietf.org/html/rfc6901" target="_blank">RFC 6901</a>

Response

File was successfully updated

Example response

{
  "data": {
    "id": 44,
    "projectId": 2,
    "branchId": 34,
    "directoryId": 4,
    "name": "umbrella_app.xliff",
    "title": "source_app_info",
    "context": "Context for translators",
    "type": "xliff",
    "path": "/directory1/directory2/filename.extension",
    "status": "active",
    "revisionId": 1,
    "priority": "normal",
    "importOptions": {
      "scheme": {
        "identifier": 0,
        "sourcePhrase": 1,
        "en": 2,
        "de": 3
      }
    },
    "exportOptions": {
      "exportPattern": "/localization/%locale%/%file_name%.%file_extension%"
    },
    "excludedTargetLanguages": [
      "en",
      "es",
      "pl"
    ],
    "parserVersion": 12,
    "createdAt": "2019-09-19T15:10:43+00:00",
    "updatedAt": "2019-09-19T15:10:46+00:00",
    "fields": {
      "some-field-1": "some value 1",
      "some-field-2": 12,
      "some-field-3": true,
      "some-field-4": [
        "en",
        "ja"
      ]
    }
  }
}

Changes

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