Source Files

Add Directory

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

post/projects/{projectId}/directories

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

namestring required

Directory name

Note: Can't contain \ / : * ? " < > | symbols

branchIdinteger

Branch identifier. Get via List Branches

Note: Can't be used with directoryId in same request

directoryIdinteger

Parent Directory Identifier. Get via List Directories

Note: Can't be used with branchId in same request

titlestring

Use to provide more details for translators. Title is available in UI only

exportPatternstring

Directory export pattern. Defines directory name and path in resulting translations bundle

Note: Can't contain : * ? " < > | symbols

priority'low' | 'normal' | 'high'

Defines priority level for each branch

Example request

{
  "name": "main",
  "branchId": 34,
  "directoryId": 2,
  "title": "<Description materials>",
  "exportPattern": "/localization/%locale%/%file_name%",
  "priority": "normal"
}

Response

Directory was successfully created

Example response

{
  "data": {
    "id": 4,
    "projectId": 2,
    "branchId": 34,
    "name": "main",
    "title": "<Description materials>",
    "exportPattern": "/localization/%locale%/%file_name%",
    "path": "/main",
    "priority": "normal",
    "createdAt": "2019-09-19T14:14:00+00:00",
    "updatedAt": "2019-09-19T14:14:00+00:00"
  }
}

Changes

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