Module: job_role

Enumeration: SystemRoleType

JOB_CREATOR	1
ISSUE_CREATOR	2
OBSERVER	200	Deprecated *

Struct: StepPermissions

Key	Field	Type	Description	Requiredness	Default value
1	addAndDuplicateSteps	bool		default
2	addAndDuplicateStepGroups	bool		default
3	markStepsNA	bool		default
4	sendFieldInput	bool		default
5	completeSteps	bool		default

Struct: UserPermissions

Key	Field	Type	Description	Requiredness	Default value
1	inviteUsers	bool		default
2	removeUsers	bool		default

Struct: TemplatePermissions

Key	Field	Type	Description	Requiredness	Default value
1	addTemplates	bool		default
2	addSets	bool		default

Struct: DocumentPermissions

Key	Field	Type	Description	Requiredness	Default value
1	add	bool		default
2	remove	bool		default

Struct: IssuePermissions

Key	Field	Type	Description	Requiredness	Default value
1	create	bool		default
2	resolve	bool		default
3	inviteUsers	bool		default
4	removeUsers	bool		default

Struct: JobPermissions

Key	Field	Type	Description	Requiredness	Default value
1	editTitle	bool		default
2	editMetadata	bool		default
3	complete	bool		default
4	uncomplete	bool		default
101	step	StepPermissions		default
102	user	UserPermissions		default
103	template	TemplatePermissions		default
104	doc	DocumentPermissions		default
105	issue	IssuePermissions		optional

Struct: IndexOpts

Key	Field	Type	Description	Requiredness	Default value
1	showArchived	bool	Set showArchived to false to filter out archived jobRoles. Defaults to true	default	true

Struct: JobRoleSelectOpts

Key	Field	Type	Description	Requiredness	Default value
1	includeRestrictedUserModulars	bool	Returns restricted user ids instead of user modulars when false	default
2	allUsers	bool	Returns roles for all users instead of just current user's Only valid for getAllAssignedRoles, and is ignored if user is not a team admin	default

Struct: JobRoleRestriction

Key	Field	Type	Description	Requiredness	Default value
1	restricted	bool	When creating/updating a job role, if true, restrict to the user ids/emails specified by permitUserIds When retrieving a job role, it is restricted to the users specified by permittedUsers or permitUserIds based on JobRoleSelectOpts, by default permitUserIds	optional
2	permitUserIds	list<string>		optional
3	permittedUsers	list<user.UserModular>		optional

Struct: JobRoleParams

Key	Field	Type	Description	Requiredness	Default value
1	name	string	Name of the job role	optional
2	descrip	string	Description of the job role	optional
3	permissions	setting.SettingsForm	Settings form for job role permissions. Get by calling settings#indexJobPermissions()	optional
4	restriction	JobRoleRestriction	Restrictions for this job role	optional

Mutable parts of the job role

Struct: JobRole

Key	Field	Type	Description	Requiredness	Default value
1	id	string	UUID of the job role	default
2	teamId	string	UUID of the associated team	default
3	name	string	Name of the job role	default
4	descrip	string	Description of the job role	default
5	archivedAt	i64	Unix timestamp of when the role was archived. 0 means the role is not archived.	default
6	systemRole	bool	System job role, cannot be modified	default
7	systemRoleType	SystemRoleType	Kind of system job role (for client-side identification, e.g. for translation)	optional
8	permissions	JobPermissions		optional
9	restriction	JobRoleRestriction	Restrictions for this job role	optional

Struct: PermissionChangeWarning

Key	Field	Type	Description	Requiredness	Default value
1	unexecutableTemplateIds	set<string>		default

Shows the templates and jobs that would be placed in an un-executable state on the given permissions update. I.e. a job role is not longer able to execute a step but there exist steps assigned to that job role.

Struct: AllRolesResult

Key	Field	Type	Description	Requiredness	Default value
1	userRoleIds	map<string, list<string>>	User id to role id list, all this user's assigned roles on the team	default
2	idRoles	map<string, JobRole>	All the job roles contained in the above map, indexed by job role id	default

Function: JobRoleService.index

list<JobRole> index(string teamId,
                    IndexOpts opts,
                    JobRoleSelectOpts selectOpts)
    throws common.SystemException

List all of a team's job roles

Function: JobRoleService.getAllAssignedRoles

AllRolesResult getAllAssignedRoles(string teamId,
                                   JobRoleSelectOpts selectOpts)
    throws common.SystemException

Gets a map of the team's job roles If current user is not a team admin, return only his assigned roles.

Function: JobRoleService.create

JobRole create(string teamId,
               JobRoleParams params)
    throws common.SystemException

Create a new job role Fails with error XXX if name is not unique Fails with error YYY if missing name

Parameters

Name	Description
teamId	Team to create role for
params	Parameters for the job role

Function: JobRoleService.update

JobRole update(string roleId,
               JobRoleParams params)
    throws common.SystemException

Fails with error XXX if name is not unique

Parameters

Name	Description
roleId	Id of job role
params	Parameters for the job role

Function: JobRoleService.validatePermissionsForm

PermissionChangeWarning validatePermissionsForm(string roleId,
                                                setting.SettingsForm permissions)
    throws common.SystemException

Validate the contents of the job role permissions form. See PermissionChangeWarning for details about warnings.

Function: JobRoleService.get

JobRole get(string roleId,
            JobRoleSelectOpts selectOpts)
    throws common.SystemException

Get a job role

Function: JobRoleService.archive

JobRole archive(string jobRoleId)
    throws common.SystemException

Archive a job role. Archived job roles can no longer be assigned in future jobs. They will still function normally in existing jobs.

Function: JobRoleService.unarchive

JobRole unarchive(string jobRoleId)
    throws common.SystemException

Unarchive a job role.

Function: JobRoleService.getPermissionsSettings

setting.SettingsForm getPermissionsSettings(string jobRoleId)
    throws common.SystemException

Get the current permissions form for a job role