Source Files

Get File

Required scopes: project.source.file (Read only).

get/projects/{projectId}/files/{fileId}

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

fileIdinteger required

File Identifier. Get via List Files

Response

File data

  • Translators and proofreaders – receive the response File Info Resource
  • Project owners, organization admins, and managers – receive the response File Resource
OR

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",
    "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.