ProjectApi
extends AbstractApi
in package
Using projects, you can keep your source files sorted.
Use API to manage projects, change their settings, or remove them if required.
Table of Contents
Methods
- create() : Project|null
- Add Project
- createFileFormatSettings() : FileFormatSettings|null
- Add Project File Format Settings
- delete() : mixed
- Delete Project
- deleteFileFormatSettings() : void
- Delete Project File Format Settings
- downloadFileFormatSettingsCustomSegmentation() : DownloadFile|null
- Download Project File Format Settings Custom Segmentation
- get() : Project|null
- Get Project Info
- getFileFormatSettings() : FileFormatSettings|null
- Get Project File Format Settings
- list() : ModelCollection
- List Projects
- listFileFormatSettings() : ModelCollection
- List Project File Format Settings
- resetFileFormatSettingsCustomSegmentation() : void
- Reset Project File Format Settings Custom Segmentation
- update() : Project|null
- Edit Project Info
- updateFileFormatSettings() : FileFormatSettings|null
- Edit Project File Format Settings
Methods
create()
Add Project
public
create(array<string|int, mixed> $data) : Project|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[identifier]
string $data[type]
string $data[sourceLanguageId] required
integer $data[groupId] required
integer $data[templateId] required
integer $data[groupId]
array $data[targetLanguageIds]
string $data[visibility]
string $data[languageAccessPolicy]
string $data[cname]
integer $data[vendorId]
integer $data[mtEngineId]
string $data[description]
boolean $data[delayedWorkflowStart]
boolean $data[skipUntranslatedStrings]
boolean $data[skipUntranslatedFiles]
integer $data[exportWithMinApprovalsCount]
integer $data[exportApprovedOnly]
integer $data[defaultTmId]
integer $data[defaultGlossaryId]
Tags
Return values
Project|nullcreateFileFormatSettings()
Add Project File Format Settings
public
createFileFormatSettings(int $projectId, array<string|int, mixed> $data) : FileFormatSettings|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
Tags
Return values
FileFormatSettings|nulldelete()
Delete Project
public
delete(int $projectId) : mixed
Parameters
- $projectId : int
Tags
deleteFileFormatSettings()
Delete Project File Format Settings
public
deleteFileFormatSettings(int $projectId, int $fileFormatSettingsId) : void
Parameters
- $projectId : int
- $fileFormatSettingsId : int
Tags
downloadFileFormatSettingsCustomSegmentation()
Download Project File Format Settings Custom Segmentation
public
downloadFileFormatSettingsCustomSegmentation(int $projectId, int $fileFormatSettingsId) : DownloadFile|null
Parameters
- $projectId : int
- $fileFormatSettingsId : int
Tags
Return values
DownloadFile|nullget()
Get Project Info
public
get(int $projectId) : Project|null
Parameters
- $projectId : int
Tags
Return values
Project|nullgetFileFormatSettings()
Get Project File Format Settings
public
getFileFormatSettings(int $projectId, int $fileFormatSettingsId) : FileFormatSettings|null
Parameters
- $projectId : int
- $fileFormatSettingsId : int
Tags
Return values
FileFormatSettings|nulllist()
List Projects
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[groupId] for enterprise only
integer $params[hasManagerAccess] for enterprise only Enum{0,1} (0 -false, 1 true)
integer $params[limit]
integer $params[offset]
integer $params[userId] Get user own projects
Tags
Return values
ModelCollectionlistFileFormatSettings()
List Project File Format Settings
public
listFileFormatSettings(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
Tags
Return values
ModelCollectionresetFileFormatSettingsCustomSegmentation()
Reset Project File Format Settings Custom Segmentation
public
resetFileFormatSettingsCustomSegmentation(int $projectId, int $fileFormatSettingsId) : void
Parameters
- $projectId : int
- $fileFormatSettingsId : int
Tags
update()
Edit Project Info
public
update(Project $project) : Project|null
Parameters
- $project : Project
Tags
Return values
Project|nullupdateFileFormatSettings()
Edit Project File Format Settings
public
updateFileFormatSettings(int $projectId, FileFormatSettings $fileFormatSettings) : FileFormatSettings|null
Parameters
- $projectId : int
- $fileFormatSettings : FileFormatSettings