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
- delete() : mixed
- Delete Project
- get() : Project|null
- Get Project Info
- list() : ModelCollection
- List Projects
- update() : mixed
- Edit Project Info
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]
Tags
Return values
Project|nulldelete()
Delete Project
public
delete(int $projectId) : mixed
Parameters
- $projectId : int
Tags
get()
Get Project Info
public
get(int $projectId) : Project|null
Parameters
- $projectId : int
Tags
Return values
Project|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
ModelCollectionupdate()
Edit Project Info
public
update(Project $project) : mixed
Parameters
- $project : Project