TeamApi
extends AbstractApi
in package
Use API to manage organization teams
Table of Contents
Methods
- addTeamToProject() : AddedProjectTeamInfo
- Add Team ToProject
- create() : Team
- Add Team
- delete() : mixed
- Delete Team
- get() : Team
- Get Team
- list() : ModelCollection
- List Teams
- listProjectPermissions() : ModelCollection
- List Team Projects Permissions
- update() : Team
- Edit Team
- updateProjectPermissions() : ModelCollection
- Permissions Batch Operations
Methods
addTeamToProject()
Add Team ToProject
public
addTeamToProject(int $projectId, array<string|int, mixed> $data) : AddedProjectTeamInfo
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
integer $data[teamId] required
boolean $data[accessToAllWorkflowSteps] Deprecated, use roles instead
boolean $data[managerAccess]
array $data[permissions] Deprecated, use roles instead
array $data[roles]
Tags
Return values
AddedProjectTeamInfocreate()
Add Team
public
create(array<string|int, mixed> $data) : Team
Parameters
- $data : array<string|int, mixed>
-
string $data[name]
Tags
Return values
Teamdelete()
Delete Team
public
delete(int $teamId) : mixed
Parameters
- $teamId : int
Tags
get()
Get Team
public
get(int $teamId) : Team
Parameters
- $teamId : int
Tags
Return values
Teamlist()
List Teams
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
Tags
Return values
ModelCollectionlistProjectPermissions()
List Team Projects Permissions
public
listProjectPermissions(int $teamId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $teamId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Team
public
update(Team $team) : Team
Parameters
- $team : Team
Tags
Return values
TeamupdateProjectPermissions()
Permissions Batch Operations
public
updateProjectPermissions(int $teamId, array<string|int, mixed> $data) : ModelCollection
Parameters
- $teamId : int
- $data : array<string|int, mixed>
-
JSON Patch array. op: add, replace or remove, path: /{projectId}/roles
value: list of role name and permissions