reference.md

• projects.branches.getMany(projectId, [options])
• projects.branches.createOne(projectId)
• projects.branches.getOne(projectId, branchId)
• projects.branches.deleteOne(projectId, branchId)
• projects.branches.patchOne(projectId, branchId)
• projects.directories.getMany(projectId, [options])
• projects.directories.createOne(projectId)
• projects.directories.getOne(projectId, directoryId)
• projects.directories.deleteOne(projectId, directoryId)
• projects.directories.patchOne(projectId, directoryId)
• projects.files.getMany(projectId, [options])
• projects.files.createOne(projectId, [options])
• projects.files.getOne(projectId, fileId)
• projects.files.deleteOne(projectId, fileId)
• projects.files.patchOne(projectId, fileId)
• projects.files.downloadLink(projectId, fileId)
• glossaries.getMany([options])
• glossaries.createOne()
• glossaries.getOne(glossaryId)
• glossaries.deleteOne(glossaryId)
• glossaries.patchOne(glossaryId)
• glossaries.export.exportOne(glossaryId)
• glossaries.export.getDownloadLink(glossaryId, [options])
• glossaries.export.getExportStatus(glossaryId, exportId)
• glossaries.import.importOne(glossaryId)
• glossaries.import.getImportOne(glossaryId, importId)
• groups.getMany([options])
• groups.createOne()
• groups.getOne(groupId)
• groups.deleteOne(groupId)
• groups.patchOne(groupId)
• projects.images.background.uploadOne(projectId)
• projects.images.background.deleteOne(projectId)
• projects.images.logo.uploadOne(projectId)
• projects.images.logo.deleteOne(projectId)
• issues.getMany(projectId, [options])
• projects.issues.statistics.getMany(projectId, [options])
• languages.getMany([options])
• languages.getOne(languageId)
• projects.preTranslates.preTranslate(projectId)
• projects.preTranslates.getTranslation(projectId, preTranslationId)
• storages.preview.getOne(storageId)
• projects.branches.languages.progress.getMany(projectId, branchId)
• projects.directories.languages.progress.getMany(projectId, directoryId)
• projects.exportReadyProgress.getMany(projectId, [options])
• projects.files.languages.progress.getMany(projectId, fileId)
• projects.languages.progress.getMany(projectId)
• projects.getMany([options])
• projects.createOne()
• projects.getOne(projectId)
• projects.deleteOne(projectId)
• projects.patchOne(projectId)
• projects.pseudo.builds.getOne(projectId)
• projects.pseudo.builds.getStatus(projectId, pseudoTranslationBuildId)
• projects.pseudo.getDownloadLink(projectId)
• reportTypes.getMany(projectId, [options])
• projects.reports.createOne(projectId)
• projects.reports.raw.exportOne(projectId, reportId)
• projects.files.revisions.getMany(projectId, fileId, [options])
• projects.files.revisions.createOne(projectId, fileId)
• projects.files.revisions.getOne(projectId, fileId, revision)
• projects.screenshots.getMany(projectId, [options])
• projects.screenshots.createOne(projectId)
• projects.screenshots.getOne(projectId, screenshotId)
• projects.screenshots.replaceOne(projectId, screenshotId)
• projects.screenshots.deleteOne(projectId, screenshotId)
• projects.screenshots.patchOne(projectId, screenshotId)
• projects.screenshots.tags.getMany(projectId, screenshotId, [options])
• projects.screenshots.tags.replaceAll(projectId, screenshotId)
• projects.screenshots.tags.createOne(projectId, screenshotId)
• projects.screenshots.tags.deleteAll(projectId, screenshotId)
• projects.screenshots.tags.getOne(projectId, screenshotId, tagId)
• projects.screenshots.tags.deleteOne(projectId, screenshotId, tagId)
• projects.screenshots.tags.patchOne(projectId, screenshotId, tagId)
• projects.settings.getOne(projectId)
• projects.settings.patchOne(projectId)
• storages.getAll(storageId)
• storages.uploadOne()
• storages.getOne(storageId)
• storages.deleteOne(storageId)
• projects.strings.createOne(projectId)
• projects.strings.getOne(projectId, stringId)
• projects.strings.deleteOne(projectId, stringId)
• projects.strings.patchOne(projectId, stringId)
• projects.tasks.getMany(projectId, [options])
• projects.tasks.createOne(projectId)
• projects.tasks.getOne(projectId, taskId)
• projects.tasks.deleteOne(projectId, taskId)
• projects.tasks.patchOne(projectId, taskId)
• projects.tasks.statistics.getMany(projectId, [options])
• glossaries.terms.getMany(glossaryId, [options])
• glossary.terms.createOne(glossaryId)
• glossaries.terms.getOne(glossaryId, termId)
• glossaries.terms.deleteOne(glossaryId, termId)
• glossaries.terms.patchOne(glossaryId, termId)
• tms.getList([options])
• tms.uploadOne()
• tms.getOne(tmId)
• tms.deleteOne(tmId)
• tms.patchOne(tmId)
• tms.downloadOne(tmId, [options])
• tms.exportOne(tmId)
• tms.export.getOne(tmId, exportId)
• tms.upload(tmId)
• tms.upload.jobByTm(tmId, importId)
• projects.translations.builds.getList([options])
• projects.translations.builds.init(projectId)
• projects.translations.builds.getDownloadLink(projectId, buildId)
• projects.translations.builds.getOne(projectId, buildId)
• projects.translations.builds.cancel(projectId, buildId)
• projects.translations.initByLanguage(projectId, languageId)
• projects.webhooks.getMany(projectId, [options])
• projects.webhooks.createOne(projectId)
• projects.webhooks.getOne(projectId, webhookId)
• projects.webhooks.deleteOne(projectId, webhookId)
• projects.webhooks.patchOne(projectId, webhookId)

projects.branches.getMany(projectId, [options])

List project branches

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: name
  in: query
  description: Filter branch by name.
  schema:
    type: string
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.branches.createOne(projectId)

Create a branch

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.branches.getOne(projectId, branchId)

Get a branch

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: path
  description: Branch Identifier.
  required: true
  schema:
    type: integer

projects.branches.deleteOne(projectId, branchId)

Delete a branch

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: path
  description: Branch Identifier.
  required: true
  schema:
    type: integer

projects.branches.patchOne(projectId, branchId)

Update a branch

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: path
  description: Branch Identifier.
  required: true
  schema:
    type: integer

projects.directories.getMany(projectId, [options])

List project directories

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: query
  description: Filter directories by branchId
  schema:
    type: integer
- name: directoryId
  in: query
  description: Filter directories by directoryId
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.directories.createOne(projectId)

Create a directory

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.directories.getOne(projectId, directoryId)

Get a directory

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: directoryId
  in: path
  description: Directory Identifier.
  required: true
  schema:
    type: integer

projects.directories.deleteOne(projectId, directoryId)

Delete a directory

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: directoryId
  in: path
  description: Directory Identifier.
  required: true
  schema:
    type: integer

projects.directories.patchOne(projectId, directoryId)

Update a directory

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: directoryId
  in: path
  description: Directory Identifier.
  required: true
  schema:
    type: integer

projects.files.getMany(projectId, [options])

List project files

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: query
  description: >-
    List branch files.


    __Note!__ You can either list files for the specified branch (branchId) in
    the same request.
  schema:
    type: integer
- name: directoryId
  in: query
  description: >-
    List directory files.


    __Note!__ You can either list files for the specified directory
    (directoryId) in the same request.
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.files.createOne(projectId, [options])

Create a file

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: query
  description: 'Get files of branch. You can set branchId or directoryId, not both'
  schema:
    type: integer
- name: directoryId
  in: query
  description: 'Get files of directory. You can set branchId or directoryId, not both'
  schema:
    type: integer

projects.files.getOne(projectId, fileId)

Get a file

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

projects.files.deleteOne(projectId, fileId)

Delete a file

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

projects.files.patchOne(projectId, fileId)

Update a file

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

projects.files.downloadLink(projectId, fileId)

Export file raw

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

glossaries.getMany([options])

List Glossaries

Parameters

- name: groupId
  in: query
  description: 'A unique identifier for the group, this glossary is associated with.'
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

glossaries.createOne()

Create a Glossary

Parameters

[]

glossaries.getOne(glossaryId)

Get a Glossary

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.deleteOne(glossaryId)

Delete a Glossary

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.patchOne(glossaryId)

Update a Glossary

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.export.exportOne(glossaryId)

Start Glossary export

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.export.getDownloadLink(glossaryId, [options])

Get a Glossary download link

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: format
  in: query
  description: Defines download format. Default is tbx.
  schema:
    type: string
    enum:
      - tbx
      - csv
      - xlsx

glossaries.export.getExportStatus(glossaryId, exportId)

Get Glossary export status

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: exportId
  in: path
  description: 'Export Identifier, consists of 36 characters.'
  required: true
  schema:
    type: string

glossaries.import.importOne(glossaryId)

Import a Glossary file

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.import.getImportOne(glossaryId, importId)

Get Glossary import status

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: importId
  in: path
  description: 'Import Identifier, consists of 36 characters.'
  required: true
  schema:
    type: string

groups.getMany([options])

List groups

Parameters

- name: parentId
  in: query
  description: Parent group Identifier
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

groups.createOne()

Create group

Parameters

[]

groups.getOne(groupId)

Get group

Parameters

- name: groupId
  in: path
  description: A unique identifier for the group.
  required: true
  schema:
    type: integer

groups.deleteOne(groupId)

Delete Group

Parameters

- name: groupId
  in: path
  description: A unique identifier for the group.
  required: true
  schema:
    type: integer

groups.patchOne(groupId)

Update group

Parameters

- name: groupId
  in: path
  description: A unique identifier for the group.
  required: true
  schema:
    type: integer

projects.images.background.uploadOne(projectId)

Upload project background

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.images.background.deleteOne(projectId)

Delete project background

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.images.logo.uploadOne(projectId)

Upload project logo

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.images.logo.deleteOne(projectId)

Delete project logo

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

issues.getMany(projectId, [options])

List issues

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0
- name: type
  in: query
  description: Defines the issue type.
  schema:
    type: string
    enum:
      - all
      - general_question
      - translation_mistake
      - context_request
      - source_mistake
- name: status
  in: query
  description: Defines the issue resolution status.
  schema:
    type: string
    enum:
      - all
      - resolved
      - unresolved

projects.issues.statistics.getMany(projectId, [options])

List issue statistics

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0
- name: status
  in: query
  description: Defines the issue resolution status.
  schema:
    type: string
    default: all
    enum:
      - resolved
      - unresolved
      - all
- name: languageIds
  in: query
  description: Language identifier for filter.
  schema:
    type: string
    pattern: '^[\d]+(\,[\d]+)*$'

languages.getMany([options])

List supported languages

Parameters

- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

languages.getOne(languageId)

Get language

Parameters

- name: languageId
  in: path
  description: Language Identifier.
  required: true
  schema:
    type: integer

projects.preTranslates.preTranslate(projectId)

Pre-translate project files

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.preTranslates.getTranslation(projectId, preTranslationId)

Get status of pre-translation

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: preTranslationId
  in: path
  description: Pre Translate Identifier.
  required: true
  schema:
    type: string

storages.preview.getOne(storageId)

Get preview

Parameters

- parameter: StorageId
  name: storageId
  in: path
  description: A unique identifier for the storage.
  required: true
  schema:
    type: integer

projects.branches.languages.progress.getMany(projectId, branchId)

Get branch translation progress

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: branchId
  in: path
  description: Branch Identifier.
  required: true
  schema:
    type: integer

projects.directories.languages.progress.getMany(projectId, directoryId)

Get directory translation progress

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: directoryId
  in: path
  description: Directory Identifier.
  required: true
  schema:
    type: integer

projects.exportReadyProgress.getMany(projectId, [options])

Get project translations export status

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: languageIds
  in: query
  description: Language identifier for filter.
  schema:
    type: string
    pattern: '^[\d]+(\,[\d]+)*$'
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.files.languages.progress.getMany(projectId, fileId)

Get file translation progress

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

projects.languages.progress.getMany(projectId)

Get project translation progress

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.getMany([options])

List projects

Parameters

- name: groupId
  in: query
  description: Group Identifier
  schema:
    type: integer
- name: hasManagerAccess
  in: query
  description: |-
    Projects with Manager Access
     *          0 - false
     *          1 - true
  schema:
    type: integer
    default: 0
    enum:
      - 1
      - 0
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.createOne()

Create project

Parameters

[]

projects.getOne(projectId)

Get project

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.deleteOne(projectId)

Delete project

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.patchOne(projectId)

Update project

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.pseudo.builds.getOne(projectId)

Build pseudo-translation files

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.pseudo.builds.getStatus(projectId, pseudoTranslationBuildId)

View pseudo-translation build status

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: pseudoTranslationBuildId
  in: path
  description: 'Pseudo Translation Build Identifier, consists of 36 characters.'
  required: true
  schema:
    type: string

projects.pseudo.getDownloadLink(projectId)

Get pseudo-translation last build download link

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

reportTypes.getMany(projectId, [options])

List supported reports

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.reports.createOne(projectId)

Generate a report

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.reports.raw.exportOne(projectId, reportId)

Export project report raw

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: reportId
  in: path
  description: 'Report Identifier, consists of 36 characters'
  required: true
  schema:
    type: string

projects.files.revisions.getMany(projectId, fileId, [options])

List file revisions

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.files.revisions.createOne(projectId, fileId)

Create a file revision

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer

projects.files.revisions.getOne(projectId, fileId, revision)

Get a file revision

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: fileId
  in: path
  description: File Identifier.
  required: true
  schema:
    type: integer
- name: revision
  in: path
  description: Revision number.
  required: true
  schema:
    type: integer

projects.screenshots.getMany(projectId, [options])

List screenshots

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.screenshots.createOne(projectId)

Create a screenshot

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.getOne(projectId, screenshotId)

Get a screenshot

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.replaceOne(projectId, screenshotId)

Replace a screenshot

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.deleteOne(projectId, screenshotId)

Delete a screenshot

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.patchOne(projectId, screenshotId)

Update a screenshot

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.tags.getMany(projectId, screenshotId, [options])

List screenshot tags

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.screenshots.tags.replaceAll(projectId, screenshotId)

Replace all screenshot tags

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.tags.createOne(projectId, screenshotId)

Add a tag

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.tags.deleteAll(projectId, screenshotId)

Delete all screenshot tags

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer

projects.screenshots.tags.getOne(projectId, screenshotId, tagId)

Get a tag

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer
- name: tagId
  in: path
  description: >-
    Screenshot’s tag identifier. Use List screenshots or Get screenshots method
    to get the tag identifier..
  required: true
  schema:
    type: integer

projects.screenshots.tags.deleteOne(projectId, screenshotId, tagId)

Delete a tag

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer
- name: tagId
  in: path
  description: >-
    Screenshot’s tag identifier. Use List screenshots or Get screenshots method
    to get the tag identifier..
  required: true
  schema:
    type: integer

projects.screenshots.tags.patchOne(projectId, screenshotId, tagId)

Update a tag

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: screenshotId
  in: path
  description: Screenshot Identifier.
  required: true
  schema:
    type: integer
- name: tagId
  in: path
  description: >-
    Screenshot’s tag identifier. Use List screenshots or Get screenshots method
    to get the tag identifier..
  required: true
  schema:
    type: integer

projects.settings.getOne(projectId)

Get project settings

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.settings.patchOne(projectId)

Update project settings

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

storages.getAll(storageId)

List user storages

Parameters

- parameter: StorageId
  name: storageId
  in: path
  description: A unique identifier for the storage.
  required: true
  schema:
    type: integer

storages.uploadOne()

Upload a file

Parameters

- name: Content-Type
  in: header
  description: File content type
  required: true
  schema:
    type: string

storages.getOne(storageId)

Get storage

Parameters

- parameter: StorageId
  name: storageId
  in: path
  description: A unique identifier for the storage.
  required: true
  schema:
    type: integer

storages.deleteOne(storageId)

Delete Storage

Parameters

- parameter: StorageId
  name: storageId
  in: path
  description: A unique identifier for the storage.
  required: true
  schema:
    type: integer

projects.strings.createOne(projectId)

Create a project string

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.strings.getOne(projectId, stringId)

Get a project string

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: stringId
  in: path
  description: String Identifier.
  required: true
  schema:
    type: integer

projects.strings.deleteOne(projectId, stringId)

Delete a project string

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: stringId
  in: path
  description: String Identifier.
  required: true
  schema:
    type: integer

projects.strings.patchOne(projectId, stringId)

Update a project string

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: stringId
  in: path
  description: String Identifier.
  required: true
  schema:
    type: integer

projects.tasks.getMany(projectId, [options])

List tasks

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.tasks.createOne(projectId)

Create a task

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.tasks.getOne(projectId, taskId)

Get a task

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: taskId
  in: path
  description: Task Identifier.
  required: true
  schema:
    type: integer

projects.tasks.deleteOne(projectId, taskId)

Delete a task

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: taskId
  in: path
  description: Task Identifier.
  required: true
  schema:
    type: integer

projects.tasks.patchOne(projectId, taskId)

Update a task

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: taskId
  in: path
  description: Task Identifier.
  required: true
  schema:
    type: integer

projects.tasks.statistics.getMany(projectId, [options])

List of task statistic

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0
- name: status
  in: query
  description: |-
    Defines the task resolution status:
     * 0 - todo
     * 1 - in_progress
     * 2 - done
     * 3 - closed
     * 4 - archived
     * 5 - overdue
  schema:
    type: integer
    enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
- name: languageIds
  in: query
  description: Language identifier for filter.
  schema:
    type: string
    pattern: '^[\d]+(\,[\d]+)*$'

glossaries.terms.getMany(glossaryId, [options])

List terms

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: userId
  in: query
  description: User Identifier.
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

glossary.terms.createOne(glossaryId)

Create a term

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer

glossaries.terms.getOne(glossaryId, termId)

Get a term

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: termId
  in: path
  description: Term Identifier.
  required: true
  schema:
    type: integer

glossaries.terms.deleteOne(glossaryId, termId)

Delete a term

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: termId
  in: path
  description: Term Identifier.
  required: true
  schema:
    type: integer

glossaries.terms.patchOne(glossaryId, termId)

Update a term

Parameters

- name: glossaryId
  in: path
  description: Glossary Identifier.
  required: true
  schema:
    type: integer
- name: termId
  in: path
  description: Term Identifier.
  required: true
  schema:
    type: integer

tms.getList([options])

List TMs

Parameters

- name: groupId
  in: query
  description: A unique identifier for the group.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

tms.uploadOne()

Create a TM

Parameters

[]

tms.getOne(tmId)

Get a TM

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer

tms.deleteOne(tmId)

Delete a TM

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer

tms.patchOne(tmId)

Update a TM

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer

tms.downloadOne(tmId, [options])

Get a TM download link

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer
- name: sourceLanguageId
  in: query
  description: Defines a source language in the language pair.
  schema:
    type: integer
- name: targetLanguageId
  in: query
  description: Defines a target language in the language pair.
  schema:
    type: integer
- name: format
  in: query
  description: Defines the format of TMs file. Default is tmx.
  schema:
    type: string

tms.exportOne(tmId)

Start TM export

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer

tms.export.getOne(tmId, exportId)

Get TM export status

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer
- name: exportId
  in: path
  description: 'Export Identifier, consists of 36 characters.'
  required: true
  schema:
    type: string

tms.upload(tmId)

Upload a TM

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer

tms.upload.jobByTm(tmId, importId)

Get TM import status

Parameters

- name: tmId
  in: path
  description: TM Identifier.
  required: true
  schema:
    type: integer
- name: importId
  in: path
  description: 'Import Identifier, consists of 36 characters.'
  required: true
  schema:
    type: string

projects.translations.builds.getList([options])

List project builds

Parameters

- name: branchId
  in: query
  description: Filter builds by branchId
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.translations.builds.init(projectId)

Build transaltions

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.translations.builds.getDownloadLink(projectId, buildId)

Download translations URL

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: buildId
  in: path
  description: Project Build Identifier.
  required: true
  schema:
    type: integer

projects.translations.builds.getOne(projectId, buildId)

Get project build info

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: buildId
  in: path
  description: Project Build Identifier.
  required: true
  schema:
    type: integer

projects.translations.builds.cancel(projectId, buildId)

Cancel project build

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: buildId
  in: path
  description: Project Build Identifier.
  required: true
  schema:
    type: integer

projects.translations.initByLanguage(projectId, languageId)

Upload translation for a specified language

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: languageId
  in: path
  description: Language Identifier.
  required: true
  schema:
    type: integer

projects.webhooks.getMany(projectId, [options])

List webhooks

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: limit
  in: query
  description: Maximum number of items to retrieve.
  schema:
    type: integer
    default: 25
    maximum: 500
    minimum: 1
- name: offset
  in: query
  description: Starting offset in the collection.
  schema:
    type: integer
    default: 0
    minimum: 0

projects.webhooks.createOne(projectId)

Create a webhook

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer

projects.webhooks.getOne(projectId, webhookId)

Get a webhook

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: webhookId
  in: path
  description: Webhook Identifier.
  required: true
  schema:
    type: integer

projects.webhooks.deleteOne(projectId, webhookId)

Delete a webhook

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: webhookId
  in: path
  description: Webhook Identifier.
  required: true
  schema:
    type: integer

projects.webhooks.patchOne(projectId, webhookId)

Update a webhook

Parameters

- name: projectId
  in: path
  description: Project Identifier.
  required: true
  schema:
    type: integer
- name: webhookId
  in: path
  description: Webhook Identifier.
  required: true
  schema:
    type: integer